Address deprecation warnings for tests and add local install gradle action #19
Conversation
| @@ -78,10 +78,43 @@ dependencies { | |||
| modules { | |||
| module("commons-logging:commons-logging") { replacedBy("org.slf4j:jcl-over-slf4j") } | |||
| } | |||
|
|
|||
| // Add this line to explicitly declare the test framework launcher | |||
| testRuntimeOnly 'org.junit.platform:junit-platform-launcher' | |||
There was a problem hiding this comment.
This is an addition to address the warning when running make test. The warning was:
./gradlew test --warning-mode all
Task :plugins:nf-hello:test
The automatic loading of test framework implementation dependencies has been deprecated. This is scheduled to be removed in Gradle 9.0. Declare the desired test framework directly on the test suite or explicitly declare the test framework implementation dependencies on the test's runtime classpath. Consult the upgrading guide for further information: https://docs.gradle.org/8.4/userguide/upgrading_version_8.html#test_framework_implementation_dependencies
plugins/nf-hello/build.gradle
Outdated
| } | ||
|
|
||
| // use JUnit 5 platform | ||
| test { | ||
| useJUnitPlatform() | ||
| } | ||
|
|
||
| // Task to install the plugin to the Nextflow plugins directory |
There was a problem hiding this comment.
Would it make sense to put this task in the parent build.gradle, inside the submodules config with the other related tasks?
There was a problem hiding this comment.
It would make sense if we can have the task iterate over all the possible plugins in the plugins directory. There is only a single plugin at the moment, but it's very possible to have a single repository that hosts multiple plugins.
I'm no gradle expert, but I'll see what I can do.
There was a problem hiding this comment.
Done. Thanks for the suggestion, Tom!
| /* | ||
| * Task to install all plugins to the Nextflow plugins directory | ||
| */ | ||
| task installPlugins() { |
There was a problem hiding this comment.
Gradle isn't the most intuitive, but in this case these two tasks (installPlugins and installSpecificPlugin) are actually implied by installPlugin.
The command
./gradlew installPlugin
will execute the installPlugin task on all modules which define it, and since we define the installPlugin in the submodules block, it's automatically defined on all the individual plugin modules.
To execute the task only for a specific plugin, we can explicitly state which submodule to run the task on:
./gradlew :plugins:nf-hello:installPlugin
This means we can remove both of these tasks, and update the Makefile to use the above forms.
There was a problem hiding this comment.
Ah! I didn't know that! Thanks Tom!!
| /* | ||
| * Task to install all plugins to the Nextflow plugins directory | ||
| */ | ||
| task installPlugins() { | ||
| description = 'Installs all plugins to the Nextflow plugins directory' | ||
| group = 'Plugin Installation' | ||
|
|
||
| dependsOn subprojects.installPlugin | ||
| } | ||
|
|
||
| /* | ||
| * Task to install a specific plugin by name | ||
| * Usage: ./gradlew installPlugin -Pplugin=nf-hello | ||
| */ | ||
| task installSpecificPlugin { | ||
| description = 'Installs a specific plugin (specify with -Pplugin=plugin-name)' | ||
| group = 'Plugin Installation' | ||
|
|
||
| doFirst { | ||
| if (!project.hasProperty('plugin')) { | ||
| throw new GradleException("Please specify a plugin name using -Pplugin=plugin-name") | ||
| } | ||
| def pluginName = project.property('plugin') | ||
| def pluginProject = project.findProject(":plugins:${pluginName}") | ||
| if (!pluginProject) { | ||
| throw new GradleException("Plugin '${pluginName}' not found") | ||
| } | ||
| dependsOn pluginProject.installPlugin | ||
| } | ||
| } |
There was a problem hiding this comment.
Don't forget to remove these
| /* | |
| * Task to install all plugins to the Nextflow plugins directory | |
| */ | |
| task installPlugins() { | |
| description = 'Installs all plugins to the Nextflow plugins directory' | |
| group = 'Plugin Installation' | |
| dependsOn subprojects.installPlugin | |
| } | |
| /* | |
| * Task to install a specific plugin by name | |
| * Usage: ./gradlew installPlugin -Pplugin=nf-hello | |
| */ | |
| task installSpecificPlugin { | |
| description = 'Installs a specific plugin (specify with -Pplugin=plugin-name)' | |
| group = 'Plugin Installation' | |
| doFirst { | |
| if (!project.hasProperty('plugin')) { | |
| throw new GradleException("Please specify a plugin name using -Pplugin=plugin-name") | |
| } | |
| def pluginName = project.property('plugin') | |
| def pluginProject = project.findProject(":plugins:${pluginName}") | |
| if (!pluginProject) { | |
| throw new GradleException("Plugin '${pluginName}' not found") | |
| } | |
| dependsOn pluginProject.installPlugin | |
| } | |
| } |
|
The settings on this repo require you to both 'sign-off' ( |
Signed-off-by: Rob Syme <[email protected]>
This fix is to address the deprecation warning that occurs when running tests. This solution follows the recommended approach from the Gradle documentation and should resolve the deprecation warning while maintaining the same test functionality. Signed-off-by: Rob Syme <[email protected]>
Signed-off-by: Rob Syme <[email protected]>
Co-authored-by: Tom Sellman <[email protected]> Signed-off-by: Rob Syme <[email protected]>
robsyme
force-pushed
the
pre-work-tidy
branch
from
0da2576 to
9553876
Compare
|
Signed and delivered 🫡 |
This adds a new make command and corresponding gradle task to install the plugin in the user's local plugins directory. This is to make it a little bit easier to get started with plugin development.