Adding a configuration directory to the plugins classpath

Help/Discuss
1

Hi,

I am trying to add an external directory of configuration files to the Gradle plugins classpath so that one of my plugins can do the following:

MyPlugin.class.getClassLoader().getResourceAsStream("com/foo/bar/config.properties");

To that end, I have created this file in my project directory:

repository/com/foo/bar/config.properties

and added this buildscript to my build.gradle:

buildscript {
    dependencies {
        classpath files('repository')
    }
}

However, my plugin is consistently failing to find my resource file. Is the buildscript classpath invisible from the plugins classpath? Because I am expecting its classloader to be one of the plugins classloader’s parents.

Thanks for any insights here,
Cheers,
Chris

P.S This example project is using Gradle 6.7.1 and Gradle’s test kit.

2

Could this just be a failing in the Gradle Test Kit? I am starting to suspect that the GradleRunner does not augment the plugins classpath with anything from the buildscript classpath.

3

I’ve tried adding buildSrc.jar to GradleRunner via logic resembling:

runner.withPluginClasspath(File("buildSrc/build/libs/buildSrc.jar") + runner.pluginClasspath)

but this doesn’t work either :man_facepalming:. I can only assume that the Gradle Test Kit just doesn’t support this.

4

I think I’ve finally managed to resolve this by wrapping my configuration file inside its own Gradle plugin. This allows me to perform :sparkles: magic :sparkles: like this:

project.getPluginManager().withPlugin(plug -> {
    Class<? extends Plugin> pluginClass = project.getPlugins().getPlugin(plug.getId()).getClass();
    loadConfig(pluginClass.getResourceAsStream("config.properties"));
});

provided my new plugin’s Plugin implementation lives in the same package as its configuration file.