Create (and document) GitHub Action to integrate with Docker image

[lukehesluke]

CURRENT STATUS (written by @lukehesluke)

• Task 1 (see: ORIGINAL COMMENT) was completed as a part of feat: Add Docker support #597
• Task 2 was partially completed within that PR in that there was an action.yml file included. I removed that action.yml file for now as it seems to me like it shouldn't work. It is included in full in this comment: Create (and document) GitHub Action to integrate with Docker image #682 (comment). It seems like this action.yml, as it currently stands, shouldn't work because the config arg isn't used in the runs: step.
  • To get this to work, you (the implementer) may need to update config to instead use the INPUT_CONFIG logic that is documented in README.md (once this PR is merged: feat: Add Docker support #597).

SO, this is what needs to be done for this issue:

1. Await feat: Add Docker support #597 to be merged, or branch off of it.
2. Add action.yml, based off of Create (and document) GitHub Action to integrate with Docker image #682 (comment), but fixing the config arg.
3. Document how to use action.yml, using the example provided in ORIGINAL COMMENT > Task 2

ORIGINAL COMMENT (written by @nickevansuk)

Task 1: Fully document the docker run call

Explain all of the following:

docker run -it -e INPUT_CONFIG=/config/strmln.json -e NODE_ENV=strmln -p 3000:3000 -v ${PWD}/config:/config -v ${PWD}/packages/openactive-integration-tests/output:/openactive-test-suite/packages/openactive-integration-tests/output ghcr.io/openactive/test-suite:latest -- booking-partner-authentication

And potentially simplify this command too

Task 2: Create and document GitHub Action to integrate with Docker image

Assuming dev.json is renamed openactive-test-suite-config.json and exists in a directory named example-booking-system in the GitHub workspace, and assuming that within the GitHub action the app is running on http://localhost:8081/ then the following should work currently, and output the resulting cert to conformance/ in the current workspace

    - name: Run OpenActive Test Suite
      uses: openactive/openactive-test-suite@d7cbdac7f03ce75f282927fe67c9a375f1e440a8
      with:
        config: example-booking-system/openactive-test-suite-config.json
        NODE_CONFIG: |
          { "ci": true, "consoleOutputLevel": "detail", "broker": {"datasetSiteUrl": "http://localhost:8081/openactive", "outputPath": "/github/workspace/output/"}, "integrationTests": {"testDatasetIdentifier": "github-ci", "outputPath": "/github/workspace/output/", "generateConformanceCertificate": true, "conformanceCertificatePath": "/github/workspace/conformance/", "conformanceCertificateId": "https://openactive-certificate.example.com/" }}
        NODE_ENV: openactive-test-suite-config

    - name: Upload OpenActive Test Suite output as artifact for debugging
      uses: actions/upload-artifact@v2
      if: ${{ success() || failure() }}
      with:
        name: openactive-test-suite
        path: ./output/

Ensure that all of the above works and is clearly documented at the appropriate levels within README.md and also developer.openactive.io

[lukehesluke]

action.yml:

name: 'OpenActive Test Suite'
description: 'Test suite for OpenActive implementations'
inputs:
  args:  # id of input
    description: 'Arguments to pass to `npm start` of OpenActive Test Suite'
    required: false
    default: ''
  config:  # id of input
    description: 'The path of a config file to copy into ./config/ of OpenActive Test Suite'
    required: false
    default: ''
  NODE_CONFIG:  # id of input
    description: 'JSON configuration string to pass into OpenActive Test Suite'
    required: true
    default: '{ "ci": true }'
  NODE_ENV:  # id of input
    description: 'Value of NODE_ENV environment variable to pass into OpenActive Test Suite'
    required: false
    default: ''
  NODE_APP_INSTANCE:  # id of input
    description: 'Value of NODE_APP_INSTANCE environment variable to pass into OpenActive Test Suite'
    required: false
    default: ''
runs:
  using: 'docker'
  image: 'docker://ghcr.io/openactive/test-suite:latest'
  args:
    - ${{ inputs.args }}
  env:
    FORCE_COLOR: 1
    NODE_CONFIG: ${{ inputs.NODE_CONFIG }}
    NODE_ENV: ${{ inputs.NODE_ENV }}
    NODE_APP_INSTANCE: ${{ inputs.NODE_APP_INSTANCE }}