soak.yml

name: on_demand_soak_test
on:
  workflow_dispatch:
    inputs:
      base64_config:
        description: Your .toml file as base64 (must NOT contain test secrets)
        required: true
      test_secrets_override_key:
        description: 'Key to run tests with custom test secrets like ws url, rpc url, private key, etc.'
        required: false
        type: string        
      cl_image_tag:
        description: Core image tag
        required: true
        default: develop
        type: string
      test_runner_tag:
        description: Remote runner tag that will run the tests
        default: develop
        required: true
        type: string
env:
  CL_ECR: ${{ secrets.QA_AWS_ACCOUNT_NUMBER }}.dkr.ecr.${{ secrets.QA_AWS_REGION }}.amazonaws.com/chainlink
  CONTRACT_ARTIFACTS_PATH: contracts/target/deploy
  MOD_CACHE_VERSION: 1

jobs:
  get_projectserum_version:
    name: Get ProjectSerum Version
    environment: integration
    runs-on: ubuntu-latest
    outputs:
      projectserum_version: ${{ steps.psversion.outputs.projectserum_version }}
    steps:
      - name: Checkout the repo
        uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
      - name: Get ProjectSerum Version
        id: psversion
        uses: ./.github/actions/projectserum_version

  e2e_custom_build_artifacts:
    name: E2E Custom Build Artifacts
    environment: integration
    permissions:
      id-token: write
      contents: read
    steps:
      - name: Checkout the repo
        uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
      - name: Build contracts
        uses: ./.github/actions/build_contract_artifacts
        with:
          image: backpackapp/build
          image-version: ${{ needs.get_projectserum_version.outputs.projectserum_version }}

  e2e_custom_run_smoke_tests:
    name: Run on demand soak test
    environment: integration
    permissions:
      checks: write
      pull-requests: write
      id-token: write
      contents: read
    runs-on: ubuntu-latest-16cores-64GB

    needs: [e2e_custom_build_artifacts]
    env:
      TEST_ARGS: -test.timeout 30m
      TEST_LOG_LEVEL: debug
      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      TEST_SUITE: soak
      DETACH_RUNNER: true
      ENV_JOB_IMAGE: ${{ secrets.QA_AWS_ACCOUNT_NUMBER }}.dkr.ecr.${{ secrets.QA_AWS_REGION }}.amazonaws.com/chainlink-solana-tests:${{ github.event.inputs.test_runner_tag }}
    steps:
      - name: Collect Metrics
        id: collect-gha-metrics
        uses: smartcontractkit/push-gha-metrics-action@dea9b546553cb4ca936607c2267a09c004e4ab3f # v3.0.0
        with:
          id: solana-e2e-soak
          org-id: ${{ secrets.GRAFANA_INTERNAL_TENANT_ID }}
          basic-auth: ${{ secrets.GRAFANA_INTERNAL_BASIC_AUTH }}
          hostname: ${{ secrets.GRAFANA_INTERNAL_HOST }}
          this-job-name: Run on demand soak test
          test-results-file: '{"testType":"go","filePath":"/tmp/gotest.log"}'
        continue-on-error: true
      - name: Checkout the repo
        uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
      - name: Install Solana CLI # required for ensuring the local test validator is configured correctly
        run: ./scripts/install-solana-ci.sh
      - name: Install gauntlet
        uses: ./.github/actions/build-gauntlet
      - name: Mask base64 config
        # shellcheck disable=SC2086
        run: |
          BASE64_CONFIG_OVERRIDE=$(jq -r '.inputs.base64_config' "$GITHUB_EVENT_PATH")
          echo "::add-mask::$BASE64_CONFIG_OVERRIDE"
          echo "BASE64_CONFIG_OVERRIDE=$BASE64_CONFIG_OVERRIDE" >> "$GITHUB_ENV"
      - name: Run Tests
        uses: smartcontractkit/chainlink-github-actions/chainlink-testing-framework/run-tests@fdaf56b1df7248d18e30ad09982d03ec67d6b71c # v2.3.29
        with:
          test_command_to_run: cd ./integration-tests && go test -timeout 24h -count=1 -run TestSolanaOCRV2Soak/embedded -json $(args) ./soak 2>&1 | tee /tmp/gotest.log | gotestloghelper -ci -singlepackage
          test_download_vendor_packages_command: cd ./integration-tests && go mod download
          test_config_override_base64: ${{ env.BASE64_CONFIG_OVERRIDE }}
          test_secrets_override_base64: ${{ secrets[inputs.test_secrets_override_key] }}
          download_contract_artifacts_path: ${{ env.CONTRACT_ARTIFACTS_PATH }} 
          go_mod_path: ./integration-tests/go.mod
          cl_repo: ${{ env.CL_ECR }}
          cl_image_tag: ${{ github.event.inputs.cl_image_tag }}
          token: ${{ secrets.GITHUB_TOKEN }}
          aws_registries: ${{ secrets.QA_AWS_ACCOUNT_NUMBER }}
          artifacts_name: smoke-test-logs
          artifacts_location: ./integration-tests/smoke/logs/
          QA_AWS_REGION: ${{ secrets.QA_AWS_REGION }}
          QA_AWS_ROLE_TO_ASSUME: ${{ secrets.QA_AWS_ROLE_TO_ASSUME }}
          QA_KUBECONFIG: ${{ secrets.QA_KUBECONFIG }}
          cache_key_id: solana-e2e-${{ env.MOD_CACHE_VERSION }}
          cache_restore_only: "false"
        env:
          E2E_TEST_SOLANA_SECRET: thisisatestingonlysecret