integration.yml

# Copyright 2021 Security Scorecard Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Run secret-dependent integration tests only after approval
name: Integration tests
on: pull_request_target

permissions:
  contents: read
  pull-requests: write

jobs:
  approve:
    runs-on: ubuntu-latest
    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@dd2c410b088af7c0dc8046f3ac9a8f4148492a95 # v1
        with:
          egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs

      - name: approve
        run: echo For security reasons, all pull requests need to be approved before running integration tests.

  integration-trusted:
    runs-on: ubuntu-latest
    environment: integration-test
    needs: [approve]
    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@dd2c410b088af7c0dc8046f3ac9a8f4148492a95 # v1
        with:
          egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs

      - name: pull_request actions/checkout
        uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # v2.3.4
        with:
          ref: ${{ github.event.pull_request.head.sha }}

      - name: setup-go
        uses: actions/setup-go@268d8c0ca0432bb2cf416faae41297df9d262d7f # v2.2.0
        with:
          go-version: '1.18'
          check-latest: true

      - name: Prepare test env
        run: |
            go mod download

      - name: Run GITHUB_TOKEN E2E  #using retry because the GitHub token is being throttled.
        uses: nick-invision/retry@b4fa57557dda8c2f30bcb2d19372cc3237190f7f
        env:
          GITHUB_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          max_attempts: 3
          retry_on: error
          timeout_minutes: 30
          command: make e2e-gh-token

      - name: Run PAT E2E  #using retry because the GitHub token is being throttled.
        uses: nick-invision/retry@b4fa57557dda8c2f30bcb2d19372cc3237190f7f
        env:
          GITHUB_AUTH_TOKEN: ${{ secrets.GH_AUTH_TOKEN }}
        with:
          max_attempts: 3
          retry_on: error
          timeout_minutes: 30
          command: make e2e-pat

      - name: codecov
        uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # 2.1.0
        with:
         files: ./e2e-coverage.out
         verbose: true

      - name: find comment
        uses: peter-evans/find-comment@1769778a0c5bd330272d749d12c036d65e70d39d # v1.2.0
        id: fc
        with:
          issue-number: ${{ github.event.pull_request.number || github.event.client_payload.pull_request.number }}
          comment-author: 'github-actions[bot]'
          body-includes: Integration tests ran for

      - name: create or update comment
        uses: peter-evans/create-or-update-comment@c9fcb64660bc90ec1cc535646af190c992007c32 # v1.4.5
        with:
          issue-number: ${{ github.event.pull_request.number || github.event.client_payload.pull_request.number }}
          comment-id: ${{ steps.fc.outputs.comment-id }}
          body: |
            Integration tests ${{ job.status }} for
            [${{ github.event.client_payload.slash_command.args.named.sha || github.event.pull_request.head.sha }}]
            (https://github.com/ossf/scorecard/actions/runs/${{ github.run_id }})