feat: Updated GitHub Workflows to run API tests on PR creation (#312)

* feat: Updated GitHub Workflows to run API tests on PR creation

* fix: Updated InputSchemaServiceTest tests

* chore: Update 'paths' for running API and E2E tests.

Author: Justin-MacIntosh

.github/actions/devbox-setup/action.yml

@@ -0,0 +1,19 @@
+name: Devbox Setup
+description: Install devbox with caching and create required .env file
+
+inputs:
+  enable-cache:
+    description: Enable devbox caching
+    default: 'true'
+
+runs:
+  using: composite
+  steps:
+    - name: Create .env file
+      run: touch .env
+      shell: bash
+
+    - name: Install devbox
+      uses: jetify-com/devbox-install-action@v0.12.0
+      with:
+        enable-cache: ${{ inputs.enable-cache }}

.github/workflows/deploy-builder-api.yml

@@ -31,17 +31,8 @@ jobs:
       - name: 'Checkout'
         uses: 'actions/checkout@v4'
 
-      # Devbox needs a .env file to exist, even if it's empty
-      # TODO: Make this useful in this and other workflows by just consolidating env vars
-      #       here (so that we don't need to manage multiple places)
-      - name: 'Create .env file'
-        run: touch .env
-
-      # Setup devbox which includes all our dependencies: Maven, JDK 21, Quarkus, etc.
-      - name: 'Install devbox'
-        uses: 'jetify-com/devbox-install-action@v0.12.0'
-        with:
-          enable-cache: true
+      - name: 'Setup devbox'
+        uses: ./.github/actions/devbox-setup
 
       # Cache Maven dependencies to speed up builds
       - name: 'Cache Maven dependencies'

.github/workflows/deploy-builder-frontend.yml

@@ -29,15 +29,8 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-        # Devbox needs a .env file to exist, even if it's empty
-      - name: 'Create .env file'
-        run: touch .env
-
-      # Setup devbox which includes Node.js, Firebase CLI, and Google Cloud SDK
-      - name: 'Install devbox'
-        uses: 'jetify-com/devbox-install-action@v0.12.0'
-        with:
-          enable-cache: true
+      - name: 'Setup devbox'
+        uses: ./.github/actions/devbox-setup
 
       # Configure Workload Identity Federation and generate an access token
       - id: 'auth'

.github/workflows/deploy-library-api.yml

@@ -27,15 +27,8 @@ jobs:
       - name: 'Checkout'
         uses: 'actions/checkout@v4'
 
-      # Devbox needs a .env file to exist, even if it's empty
-      - name: 'Create .env file'
-        run: touch .env
-
-      # Setup devbox which includes all our dependencies: Maven, JDK 21, Quarkus, etc.
-      - name: 'Install devbox'
-        uses: 'jetify-com/devbox-install-action@v0.12.0'
-        with:
-          enable-cache: true
+      - name: 'Setup devbox'
+        uses: ./.github/actions/devbox-setup
 
       # Cache Maven dependencies to speed up builds
       - name: 'Cache Maven dependencies'

.github/workflows/run-api-tests.yml

@@ -0,0 +1,54 @@
+name: Run API Tests
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "builder-api/**"
+      - "library-api/**"
+  pull_request:
+    branches: [main]
+    paths:
+      - "builder-api/**"
+      - "library-api/**"
+
+jobs:
+  builder-api-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup devbox
+        uses: ./.github/actions/devbox-setup
+
+      - name: Cache Maven dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-builder-${{ hashFiles('builder-api/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+
+      - name: Run builder-api tests
+        run: devbox run -- bash -c "cd builder-api && mvn test"
+
+  library-api-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup devbox
+        uses: ./.github/actions/devbox-setup
+
+      - name: Cache Maven dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-library-${{ hashFiles('library-api/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+
+      - name: Run library-api tests
+        run: devbox run -- bash -c "cd library-api && mvn test"

.github/workflows/run-e2e-tests.yml

@@ -5,11 +5,13 @@ on:
     paths:
       - "builder-frontend/**"
       - "builder-api/**"
+      - "library-api/**"
   pull_request:
     branches: [main]
     paths:
       - "builder-frontend/**"
       - "builder-api/**"
+      - "library-api/**"
 
 env:
   PROJECT_ID: "benefit-decision-toolkit-play"
@@ -34,19 +36,14 @@ jobs:
           node-version: lts/*
 
       # 1) Devbox Setup #
-      - name: "Create .env file" # Devbox needs a .env file to exist, even if it's empty
-        run: touch .env
+      - name: Setup devbox
+        uses: ./.github/actions/devbox-setup
 
       - name: Rename env files
         run: |
           mv builder-frontend/.env.example builder-frontend/.env
           mv builder-api/.env.example builder-api/.env
 
-      - name: "Install devbox" # Setup devbox which includes Node.js, Firebase CLI, and Google Cloud SDK
-        uses: "jetify-com/devbox-install-action@v0.12.0"
-        with:
-          enable-cache: true
-
       # 2) Prepare app dependencies #
       - name: "Cache Maven dependencies"
         # Cache Maven dependencies to speed up builds

builder-api/src/test/java/org/acme/service/InputSchemaServiceTest.java

@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
+
 import org.acme.model.domain.CheckConfig;
 import org.acme.model.domain.FormPath;
 import org.junit.jupiter.api.BeforeEach;
@@ -551,8 +552,8 @@ void extractJsonSchemaPaths_withTransformedSchema_extractsCorrectPaths() throws
 
         List<FormPath> paths = service.extractJsonSchemaPaths(schema);
 
-        assertTrue(paths.contains(new FormPath("people.applicant.dateOfBirth", "string")));
-        assertTrue(paths.contains(new FormPath("people.applicant.enrollments", "array")));
+        assertTrue(paths.contains(new FormPath("people.applicant.dateOfBirth", "date")));
+        assertTrue(paths.contains(new FormPath("people.applicant.enrollments", "array:string")));
         assertEquals(2, paths.size());
     }
 
@@ -584,7 +585,7 @@ void extractJsonSchemaPaths_withEnrollmentOnlySchema_extractsCorrectPath() throw
 
         List<FormPath> paths = service.extractJsonSchemaPaths(schema);
 
-        assertTrue(paths.contains(new FormPath("people.applicant.enrollments", "array")));
+        assertTrue(paths.contains(new FormPath("people.applicant.enrollments", "array:string")));
         assertEquals(1, paths.size());
     }
 
@@ -619,8 +620,8 @@ void extractJsonSchemaPaths_withMultiplePersonIds_extractsPathsForAll() throws E
 
         List<FormPath> paths = service.extractJsonSchemaPaths(schema);
 
-        assertTrue(paths.contains(new FormPath("people.applicant.dateOfBirth", "string")));
-        assertTrue(paths.contains(new FormPath("people.spouse.dateOfBirth", "string")));
+        assertTrue(paths.contains(new FormPath("people.applicant.dateOfBirth", "date")));
+        assertTrue(paths.contains(new FormPath("people.spouse.dateOfBirth", "date")));
         assertEquals(2, paths.size());
     }
 }