doc-tests.yml

name: Documentation Tests
description: Run tests for the documentation examples

env:
  NX_NO_CLOUD: true
  CI: true
  DEFAULT_RETENTION_DAYS: 30
  PREV_COMMIT_SHA_FILE: ./commit-sha.txt
  CTRF_FILE: ./ctrf-report.json
  SLACK_CHANNEL: '#ci-grid-gate'
  AG_LIBRARY: grid
on:
  schedule:
      - cron: '30 2 * * *' # Run daily at 2:30am UTC. Temporarily enabled until full build is tested
  workflow_dispatch:
    inputs:
      skip_vanilla:
        description: 'Skip Vanilla tests'
        type: boolean
        required: true
        default: true
      skip_typescript:
        description: 'Skip Typescript tests'
        type: boolean
        required: true
        default: true
      skip_reactFunctionalTs:
        description: 'Skip React Functional TS tests'
        type: boolean
        required: true
        default: true
      skip_angular:
        description: 'Skip Angular tests'
        type: boolean
        required: true
        default: true
      skip_vue3:
        description: 'Skip Vue3 tests'
        type: boolean
        required: true
        default: true
      skip_recipes:
        description: 'Skip Recipe tests'
        type: boolean
        required: true
        default: true
      test_pattern:
        description: 'Run only tests matching this pattern'
        type: string
        required: false
        default: ''
      base_url:
        description: 'Override base URL'
        type: string
        required: false
        default: 'https://grid-staging.ag-grid.com/'
      notify:
        description: 'Notify Slack channel'
        type: boolean
        default: true
        required: true
      force_jira_ticket:
        description: 'Force create a Jira ticket even if the run is not scheduled'
        type: boolean
        default: false
        required: true

permissions:
  contents: read
  actions: read

jobs:

  test-vanilla:
    if: ${{ github.event.inputs.skip_vanilla != 'true' }}
    name: Test vanilla Examples
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        shardIndex: [1]
        shardTotal: [1]
    steps:
      - uses: actions/checkout@v4
      - uses: ./.github/actions/test-framework-examples
        with:
          base_url: ${{github.event.inputs.base_url}}
          framework: vanilla
          browsers: all
          test_pattern: ${{github.event.inputs.test_pattern}}

  test-typescript:
    if: ${{ github.event.inputs.skip_typescript != 'true' }}
    name: Test typescript Examples
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        shardIndex: [1]
        shardTotal: [1]
    steps:
      - uses: actions/checkout@v4
      - uses: ./.github/actions/test-framework-examples
        with:
          base_url: ${{github.event.inputs.base_url}}
          framework: typescript
          browsers: chromium
          test_pattern: ${{github.event.inputs.test_pattern}}

  test-reactFunctionalTs:
    if: ${{ github.event.inputs.skip_reactFunctionalTs != 'true' }}
    name: Test reactFunctionalTs Examples
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        shardIndex: [1, 2]
        shardTotal: [2]
    steps:
      - uses: actions/checkout@v4
      - uses: ./.github/actions/test-framework-examples
        with:
          base_url: ${{github.event.inputs.base_url}}
          framework: reactFunctionalTs
          browsers: all
          test_pattern: ${{github.event.inputs.test_pattern}}

  test-vue3:
    if: ${{ github.event.inputs.skip_vue3 != 'true' }}
    name: Test vue3 Examples
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        shardIndex: [1]
        shardTotal: [1]
    steps:
      - uses: actions/checkout@v4
      - uses: ./.github/actions/test-framework-examples
        with:
          base_url: ${{github.event.inputs.base_url}}
          framework: vue3
          browsers: chromium
          test_pattern: ${{github.event.inputs.test_pattern}}

  test-angular:
    if: ${{ github.event.inputs.skip_angular != 'true' }}
    name: Test angular Examples
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        shardIndex: [1, 2]
        shardTotal: [2]
    steps:
      - uses: actions/checkout@v4
      - uses: ./.github/actions/test-framework-examples
        with:
          base_url: ${{github.event.inputs.base_url}}
          framework: angular
          browsers: chromium
          test_pattern: ${{github.event.inputs.test_pattern}}


  test-recipes:
    if: ${{ github.event.inputs.skip_recipes != 'true' }}
    name: Test Public Testing Recipes
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 1

      - name: Setup
        id: setup
        uses: ./.github/actions/setup-nx
        with:
          cache_mode: ro
      - name: Run Public Testing Recipes
        run: yarn nx run ag-grid-public-e2e-testing-recipes:test:recipes -c staging
      - name: Upload Test Report
        id: upload-recipes-report
        uses: actions/upload-artifact@v4
        if: ${{ !cancelled() }}
        with:
          name: playwright-report-recipes
          path: reports/
          retention-days: ${{env.DEFAULT_RETENTION_DAYS}}
  
  publish-reports:
    if: always()
    needs:
      - test-reactFunctionalTs
      - test-angular
      - test-typescript
      - test-vanilla
      - test-vue3
      - test-recipes
    env:
      IS_SUCCESS: ${{ needs.test-angular.result != 'failure' && needs.test-reactFunctionalTs.result != 'failure' && needs.test-typescript.result != 'failure' && needs.test-vanilla.result != 'failure' && needs.test-vue3.result != 'failure' && needs.test-recipes.result != 'failure' }}
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 1

      - name: Download all test reports
        uses: actions/download-artifact@v4
        with:
          path: combined-reports

      - name: Publish Combined Test Report
        id: ctrf
        uses: ctrf-io/github-test-reporter@v1.0.17
        with:
          report-path: 'combined-reports/**/*.json'
          summary-report: true
          failed-report: true
          flaky-report: true
          skipped-report: false
          write-ctrf-to-file: ${{ env.CTRF_FILE }}

      - name: Get previous run commit SHA
        id: prev-commit-sha
        uses: actions/cache/restore@v4
        with:
          restore-keys: |
            doc-tests-prev-commit-
            doc-tests-prev-commit-${{ github.ref }}
          path: ${{ env.PREV_COMMIT_SHA_FILE }}
          key: doc-tests-prev-commit-${{ github.ref }}-${{ github.sha }}

      - name: Load files into environment
        continue-on-error: true
        run: |
          if [ -f ${{ env.PREV_COMMIT_SHA_FILE }} ]; then
          {
             echo 'PREV_COMMIT_SHA<<EOF'
             cat ${{ env.PREV_COMMIT_SHA_FILE }}
             echo 'EOF'
          } >> $GITHUB_ENV
          else
            echo 'PREV_COMMIT_SHA_FILE not found'
          fi

      - name: Slack Notification
        if: ${{ github.event_name == 'schedule' || inputs.notify }}
        continue-on-error: true
        uses: ./external/ag-shared/github/actions/slack-integration
        with:
          AG_LIBRARY: ${{ env.AG_LIBRARY }}
          CTRF_REPORT_FILE: ${{ env.CTRF_FILE }}
          SLACK_BOT_OAUTH_TOKEN: ${{ secrets.SLACK_BOT_OAUTH_TOKEN }}
          SLACK_CHANNEL: ${{ env.SLACK_CHANNEL }}
          PREV_COMMIT_SHA: ${{ env.PREV_COMMIT_SHA }}
          CURRENT_COMMIT_SHA: ${{ github.sha }}
          IS_SUCCESS: ${{ env.IS_SUCCESS }}

      - name: Create Jira Ticket
        uses: ./.github/actions/jira-integration
        continue-on-error: true
        if: ${{ github.event_name == 'schedule' || inputs.force_jira_ticket }}
        with:
          JIRA_API_AUTH: ${{ secrets.JIRA_API_AUTH }}
          JIRA_SUMMARY: "[NR] CI/CD workflow '${{ github.workflow }}' is failing."
          CTRF_REPORT_FILE: ${{ env.CTRF_FILE }}
          PREV_COMMIT_SHA: ${{ env.PREV_COMMIT_SHA }}
          CURRENT_COMMIT_SHA: ${{ github.sha }}
          IS_SUCCESS: ${{ env.IS_SUCCESS }}

      - name: Set commit SHA
        id: set-commit-sha
        run: |
          echo ${{ github.sha }} > ${{ env.PREV_COMMIT_SHA_FILE }}

      - name: Save Current Commit Hash
        uses: actions/cache/save@v4
        with:
          path: ${{ env.PREV_COMMIT_SHA_FILE }}
          key: ${{ steps.prev-commit-sha.outputs.cache-primary-key }}