run_notify_load.yml

name: Run psu notify load test

on:
  workflow_dispatch:
    inputs:
      environment:
        description: 'Environment to run tests against. Allowed values are dev or ref'
        required: true
        default: 'ref'
      arrivalRate:
        description: 'How many requests to send per second during the main test'
        required: true
        default: '100'
      duration:
        description: 'The duration of the main test'
        required: true
        default: '900'
      rampUpDuration:
        description: 'The duration of ramp-up phase of the test'
        required: true
        default: '900'
      maxVusers:
        description: 'Maximum number of virtual users to create'
        required: true
        default: '100'
      artillery_key:
        description: 'Your Artillery cloud API key (optional – omit to run without recording)'
        required: false
        default: ''

jobs:
  run_artillery:
    name: Run Artillery
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: read
    steps:
      - name: Show input params
        shell: bash
        run: |
          echo "## environment : ${{ github.event.inputs.environment }}" >> "$GITHUB_STEP_SUMMARY"
          echo "## arrivalRate : ${{ github.event.inputs.arrivalRate }}" >> "$GITHUB_STEP_SUMMARY"
          echo "## duration : ${{ github.event.inputs.duration }}" >> "$GITHUB_STEP_SUMMARY"
          echo "## rampUpDuration : ${{ github.event.inputs.rampUpDuration }}" >> "$GITHUB_STEP_SUMMARY"
          echo "## maxVusers : ${{ github.event.inputs.maxVusers }}" >> "$GITHUB_STEP_SUMMARY"
          if [ -n "${{ github.event.inputs.artillery_key }}" ]; then
            echo "## artillery_key        : (provided)" >> "$GITHUB_STEP_SUMMARY"
          else
            echo "## artillery_key        : (not provided)" >> "$GITHUB_STEP_SUMMARY"
          fi

      - name: Checkout repo
        uses: actions/checkout@v4
        with:
          ref: ${{ env.BRANCH_NAME }}

      - name: Install asdf
        uses: asdf-vm/actions/setup@05e0d2ed97b598bfce82fd30daf324ae0c4570e6
        with:
          asdf_branch: v0.14.0
      
      - name: Cache asdf
        uses: actions/cache@v4
        with:
          path: |
            ~/.asdf
          key: ${{ runner.os }}-asdf-${{ hashFiles('**/.tool-versions') }}
          restore-keys: |
            ${{ runner.os }}-asdf-
      
      - name: Install asdf dependencies in .tool-versions
        uses: asdf-vm/actions/install@05e0d2ed97b598bfce82fd30daf324ae0c4570e6
        with:
          asdf_branch: v0.14.0
        env:
          PYTHON_CONFIGURE_OPTS: --enable-shared

      - name: Install Dependencies
        run: make install

      - name: Assume dev artillery runner role
        if: github.event.inputs.environment == 'dev'
        uses: aws-actions/configure-aws-credentials@v4
        with:
          aws-region: eu-west-2
          role-to-assume: ${{ secrets.DEV_ARTILLERY_RUNNER_ROLE }}
          role-session-name: github-actions-artillery

      - name: Assume ref artillery runner role
        if: github.event.inputs.environment == 'ref'
        uses: aws-actions/configure-aws-credentials@v4
        with:
          aws-region: eu-west-2
          role-to-assume: ${{ secrets.REF_ARTILLERY_RUNNER_ROLE }}
          role-session-name: github-actions-artillery

      - name: Run load tests
        shell: bash
        env:
          environment: ${{ github.event.inputs.environment }}
          arrivalRate: ${{ github.event.inputs.arrivalRate }}
          duration: ${{ github.event.inputs.duration }}
          rampUpDuration: ${{ github.event.inputs.rampUpDuration }}
          maxVusers: ${{ github.event.inputs.maxVusers }}
          artillery_key: ${{ github.event.inputs.artillery_key }}
        run: |
          ./scripts/run_notify_load_test.sh 

      - uses: actions/upload-artifact@v4
        if: always()
        name: Upload test_report
        with:
          name: test_report
          path: |
            notify_load_test.json
            notify_load_test.json.html

      - name: Upload artifacts to S3, if we are using REF environment
        if: github.event.inputs.environment == 'ref'
        continue-on-error: true
        env:
          AWS_REGION: eu-west-2
          BUCKET_NAME: artilleryio-test-data-${{ secrets.AWS_ACCOUNT_ID }}
          RUN_ID: ${{ github.run_id }}
        run: |
          aws s3 cp notify_load_test.json s3://$BUCKET_NAME/reports/$RUN_ID/notify_load_test.json --acl public-read
          aws s3 cp notify_load_test.json.html s3://$BUCKET_NAME/reports/$RUN_ID/notify_load_test.json.html --acl public-read

      - name: Output link to HTML report
        if: github.event.inputs.environment == 'ref'
        env:
          AWS_REGION: eu-west-2
          BUCKET_NAME: artilleryio-test-data-${{ secrets.AWS_ACCOUNT_ID }}
          RUN_ID: ${{ github.run_id }}
        run: |
          REPORT_URL="https://$BUCKET_NAME.s3.${AWS_REGION}.amazonaws.com/reports/$RUN_ID/notify_load_test.json.html"
          echo "Test report is hosted at: $REPORT_URL" >> "$GITHUB_STEP_SUMMARY"
          echo "::set-output name=report_url::$REPORT_URL"