NCL-9314 Add compatibility layer for groovy scripts. Updates for README.

Author: rnc

README.md

@@ -32,7 +32,7 @@ The `analyzer` directory contains the gradle plugin that generates metadata info
 the project version.
 
 The latest version of the Analyzer init script can be retrieved from
-https://repo1.maven.org/maven2/org/jboss/gm/analyzer/3.24/analyzer-3.24-init.gradle
+https://repo1.maven.org/maven2/org/jboss/pnc/gradle-manipulator/analyzer/4.0/analyzer-4.0-init.gradle
 
 ## Manipulation
 

analyzer/src/main/resources/analyzer-init.gradle

@@ -13,7 +13,6 @@ initscript {
 }
 
 allprojects {
-
     ext.gmeAnalyse = true
 
     apply plugin: org.jboss.pnc.gradlemanipulator.analyzer.alignment.AlignmentPlugin

analyzer/src/main/resources/gme.gradle

@@ -40,5 +40,4 @@ allprojects {
         logger.info("Applying plugin org.jboss.pnc.gradlemanipulator.manipulation.ManipulationPlugin to project in {}", project.getProjectDir())
         apply plugin: org.jboss.pnc.gradlemanipulator.manipulation.ManipulationPlugin
     }
-
 }

build.gradle.kts

@@ -13,6 +13,7 @@ import net.linguica.gradle.maven.settings.MavenSettingsPlugin.MAVEN_SETTINGS_EXT
 import net.linguica.gradle.maven.settings.MavenSettingsPluginExtension
 import org.ajoberstar.grgit.Grgit
 import org.apache.maven.settings.building.SettingsBuildingException
+import org.gradle.kotlin.dsl.project
 
 plugins {
     java
@@ -142,7 +143,7 @@ tasks.register("fixupReadme") {
         if ("true" == System.getProperty("release", "") && project == project.rootProject) {
             val tmp = File(System.getProperty("java.io.tmpdir"))
             val source = File(project.rootDir, "README.md")
-            val searchString = "https://repo1.maven.org/maven2/org/jboss/gm/analyzer"
+            val searchString = "https://repo1.maven.org/maven2/org/jboss/pnc/gradle-manipulator/analyzer"
 
             if (!source.exists() || Files.readAllLines(source.toPath()).none { s -> s.contains(searchString) }) {
                 throw GradleException("Unable to find '$searchString' in README.md")
@@ -350,9 +351,9 @@ subprojects {
 
     val testFixturesCompile by configurations.creating { extendsFrom(configurations["implementation"]) }
 
-    configurations.create("testFixturesRuntime") {
-        extendsFrom(configurations["runtimeOnly"], configurations["testFixturesCompile"])
-    }
+    configurations.create(
+        "testFixturesRuntime",
+        Action { extendsFrom(configurations["runtimeOnly"], configurations["testFixturesCompile"]) })
 
     val testFixturesUsageImplementation by
         configurations.creating {
@@ -367,12 +368,14 @@ subprojects {
     configurations["testImplementation"].extendsFrom(testFixturesUsageImplementation)
     configurations["testRuntimeOnly"].extendsFrom(testFixturesUsageRuntimeOnly)
 
-    sourceSets.create("testFixtures") {
-        java.srcDir("src/testFixtures/java")
-        resources.srcDir("src/testFixtures/resources")
-        compileClasspath = sourceSets["main"].output + configurations["testFixturesCompile"]
-        runtimeClasspath = output + compileClasspath + configurations["testFixturesRuntime"]
-    }
+    sourceSets.create(
+        "testFixtures",
+        Action {
+            java.srcDir("src/testFixtures/java")
+            resources.srcDir("src/testFixtures/resources")
+            compileClasspath = sourceSets["main"].output + configurations["testFixturesCompile"]
+            runtimeClasspath = output + compileClasspath + configurations["testFixturesRuntime"]
+        })
 
     dependencies {
         outputDirectories(sourceSets["testFixtures"].output)
@@ -435,6 +438,8 @@ subprojects {
                     exclude(dependency("org.commonjava.atlas.maven:.*:.*"))
                     exclude(dependency("org.jboss.pnc.maven-manipulator:.*:.*"))
                     exclude(dependency("org.slf4j:.*:.*"))
+                    // Prevent org.jboss.gm.common.groovy.BaseScript from being removed.
+                    exclude(project(":common"))
                 }
             }
 

cli/src/test/java/org/jboss/pnc/gradlemanipulator/cli/MainTest.java

@@ -197,6 +197,44 @@ public void testInvokeGroovy() throws Exception {
         assertTrue(systemOutRule.getLinesNormalized().contains("Executor org.zeroturnaround.exec.ProcessExecutor"));
     }
 
+    @Test
+    public void testInvokeGroovyFails1() throws Exception {
+        final File projectRoot = new File(MainTest.class.getClassLoader().getResource("build.gradle").getPath());
+        final URL groovy = Thread.currentThread().getContextClassLoader().getResource("sample-bad1.groovy");
+
+        Main m = new Main();
+        String[] args = new String[] {
+                "-t",
+                projectRoot.getParentFile().getAbsolutePath(),
+                "tasks",
+                "-DgroovyScripts=" + groovy };
+        try {
+            m.run(args);
+            fail("No exception thrown");
+        } catch (ManipulationException e) {
+            assertTrue(e.getCause().getMessage().contains("Getting the project is not supported for Groovy in stage"));
+        }
+    }
+
+    @Test
+    public void testInvokeGroovyFails2() throws Exception {
+        final File projectRoot = new File(MainTest.class.getClassLoader().getResource("build.gradle").getPath());
+        final URL groovy = Thread.currentThread().getContextClassLoader().getResource("sample-bad2.groovy");
+
+        Main m = new Main();
+        String[] args = new String[] {
+                "-t",
+                projectRoot.getParentFile().getAbsolutePath(),
+                "tasks",
+                "-DgroovyScripts=" + groovy };
+        try {
+            m.run(args);
+            fail("No exception thrown");
+        } catch (ManipulationException e) {
+            assertTrue(e.getCause().getMessage().contains("Getting the model is not supported for Groovy in stage"));
+        }
+    }
+
     @Test
     public void testDisableGME() throws Exception {
 

cli/src/test/resources/sample-bad1.groovy

@@ -0,0 +1,10 @@
+import org.jboss.pnc.mavenmanipulator.core.groovy.GMEBaseScript
+import org.jboss.pnc.mavenmanipulator.core.groovy.InvocationPoint
+import org.jboss.pnc.mavenmanipulator.core.groovy.InvocationStage
+import org.jboss.gm.common.groovy.BaseScript
+
+@InvocationPoint(invocationPoint = InvocationStage.FIRST)
+@GMEBaseScript BaseScript gmeScript
+
+println("Running Groovy script on " + gmeScript.getBaseDir())
+println("Project " + gmeScript.getProject())

cli/src/test/resources/sample-bad2.groovy

@@ -0,0 +1,10 @@
+import org.jboss.pnc.mavenmanipulator.core.groovy.GMEBaseScript
+import org.jboss.pnc.mavenmanipulator.core.groovy.InvocationPoint
+import org.jboss.pnc.mavenmanipulator.core.groovy.InvocationStage
+import org.jboss.gm.common.groovy.BaseScript
+
+@InvocationPoint(invocationPoint = InvocationStage.FIRST)
+@GMEBaseScript BaseScript gmeScript
+
+println("Running Groovy script on " + gmeScript.getBaseDir())
+println("Model " + gmeScript.getModel())

cli/src/test/resources/sample.groovy

@@ -1,17 +1,16 @@
 import org.jboss.pnc.mavenmanipulator.core.groovy.GMEBaseScript
 import org.jboss.pnc.mavenmanipulator.core.groovy.InvocationPoint
 import org.jboss.pnc.mavenmanipulator.core.groovy.InvocationStage
-import org.jboss.pnc.gradlemanipulator.common.groovy.BaseScript
+import org.jboss.gm.common.groovy.BaseScript
 import org.jboss.pnc.gradlemanipulator.common.utils.PluginUtils
 
-@GrabResolver(name='private', root='https://maven.repository.redhat.com/techpreview/all/')
-@Grab('org.zeroturnaround:zt-exec:1.10')
-
 @InvocationPoint(invocationPoint = InvocationStage.FIRST)
 @GMEBaseScript BaseScript gmeScript
 
 println("Running Groovy script on " + gmeScript.getBaseDir())
 println("Known properties " + gmeScript.getUserProperties())
+println("FileIO " + gmeScript.getFileIO())
+println("InvocationStage " + gmeScript.getInvocationStage())
 
 println(PluginUtils.getSupportedPlugins())
 // Hack to avoid using imports and groovy script causing errors in IntelliJ.

common/src/main/java/org/jboss/gm/common/groovy/BaseScript.java

@@ -0,0 +1,11 @@
+package org.jboss.gm.common.groovy;
+
+/**
+ * Abstract class that should be used by developers wishing to implement groovy scripts
+ * for GME.
+ */
+public abstract class BaseScript extends org.jboss.pnc.gradlemanipulator.common.groovy.BaseScript {
+    {
+        println("Deprecated Groovy API - switch to importing org.jboss.pnc.gradlemanipulator");
+    }
+}