remote_cypress_workflow.yml

name: remote_cypress_workflow
run-name: remote_cypress_workflow [${{ inputs.UNIQUE_ID}}] # Unique workflow number appended to the workflow run-name to filter the run results based on that.
# trigger on every PR for all branches
on:
  push:
    branches: [ '**' ]
  workflow_dispatch:
    inputs:
      test_repo:
        description: 'Cypress test repo'
        default: ''
        required: false
        type: string
      test_branch:
        description: 'Cypress test branch (default: source branch)'
        required: false
        type: string
      specs:
        description: 'Tests to run (default: osd:ciGroup)'
        required: false
        type: string
      build_id:
        description: 'Build Id'
        required: false
        type: string
      OS_URL:
        description: 'OpenSearch release artifact'
        required: false
        type: string
      OSD_URL:
        description: 'OpenSearch Dashboards release artifact'
        required: false
        type: string
      UNIQUE_ID:
        description: 'Unique Id for the workflow execution'
        required: true
        type: string

env:
  TEST_REPO: ${{ inputs.test_repo != '' && inputs.test_repo || github.repository }}
  TEST_BRANCH: "${{ inputs.test_branch != '' && inputs.test_branch || github.base_ref }}"
  FTR_PATH: 'cypress'
  START_CMD: 'node ../scripts/opensearch_dashboards --dev --no-base-path --no-watch --savedObjects.maxImportPayloadBytes=10485760 --server.maxPayloadBytes=1759977 --logging.json=false --data.search.aggs.shardDelay.enabled=true'
  OPENSEARCH_SNAPSHOT_CMD: 'node ../scripts/opensearch snapshot -E cluster.routing.allocation.disk.threshold_enabled=false'
  CYPRESS_BROWSER: 'chromium'
  JOB_ID: ${{ inputs.UNIQUE_ID}}

jobs:
  cypress-tests:
    runs-on: ubuntu-latest
    container:
      image: docker://opensearchstaging/ci-runner:ci-runner-rockylinux8-opensearch-dashboards-integtest-v2
      options: --user 1001
    env:
      # prevents extra Cypress installation progress messages
      CI: 1
      # avoid warnings like "tput: No value for $TERM and no -T specified"
      TERM: xterm
    name: Run cypress tests (${{ inputs.UNIQUE_ID}})
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
        with:
          repository: ${{ env.SOURCE_REPO }}
          ref: '${{ env.SOURCE_BRANCH }}'

      - name: Setup Node
        uses: actions/setup-node@v2
        with:
          node-version-file: '.nvmrc'
          registry-url: 'https://registry.npmjs.org'

      - name: Setup Yarn
        run: |
          npm uninstall -g yarn
          npm i -g yarn@1.22.10

      - name: Run bootstrap
        run: yarn osd bootstrap

      - name: Build plugins
        run: node scripts/build_opensearch_dashboards_platform_plugins --no-examples --workers 12
      
      - name: Checkout
        uses: actions/checkout@v2
        with:
          path: ${{ env.FTR_PATH }}
          repository: ${{ env.TEST_REPO }}
          ref: '${{ env.TEST_BRANCH }}'
      
      - name: Get Cypress version
        id: cypress_version
        run: |
          echo "name=cypress_version::$(cat ./${{ env.FTR_PATH }}/package.json | jq '.devDependencies.cypress' | tr -d '"')" >> $GITHUB_OUTPUT

      - name: Cache Cypress
        id: cache-cypress
        uses: actions/cache@v1
        with:
          path: ~/.cache/Cypress
          key: cypress-cache-v2-${{ runner.os }}-${{ hashFiles('**/package.json') }}
        env:
          CYPRESS_INSTALL_BINARY: ${{ steps.cypress_version.outputs.cypress_version }}
      - run: npx cypress cache list
      - run: npx cypress cache path

      - name: Run tests
        uses: cypress-io/github-action@v2
        with:
          working-directory: ${{ env.FTR_PATH }}
          start: ${{ env.OPENSEARCH_SNAPSHOT_CMD }}, ${{ env.START_CMD }}
          wait-on: 'http://localhost:9200, http://localhost:5601'
          command: yarn cypress:run-without-security --browser ${{ env.CYPRESS_BROWSER }} --spec ${{ env.FTR_PATH }}/integration/dasboard_sanity_test.spec.js

      # Screenshots are only captured on failure, will change this once we do visual regression tests
      - uses: actions/upload-artifact@v3
        if: failure()
        with:
          name: ftr-cypress-screenshots
          path: ${{ env.FTR_PATH }}/screenshots
          retention-days: 1
      
      - uses: actions/upload-artifact@v3
        if: always()
        with:
          name: ftr-cypress-videos
          path: ${{ env.FTR_PATH }}/videos
          retention-days: 1

      - uses: actions/upload-artifact@v3
        if: always()
        with:
          name: ftr-cypress-results
          path: ${{ env.FTR_PATH }}/results
          retention-days: 1