|
| 1 | +package io.nextflow.gradle |
| 2 | + |
| 3 | +import org.gradle.api.file.RegularFileProperty |
| 4 | +import org.gradle.api.provider.ListProperty |
| 5 | +import org.gradle.api.tasks.Input |
| 6 | +import org.gradle.api.tasks.JavaExec |
| 7 | +import org.gradle.api.tasks.OutputFile |
| 8 | + |
| 9 | +/** |
| 10 | + * Gradle task to generate the plugin specification file for a Nextflow plugin. |
| 11 | + * |
| 12 | + * <p>This task creates a JSON specification file (spec.json) that describes the plugin's |
| 13 | + * structure and capabilities. The spec file is used by Nextflow's plugin system to understand |
| 14 | + * what extension points and functionality the plugin provides. |
| 15 | + * |
| 16 | + * <p>This task extends {@link JavaExec} because it needs to execute Java code from the |
| 17 | + * Nextflow core library (specifically {@code nextflow.plugin.spec.PluginSpecWriter}) to |
| 18 | + * generate the spec file. The JavaExec task type provides the necessary infrastructure to: |
| 19 | + * <ul> |
| 20 | + * <li>Set up a Java process with the correct classpath</li> |
| 21 | + * <li>Execute a main class with arguments</li> |
| 22 | + * <li>Handle the execution lifecycle and error reporting</li> |
| 23 | + * </ul> |
| 24 | + * |
| 25 | + * <p>The task automatically checks if the configured Nextflow version supports plugin specs |
| 26 | + * (version 25.09.0 or later). For earlier versions, it creates an empty spec file to maintain |
| 27 | + * compatibility. |
| 28 | + * |
| 29 | + * <p>The generated spec file is placed at {@code build/resources/main/META-INF/spec.json} |
| 30 | + * and is included in the plugin's JAR file. |
| 31 | + * |
| 32 | + * @author Ben Sherman <bentshermann@gmail.com> |
| 33 | + */ |
| 34 | +abstract class GenerateSpecTask extends JavaExec { |
| 35 | + |
| 36 | + /** |
| 37 | + * List of fully qualified class names that represent extension points provided by this plugin. |
| 38 | + * These classes extend or implement Nextflow extension point interfaces. |
| 39 | + */ |
| 40 | + @Input |
| 41 | + final ListProperty<String> extensionPoints |
| 42 | + |
| 43 | + /** |
| 44 | + * The output file where the plugin specification JSON will be written. |
| 45 | + * Defaults to {@code build/resources/main/META-INF/spec.json}. |
| 46 | + */ |
| 47 | + @OutputFile |
| 48 | + final RegularFileProperty specFile |
| 49 | + |
| 50 | + /** |
| 51 | + * Constructor that configures the task to execute the PluginSpecWriter from Nextflow core. |
| 52 | + * Sets up the classpath, main class, and arguments needed to generate the spec file. |
| 53 | + */ |
| 54 | + GenerateSpecTask() { |
| 55 | + extensionPoints = project.objects.listProperty(String) |
| 56 | + extensionPoints.convention(project.provider { |
| 57 | + project.extensions.getByType(NextflowPluginConfig).extensionPoints |
| 58 | + }) |
| 59 | + |
| 60 | + specFile = project.objects.fileProperty() |
| 61 | + specFile.convention(project.layout.buildDirectory.file("resources/main/META-INF/spec.json")) |
| 62 | + |
| 63 | + getMainClass().set('nextflow.plugin.spec.PluginSpecWriter') |
| 64 | + |
| 65 | + project.afterEvaluate { |
| 66 | + setClasspath(project.sourceSets.getByName('specFile').runtimeClasspath) |
| 67 | + setArgs([specFile.get().asFile.toString()] + extensionPoints.get()) |
| 68 | + } |
| 69 | + |
| 70 | + doFirst { |
| 71 | + specFile.get().asFile.parentFile.mkdirs() |
| 72 | + } |
| 73 | + } |
| 74 | + |
| 75 | + /** |
| 76 | + * Executes the task to generate the plugin spec file. |
| 77 | + * Checks if the Nextflow version supports plugin specs (>= 25.09.0). |
| 78 | + * For unsupported versions, creates an empty spec file instead. |
| 79 | + */ |
| 80 | + @Override |
| 81 | + void exec() { |
| 82 | + def config = project.extensions.getByType(NextflowPluginConfig) |
| 83 | + if (!isVersionSupported(config.nextflowVersion)) { |
| 84 | + createEmptySpecFile() |
| 85 | + return |
| 86 | + } |
| 87 | + super.exec() |
| 88 | + } |
| 89 | + |
| 90 | + /** |
| 91 | + * Determines whether the given Nextflow version supports plugin specifications. |
| 92 | + * Plugin specs are supported in Nextflow version 25.09.0 and later. |
| 93 | + * |
| 94 | + * @param nextflowVersion the Nextflow version string (e.g., "25.09.0-edge") |
| 95 | + * @return true if the version supports plugin specs, false otherwise |
| 96 | + */ |
| 97 | + private boolean isVersionSupported(String nextflowVersion) { |
| 98 | + try { |
| 99 | + def parts = nextflowVersion.split(/\./, 3) |
| 100 | + if (parts.length < 3) |
| 101 | + return false |
| 102 | + def major = Integer.parseInt(parts[0]) |
| 103 | + def minor = Integer.parseInt(parts[1]) |
| 104 | + return major >= 25 && minor >= 9 |
| 105 | + } catch (Exception e) { |
| 106 | + project.logger.warn("Unable to parse Nextflow version '${nextflowVersion}', assuming plugin spec is not supported: ${e.message}") |
| 107 | + return false |
| 108 | + } |
| 109 | + } |
| 110 | + |
| 111 | + /** |
| 112 | + * Creates an empty spec file for backward compatibility with Nextflow versions |
| 113 | + * that don't support plugin specifications. |
| 114 | + */ |
| 115 | + private void createEmptySpecFile() { |
| 116 | + specFile.get().asFile.text = '' |
| 117 | + } |
| 118 | +} |
0 commit comments