trunk-pipeline.yml

---
name: Trunk pipeline to production

on:  # yamllint disable-line rule:truthy
  push:
    branches:
      - master

jobs:

  deploy-to-post-merge:
    runs-on: ubuntu-latest
    environment: post-merge
    steps:
      - uses: actions/checkout@v2.3.4
      - uses: akhileshns/heroku-deploy@v3.12.12
        with:
          heroku_api_key: ${{ secrets.HEROKU_API_KEY }}
          heroku_app_name: ${{ secrets.HEROKU_APP_NAME }}
          heroku_email: ${{ secrets.HEROKU_EMAIL }}

      - name: Check out code
        uses: actions/checkout@v2

      - name: Install Gauge
        uses: getgauge/setup-gauge@master
        with:
          gauge-version: master
          gauge-plugins: js, html-report, screenshot

      - name: Post-merge FTs
        env:
          WEB_URL: ${{ secrets.WEB_URL }}
        run: |
          cd functional-tests
          npm install
          gauge run

      - name: Upload logs
        uses: actions/upload-artifact@v1
        if: always()
        with:
          name: post-merge-fts-logs
          path: functional-tests/logs

      - name: Set contract repo HEAD output var
        id: set-contract-head-output-var
        # NB we append the date time to the tag to make it unique,
        # as multiple commits can be linked to the same contract repo commit
        run: |
          CONTRACT_REPO=https://github.com/agilepathway/available-pets-consumer-contract
          CONTRACT_HEAD=($(git ls-remote --heads $CONTRACT_REPO refs/heads/master))
          DATETIME=$(date '+%Y-%m-%d-%H-%M-%S')
          echo "::set-output name=contract-head::available-pets-consumer-contract-${CONTRACT_HEAD}-${DATETIME}"

      - name: Tag commit with HEAD commit from contract repo
        uses: actions/github-script@v5
        with:
          github-token: ${{ github.token }}
          script: |
            github.rest.git.createRef({
              owner: context.repo.owner,
              repo: context.repo.repo,
              ref: "refs/tags/${{ steps.set-contract-head-output-var.outputs.contract-head }}",
              sha: context.sha
            })

  deploy-ephemeral-provider-for-can-i-deploy-check:
    needs: deploy-to-post-merge
    runs-on: ubuntu-latest
    environment: can-i-deploy
    steps:

      - name: Set provider repo production commit output var
        id: set-provider-production-commit-output-var
        # HEROKU_SLUG_COMMIT is available via https://devcenter.heroku.com/articles/dyno-metadata
        run: |
          COMMIT=$(heroku config:get --app petstore-openapi-service HEROKU_SLUG_COMMIT)
          echo "::set-output name=commit::${COMMIT}"
        env:
          HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}

      - uses: actions/checkout@v2.3.4
        with:
          repository: agilepathway/petstore-service
          ref: ${{ steps.set-provider-production-commit-output-var.outputs.commit }}
      - uses: akhileshns/heroku-deploy@v3.12.12
        with:
          heroku_api_key: ${{ secrets.HEROKU_API_KEY }}
          heroku_app_name: ephemeral-petstore-service
          heroku_email: ${{ secrets.HEROKU_EMAIL }}

  can-i-deploy:
    needs: deploy-ephemeral-provider-for-can-i-deploy-check
    # Verify that the provider satisfies the contract for our specific consumer commit.
    # If the contract is not satisfied by the provider then the pipeline stops and we do
    # not deploy to our integrated environments (pre-production and production).  We would
    # then wait for the provider to deploy the changes necessary on their side.
    runs-on: ubuntu-latest
    steps:
      - name: Check out code
        uses: actions/checkout@v2
        with:
          fetch-depth: '0'

      - name: Set contract repo commit output var
        id: set-contract-commit-output-var
        run: |
          CONTRACT_TAG=$(git describe --match "available-pets-consumer-contract*" --tags ${GITHUB_SHA})
          TMP=${CONTRACT_TAG#*available-pets-consumer-contract-}   # remove prefix ending in "_"
          CONTRACT_COMMIT=${TMP%%-*} # remove suffix starting with "-"
          echo "::set-output name=contract-commit::${CONTRACT_COMMIT}"

      - name: Check out contract repo
        # We checkout the specific commit on the contract repo that we associated (tagged) with our consumer commit
        uses: actions/checkout@v2
        with:
          repository: agilepathway/available-pets-consumer-contract
          path: './contract'
          ref: ${{ steps.set-contract-commit-output-var.outputs.contract-commit }}

      - name: Set up Java
        uses: actions/setup-java@v2
        with:
          distribution: 'temurin'
          java-version: '17'

      - name: Install Gauge
        uses: getgauge/setup-gauge@master
        with:
          gauge-plugins: java, html-report

      - name: Install Prism
        run: npm install -g @stoplight/prism-cli

      - name: Start Prism in validation proxy mode
        working-directory: ./contract
        run: prism proxy openapi.yaml https://ephemeral-petstore-service.herokuapp.com/v2 --errors &
      - name: Check that the provider in production satisfies the contract
        env:
          OPENAPI_HOST: http://127.0.0.1:4010
        working-directory: ./contract
        run: gauge run specs

      - name: Upload Gauge test report
        uses: actions/upload-artifact@v2
        if: always()
        with:
          name: gauge-html-report
          path: contract/reports/html-report/


  deploy-to-pre-production:
    needs: can-i-deploy
    runs-on: ubuntu-latest
    environment: pre-production
    steps:
      - uses: actions/checkout@v2.3.4
      - uses: akhileshns/heroku-deploy@v3.12.12
        with:
          heroku_api_key: ${{ secrets.HEROKU_API_KEY }}
          heroku_app_name: ${{ secrets.HEROKU_APP_NAME }}
          heroku_email: ${{ secrets.HEROKU_EMAIL }}

      - name: Check out code
        uses: actions/checkout@v2

      - name: Install Gauge
        uses: getgauge/setup-gauge@master
        with:
          gauge-version: master
          gauge-plugins: js, html-report, screenshot

      - name: Pre-production FTs
        env:
          WEB_URL: ${{ secrets.WEB_URL }}
        run: |
          cd functional-tests
          npm install
          gauge run

      - name: Upload logs
        uses: actions/upload-artifact@v1
        if: always()
        with:
          name: pre-production-fts-logs
          path: functional-tests/logs

  deploy-to-production:
    needs: deploy-to-pre-production
    runs-on: ubuntu-latest
    environment: production
    steps:
      - uses: actions/checkout@v2.3.4
      - uses: akhileshns/heroku-deploy@v3.12.12
        with:
          heroku_api_key: ${{ secrets.HEROKU_API_KEY }}
          heroku_app_name: ${{ secrets.HEROKU_APP_NAME }}
          heroku_email: ${{ secrets.HEROKU_EMAIL }}

      - name: Check out code
        uses: actions/checkout@v2

      - name: Install Gauge
        uses: getgauge/setup-gauge@master
        with:
          gauge-version: master
          gauge-plugins: js, html-report, screenshot

      - name: Production FTs
        env:
          WEB_URL: ${{ secrets.WEB_URL }}
        run: |
          cd functional-tests
          npm install
          gauge run

      - name: Upload logs
        uses: actions/upload-artifact@v1
        if: always()
        with:
          name: production-fts-logs
          path: functional-tests/logs