CCM-15633: Add Pact tests for channel status published event (#289)

* CCM-15633: Add pact tests for channel status published event

* CCM-15633: Add contract tests to workflow

* CCM-15633: Publish pact contracts package

* CCM-15633: Don't run contract tests in acceptance stage

Author: gareth-allan

.github/workflows/cicd-1-pull-request.yaml

@@ -15,7 +15,7 @@ on:
 permissions:
   id-token: write
   contents: write
-  packages: read
+  packages: write
 
 jobs:
   metadata:

.github/workflows/stage-2-test.yaml

@@ -146,6 +146,48 @@ jobs:
             src/**/coverage.xml
             utils/**/coverage.xml
             lambdas/**/coverage.xml
+  test-contract:
+    name: "Contract tests"
+    runs-on: ubuntu-latest
+    timeout-minutes: 4
+    permissions:
+      contents: read
+      packages: read
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
+      - uses: ./.github/actions/node-install
+        with:
+          node-version: ${{ inputs.nodejs_version }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: "Install dependencies"
+        run: npm ci --ignore-scripts
+      - name: "Cache generated dependencies"
+        id: schema-cache
+        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
+        with:
+          path: |
+            schemas/digital-letters/
+            output/digital-letters/
+            src/digital-letters-events/types/
+            src/digital-letters-events/validators/
+            src/digital-letters-events/digital_letters_events/models/
+            src/digital-letters-events/guard-functions/
+          key: generated-deps-${{ runner.os }}-${{ hashFiles('src/cloudevents/**', 'src/typescript-schema-generator/**', 'src/python-schema-generator/**') }}
+      - name: "Generate dependencies"
+        if: steps.schema-cache.outputs.cache-hit != 'true'
+        run: |
+          npm run generate-dependencies
+      - name: "Run contract test suite"
+        run: |
+          make test-contract
+      - name: "Upload generated contracts"
+        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6
+        with:
+          name: pact-contracts
+          path: "tests/pact-tests/.pacts"
+          include-hidden-files: true
+
   test-lint:
     name: "Linting"
     runs-on: ubuntu-latest

.github/workflows/stage-4-acceptance.yaml

@@ -22,19 +22,6 @@ on:
         type: string
 
 jobs:
-  test-contract:
-    name: "Contract test"
-    runs-on: ubuntu-latest
-    timeout-minutes: 10
-    steps:
-      - name: "Checkout code"
-        uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
-      - name: "Run contract test"
-        run: |
-          make test-contract
-      - name: "Save result"
-        run: |
-          echo "Nothing to save"
   test-security:
     name: "Security test"
     runs-on: ubuntu-latest

.github/workflows/stage-5-publish.yaml

@@ -40,21 +40,36 @@ jobs:
     name: "Publish packages"
     runs-on: ubuntu-latest
     timeout-minutes: 10
+    permissions:
+      contents: read
+      packages: write
 
     steps:
       - name: "Checkout code"
         uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
+      - uses: ./.github/actions/node-install
+        with:
+          node-version: ${{ inputs.nodejs_version }}
+          GITHUB_TOKEN: ${{ github.token }}
       - name: "Get artifacts: jekyll docs"
         uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5
         with:
           path: ./artifacts/jekyll-docs-${{ inputs.version }}
           name: jekyll-docs-${{ inputs.version }}
-
       - name: "Get artifacts: schema"
         uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5
         with:
           path: ./artifacts/schemas-${{ inputs.version }}
           name: schemas-${{ inputs.version }}
+      - name: "Get artifacts: pact contracts"
+        uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5
+        with:
+          path: ./pact-contracts/pacts
+          name: pact-contracts
+      - name: "Publish pact contracts package"
+        run: |
+          export BRANCH_NAME=${GITHUB_HEAD_REF:-$(echo $GITHUB_REF | sed 's#refs/heads/##')}
+          scripts/publish-pact-contracts.sh
 
 
       - name: Draft Release

.gitignore

@@ -57,6 +57,8 @@ coverage.xml
 *.coverage
 coverage/
 coverage-*/
+**/.pacts
+/pact-contracts/pacts
 **/playwright-report
 **/test-results
 plugin-cache

eslint.config.mjs

@@ -224,6 +224,12 @@ export default defineConfig([
       'import-x/no-relative-packages': 0,
     },
   },
+  {
+    files: ['tests/pact-tests/**'],
+    rules: {
+      'no-relative-import-paths/no-relative-import-paths': 0,
+    },
+  },
   {
     files: ['scripts/**'],
     rules: {