Release integration test framework - generate images during check action execution (#235)

- Release integration test framework - generate images during check action execution

Author: arturoespinoza15

.github/workflows/checks.yml

@@ -4,22 +4,70 @@ on:
   push:
   workflow_dispatch:
 
+env:
+  TEST_FRAMEWORK_PATH: core-codemods/src/test/java/io/codemodder/codemods/integration
+
 jobs:
   check:
     name: Check
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - name: Clone repository
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+      - name: Setup Java
+        uses: actions/setup-java@0ab4596768b603586c0de567f2430c30f5b0d2b0 # v3.13.0
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+#     tar file generation, tar file contains codemodder executable file to be used in the codemodder-base image
+      - name: Generate distribution
+        uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a # v2.9.0
+        with:
+          arguments: core-codemods:distTar
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # v3.0.0
+        with:
+          driver: docker
+
+      - name: Build codemodder base image
+        uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0
+        with:
+          context: .
+          file: ${{ env.TEST_FRAMEWORK_PATH }}/baseimage/Dockerfile
+          tags: codemodder/codemodder-base:latest
+
+#     defining the list of test projects for which an image will be generated
+      - name: Setup test project names
+        run: |
+          TEST_PROJECT_NAMES=$(./gradlew core-codemods:getTestProjectNames -q)
+          echo "TEST_PROJECT_NAMES<<EOF">> $GITHUB_ENV
+          echo $TEST_PROJECT_NAMES >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+
+      - name: Build test projects images
+        run: |
+          for TEST_PROJECT_NAME in ${{ env.TEST_PROJECT_NAMES }}; do
+            docker build \
+              -f ${{ env.TEST_FRAMEWORK_PATH }}/projectimage/Dockerfile \
+              --build-arg CODEMODDER_BASE_IMAGE=codemodder/codemodder-base \
+              --build-arg CODEMOD_ID=${TEST_PROJECT_NAME} \
+              -t codemodder/${TEST_PROJECT_NAME}:latest \
+              .
+          done
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
         with:
           python-version: '3.10'
+
       - name: Install Semgrep
         run: python3 -m pip install semgrep==1.15.0
-      - uses: actions/setup-java@v3
-        with:
-          distribution: 'temurin'
-          java-version: '17'
-      - uses: gradle/gradle-build-action@v2
+
+      - name: Run Check task
+        uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a # v2.9.0
         with:
           arguments: check --stacktrace
           cache-read-only: ${{ github.ref != 'refs/heads/main' }}

core-codemods/build.gradle.kts

@@ -68,3 +68,32 @@ tasks.named("check") {
     @Suppress("UnstableApiUsage")
     dependsOn(testing.suites.named(integrationTestSuiteName))
 }
+
+val getTestProjectNames by tasks.registering {
+    group = "custom"
+    description = "Extracts codemodIds from IntegrationTestMetadata"
+
+    val sourceDir = file("src/test/java/io/codemodder/codemods/integration/tests")
+    val codemodIdRegex = """codemodId\s*=\s*["']([^"']+)["']""".toRegex()
+
+    doLast {
+        val codemodIds = mutableListOf<String>()
+        sourceDir
+            .walkTopDown()
+            .filter { it.isFile && it.name.endsWith(".java") }
+            .forEach { file ->
+                val content = file.readText()
+                val matchResult = codemodIdRegex.find(content)
+
+                if (matchResult != null) {
+                    codemodIds.add(matchResult.groupValues[1])
+                }
+            }
+
+        println(codemodIds.joinToString(" "))
+    }
+}
+
+tasks.withType(JavaCompile::class) {
+    dependsOn(getTestProjectNames)
+}

core-codemods/src/test/java/io/codemodder/codemods/integration/Dockerfile

@@ -1,6 +1,6 @@
 ARG CODEMOD_ID
 
-FROM $CODEMOD_ID
+FROM codemodder/$CODEMOD_ID
 
 ARG RUN_CODEMOD=false
 #defining the argument again because the value is unavailable after the first stage ends.

core-codemods/src/test/java/io/codemodder/codemods/integration/baseimage/Dockerfile

@@ -2,11 +2,8 @@ FROM openjdk:17-jdk-slim
 
 RUN apt-get update
 
-# Install Python 3 and pip
-RUN apt-get install -y python3 python3-pip
-
-# Update the package list and install wget
-RUN apt-get install -y wget unzip
+# Install Python 3, pip and wget
+RUN apt-get install -y python3 python3-pip wget unzip
 
 # Install Gradle
 ENV GRADLE_VERSION=8.2.1
@@ -19,16 +16,11 @@ RUN wget -q "https://services.gradle.org/distributions/gradle-${GRADLE_VERSION}-
 # Set environment variables
 ENV PATH="${GRADLE_HOME}/bin:${PATH}"
 
-# Set Python as the default Python interpreter
-RUN ln -s /usr/bin/python3 /usr/bin/python
-
-# Display the installed versions for verification
-RUN java -version
-RUN python --version
-RUN gradle --version
-
-# Install Semgrep using pip
-RUN pip install semgrep
+RUN ln -s /usr/bin/python3 /usr/bin/python && \
+    java -version && \
+    python --version && \
+    gradle --version && \
+    python3 -m pip install semgrep==1.15.0
 
 # Generate tool executable
 WORKDIR /codemodder-java

core-codemods/src/test/java/io/codemodder/codemods/integration/tests/MoveSwitchDefaultCaseLastCodemodIntegrationTest.java

@@ -3,9 +3,7 @@
 import io.codemodder.codemods.integration.util.CodemodIntegrationTestMixin;
 import io.codemodder.codemods.integration.util.IntegrationTestMetadata;
 import io.codemodder.codemods.integration.util.IntegrationTestPropertiesMetadata;
-import org.junit.jupiter.api.Disabled;
 
-@Disabled
 @IntegrationTestMetadata(
     codemodId = "move-switch-default-last",
     tests = {

core-codemods/src/test/java/io/codemodder/codemods/integration/tests/VerboseRequestMappingCodemodIntegrationTest.java

@@ -3,9 +3,7 @@
 import io.codemodder.codemods.integration.util.CodemodIntegrationTestMixin;
 import io.codemodder.codemods.integration.util.IntegrationTestMetadata;
 import io.codemodder.codemods.integration.util.IntegrationTestPropertiesMetadata;
-import org.junit.jupiter.api.Disabled;
 
-@Disabled
 @IntegrationTestMetadata(
     codemodId = "verbose-request-mapping",
     tests = {