heartbeat-tests.yml

name: heartbeat-tests
on:
  workflow_dispatch: # As per documentation, the colon is necessary even though no config is required.
  schedule:
    # Cron syntax is "minute[0-59] hour[0-23] date[1-31] month[1-12] day[0-6]". '*' is 'any value', and multiple values
    # can be specified with comma-separated lists. All times are UTC.
    # So this expression means "run at 45 minutes past 1, 5, and 9 AM/PM UTC". The hours were chosen so that
    # the jobs run only close to business hours of Central Time.
    # Days were chosen to run only from Monday through Friday.
    - cron: "45 13,17,21 * * 1,2,3,4,5"

jobs:
  production-heartbeat:
    strategy:
      # By default, if any job in a matrix fails, all other jobs are immediately cancelled. This makes the jobs run to completion instead.
      fail-fast: false
      matrix:
        os: [{ vm: ubuntu-latest, exe: .sh }, { vm: windows-latest, exe: .cmd }]
        node: ["lts/*"]
    runs-on: ${{ matrix.os.vm }}
    timeout-minutes: 60
    steps:
      # === Setup. We need to get the code, set up nodejs, java, and python, and create the results directory. ===
      - uses: actions/checkout@v4
        with:
          ref: "dev"
      - uses: actions/setup-node@v4
        with:
          node-version: ${{ matrix.node }}
      - uses: actions/setup-java@v4
        with:
          distribution: "temurin"
          java-version: "11"
      - uses: actions/setup-python@v5
        with:
          python-version: "3.10"
      - run: mkdir smoke-test-results

      # === Set our environment variables, either using default values or the repo's secrets ===
      - name: Set environment variables
        id: env_var_setup
        # We'll want to use bash for this, to avoid any cross-platform shenanigans
        shell: bash
        run: |
          # In the following script, the use of the `echo "name=value" >> $GITHUB_ENV` structure is used to set/update
          # environment variables. Such updates are visible to all subsequent steps.
          #
          # If the CLI_VERSION repo secret is set, we want to install that version of sf-cli, so we set an environment
          # variable. Otherwise, we leave the environment variable unset, so it implicitly defaults to `latest`.
          # Note: This can be used to intentionally fail the GHA by providing an invalid version number.
          if [[ -n "${{ secrets.CLI_VERSION }}" ]]; then
            echo "CLI_VERSION=@${{ secrets.CLI_VERSION}}" >> $GITHUB_ENV
          fi
          # If the CODE_ANALYZER_VERSION repo secret is set, we want to install that version of code-analyzer, so we set an
          # environment variable. Otherwise, we leave the environment variable unset, so it implicitly defaults to `latest`.
          # Note: This can be used to intentionally fail the GHA by providing an invalid version number.
          if [[ -n "${{ secrets.CODE_ANALYZER_VERSION }}" ]]; then
            echo "CODE_ANALYZER_VERSION=@${{ secrets.CODE_ANALYZER_VERSION }}" >> $GITHUB_ENV
          fi
          # If the FAIL_SMOKE_TESTS repo secret is set to ANY value, we should respond by deleting the `test/test-jars`
          # folder. The smoke tests expect this folder's contents to exist, so an invocation of any command should
          # fail, thereby failing the smoke tests as a whole.
          # Note: This serves no purpose aside from providing a way to simulate a smoke test failure.
          if [[ -n "${{ secrets.FAIL_SMOKE_TESTS }}" ]]; then
            rm -rf ./test/test-jars
          fi

      # === Make three attempts to install SF through npm ===
      - name: Install SF
        shell: bash
        id: sf_install
        # If the first attempt fails, wait a minute and try again. After a second failure, wait 5 minutes then try again. Then give up.
        # Set an output parameter, `retry_count`, indicating the number of retry attempts that were made.
        run: |
          (echo "retry_count=0" >> $GITHUB_OUTPUT && npm install -g @salesforce/cli${{ env.CLI_VERSION }}) ||
          (echo "retry_count=1" >> $GITHUB_OUTPUT && sleep 60 && npm install -g @salesforce/cli${{ env.CLI_VERSION }}) ||
          (echo "retry_count=2" >> $GITHUB_OUTPUT && sleep 300 && npm install -g @salesforce/cli${{ env.CLI_VERSION }})

      # === Make three attempts to install the code analyzer plugin through sf ===
      - name: Install Code Analyzer Plugin
        shell: bash
        id: code_analyzer_install
        # If the first attempt fails, wait a minute and try again. After a second failure, wait 5 minutes then try again. Then give up.
        # Set an output parameter, `retry_count`, indicating the number of retry attempts that were made.
        run: |
          (echo "retry_count=0" >> $GITHUB_OUTPUT && sf plugins install code-analyzer${{ env.CODE_ANALYZER_VERSION }}) ||
          (echo "retry_count=1" >> $GITHUB_OUTPUT && sleep 60 && sf plugins install code-analyzer${{ env.CODE_ANALYZER_VERSION }}) ||
          (echo "retry_count=2" >> $GITHUB_OUTPUT && sleep 300 && sf plugins install code-analyzer${{ env.CODE_ANALYZER_VERSION }})

      # === Log the installed plugins for easier debugging ===
      - name: Log plugins
        shell: bash
        run: |
          echo "Plugins Results Output"
          echo "SF CLI required ${{ steps.sf_install.outputs.retry_count }} retries"
          echo "Code Analyzer Plugin required ${{ steps.code_analyzer_install.outputs.retry_count }} retries"
          echo ""
          echo "Verifying installed plugins:"
          sf plugins

      # === Attempt to execute the smoke tests ===
      - name: Run smoke tests
        id: smoke_tests
        run: smoke-tests/smoke-test${{ matrix.os.exe }} sf

      # === Upload the smoke-test-results folder as an artifact ===
      - name: Upload smoke-test-results folder as artifact
        if: ${{ always() }}
        uses: actions/upload-artifact@v4
        with:
          name: smoke-test-results-${{ runner.os }}
          path: smoke-test-results

      # === Report any problems ===
      - name: Report problems
        # There are problems if any step failed or was skipped.
        # Note that the `join()` call omits null values, so if any steps were skipped, they won't have a corresponding
        # value in the string.
        if: ${{ failure() || cancelled() }}
        shell: bash
        env:
          # Build the status strings for each step as environment variables to save space later. Null retry_count values
          # will be replaced with `n/a` to maintain readability in the alert.
          CLI_INSTALL_STATUS: ${{ steps.sf_install.outcome }} after ${{ steps.sf_install.outputs.retry_count || 'n/a' }} retries
          CODE_ANALYZER_INSTALL_STATUS: ${{ steps.code_analyzer_install.outcome }} after ${{ steps.code_analyzer_install.outputs.retry_count || 'n/a' }} retries
          SMOKE_TESTS_STATUS: ${{ steps.smoke_tests.outcome }}
          # A link to this run, so the PagerDuty assignee can quickly get here.
          RUN_LINK: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
        run: |
          # GHA env-vars don't have robust conditional logic, so we'll use this if-else branch to define some bash env-vars.
          ALERT_SEV="info"
          ALERT_SUMMARY="Production heartbeat script failed on ${{ runner.os }}"
          # Define a helper function to create our POST request's data, to sidestep issues with nested quotations.
          generate_post_data() {
          # This is known as a HereDoc, and it lets us declare multi-line input ending when the specified limit string,
          # in this case EOF, is encountered.
          cat <<EOF
          {"payload": {
            "summary": "${ALERT_SUMMARY}",
            "source": "Github Actions",
            "severity": "${ALERT_SEV}",
            "custom_details": "SF install: ${{ env.CLI_INSTALL_STATUS }}. Code Analyzer install: ${{ env.CODE_ANALYZER_INSTALL_STATUS }}. Smoke tests: ${{ env.SMOKE_TESTS_STATUS }}."
          },
          "links": [{
            "href": "${{ env.RUN_LINK }}",
            "text": "Link to action execution"
          }],
          "event_action": "trigger",
          "dedup_key": "GH-HB-${{ matrix.os.vm }}-${{ matrix.node }}",
          "routing_key": "${{ secrets.PAGERDUTY_HEARTBEAT_KEY }}"
          }
          EOF
          }
          # Make our POST request
          curl --request POST --data "$(generate_post_data)" https://events.pagerduty.com/v2/enqueue