Скачать или смотреть Resolving the Test runtime classpath does not contain plugin metadata file Error in Gradle Testing

Learn how to fix the common Gradle error related to missing `plugin-under-test-metadata.properties` file during integration testing.
---
This video is based on the question https://stackoverflow.com/q/68311756/ asked by the user 'Sam' ( https://stackoverflow.com/u/3744824/ ) and on the answer https://stackoverflow.com/a/68388583/ provided by the user 'Sam' ( https://stackoverflow.com/u/3744824/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Test runtime classpath does not contain plugin metadata file 'plugin-under-test-metadata.properties'

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Resolving the Test runtime classpath does not contain plugin metadata file Error in Gradle Testing

When upgrading to a newer version of Gradle, developers often encounter issues that can cause their tests to fail. One such error is the dreaded message stating: Test runtime classpath does not contain plugin metadata file 'plugin-under-test-metadata.properties'. This can be particularly frustrating when you're trying to implement tests for your Gradle plugins using the TestKit framework. In this post, we’ll go through the root cause of this problem and how you can fix it effectively.

The Problem: Missing Metadata File

After upgrading your Gradle version (in this scenario, to 6.8.1), and making necessary dependencies in your build.gradle, you're likely to run into errors related to missing metadata files essential for the plugin you're testing. Specifically, the error message references the absence of the plugin-under-test-metadata.properties file.

The Code Context

In your testing setup, you might have setup code that looks like this:

[[See Video to Reveal this Text or Code Snippet]]

When you call the method withPluginClasspath(), it checks for the necessary plugin-under-test-metadata.properties file, and upon failing to find it, throws the error.

The Solution: Adding the Missing Properties File

The solution to the issue is pretty straightforward - you need to include the plugin-under-test-metadata.properties file in your project structure. Here’s a step-by-step guide on how to do that:

Step 1: Locate the Resources Folder

In your Gradle project, navigate to the src directory.

Create a folder named resources if it doesn't already exist. This is where Gradle looks for resource files.

Step 2: Create the Metadata File

Inside the src/resources folder, create a new file named plugin-under-test-metadata.properties.

Populate it with the necessary metadata information. While the contents can vary based on your plugin, a basic example would look like this:

[[See Video to Reveal this Text or Code Snippet]]

Step 3: Verify Classpath Configuration

Make sure that your build.gradle file is correctly configured to include this resource in your testing classpath. Gradle generally includes src/test/resources in the compilation classpath, but it's good practice to verify.

Step 4: Run Your Tests

Once you have added the plugin-under-test-metadata.properties file, proceed to run your integration tests again. You should no longer encounter the missing file error.

Conclusion

Encountering the error Test runtime classpath does not contain plugin metadata file 'plugin-under-test-metadata.properties' can disrupt your development process, particularly during testing phases. By following the steps outlined to manually add the necessary properties file, you can quickly resolve this issue and continue working on your Gradle plugin development with confidence.

Consider this solution as a go-to for similar problems related to Gradle metadata when working with plugins. Happy coding!