Merge pull request #24 from hmcts/chore/amp-187-api_tests

AMP-187 Trigger api test as downstream of building docker image(push to main)

Author: samirgarg

.github/workflows/ci-build-publish.yml

@@ -74,7 +74,7 @@ jobs:
           ARTEFACT_VERSION: ${{ needs.Artefact-Version.outputs.artefact_version }}
         run: |
           echo "Building with ARTEFACT_VERSION=$ARTEFACT_VERSION"
-          gradle build -DARTEFACT_VERSION=$ARTEFACT_VERSION
+          ./gradlew build -DARTEFACT_VERSION=$ARTEFACT_VERSION
 
       - name: Extract repo name
         id: repo_vars
@@ -89,7 +89,7 @@ jobs:
           name: app-jar
           path: build/libs/${{ steps.repo_vars.outputs.artefact_name }}.jar
 
-  api-test:
+  API-Test-PR:
     if: ${{ inputs.run_api_test }}
     needs: [Build]
     runs-on: ubuntu-latest
@@ -114,13 +114,13 @@ jobs:
       - name: Run API Tests
         run: |
           cd apiTest
-          gradle test
+          ../gradlew test
 
       - name: Upload test reports
         if: always()
         uses: actions/upload-artifact@v6
         with:
-          name: api-test-reports
+          name: api-test-pr-reports
           path: |
             apiTest/build/reports/tests/test/
             apiTest/build/test-results/test/
@@ -162,7 +162,7 @@ jobs:
 
           echo "Publishing artefact for version: $ARTEFACT_VERSION"
           
-          gradle publish \
+          ./gradlew publish \
             -DARTEFACT_VERSION=$ARTEFACT_VERSION \
             -DGITHUB_REPOSITORY=${{ github.repository }} \
             -DGITHUB_ACTOR=${{ github.actor }} \
@@ -206,6 +206,74 @@ jobs:
             BASE_IMAGE=openjdk:21-jdk-slim
             JAR_FILENAME=${{ needs.Build.outputs.artefact_name }}.jar
 
+  API-Test-Main:
+    if: ${{ inputs.trigger_docker }}
+    needs: [Build-Docker, Artefact-Version]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Set up JDK
+        uses: actions/setup-java@v5
+        with:
+          distribution: 'temurin'
+          java-version: '21'
+
+      - name: Set up Gradle
+        uses: gradle/actions/setup-gradle@v5
+        with:
+          gradle-version: current
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to GitHub Packages
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Run API Tests against published Docker image
+        env:
+          DOCKER_IMAGE: ghcr.io/${{ github.repository }}:${{ needs.Artefact-Version.outputs.artefact_version }}
+        run: |
+          cd apiTest
+          # DOCKER_IMAGE is set via env, so docker-compose will use the image instead of building
+          # Pull the image first to ensure it's available
+          docker pull $DOCKER_IMAGE
+          
+          # Start containers using the published image
+          docker compose up -d
+          
+          echo "Waiting for health endpoint..."
+          for i in {1..30}; do
+            if curl -s http://localhost:8082/actuator/health > /dev/null; then
+              echo "App is healthy"
+              break
+            fi
+            echo "Waiting for app to be healthy ($i)..."
+            sleep 2
+          done
+          
+          # Run tests (containers already running via docker compose)
+          # Skip composeUp and composeDown since we manage containers manually
+          ../gradlew testClasses
+          ../gradlew --no-daemon test -x composeUp -x composeDown
+          
+          # Clean up containers manually
+          docker compose down
+
+      - name: Upload test reports
+        if: always()
+        uses: actions/upload-artifact@v6
+        with:
+          name: api-test-main-reports
+          path: |
+            apiTest/build/reports/tests/test/
+            apiTest/build/test-results/test/
+
   Deploy:
     needs: [ Provider-Deploy, Build, Artefact-Version ]
     if: ${{ inputs.trigger_deploy }}

.github/workflows/codeql.yml

@@ -48,7 +48,7 @@ jobs:
 
       - name: Gradle Build
         run: |
-          gradle build cyclonedxBom -x test
+          ./gradlew build cyclonedxBom -x test
 
       # ℹ️ Command-line programs to run using the OS shell.
       # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -89,7 +89,7 @@ jobs:
           gradle-version: current
 
       - name: Gradle Build
-        run: gradle build -x test
+        run: ./gradlew build -x test
 
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3

.gitignore

@@ -1,9 +1,7 @@
-gradle/wrapper
 bin/*
 !bin/run-in-docker.sh
 .gradle
 /build/
-/gradlew
 /gradlew.bat
 !gradle/wrapper/gradle-wrapper.properties
 *.class

apiTest/apiTest_README.md

@@ -40,20 +40,22 @@ Before running the tests, ensure you have the following installed and configured
 cd apiTest
 
 # Run all tests
-gradle test
+../gradlew test
 
 # Run tests with more verbose output
-gradle test --info
+../gradlew test --info
 
 # Run tests with debug output
-gradle test --debug
+../gradlew test --debug
 ```
 
 ### From the apiTest Directory
 
 ```bash
-# If you're already in the apiTest directory
-gradle test
+# If you're already in the apiTest directory, you can use either:
+./gradlew test        # Uses apiTest's own Gradle wrapper
+# or
+../gradlew test       # Uses root project's Gradle wrapper
 ```
 
 ### What Happens When You Run Tests
@@ -71,10 +73,10 @@ gradle test
 
 ```bash
 # Run a specific test class
-gradle test --tests "RootApiTest"
+../gradlew test --tests "RootApiTest"
 
 # Run a specific test method
-gradle test --tests "RootApiTest.root_endpoint_should_be_ok"
+../gradlew test --tests "RootApiTest.root_endpoint_should_be_ok"
 ```
 
 ## Test Reports
@@ -102,15 +104,15 @@ These XML reports are useful for CI/CD integration.
 ### Issue: "Could not start Gradle Test Executor 1: Failed to load JUnit Platform"
 
 **Solution:** This should be resolved with the current configuration. If you see this error:
-1. Clean the build: `gradle clean`
-2. Rebuild: `gradle build`
+1. Clean the build: `../gradlew clean`
+2. Rebuild: `../gradlew build`
 
 ### Issue: "no main manifest attribute, in /app/apiTest-0.0.999.jar"
 
 **Solution:** This means the Docker build context is wrong. Ensure:
 1. The `docker-compose.yml` has `context: ..` (builds from root directory)
 2. The root project's `bootJar` is built before Docker build
-3. Run: `gradle buildRootBootJar` manually if needed
+3. Run: `../gradlew buildRootBootJar` manually if needed
 
 ### Issue: Container exits with code 1
 
@@ -152,26 +154,6 @@ lsof -i :5432
 - Check database logs: `docker-compose -f docker-compose.yml logs db`
 - Verify connection string in `docker-compose.yml` matches database configuration
 
-## Manual Container Management
-
-If you need to manually manage containers:
-
-```bash
-# Start containers without running tests
-docker-compose -f docker-compose.yml up -d
-
-# Stop containers
-docker-compose -f docker-compose.yml down
-
-# View container logs
-docker-compose -f docker-compose.yml logs -f app
-
-# Check container status
-docker-compose -f docker-compose.yml ps
-
-# Rebuild containers
-docker-compose -f docker-compose.yml build --no-cache
-```
 
 ## Test Configuration
 
@@ -186,6 +168,6 @@ Tests use the following default configuration:
 
 You can override the application URL:
 ```bash
-gradle test -Dapp.baseUrl=http://localhost:8080
+../gradlew test -Dapp.baseUrl=http://localhost:8080
 ```
 

apiTest/build.gradle

@@ -79,7 +79,7 @@ dockerCompose {
 tasks.register('buildRootBootJar', Exec) {
   description = "Builds the root project's bootJar"
   workingDir = projectDir.parent
-  executable = "gradle"
+  executable = "./gradlew"
   args = ['bootJar']
 }
 

apiTest/docker-compose.yml

@@ -9,6 +9,9 @@ services:
       - "5432:5432"
 
   app:
+    # If DOCKER_IMAGE environment variable is set, it will use that image
+    # Otherwise, it will use the build section below
+    image: ${DOCKER_IMAGE}
     build:
       context: ..
       dockerfile: Dockerfile
@@ -33,4 +36,3 @@ services:
     command:
       - "--global-response-templating"
       - "--verbose"
-

apiTest/gradle/wrapper/gradle-wrapper.jar

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.0.0-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

apiTest/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.0.0-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists