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

AMP-187 Run api tests as part of the pipeline for pull requests

Author: samirgarg

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

@@ -23,6 +23,10 @@ on:
       trigger_deploy:
         required: true
         type: boolean
+      run_api_test:
+        required: false
+        type: boolean
+        default: false
 
 
 jobs:
@@ -85,6 +89,43 @@ jobs:
           name: app-jar
           path: build/libs/${{ steps.repo_vars.outputs.artefact_name }}.jar
 
+  api-test:
+    if: ${{ inputs.run_api_test }}
+    needs: [Build]
+    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: Run API Tests
+        run: |
+          cd apiTest
+          gradle test
+
+      - name: Upload test reports
+        if: always()
+        uses: actions/upload-artifact@v6
+        with:
+          name: api-test-reports
+          path: |
+            apiTest/build/reports/tests/test/
+            apiTest/build/test-results/test/
+  
+
   Provider-Deploy:
     needs: [ Artefact-Version, Build ]
     runs-on: ubuntu-latest

.github/workflows/ci-draft.yml

@@ -21,3 +21,4 @@ jobs:
       is_publish: ${{ github.event_name == 'push' }}
       trigger_docker: ${{ github.event_name == 'push' }}
       trigger_deploy: ${{ github.event_name == 'push' }}
+      run_api_test: ${{ github.event_name == 'pull_request' }}

apiTest/apiTest_README.md

@@ -40,20 +40,20 @@ Before running the tests, ensure you have the following installed and configured
 cd apiTest
 
 # Run all tests
-../gradlew test
+gradle test
 
 # Run tests with more verbose output
-../gradlew test --info
+gradle test --info
 
 # Run tests with debug output
-../gradlew test --debug
+gradle test --debug
 ```
 
 ### From the apiTest Directory
 
 ```bash
 # If you're already in the apiTest directory
-../gradlew test
+gradle test
 ```
 
 ### What Happens When You Run Tests
@@ -71,10 +71,10 @@ cd apiTest
 
 ```bash
 # Run a specific test class
-../gradlew test --tests "RootApiTest"
+gradle test --tests "RootApiTest"
 
 # Run a specific test method
-../gradlew test --tests "RootApiTest.root_endpoint_should_be_ok"
+gradle test --tests "RootApiTest.root_endpoint_should_be_ok"
 ```
 
 ## Test Reports
@@ -102,15 +102,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: `../gradlew clean`
-2. Rebuild: `../gradlew build`
+1. Clean the build: `gradle clean`
+2. Rebuild: `gradle 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: `../gradlew buildRootBootJar` manually if needed
+3. Run: `gradle buildRootBootJar` manually if needed
 
 ### Issue: Container exits with code 1
 

apiTest/build.gradle

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