feat: Reusable GitHub Actions Workflow (#708)

.github/workflows/code-tests.yml → .github/workflows/quick-test.yml

@@ -2,7 +2,7 @@ name: Code Tests
 
 on:
   # This does not run on push to master, as tests will instead be run there as
-  # part of the docker.yml workflow.
+  # part of the test-and-publish workflow.
   pull_request:
     branches: [ master ]
 

.github/workflows/reference-implementation.yml → .github/workflows/test-and-publish.yml

@@ -1,27 +1,41 @@
-name: Reference Implementation
+name: Test and Publish
 
 on:
   push:
     branches: [ master ]
   pull_request:
     branches: [ master ]
+  workflow_call:
+    inputs:
+      quick_test:
+        description: 'Run only random mode with all-features and both flows'
+        required: false
+        type: boolean
+        default: true
+      data-models_ref:
+        required: false
+        type: string
+      data-model-validator_ref:
+        required: false
+        type: string
+      rpde-validator_ref:
+        required: false
+        type: string
+      openactive-test-suite_ref:
+        required: false
+        type: string
+        default: 'refs/heads/master'
 
 jobs:
   tests:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
-        mode: ['random', 'controlled']
-        profile: ['all-features', 'single-seller', 'no-payment-reconciliation', 'no-auth', 'no-tax-calculation', 'prepayment-always-required', 'facilityuse-has-slots']
-        flow: ['simple', 'approval']
-        include:
-        - mode: 'random'
-          profile: 'all-features'
-          flow: 'both'
-        - mode: 'controlled'
-          profile: 'all-features'
-          flow: 'both'
+        mode: ${{ inputs.quick_test == 'true' && fromJson('["random"]') || fromJson('["random","controlled"]') }}
+        profile: ${{ inputs.quick_test == 'true' && fromJson('["all-features"]') || fromJson('["all-features","single-seller","no-payment-reconciliation","no-auth","no-tax-calculation","prepayment-always-required","facilityuse-has-slots"]') }}
+        flow: ${{ inputs.quick_test == 'true' && fromJson('["both"]') || fromJson('["simple","approval"]') }}
+        include: ${{ inputs.quick_test == 'true' && fromJson('[]') || fromJson('[{"mode":"random","profile":"all-features","flow":"both"},{"mode":"controlled","profile":"all-features","flow":"both"}]') }}
 
     concurrency: 
       group: openactive-test-suite--${{ github.head_ref }}--${{ matrix.mode }}.${{ matrix.profile }}.${{ matrix.flow }}
@@ -32,8 +46,11 @@ jobs:
       uses: actions/checkout@v4
       with:
         path: tests
+        repository: openactive/openactive-test-suite
+        # If this is being called from another workflow, then the openactive-test-suite_ref will be provided or defaulted; otherwise we can assume a different trigger
+        ref: ${{ inputs.openactive-test-suite_ref || github.ref }}
     - name: Use matching coverage/* branch ${{ github.head_ref }} in OpenActive.Server.NET
-      if: ${{ startsWith(github.head_ref, 'coverage/') }}
+      if: ${{ github.repository == 'openactive/openactive-test-suite' && startsWith(github.head_ref, 'coverage/') }}
       id: refs
       run: echo "::set-output name=mirror_ref::${{ github.head_ref }}"
     - name: Checkout OpenActive.Server.NET ${{ steps.refs.outputs.mirror_ref }}
@@ -74,6 +91,30 @@ jobs:
         npm install
       working-directory: tests
 
+    - name: Install specific version of data-models ${{ inputs.data-models_ref }}
+      if: ${{ inputs.data-models_ref }}
+      run: |
+        cd packages/openactive-broker-microservice && npm install github:openactive/data-models#${{ inputs.data-models_ref }}
+        cd packages/openactive-integration-tests && npm install github:openactive/data-models#${{ inputs.data-models_ref }}
+      working-directory: tests
+
+    - name: Install specific version of data-model-validator ${{ inputs.data-model-validator_ref }}
+      if: ${{ inputs.data-model-validator_ref }}
+      run: |
+        cd packages/openactive-broker-microservice && npm install github:openactive/data-model-validator#${{ inputs.data-model-validator_ref }}
+        cd packages/openactive-integration-tests && npm install github:openactive/data-model-validator#${{ inputs.data-model-validator_ref }}
+      working-directory: tests
+
+    - name: Install specific version of rpde-validator ${{ inputs.rpde-validator_ref }}
+      if: ${{ inputs.rpde-validator_ref }}
+      run: |
+        cd packages/openactive-broker-microservice && npm install github:openactive/rpde-validator#${{ inputs.rpde-validator_ref }}
+      working-directory: tests
+
+    - name: Run Checks on the Code (Test the Tests!)
+      run: npm test
+      working-directory: tests
+
     - name: Run OpenActive Integration Tests in ${{ matrix.mode }} mode
       run: npm start
       env:
@@ -83,6 +124,7 @@ jobs:
         NODE_ENV: .example.${{ matrix.profile }}
         NODE_APP_INSTANCE: ci
       working-directory: tests
+
     # Two purposes to uploading the output from these tests:
     # 1. So that the `deploy-output` job can use this output in order to publish it, as examples, to gh-pages
     # 2. Make the artifact downloadable from GitHub to a developer so that they can debug
@@ -96,9 +138,9 @@ jobs:
   deploy-output:
     needs: tests
     # Master branch only
-    if: ${{ github.ref == 'refs/heads/master' }}
+    if: ${{ github.repository == 'openactive/openactive-test-suite' && github.ref == 'refs/heads/master' }}
 
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     steps:
     # Checkout the repo to seed the contents of ./tests/publish/
@@ -124,3 +166,45 @@ jobs:
         publish_dir: ./tests/publish
         force_orphan: true
         enable_jekyll: true
+
+  # Publish to GitHub Container Registry
+  build-and-push-docker-image:
+    # Master branch only - extra checks
+    if: ${{ github.repository == 'openactive/openactive-test-suite' && github.ref == 'refs/heads/master' }}
+    needs: tests
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: read
+      packages: write
+    env: 
+      REGISTRY: ghcr.io
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for OpenActive Test Suite
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/openactive/test-suite
+          labels: |
+            org.opencontainers.image.title=OpenActive Test Suite
+            org.opencontainers.image.description=Test suite for OpenActive data publishing and Open Booking API implementations
+            org.opencontainers.image.vendor=OpenActive
+          tags: |
+            latest
+
+      - name: Build and push Docker image for OpenActive Test Suite
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}