Release integration test framework - generate and upload official images (#237)

* Release integration test framework - generate and upload official images

Author: arturoespinoza15

.github/workflows/release-integration-test-framework-images.yml

@@ -0,0 +1,71 @@
+# After each commit to main, this action will be triggered in order to build and push the images into the public registry.
+# the images from the public registry will be pulled and used during the execution of the integration test locally
+name: Release integration test framework
+
+on:
+  push:
+    branches:
+      - 'main'
+
+
+env:
+  TEST_FRAMEWORK_PATH: core-codemods/src/test/java/io/codemodder/codemods/integration
+
+jobs:
+  upload-images:
+    name: Upload images to Dockerhub
+    runs-on: ubuntu-latest
+    steps:
+      - 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: Login to Docker Hub
+        uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
+        with:
+          username: ${{ vars.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - 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
+          push: true
+          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 \
+              .
+            docker push codemodder/${TEST_PROJECT_NAME}:latest
+          done

core-codemods/src/test/java/io/codemodder/codemods/integration/README.md

@@ -8,23 +8,45 @@ This is a test framework, built to test that each codemod does not break the fun
 - A main Dockerfile will be used to generate two containers, the generated images will use a specific test project image as base and the codemod will be run in just one of them. Finally, we will have two containers running the same application but one of them will have undergone a  code transformation.
 - A request to an endpoint in the test application will be performed to verify the functionality has not changed. 
 
-### Running test locally
+### How the framework works during CI/CD
+- Codemodder base image is built at the pipeline context with the last changes in a PR.
+- Test projects images are built at the pipeline context with the last changes in a PR.
+- Integration tests are executed using the latest generated images.
+- Generated images only live during the pipeline execution, a new commit wil generate new images.
+
+### Running an integration test locally
+All what you need to do is running the integration test, required images will be pulled from the public
+repository https://hub.docker.com/repositories/codemodder
+
+All the test framework images are re-built and pushed to the registry with the latest changes in each commit to main.
+
+#### Running integration test for a specific codemod
+```
+./gradlew :core-codemods:test --tests io.codemodder.codemods.integration.tests.MoveSwitchDefaultCaseLastCodemodIntegrationTest
+```
+#### Running all the tests
+```
+./gradlew test
+```
+
+
+### Generating framework images locally
 #### Generate codemodder base image
 - Run `gradle distTar` command in the `core-codemods` root directory to generate `.tar` file used in the base image generation.
 - Run the `docker build`command in the root of the project.
 ```
-docker build -f core-codemods/src/test/java/io/codemodder/codemods/integration/baseimage/Dockerfile -t codemodder-base:latest .
+docker build -f core-codemods/src/test/java/io/codemodder/codemods/integration/baseimage/Dockerfile -t codemodder/codemodder-base:latest .
 ```
 
 #### Generate test project base image
 Run the `docker build`command in the `codemodder-java` root directory, the `CODEMOD_ID` argument must have the value of the ID of the codemod we want to test
 and the `CODEMODDER_BASE_IMAGE` argument should have the name of the codemodder base image we want to use as name.
 The image tag must be the codemod ID also.  
 ```
-docker build -f core-codemods/src/test/java/io/codemodder/codemods/integration/projectimage/Dockerfile --build-arg CODEMOD_ID=move-switch-default-last --build-arg CODEMODDER_BASE_IMAGE=codemodder-base -t move-switch-default-last .
+docker build -f core-codemods/src/test/java/io/codemodder/codemods/integration/projectimage/Dockerfile --build-arg CODEMOD_ID=move-switch-default-last --build-arg CODEMODDER_BASE_IMAGE=codemodder/codemodder-base -t codemodder/move-switch-default-last .
 ```
 
-#### Running the integration test for a specific codemod
+#### Running integration test for a specific codemod
 ```
 ./gradlew :core-codemods:test --tests io.codemodder.codemods.integration.tests.MoveSwitchDefaultCaseLastCodemodIntegrationTest
 ```