accept_tests.yml

name: Acceptance_Test
env:
  RECORD_HAR: false
  TEST_ENV: IST # If changed update name property of run_tests job
  CI: true
  SYS_ADMIN_USERNAME: ${{ secrets.SYS_ADMIN_USERNAME }}
  SYS_ADMIN_PASSWORD: ${{ secrets.SYS_ADMIN_PASSWORD }}
  SYS_ADMIN_FIRST_NAME: ${{ secrets.SYS_ADMIN_FIRST_NAME }}
  SYS_ADMIN_LAST_NAME: ${{ secrets.SYS_ADMIN_LAST_NAME }}
  SYS_ADMIN_EMAIL: ${{ secrets.SYS_ADMIN_EMAIL }}
  SYS_ADMIN_EMAIL_PASSWORD: ${{ secrets.SYS_ADMIN_EMAIL_PASSWORD }}
  SYS_ADMIN_EMAIL_HOST: ${{ secrets.SYS_ADMIN_EMAIL_HOST }}
  SYS_ADMIN_EMAIL_PORT: ${{ secrets.SYS_ADMIN_EMAIL_PORT }}
  ALPHA_INSTANCE_URL: ${{ secrets.ALPHA_INSTANCE_URL }}
  BETA_INSTANCE_URL: ${{ secrets.BETA_INSTANCE_URL }}
  QA_INSTANCE_URL: ${{ secrets.QA_INSTANCE_URL }}
  IST_INSTANCE_URL: ${{ secrets.IST_INSTANCE_URL }}
  VPRIOR_INSTANCE_URL: ${{ secrets.VPRIOR_INSTANCE_URL }}
  VNEXT_INSTANCE_URL: ${{ secrets.VNEXT_INSTANCE_URL }}
  PROD_INSTANCE_URL: ${{ secrets.PROD_INSTANCE_URL }}
  FEDSPRING_IST_INSTANCE_URL: ${{ secrets.FEDSPRING_IST_INSTANCE_URL }}
  RENDER_API_KEY: ${{ secrets.RENDER_API_KEY }}
  RENDER_REPORT_SITE_SERVICE_ID: ${{ secrets.RENDER_REPORT_SITE_SERVICE_ID }}
  BITSIGHT_API_KEY: ${{ secrets.BITSIGHT_API_KEY }}
on:
  pull_request:
    branches:
      - master
    paths-ignore:
      - .vscode/**
      - .github/**
      - scripts/**
      - '**/README.md'
      - '**/example.env'
      - '**/.gitignore'
      - '**/.env.vault'
jobs:
  check_for_test_file_changes:
    name: Check for test file changes
    runs-on: ubuntu-latest
    outputs:
      changed_test_files: ${{ steps.get_changed_test_files.outputs.changed_test_files }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          ref: ${{ github.event.pull_request.head.ref }}
          fetch-depth: 0
      - name: Get changed test files
        id: get_changed_test_files
        shell: bash {0}
        run: |
          echo "Changed files in this PR:"
          BASE_HEAD_SHA=${{ github.event.pull_request.base.sha }}
          PR_HEAD_SHA=${{ github.event.pull_request.head.sha }}
          CHANGED_FILES=$(git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }} | grep '\.spec\.ts' | tr '\n' ' ')
          if [ -n "$CHANGED_FILES" ]
          then
            echo "Test files changed:"
            echo "$CHANGED_FILES"
            echo "changed_test_files=$CHANGED_FILES" >> $GITHUB_OUTPUT
          else
            echo "No test files changed."
          fi
  generate_shards:
    name: 'Generate Shards'
    needs: check_for_test_file_changes
    runs-on: ubuntu-latest
    outputs:
      shards: ${{ steps.generate_shards.outputs.shards }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: Install jq
        run: |
          sudo apt-get update
          sudo apt-get install jq
      - name: Generate shards
        id: generate_shards
        run: |
          #!/bin/bash
          test_directory="tests"

          test_count=0

          while IFS= read -r file; do
            count=$(grep -c "test(" "$file")
            test_count=$((test_count + count))
          done < <(for filePath in ${{ needs.check_for_test_file_changes.outputs.changed_test_files }}; do basename "$filePath"; done | xargs -I {} find "tests" -type f -name {})

          test_count=$((test_count * 3)) # repeat-each 3
          min_shards=10
          max_tests_per_shard=20

          num_of_shards=$((test_count / max_tests_per_shard))

          if [ "$num_of_shards" -le "$min_shards" ]; then
            num_of_shards=$min_shards
          fi

          shards_array=()

          for ((i=1; i<=$num_of_shards; i++)); do
            shards_array+=("$i/$num_of_shards")
          done

          json_shards_array=$(jq -n -c --arg arr "$(printf '%s\n' "${shards_array[@]}")" '$arr | split("\n")')

          # Output the result and the array
          echo "Total tests: $test_count"
          echo "Total shards: $num_of_shards"
          echo "shards=${shards_array[@]}"
          echo "shards=$json_shards_array" >> $GITHUB_OUTPUT
  run_tests:
    name: 'Playwright Tests - IST - ${{ matrix.project }} - Shard ${{ matrix.shard }}'
    needs: [check_for_test_file_changes, generate_shards]
    if: ${{ needs.check_for_test_file_changes.outputs.changed_test_files != '' }}
    runs-on: ubuntu-latest
    container:
      image: mcr.microsoft.com/playwright:v1.44.0-jammy
    strategy:
      fail-fast: false
      matrix:
        project: [chrome, edge, api]
        shard: ${{ fromJson(needs.generate_shards.outputs.shards) }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: lts/*
      - name: Install dependencies
        run: npm ci
      - name: Run your tests
        run: |
          echo "Running tests for ${{ matrix.project }} shard ${{ matrix.shard }}"
          npx playwright test ${{ needs.check_for_test_file_changes.outputs.changed_test_files }} --project=${{ matrix.project }} --shard=${{ matrix.shard }} --repeat-each 3 --retries 1
      - name: Rename blob-reports
        if: ${{ cancelled() != true }}
        run: for file in blob-report/*; do [ -f "$file" ] && mv "$file" "blob-report/${{ matrix.project }}-$(basename "$file")"; done
      - name: Upload blob report'
        if: ${{ cancelled() != true }}
        uses: actions/upload-artifact@v4
        with:
          name: all-blob-reports-${{ matrix.project }}-${{ strategy.job-index }}
          path: blob-report
          retention-days: 1
  merge_reports_and_publish:
    name: 'Merge Reports and Publish'
    needs: run_tests
    if: ${{ cancelled() != true }}
    runs-on: ubuntu-latest
    outputs:
      deployment_url: ${{ steps.report_url.outputs.value }}
    steps:
      - name: Checkout repository
        if: ${{ needs.run_tests.result != 'skipped' && needs.run_tests.result != 'cancelled' }}
        uses: actions/checkout@v4
      - name: Setup Node.js
        if: ${{ needs.run_tests.result != 'skipped' && needs.run_tests.result != 'cancelled' }}
        uses: actions/setup-node@v4
        with:
          node-version: lts/*
      - name: Install dependencies
        if: ${{ needs.run_tests.result != 'skipped' && needs.run_tests.result != 'cancelled' }}
        run: npm ci
      - name: Download blob reports
        if: ${{ needs.run_tests.result != 'skipped' && needs.run_tests.result != 'cancelled' }}
        uses: actions/download-artifact@v4
        with:
          pattern: all-blob-reports-*
          merge-multiple: true
          path: all-blob-reports
      - name: Rename reports
        if: ${{ needs.run_tests.result != 'skipped' && needs.run_tests.result != 'cancelled' }}
        run: count=1; for file in $(find ./all-blob-reports -maxdepth 1 -type f -name "*.zip"); do mv "$file" "all-blob-reports/report-$count.zip"; count=$((count+1)); done
      - name: Merge into HTML Report
        if: ${{ needs.run_tests.result != 'skipped' && needs.run_tests.result != 'cancelled' }}
        run: npx playwright merge-reports --reporter html ./all-blob-reports
      - name: Upload HTML report
        if: ${{ needs.run_tests.result != 'skipped' && needs.run_tests.result != 'cancelled' }}
        uses: actions/upload-artifact@v4
        with:
          name: html-report-attempt-${{ github.run_attempt }}
          path: playwright-report
          retention-days: 90
      - name: Get date and time
        if: ${{ needs.run_tests.result != 'skipped' && needs.run_tests.result != 'cancelled' }}
        id: date
        run: echo "value=$(($(date '+%s%N' | cut -b1-13) / 1))" >> $GITHUB_OUTPUT
      - name: Create report directory name
        if: ${{ needs.run_tests.result != 'skipped' && needs.run_tests.result != 'cancelled' }}
        id: report_directory_name
        run: echo "value=${{ steps.date.outputs.value }}-${{ env.TEST_ENV }}-${{ needs.run_tests.result }}-${{ github.workflow }}-${{ github.run_number }}-${{ github.run_attempt }}-PR_${{ github.event.pull_request.number }}" >> $GITHUB_OUTPUT
      - name: Rename reports
        if: ${{ needs.run_tests.result != 'skipped' && needs.run_tests.result != 'cancelled' }}
        run: mv playwright-report ${{ steps.report_directory_name.outputs.value }}
      - name: Commit report to report site
        if: ${{ needs.run_tests.result != 'skipped' && needs.run_tests.result != 'cancelled' }}
        uses: cpina/github-action-push-to-another-repository@v1.7.2
        env:
          API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
        with:
          source-directory: ${{ steps.report_directory_name.outputs.value }}
          destination-github-username: 'StevanFreeborn'
          user-email: '65925598+StevanFreeborn@users.noreply.github.com'
          destination-repository-name: 'onspring-qa-playwright-reports'
          target-branch: 'main'
          commit-message: 'chore: add new report for PR [skip deploy]'
          target-directory: 'reports/${{ steps.report_directory_name.outputs.value }}/'
      - name: Deploy report site
        if: ${{ needs.run_tests.result != 'skipped' && needs.run_tests.result != 'cancelled' }}
        run: node ./scripts/deployReportSite.mjs
      - name: Output report url
        if: ${{ needs.run_tests.result != 'skipped' && needs.run_tests.result != 'cancelled' }}
        id: report_url
        run: echo "value=https://onspringqareports.stevanfreeborn.com/reports/${{ steps.report_directory_name.outputs.value }}/" >> $GITHUB_OUTPUT
  add_pr_comment:
    name: 'Add PR Comment'
    needs: [run_tests, merge_reports_and_publish]
    if: ${{ cancelled() != true }}
    runs-on: ubuntu-latest
    permissions:
      issues: write
      pull-requests: write
    steps:
      - name: Comment URL to PR
        if: ${{ needs.run_tests.result != 'skipped' && needs.run_tests.result != 'cancelled' }}
        env:
          DEPLOYMENT_URL: ${{ needs.merge_reports_and_publish.outputs.deployment_url }}
        uses: actions/github-script@v6
        id: commment_script
        with:
          script: |
            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: `PR Playwright Report ${{ github.run_number }}-${{ github.run_attempt }}: ${process.env.DEPLOYMENT_URL}`
            })
  cleanup:
    name: 'Cleanup test artifacts'
    if: ${{ !cancelled() }}
    needs: [check_for_test_file_changes, generate_shards, run_tests]
    runs-on: ubuntu-latest
    container:
      image: mcr.microsoft.com/playwright:v1.44.0-jammy
    strategy:
      fail-fast: false
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: lts/*
      - name: Install dependencies
        run: npm ci
      - name: Run your tests
        run: npm run cleanup