Merge pull request #1170 from CodexRaunak/improve-recipe

Modify the recipe UpdateJenkinsfileForJava25 to a general recipe

Author: jonesbusy

…/recipes/UpdateJenkinsfileForJava25.java …pes/UpdateJenkinsfileForJavaVersion.javaplugin-modernizer-core/src/main/java/io/jenkins/tools/pluginmodernizer/core/recipes/UpdateJenkinsfileForJava25.java renamed to plugin-modernizer-core/src/main/java/io/jenkins/tools/pluginmodernizer/core/recipes/UpdateJenkinsfileForJavaVersion.java plugin-modernizer-core/src/main/java/io/jenkins/tools/pluginmodernizer/core/recipes/UpdateJenkinsfileForJava25.java renamed to plugin-modernizer-core/src/main/java/io/jenkins/tools/pluginmodernizer/core/recipes/UpdateJenkinsfileForJavaVersion.java

@@ -8,6 +8,7 @@
 import java.util.List;
 import java.util.stream.Collectors;
 import org.openrewrite.ExecutionContext;
+import org.openrewrite.Option;
 import org.openrewrite.Recipe;
 import org.openrewrite.TreeVisitor;
 import org.openrewrite.groovy.GroovyVisitor;
@@ -17,18 +18,32 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class UpdateJenkinsfileForJava25 extends Recipe {
+public class UpdateJenkinsfileForJavaVersion extends Recipe {
 
-    private static final Logger LOG = LoggerFactory.getLogger(UpdateJenkinsfileForJava25.class);
+    private static final Logger LOG = LoggerFactory.getLogger(UpdateJenkinsfileForJavaVersion.class);
+
+    /**
+     * The java version.
+     */
+    @Option(displayName = "Version", description = "Java version.", example = "25")
+    Integer javaVersion;
+
+    /**
+     * Constructor.
+     * @param javaVersion The java version.
+     */
+    public UpdateJenkinsfileForJavaVersion(Integer javaVersion) {
+        this.javaVersion = javaVersion;
+    }
 
     @Override
     public String getDisplayName() {
-        return "Update Jenkinsfile for Java 25 Testing";
+        return "Update Jenkinsfile for specefied Java Version";
     }
 
     @Override
     public String getDescription() {
-        return "Adds Java 25 to the buildPlugin configurations in Jenkinsfile for runtime testing on ci.jenkins.io.";
+        return "Adds Java version to the buildPlugin configurations in Jenkinsfile for runtime testing on ci.jenkins.io.";
     }
 
     @Override
@@ -41,21 +56,27 @@ public J visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx)
                     return method;
                 }
 
+                JDK jdkVersion = JDK.get(javaVersion);
+                if (jdkVersion == null) {
+                    LOG.warn("Unsupported Java version: {}, probably not an LTS. No update will be made.", javaVersion);
+                    return method;
+                }
+
                 // extract all existing arguments into a simple data model.
                 JenkinsfileModel model = new JenkinsfileModel(method);
 
-                // see if java 25 is already present
-                boolean hasJava25 = model.platformConfigs.stream()
+                // see if java version is already present
+                boolean hasJavaVersion = model.platformConfigs.stream()
                         .anyMatch(p -> "linux".equalsIgnoreCase(p.name().toString())
-                                && p.jdk().getMajor() == 25);
+                                && p.jdk().getMajor() == javaVersion);
 
-                if (hasJava25) {
-                    LOG.info("Java 25 configuration already exists. No update needed.");
+                if (hasJavaVersion) {
+                    LOG.info("Java {} configuration already exists. No update needed.", javaVersion);
                     return method;
                 }
 
-                // add the new java 25 configuration to the model.
-                model.platformConfigs.add(PlatformConfig.build(Platform.LINUX, JDK.JAVA_25));
+                // add the java version configuration to the model.
+                model.platformConfigs.add(PlatformConfig.build(Platform.LINUX, jdkVersion));
 
                 // We pass it the complete, updated configuration, and it will overwrite the old method call.
                 // in future at some point remove jdk 17 from the configurations

plugin-modernizer-core/src/main/resources/META-INF/rewrite/recipes.yml

@@ -148,7 +148,8 @@ recipeList:
 #  - org.openrewrite.java.migrate.RemoveSecurityManager
 #  - org.openrewrite.java.migrate.SystemGetSecurityManagerToNull
   - io.jenkins.tools.pluginmodernizer.SetupJenkinsfile
-  - io.jenkins.tools.pluginmodernizer.core.recipes.UpdateJenkinsfileForJava25
+  - io.jenkins.tools.pluginmodernizer.core.recipes.UpdateJenkinsfileForJavaVersion:
+      javaVersion: 25
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: io.jenkins.tools.pluginmodernizer.MigrateToJenkinsBaseLineProperty

…ipes/UpdateJenkinsfileForJava25Test.java …UpdateJenkinsfileForJavaVersionTest.javaplugin-modernizer-core/src/test/java/io/jenkins/tools/pluginmodernizer/core/recipes/UpdateJenkinsfileForJava25Test.java renamed to plugin-modernizer-core/src/test/java/io/jenkins/tools/pluginmodernizer/core/recipes/UpdateJenkinsfileForJavaVersionTest.java plugin-modernizer-core/src/test/java/io/jenkins/tools/pluginmodernizer/core/recipes/UpdateJenkinsfileForJava25Test.java renamed to plugin-modernizer-core/src/test/java/io/jenkins/tools/pluginmodernizer/core/recipes/UpdateJenkinsfileForJavaVersionTest.java

@@ -9,15 +9,15 @@
 import org.openrewrite.test.RewriteTest;
 
 /**
- * Test for {@link UpdateJenkinsfileForJava25}.
+ * Test for {@link UpdateJenkinsfileForJavaVersion}.
  */
 @Execution(ExecutionMode.CONCURRENT)
-public class UpdateJenkinsfileForJava25Test implements RewriteTest {
+public class UpdateJenkinsfileForJavaVersionTest implements RewriteTest {
 
     @Test
     void shouldUpgradeLegacyConfigAndAddJava25() {
         rewriteRun(
-                spec -> spec.recipe(new UpdateJenkinsfileForJava25()),
+                spec -> spec.recipe(new UpdateJenkinsfileForJavaVersion(25)),
                 // language=groovy
                 groovy(
                         """
@@ -51,7 +51,7 @@ void shouldUpgradeLegacyConfigAndAddJava25() {
     @Test
     void shouldAddJava25ToModernConfigurations() {
         rewriteRun(
-                spec -> spec.recipe(new UpdateJenkinsfileForJava25()),
+                spec -> spec.recipe(new UpdateJenkinsfileForJavaVersion(25)),
                 // language=groovy
                 groovy(
                         """
@@ -81,9 +81,59 @@ void shouldAddJava25ToModernConfigurations() {
     }
 
     @Test
-    void shouldNotAddJava25WhenAlreadyPresent() {
+    void shouldAddJava21ToModernConfigurations() {
         rewriteRun(
-                spec -> spec.recipe(new UpdateJenkinsfileForJava25()),
+                spec -> spec.recipe(new UpdateJenkinsfileForJavaVersion(21)),
+                // language=groovy
+                groovy(
+                        """
+                        buildPlugin(
+                          useContainerAgent: true,
+                          configurations: [
+                            [platform: 'linux', jdk: 17],
+                            [platform: 'windows', jdk: 17]
+                          ]
+                        )
+                        """,
+                        """
+                        /*
+                         See the documentation for more options:
+                         https://github.com/jenkins-infra/pipeline-library/
+                        */
+                        buildPlugin(
+                          useContainerAgent: true,
+                          forkCount: '1C', // Set to `false` if you need to use Docker for containerized tests
+                          configurations: [
+                            [platform: 'linux', jdk: 17],
+                            [platform: 'windows', jdk: 17],
+                            [platform: 'linux', jdk: 21],
+                        ])
+                        """,
+                        sourceSpecs -> sourceSpecs.path(ArchetypeCommonFile.JENKINSFILE.getPath())));
+    }
+
+    @Test
+    void shouldNotAddJavaVersionToModernConfigurationsAsNotLTS() {
+        rewriteRun(
+                spec -> spec.recipe(new UpdateJenkinsfileForJavaVersion(18)),
+                // language=groovy
+                groovy(
+                        """
+                        buildPlugin(
+                          useContainerAgent: true,
+                          configurations: [
+                            [platform: 'linux', jdk: 17],
+                            [platform: 'windows', jdk: 17]
+                          ]
+                        )
+                        """,
+                        sourceSpecs -> sourceSpecs.path(ArchetypeCommonFile.JENKINSFILE.getPath())));
+    }
+
+    @Test
+    void shouldNotAddJavaVersionWhenAlreadyPresent() {
+        rewriteRun(
+                spec -> spec.recipe(new UpdateJenkinsfileForJavaVersion(25)),
                 // language=groovy
                 groovy(
                         """
@@ -98,9 +148,9 @@ void shouldNotAddJava25WhenAlreadyPresent() {
     }
 
     @Test
-    void shouldAddConfigurationsBlockWhenMissing() {
+    void shouldAddConfigurationsBlockForJavaVersionWhenMissing() {
         rewriteRun(
-                spec -> spec.recipe(new UpdateJenkinsfileForJava25()),
+                spec -> spec.recipe(new UpdateJenkinsfileForJavaVersion(25)),
                 // language=groovy
                 groovy(
                         """