Merge pull request #14007 from jdaugherty/7.0.x

#13557 - Move functional tests to grails-core

Author: jdaugherty

.github/workflows/gradle.yml

@@ -28,6 +28,7 @@ jobs:
             echo "value=false" >> $GITHUB_OUTPUT
           fi
   build:
+    name: 'Build'
     needs: skip_check
     permissions:
       contents: read  #  to fetch code (actions/checkout)
@@ -54,10 +55,37 @@ jobs:
         env:
           DEVELOCITY_BUILD_CACHE_NODE_USER: ${{ secrets.GRADLE_ENTERPRISE_BUILD_CACHE_NODE_USER }}
           DEVELOCITY_BUILD_CACHE_NODE_KEY: ${{ secrets.GRADLE_ENTERPRISE_BUILD_CACHE_NODE_KEY }}
-        run: ./gradlew build assemble groovydoc --continue
+        run: ./gradlew build assemble groovydoc -PskipFunctionalTests --continue
+  functional:
+    name: "Functional Tests"
+    needs: skip_check
+    permissions:
+      contents: read  #  to fetch code (actions/checkout)
+    strategy:
+      fail-fast: false
+      matrix:
+        java: [ '17', '21', '23' ]
+    runs-on: ubuntu-latest
+    steps:
+      - name: "📥 Checkout repository"
+        uses: actions/checkout@v4
+      - name: "☕️ Setup JDK"
+        uses: actions/setup-java@v4
+        with:
+          distribution: liberica
+          java-version: ${{ matrix.java }}
+      - name: "🐘 Setup Gradle"
+        uses: gradle/actions/setup-gradle@v4
+        with:
+          develocity-access-key: ${{ secrets.GRADLE_ENTERPRISE_ACCESS_KEY }}
+      - name: "🔨 Functional Tests"
+        env:
+          DEVELOCITY_BUILD_CACHE_NODE_USER: ${{ secrets.GRADLE_ENTERPRISE_BUILD_CACHE_NODE_USER }}
+          DEVELOCITY_BUILD_CACHE_NODE_KEY: ${{ secrets.GRADLE_ENTERPRISE_BUILD_CACHE_NODE_KEY }}
+        run: ./gradlew build -PonlyFunctionalTests
   publish:
     if: github.event_name == 'push' && needs.skip_check.outputs.found_skip_publish != 'true'
-    needs: build
+    needs: [build, functional]
     permissions:
       contents: read # limit to read access
     runs-on: ubuntu-latest
@@ -104,29 +132,4 @@ jobs:
           workflow: Java CI
           repo: grails/grails-doc
           ref: ${{ steps.extract_branch.outputs.value }}
-          token: ${{ secrets.GH_TOKEN }}
-  invoke-third-party-workflows:
-    if: github.event_name == 'push'
-    needs: [build, publish]
-    permissions:
-      contents: read # limit to read access
-    runs-on: ubuntu-latest
-    steps:
-      - name: "📝 Store the target branch"
-        id: extract_branch
-        run: |
-          echo "Determining Target Branch"
-          TARGET_BRANCH=${GITHUB_REF#refs/heads/}
-          echo $TARGET_BRANCH
-          echo "value=${TARGET_BRANCH}" >> $GITHUB_OUTPUT
-      - name: "📝 Create Snapshot Message for the Workflow Dispatch"
-        id: dispatch_message
-        run: echo "value={\"message\":\"New Core Snapshot $(date) - $GITHUB_SHA\"}" >> $GITHUB_OUTPUT
-      - name: "📡 Invoke the Java CI workflow in Grails Functional Tests"
-        uses: benc-uk/workflow-dispatch@e2e5e9a103e331dad343f381a29e654aea3cf8fc # v1.2.4 (Use commit sha as this is a 3rd party action)
-        with:
-          workflow: Java CI
-          repo: grails/grails-functional-tests
-          ref: ${{ steps.extract_branch.outputs.value }}
-          token: ${{ secrets.GH_TOKEN }}
-          inputs: ${{ steps.dispatch_message.outputs.value }}
+          token: ${{ secrets.GH_TOKEN }}

build.gradle

@@ -17,7 +17,6 @@ buildscript {
 apply plugin: 'idea'
 
 ext {
-    isJava8Compatible = org.gradle.api.JavaVersion.current().isJava8Compatible()
     grailsVersion = project.projectVersion
     isCiBuild = System.getenv().get("CI") as Boolean
     isGitHubRepoPublish = System.getenv("GITHUB_PUBLISH") == 'true'
@@ -185,12 +184,6 @@ subprojects { subproject ->
             'grails-plugin-converters': 'converters'
     ]
 
-    if (isPlugin) {
-        group = 'org.grails.plugins'
-    } else {
-        group = 'org.grails'
-    }
-
     if(isExample) {
         // Test projects will often include dependencies from grails-core, this file will ensure any dependencies included
         // will be substituted with projects in this repository instead of pulling upstream
@@ -206,6 +199,14 @@ subprojects { subproject ->
                 }
             }
         }
+
+        return
+    }
+
+    if (isPlugin) {
+        group = 'org.grails.plugins'
+    } else {
+        group = 'org.grails'
     }
 
     ext.pomInfo = {
@@ -258,7 +259,7 @@ subprojects { subproject ->
         apply plugin: 'project-report'
     }
 
-    if (!isTestSuite && !isExample) {
+    if (!isTestSuite) {
 
         apply plugin: 'maven-publish'
         apply plugin: 'signing'
@@ -346,7 +347,7 @@ subprojects { subproject ->
         }
     }
 
-    if (subproject.name in ['grails-dependencies', 'grails-bom'] || isExample) return
+    if (subproject.name in ['grails-dependencies', 'grails-bom']) return
 
     dependencies {
         implementation platform(project(':grails-bom'))
@@ -429,6 +430,12 @@ subprojects { subproject ->
     ]
 
     tasks.withType(Test).configureEach {
+        onlyIf {
+            if(project.hasProperty('onlyFunctionalTests')) {
+                return false
+            }
+            true
+        }
         useJUnitPlatform()
         jvmArgs += java17moduleReflectionCompatibilityArguments
     }
@@ -586,4 +593,4 @@ project.afterEvaluate {
 // see: https://docs.gradle.org/current/userguide/compatibility.html#groovy
 boolean compiledByGradleGroovyVersion(Project currentProject) {
     currentProject.name in ['grails-bootstrap', 'grails-gradle-model', 'grails-shell']
-}
+}

gradle.properties

@@ -22,6 +22,11 @@ org.gradle.parallel=true
 org.gradle.daemon=true
 org.gradle.jvmargs=-Dfile.encoding=UTF-8 -Xmx1536M -XX:MaxMetaspaceSize=1024M
 
+# libraries only specific to test apps, these should not be exposed
+micronautVersion=4.6.5
+micronautSerdeJacksonVersion=2.11.0
+springSecurityCoreVersion=7.0.0-SNAPSHOT
+
 # Set when we are temporarily releasing, should be false unless we want to prevent
 # snapshot or documentation publishes.
 preventSnapshotPublish=false

gradle/functional-test-project.gradle

@@ -0,0 +1,27 @@
+ext {
+    isFunctionalTestProject = true
+}
+
+tasks.withType(Test).configureEach {
+    onlyIf {
+        if(project.hasProperty('skipFunctionalTests')) {
+            return false
+        }
+
+        true
+    }
+    useJUnitPlatform()
+    testLogging {
+        events "passed", "skipped", "failed"
+
+        showExceptions true
+        exceptionFormat "full"
+        showCauses true
+        showStackTraces true
+    }
+}
+
+// Don't need groovydoc for example project
+tasks.named('groovydoc') {
+    enabled = false
+}

grails-dependencies/build.gradle

@@ -1,55 +1,36 @@
+dependencies {
+    for (String exported : [
+            "org.grails:grails-bootstrap:${project.version}",
+            "org.grails:grails-plugin-rest:${project.version}",
+            "org.grails:grails-plugin-databinding:${project.version}",
+            "org.grails:grails-plugin-i18n:${project.version}",
+            "org.grails:grails-plugin-services:${project.version}",
+            "org.grails:grails-plugin-url-mappings:${project.version}",
+            "org.grails:grails-plugin-interceptors:${project.version}",
+            "org.grails.plugins:async:${project.version}",
+            "org.grails.plugins:events:${project.version}",
+            "org.grails.plugins:gsp:${project['gsp.version']}",
+    ]) {
+        api "${exported}"
+    }
+    for (String exported : [
+            "com.h2database:h2:${project['h2.version']}",
+    ]) {
+        runtimeOnly "${exported}"
+    }
+}
 
 apply plugin: 'maven-publish'
-
 publishing {
     publications {
         maven(MavenPublication) {
+            from components.java
+
             pom.withXml {
                 def xml = asNode()
 
-                xml.children().last() + pomInfo                
-
-                xml.children().last() + {
-                    delegate.dependencies {
-                        delegate.dependency {
-                            delegate.groupId "org.grails"
-                            delegate.artifactId "grails-bootstrap"
-                            delegate.version project.version
-                            delegate.scope "api"
-                        }
-                        for(sub in ['rest', 'databinding', 'i18n', 'services', 'url-mappings', 'interceptors']) {
-                            delegate.dependency {
-                                delegate.groupId "org.grails"
-                                delegate.artifactId "grails-plugin-${sub}"
-                                delegate.version project.version
-                                delegate.scope "api"
-                            }
-                        }
-                        for(sub in ['async', 'events']) {
-                            delegate.dependency {
-                                delegate.groupId "org.grails.plugins"
-                                delegate.artifactId sub
-                                delegate.version project.version
-                                delegate.scope "api"
-                            }
-                        }
-                        delegate.dependency {
-                            delegate.groupId "org.grails.plugins"
-                            delegate.artifactId "gsp"
-                            delegate.version project['gsp.version']
-                            delegate.scope "api"
-                        }
-                        delegate.dependency {
-                            delegate.groupId "com.h2database"
-                            delegate.artifactId "h2"
-                            delegate.version project['h2.version']
-                            delegate.scope "runtimeOnly"
-                        }
-
-                    }
-                }
+                xml.children().last() + pomInfo
             }
-
         }
     }
 }

grails-test-examples/README.md

@@ -1,3 +1,15 @@
-# grails-test-examples
+# Functional tests for Grails Core
 
-Example projects that test across Grails functions should live in this directory
+A Suite of functional tests for Grails.  
+
+The following properties exist to not run or only run tests in these directories: 
+- `onlyFunctionalTests` - Only run tests in this directory
+- `skipFunctionalTests` - Skip tests in this directory
+
+For example, at the root directory to only run the functional tests:
+
+    ./gradlew -PonlyFunctionalTests build
+
+Or to skip the functional tests:
+
+    ./gradlew -PskipFunctionalTests build

grails-test-examples/app1/build.gradle

@@ -0,0 +1,75 @@
+buildscript {
+    repositories {
+        maven { url "https://repo.grails.org/grails/core" }
+        mavenCentral()
+    }
+    dependencies {
+        classpath "org.grails:grails-gradle-plugin:${project['grails-gradle-plugin.version']}"
+        classpath "com.bertramlabs.plugins:asset-pipeline-gradle:${project['asset-pipeline-gradle.version']}"
+    }
+}
+
+version "0.1"
+group "functionaltests"
+
+apply plugin: "war"
+apply plugin: "asset-pipeline"
+apply plugin: "org.grails.grails-web"
+apply plugin: "org.grails.grails-gsp"
+
+assets {
+    minifyJs = true
+    minifyCss = true
+}
+
+apply plugin: 'java'
+compileJava.options.release = 17
+
+dependencies {
+    implementation platform(project(':grails-bom'))
+
+    implementation "org.springframework.boot:spring-boot-starter-logging"
+    implementation "org.springframework.boot:spring-boot-starter-actuator"
+    implementation "org.springframework.boot:spring-boot-autoconfigure"
+    implementation "org.springframework.boot:spring-boot-starter-tomcat"
+    implementation "org.grails:grails-dependencies"
+    implementation "org.grails:grails-web-boot"
+    implementation "org.grails:grails-core"
+
+    implementation "org.grails.plugins:hibernate5"
+    implementation "org.grails.plugins:cache"
+    implementation "org.grails.plugins:scaffolding"
+
+    runtimeOnly "com.bertramlabs.plugins:asset-pipeline-grails"
+    runtimeOnly "org.grails.plugins:fields"
+    runtimeOnly "org.apache.tomcat:tomcat-jdbc"
+
+    testImplementation "org.grails:grails-web-testing-support"
+    testImplementation "org.grails:grails-gorm-testing-support"
+
+    console "org.grails:grails-console"
+    testImplementation "io.micronaut:micronaut-http-client:$micronautVersion"
+    testImplementation "io.micronaut.serde:micronaut-serde-jackson:$micronautSerdeJacksonVersion"
+
+    implementation project(':grails-test-examples-plugins-loadfirst')
+    implementation project(':grails-test-examples-plugins-loadsecond')
+    implementation project(':grails-test-examples-plugins-loadafter')
+
+    integrationTestImplementation testFixtures("org.grails.plugins:geb")
+}
+
+tasks.withType(org.gradle.api.tasks.JavaExec) {
+    systemProperty('REPLACE_ME', 'test')
+    systemProperty('foo.bar', 'test')
+    // jvmArgs '-javaagent:agent.jar'
+}
+test {
+    systemProperty('REPLACE_ME', 'test')
+    systemProperty('foo.bar', 'test')
+}
+
+//compileTestGroovy.groovyOptions.forkOptions.jvmArgs = ['-Xdebug', '-Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005']
+//compileGroovy.groovyOptions.fork = true
+//compileGroovy.groovyOptions.forkOptions.jvmArgs = ['-Xdebug', '-Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005']
+
+apply from: rootProject.file('gradle/functional-test-project.gradle')