[ { "path": ".artilleryrc", "content": "{\n \"logFilenameFormat\": \"[artillery_report_]YMMDD_HHmmSS[.json]\"\n}\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.md", "content": "---\nname: Bug report\nabout: Create a report to help us improve\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n\n\n\nVersion info: \n```\n\n```\n\nRunning this command: \n```\n\n```\n\nI expected to see this happen:\n\n*explanation*\n\nInstead, this happened:\n\n*explanation*\n\nFiles being used:\n```\n\n```\n" }, { "path": ".github/dependabot.yml", "content": "version: 2\nupdates:\n - package-ecosystem: \"npm\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n exclude-paths:\n - \"examples/**\"\n" }, { "path": ".github/pull_request_template.md", "content": "## Description\n\n\n\n## Pre-merge checklist\n\n**This is for use by the Artillery team. Please leave this in if you're contributing to Artillery.**\n\n- [ ] Does this require an update to the docs?\n- [ ] Does this require a changelog entry?\n" }, { "path": ".github/workflows/codeql-analysis.yml", "content": "# For most projects, this workflow file will not need changing; you simply need\n# to commit it to your repository.\n#\n# You may wish to alter this file to override the set of languages analyzed,\n# or to provide custom queries or build logic.\n#\n# ******** NOTE ********\n# We have attempted to detect the languages in your repository. Please check\n# the `language` matrix defined below to confirm you have the correct set of\n# supported CodeQL languages.\n#\nname: \"CodeQL\"\n\non:\n push:\n branches: [ master ]\n pull_request:\n # The branches below must be a subset of the branches above\n branches: [ master ]\n schedule:\n - cron: '18 19 * * 3'\n\njobs:\n analyze:\n name: Analyze\n runs-on: blacksmith-4vcpu-ubuntu-2404\n permissions:\n actions: read\n contents: read\n security-events: write\n\n strategy:\n fail-fast: false\n matrix:\n language: [ 'javascript' ]\n # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]\n # Learn more about CodeQL language support at https://git.io/codeql-language-support\n\n steps:\n - name: Checkout repository\n uses: actions/checkout@v2\n\n # Initializes the CodeQL tools for scanning.\n - name: Initialize CodeQL\n uses: github/codeql-action/init@v1\n with:\n languages: ${{ matrix.language }}\n # If you wish to specify custom queries, you can do so here or in a config file.\n # By default, queries listed here will override any specified in a config file.\n # Prefix the list here with \"+\" to use these queries and those in the config file.\n # queries: ./path/to/local/query, your-org/your-repo/queries@main\n\n # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).\n # If this step fails, then you should remove it and run the build manually (see below)\n - name: Autobuild\n uses: github/codeql-action/autobuild@v1\n\n # ℹī¸ Command-line programs to run using the OS shell.\n # 📚 https://git.io/JvXDl\n\n # ✏ī¸ If the Autobuild fails above, remove it and uncomment the following three lines\n # and modify them (or add more) to build your code if your project\n # uses a compiled language\n\n #- run: |\n # make bootstrap\n # make release\n\n - name: Perform CodeQL Analysis\n uses: github/codeql-action/analyze@v1\n" }, { "path": ".github/workflows/create-release-pr.yml", "content": "name: Create Release PR\n\non:\n workflow_dispatch:\n\npermissions:\n contents: write\n pull-requests: write\n\njobs:\n create_release_pr:\n runs-on: blacksmith-4vcpu-ubuntu-2404\n env:\n # these are the packages we auto release (e.g. standalone pkgs like artillery/skytrace/types, and included dependencies like plugins)\n # some non-included dependencies are not released automatically (e.g. posthog, memory-inspector)\n # this list should be kept in sync with npm-publish-all-packages.yml\n PACKAGES_TO_RELEASE: \"\\\n artillery-engine-playwright,\\\n artillery-plugin-apdex,\\\n artillery-plugin-ensure,\\\n artillery-plugin-expect,\\\n artillery-plugin-fake-data,\\\n artillery-plugin-metrics-by-endpoint,\\\n artillery-plugin-publish-metrics,\\\n artillery-plugin-slack,\\\n commons,\\\n core,\\\n artillery\"\n steps:\n - name: Checkout code\n uses: actions/checkout@v3\n\n - name: Replace package folder name with actual name from package.json\n run: |\n for package in $(echo $PACKAGES_TO_RELEASE | tr \",\" \"\\n\"); do\n PACKAGE_NAME=$(node -e \"console.log(require('./packages/$package/package.json').name)\")\n PACKAGES_TO_RELEASE=${PACKAGES_TO_RELEASE/$package/$PACKAGE_NAME}\n echo \"PACKAGES_TO_RELEASE=$PACKAGES_TO_RELEASE\" >> \"$GITHUB_ENV\"\n done\n\n # all packages receive minor version bump, except for artillery which receives a patch version bump as convention\n - name: Update package versions\n run: |\n for package in $(echo ${{ env.PACKAGES_TO_RELEASE }} | tr \",\" \"\\n\"); do\n if [ \"$package\" = \"artillery\" ]; then\n npm version patch --workspace $package\n else\n npm version minor --workspace $package\n fi\n done\n\n - name: Get new Artillery version\n run: |\n ARTILLERY_VERSION=$(node -e \"console.log(require('./packages/artillery/package.json').version)\")\n echo \"ARTILLERY_VERSION=$ARTILLERY_VERSION\" >> \"$GITHUB_ENV\"\n\n - name: Create branch\n run: |\n export BRANCH_NAME=release/artillery-v${{ env.ARTILLERY_VERSION }}-$(date '+%Y-%m-%d-%H-%M-%S')\n echo \"BRANCH_NAME=$BRANCH_NAME\" >> \"$GITHUB_ENV\"\n git checkout -b $BRANCH_NAME\n git push --set-upstream origin $BRANCH_NAME\n\n - name: Install dependencies\n run: npm ci\n\n - name: Add changes to commit\n run: git add .\n\n - name: Commit changes\n run: |\n git config --global user.name \"${{ github.actor }}\"\n git config --global user.email \"${{ github.actor }}@users.noreply.github.com\"\n RELEASE_COMMIT_MSG=\"ci: release v${{ env.ARTILLERY_VERSION }} artillery\" >> \"$GITHUB_ENV\"\n git commit -m \"ci: release v${{ env.ARTILLERY_VERSION }} artillery\"\n git push\n\n - name: create pull request\n run: gh pr create -B main -H ${{ env.BRANCH_NAME }} --body 'Release v${{ env.ARTILLERY_VERSION }}. Created by Github action' --fill\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}" }, { "path": ".github/workflows/docker-ecs-worker-image.yml", "content": "name: Build & publish ECS/Fargate worker image to ECR\n\non:\n workflow_dispatch:\n inputs:\n SHOULD_BUILD_ARM64:\n description: 'Whether to build the ARM64 image.'\n type: boolean\n default: false\n workflow_call:\n inputs:\n COMMIT_SHA:\n description: 'Branch ref to checkout. Needed for pull_request_target to be able to pull correct ref.'\n type: string\n required: true\n USE_COMMIT_SHA_IN_VERSION:\n description: 'Whether to use the commit sha in building the pkg version of the image.'\n type: boolean\n SHOULD_BUILD_ARM64:\n description: 'Whether to build the ARM64 image.'\n type: boolean\n default: false\n secrets:\n ECR_WORKER_IMAGE_PUSH_ROLE_ARN:\n description: 'ARN of the IAM role to assume to push the image to ECR.'\n required: true\n\npermissions:\n id-token: write\n contents: read\n\njobs:\n build_docker_image_amd64:\n runs-on: blacksmith-4vcpu-ubuntu-2404\n env:\n # Set by the caller workflow, defaults to github.sha when not passed (e.g. workflow_dispatch against a branch)\n WORKER_VERSION: ${{ inputs.COMMIT_SHA || github.sha }}\n strategy:\n matrix:\n registry: [ public, private ]\n\n steps:\n - uses: actions/checkout@v3\n with:\n ref: ${{ env.WORKER_VERSION }}\n fetch-depth: 0\n \n - name: Set up QEMU\n uses: docker/setup-qemu-action@v2\n \n - name: Replace package version\n if: ${{ inputs.USE_COMMIT_SHA_IN_VERSION || false }}\n run: node .github/workflows/scripts/replace-package-versions.js\n env:\n COMMIT_SHA: ${{ env.WORKER_VERSION }}\n REPLACE_MAIN_VERSION_ONLY: true # we don't need to replace dependencies, as docker image builds using workspaces\n \n - name: Get Artillery version\n # we only want to tag with an actual version from pkg.json outside of PRs and manual dispatches\n # NOTE: can't check for refs/head/main because of pull_request_target used in some workflows\n if: github.event.pull_request == null && github.event_name != 'workflow_dispatch'\n run: |\n echo \"WORKER_VERSION=$(node -e 'console.log(require(\"./packages/artillery/package.json\").version)')\" >> $GITHUB_ENV\n\n - name: Show git ref\n run: |\n echo GITHUB REF ${{ github.ref }}\n echo GITHUB PR HEAD SHA ${{ github.event.pull_request.head.sha }}\n echo GITHUB SHA ${{ github.sha }}\n echo WORKER_VERSION ENV ${{ env.WORKER_VERSION }}\n \n - name: Configure AWS Credentials (Public ECR)\n if: matrix.registry == 'public'\n uses: aws-actions/configure-aws-credentials@v1\n with:\n aws-region: us-east-1\n audience: sts.amazonaws.com\n role-to-assume: ${{ secrets.ECR_WORKER_IMAGE_PUSH_ROLE_ARN }}\n role-session-name: OIDCSession\n mask-aws-account-id: true\n \n - name: Login to Amazon (Public ECR)\n if: matrix.registry == 'public'\n id: login-ecr-public\n uses: aws-actions/amazon-ecr-login@v1\n with:\n registry-type: public\n \n - name: Build the Docker image (Public ECR)\n if: matrix.registry == 'public'\n env: \n DOCKER_TAG: ${{ env.WORKER_VERSION }}-x86_64\n run: |\n docker build . --platform linux/amd64 --build-arg=\"WORKER_VERSION=${{ env.WORKER_VERSION }}\" --tag public.ecr.aws/d8a4z9o5/artillery-worker:${{ env.DOCKER_TAG }} -f ./packages/artillery/lib/platform/aws-ecs/worker/Dockerfile\n \n - name: Push Docker image (Public ECR)\n if: matrix.registry == 'public'\n env: \n DOCKER_TAG: ${{ env.WORKER_VERSION }}-x86_64\n run: |\n docker push public.ecr.aws/d8a4z9o5/artillery-worker:${{ env.DOCKER_TAG }}\n\n - name: Configure AWS Credentials (Private ECR)\n if: matrix.registry == 'private'\n uses: aws-actions/configure-aws-credentials@v1\n with:\n aws-region: eu-west-1\n audience: sts.amazonaws.com\n role-to-assume: ${{ secrets.ECR_WORKER_IMAGE_PUSH_ROLE_ARN }}\n role-session-name: OIDCSession\n mask-aws-account-id: true\n \n - name: Login to Amazon (Private ECR)\n if: matrix.registry == 'private'\n id: login-ecr-private\n uses: aws-actions/amazon-ecr-login@v1\n \n - name: Build the Docker image (Private ECR)\n if: matrix.registry == 'private'\n env: \n DOCKER_TAG: ${{ env.WORKER_VERSION }}-x86_64\n run: |\n docker build . --platform linux/amd64 --build-arg=\"WORKER_VERSION=${{ env.WORKER_VERSION }}\" --tag 248481025674.dkr.ecr.eu-west-1.amazonaws.com/artillery-worker:${{ env.DOCKER_TAG }} -f ./packages/artillery/lib/platform/aws-ecs/worker/Dockerfile\n\n - name: Push Docker image (Private ECR)\n if: matrix.registry == 'private'\n env: \n DOCKER_TAG: ${{ env.WORKER_VERSION }}-x86_64\n run: |\n docker push 248481025674.dkr.ecr.eu-west-1.amazonaws.com/artillery-worker:${{ env.DOCKER_TAG }}\n \n build_docker_image_arm64:\n runs-on: blacksmith-4vcpu-ubuntu-2404\n if: ${{ inputs.SHOULD_BUILD_ARM64 }}\n env:\n # Set by the caller workflow, defaults to github.sha when not passed (e.g. workflow_dispatch against a branch)\n WORKER_VERSION: ${{ inputs.COMMIT_SHA || github.sha }}\n strategy:\n matrix:\n registry: [ public, private ]\n\n steps:\n - uses: actions/checkout@v3\n with:\n ref: ${{ env.WORKER_VERSION }}\n fetch-depth: 0\n \n - name: Set up QEMU\n uses: docker/setup-qemu-action@v2\n \n - name: Replace package version\n if: ${{ inputs.USE_COMMIT_SHA_IN_VERSION || false }}\n run: node .github/workflows/scripts/replace-package-versions.js\n env:\n COMMIT_SHA: ${{ env.WORKER_VERSION }}\n REPLACE_MAIN_VERSION_ONLY: true # we don't need to replace dependencies, as docker image builds using workspaces\n\n - name: Get Artillery version\n # we only want to tag with an actual version from pkg.json outside of PRs and manual dispatches\n # NOTE: can't check for refs/head/main because of pull_request_target used in some workflows\n if: github.event.pull_request == null && github.event_name != 'workflow_dispatch'\n run: |\n echo \"WORKER_VERSION=$(node -e 'console.log(require(\"./packages/artillery/package.json\").version)')\" >> $GITHUB_ENV\n\n - name: Show git ref\n run: |\n echo GITHUB REF ${{ github.ref }}\n echo GITHUB PR HEAD SHA ${{ github.event.pull_request.head.sha }}\n echo GITHUB SHA ${{ github.sha }}\n echo WORKER_VERSION ENV ${{ env.WORKER_VERSION }}\n \n - name: Configure AWS Credentials (Public ECR)\n if: matrix.registry == 'public'\n uses: aws-actions/configure-aws-credentials@v1\n with:\n aws-region: us-east-1\n audience: sts.amazonaws.com\n role-to-assume: ${{ secrets.ECR_WORKER_IMAGE_PUSH_ROLE_ARN }}\n role-session-name: OIDCSession\n mask-aws-account-id: true\n\n - name: Login to Amazon (Public ECR)\n if: matrix.registry == 'public'\n id: login-ecr-public\n uses: aws-actions/amazon-ecr-login@v1\n with:\n registry-type: public\n \n - name: Build the Docker image (Public ECR)\n if: matrix.registry == 'public'\n env: \n DOCKER_TAG: ${{ env.WORKER_VERSION }}-arm64\n run: |\n docker build . --platform linux/arm64 --build-arg=\"WORKER_VERSION=${{ env.WORKER_VERSION }}\" --tag public.ecr.aws/d8a4z9o5/artillery-worker:${{ env.DOCKER_TAG }} -f ./packages/artillery/lib/platform/aws-ecs/worker/Dockerfile\n \n - name: Push Docker image (Public ECR)\n if: matrix.registry == 'public'\n env: \n DOCKER_TAG: ${{ env.WORKER_VERSION }}-arm64\n run: |\n docker push public.ecr.aws/d8a4z9o5/artillery-worker:${{ env.DOCKER_TAG }}\n\n - name: Configure AWS Credentials (Private ECR)\n if: matrix.registry == 'private'\n uses: aws-actions/configure-aws-credentials@v1\n with:\n aws-region: eu-west-1\n audience: sts.amazonaws.com\n role-to-assume: ${{ secrets.ECR_WORKER_IMAGE_PUSH_ROLE_ARN }}\n role-session-name: OIDCSession\n mask-aws-account-id: true\n\n - name: Login to Amazon (Private ECR)\n if: matrix.registry == 'private'\n id: login-ecr-private\n uses: aws-actions/amazon-ecr-login@v1\n\n - name: Build the Docker image (Private ECR)\n if: matrix.registry == 'private'\n env: \n DOCKER_TAG: ${{ env.WORKER_VERSION }}-arm64\n run: |\n docker build . --platform linux/arm64 --build-arg=\"WORKER_VERSION=${{ env.WORKER_VERSION }}\" --tag 248481025674.dkr.ecr.eu-west-1.amazonaws.com/artillery-worker:${{ env.DOCKER_TAG }} -f ./packages/artillery/lib/platform/aws-ecs/worker/Dockerfile\n\n - name: Push Docker image (Private ECR)\n if: matrix.registry == 'private'\n env: \n DOCKER_TAG: ${{ env.WORKER_VERSION }}-arm64\n run: |\n docker push 248481025674.dkr.ecr.eu-west-1.amazonaws.com/artillery-worker:${{ env.DOCKER_TAG }}\n \n " }, { "path": ".github/workflows/docker-publish-artillery.yml", "content": "name: Publish Docker image for Artillery\n\non:\n workflow_dispatch:\n # this will override the latest image, so only trigger when you want to publish a new version\n inputs:\n COMMIT_SHA:\n description: 'Commit SHA'\n required: true\n type: string\n workflow_call:\n inputs:\n COMMIT_SHA:\n description: 'Commit SHA'\n required: true\n type: string\n secrets:\n DOCKER_USERNAME:\n description: 'Docker Hub username'\n required: true\n DOCKER_PASSWORD:\n description: 'Docker Hub password'\n required: true\n\njobs:\n push_to_registry:\n name: Push Docker image to Docker Hub\n runs-on: blacksmith-4vcpu-ubuntu-2404\n steps:\n - name: Check out the repo\n uses: actions/checkout@v3\n with:\n ref: ${{ inputs.COMMIT_SHA || null }}\n fetch-depth: 0\n\n - name: Get Artillery version\n run: |\n echo \"ARTILLERY_VERSION=$(node -e 'console.log(require(\"./packages/artillery/package.json\").version)')\" >> $GITHUB_ENV\n\n - name: Log in to Docker Hub\n uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9\n with:\n username: ${{ secrets.DOCKER_USERNAME }}\n password: ${{ secrets.DOCKER_PASSWORD }}\n\n - name: Extract metadata (tags, labels) for Docker\n id: meta\n uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38\n with:\n images: artilleryio/artillery\n tags: |\n type=semver,pattern={{version}},value=${{env.ARTILLERY_VERSION}}\n type=raw,value=latest\n\n - name: Build and push Docker image\n uses: useblacksmith/build-push-action@v2\n with:\n context: ./packages/artillery\n push: true\n tags: ${{ steps.meta.outputs.tags }}\n labels: ${{ steps.meta.outputs.labels }}\n" }, { "path": ".github/workflows/examples.yml", "content": "name: Examples\n\non:\n push:\n branches: [main]\n pull_request:\n workflow_dispatch:\n\nenv:\n ARTILLERY_BINARY_PATH: ${{ github.workspace }}/packages/artillery/bin/run\n CLI_TAGS: repo:${{ github.repository }},actor:${{ github.actor }},type:smoke,ci:true\n CLI_NOTE: Running from the Official Artillery Github Action! đŸ˜€\n\njobs:\n browser-load-test:\n runs-on: blacksmith-4vcpu-ubuntu-2404\n timeout-minutes: 10\n env:\n CWD: ./examples/browser-load-testing-playwright\n steps:\n - name: Checkout\n uses: actions/checkout@v3\n\n - name: Setup Node\n uses: actions/setup-node@v3\n with:\n node-version: \"22.x\"\n\n - name: Install dependencies\n run: npm install\n\n # Uses the version from packages/artillery-engine-playwright\n - name: Install Playwright Browsers\n run: npm exec --workspace artillery-engine-playwright -- playwright install chromium --with-deps\n\n - name: Run test\n run: |\n $ARTILLERY_BINARY_PATH run browser-load-test.ts --record --tags ${{ env.CLI_TAGS }},group:browser-load-test --note \"${{ env.CLI_NOTE }}\"\n working-directory: ${{ env.CWD }}\n env:\n ARTILLERY_BINARY_PATH: ${{ env.ARTILLERY_BINARY_PATH }}\n ARTILLERY_CLOUD_ENDPOINT: ${{ secrets.ARTILLERY_CLOUD_ENDPOINT_TEST }}\n ARTILLERY_CLOUD_API_KEY: ${{ secrets.ARTILLERY_CLOUD_API_KEY_TEST }}\n\n http-metrics-by-endpoint:\n runs-on: blacksmith-4vcpu-ubuntu-2404\n timeout-minutes: 10\n env:\n CWD: ./examples/http-metrics-by-endpoint\n defaults:\n run:\n working-directory: ${{ env.CWD }}\n steps:\n - name: Checkout\n uses: actions/checkout@v3\n\n - name: Install\n run: npm ci\n\n - name: Test\n uses: artilleryio/action-cli@v1\n with:\n command: run ./endpoint-metrics.yml --record --tags ${{ env.CLI_TAGS }},group:http-metrics-by-endpoint --note ${{ env.CLI_NOTE }}\n working-directory: ${{ env.CWD }}\n env:\n ARTILLERY_BINARY_PATH: ${{ env.ARTILLERY_BINARY_PATH }}\n ARTILLERY_CLOUD_ENDPOINT: ${{ secrets.ARTILLERY_CLOUD_ENDPOINT_TEST }}\n ARTILLERY_CLOUD_API_KEY: ${{ secrets.ARTILLERY_CLOUD_API_KEY_TEST }}\n\n multiple-scenarios-spec:\n runs-on: blacksmith-4vcpu-ubuntu-2404\n timeout-minutes: 10\n env:\n CWD: ./examples/multiple-scenario-specs\n defaults:\n run:\n working-directory: ${{ env.CWD }}\n steps:\n - name: Checkout\n uses: actions/checkout@v3\n\n - name: Install\n run: npm ci\n\n - name: Run armadillo scenario\n uses: artilleryio/action-cli@v1\n with:\n command: run --config ./common-config.yml ./scenarios/armadillo.yml --record --tags ${{ env.CLI_TAGS }},group:multiple-scenario-specs --note ${{ env.CLI_NOTE }}\n working-directory: ${{ env.CWD }}\n env:\n ARTILLERY_BINARY_PATH: ${{ env.ARTILLERY_BINARY_PATH }}\n ARTILLERY_CLOUD_ENDPOINT: ${{ secrets.ARTILLERY_CLOUD_ENDPOINT_TEST }}\n ARTILLERY_CLOUD_API_KEY: ${{ secrets.ARTILLERY_CLOUD_API_KEY_TEST }}\n\n - name: Run dino scenario\n uses: artilleryio/action-cli@v1\n with:\n command: run --config ./common-config.yml ./scenarios/dino.yml --record --tags ${{ env.CLI_TAGS }},group:multiple-scenario-specs --note ${{ env.CLI_NOTE }}\n working-directory: ${{ env.CWD }}\n env:\n ARTILLERY_BINARY_PATH: ${{ env.ARTILLERY_BINARY_PATH }}\n ARTILLERY_CLOUD_ENDPOINT: ${{ secrets.ARTILLERY_CLOUD_ENDPOINT_TEST }}\n ARTILLERY_CLOUD_API_KEY: ${{ secrets.ARTILLERY_CLOUD_API_KEY_TEST }}\n\n using-data-from-csv:\n runs-on: blacksmith-4vcpu-ubuntu-2404\n timeout-minutes: 15\n env:\n CWD: ./examples/using-data-from-csv\n defaults:\n run:\n working-directory: ${{ env.CWD }}\n steps:\n - name: Checkout\n uses: actions/checkout@v3\n\n - name: Install\n run: npm ci\n\n - name: Test\n uses: artilleryio/action-cli@v1\n with:\n command: run ./website-test.yml --record --tags ${{ env.CLI_TAGS }},group:using-data-from-csv --note ${{ env.CLI_NOTE }}\n working-directory: ${{ env.CWD }}\n env:\n ARTILLERY_BINARY_PATH: ${{ env.ARTILLERY_BINARY_PATH }}\n ARTILLERY_CLOUD_ENDPOINT: ${{ secrets.ARTILLERY_CLOUD_ENDPOINT_TEST }}\n ARTILLERY_CLOUD_API_KEY: ${{ secrets.ARTILLERY_CLOUD_API_KEY_TEST }}\n" }, { "path": ".github/workflows/npm-publish-all-packages-canary.yml", "content": "name: Publish packages to NPM (canary)\non:\n push:\n branches:\n - main\n paths:\n - 'packages/artillery/**'\n - 'packages/artillery-engine-playwright/**'\n - 'packages/artillery-engine-posthog/**'\n - 'packages/artillery-plugin-apdex/**'\n - 'packages/artillery-plugin-ensure/**'\n - 'packages/artillery-plugin-expect/**'\n - 'packages/artillery-plugin-metrics-by-endpoint/**'\n - 'packages/artillery-plugin-publish-metrics/**'\n - 'packages/artillery-plugin-fake-data/**'\n - 'packages/artillery-plugin-slack/**'\n - 'packages/commons/**'\n - 'packages/core/**'\n - 'packages/skytrace/**'\n - 'packages/artillery-plugin-memory-inspector/**'\n \njobs:\n publish-fargate-worker-image:\n if: \"!contains( github.event.head_commit.message, 'ci: release v')\"\n uses: ./.github/workflows/docker-ecs-worker-image.yml\n permissions:\n contents: read\n id-token: write\n with:\n COMMIT_SHA: ${{ github.sha }}\n USE_COMMIT_SHA_IN_VERSION: true\n SHOULD_BUILD_ARM64: false\n secrets:\n ECR_WORKER_IMAGE_PUSH_ROLE_ARN: ${{ secrets.ECR_WORKER_IMAGE_PUSH_ROLE_ARN }}\n\n build:\n runs-on: blacksmith-4vcpu-ubuntu-2404\n if: \"!contains( github.event.head_commit.message, 'ci: release v')\"\n needs: publish-fargate-worker-image\n permissions:\n contents: read\n packages: write\n env:\n NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}\n outputs:\n ARTILLERY_VERSION: ${{ steps.get-artillery-version.outputs.ARTILLERY_VERSION }}\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-node@v3\n with:\n node-version: '22.x'\n registry-url: 'https://registry.npmjs.org'\n scope: '@artilleryio'\n - run: node .github/workflows/scripts/replace-package-versions.js\n env:\n COMMIT_SHA: ${{ github.sha }}\n # It must be published in this specific order to account for order of dependencies (e.g. artillery depends on commons, core, etc), in case failures happen in publishing.\n - run: npm -w @artilleryio/int-commons publish --tag canary\n - run: npm -w @artilleryio/int-core publish --tag canary\n - run: npm -w artillery-plugin-expect publish --tag canary\n - run: npm -w artillery-plugin-publish-metrics publish --tag canary\n - run: npm -w artillery-plugin-metrics-by-endpoint publish --tag canary\n - run: npm -w artillery-plugin-ensure publish --tag canary\n - run: npm -w artillery-plugin-apdex publish --tag canary\n - run: npm -w artillery-engine-posthog publish --tag canary\n - run: npm -w artillery-engine-playwright publish --tag canary\n - run: npm -w artillery-plugin-fake-data publish --tag canary\n - run: npm -w artillery-plugin-slack publish --tag canary\n - run: npm -w artillery publish --tag canary\n - id: get-artillery-version\n run: |\n ARTILLERY_VERSION=$(node -e \"console.log(require('./packages/artillery/package.json').version)\")\n echo \"ARTILLERY_VERSION=$ARTILLERY_VERSION\" >> $GITHUB_OUTPUT\n # Skytrace is a Typescript Package and needs to install -> build -> publish\n - run: npm install -w skytrace --ignore-scripts\n - run: npm run build -w skytrace\n - run: npm -w skytrace publish --tag canary\n - run: npm -w artillery-plugin-memory-inspector publish --tag canary\n\n run-distributed-tests:\n uses: ./.github/workflows/run-distributed-tests.yml\n needs: build\n with:\n ARTILLERY_VERSION_OVERRIDE: ${{ needs.build.outputs.ARTILLERY_VERSION }}\n HAS_ARM64_BUILD: false\n permissions:\n contents: read\n id-token: write\n secrets:\n ARTILLERY_CLOUD_ENDPOINT_TEST: ${{ secrets.ARTILLERY_CLOUD_ENDPOINT_TEST }}\n ARTILLERY_CLOUD_API_KEY_TEST: ${{ secrets.ARTILLERY_CLOUD_API_KEY_TEST }}\n DD_TESTS_API_KEY: ${{ secrets.DD_TESTS_API_KEY }}\n DD_TESTS_APP_KEY: ${{ secrets.DD_TESTS_APP_KEY }}\n AWS_TEST_EXECUTION_ROLE_ARN_TEST5: ${{ secrets.AWS_TEST_EXECUTION_ROLE_ARN_TEST5 }}\n\n publish-cloudformation-templates-canary-to-s3:\n uses: ./.github/workflows/s3-publish-cf-templates.yml\n needs: run-distributed-tests\n with:\n canary: true\n permissions:\n contents: read\n id-token: write\n secrets:\n AWS_ASSET_UPLOAD_ROLE_ARN: ${{ secrets.AWS_ASSET_UPLOAD_ROLE_ARN }}\n" }, { "path": ".github/workflows/npm-publish-all-packages.yml", "content": "name: Publish packages to NPM\non:\n workflow_dispatch:\n push:\n branches:\n - main\n paths:\n #If there are changes to package.json and ci:release v is in commit msg, it's a release\n - 'packages/artillery/package.json'\n \njobs:\n publish-fargate-worker-image:\n if: >\n github.event_name == 'workflow_dispatch' ||\n contains(github.event.head_commit.message, 'ci: release v')\n uses: ./.github/workflows/docker-ecs-worker-image.yml\n permissions:\n contents: read\n id-token: write\n with:\n COMMIT_SHA: ${{ github.sha }}\n SHOULD_BUILD_ARM64: true\n secrets:\n ECR_WORKER_IMAGE_PUSH_ROLE_ARN: ${{ secrets.ECR_WORKER_IMAGE_PUSH_ROLE_ARN }}\n\n publish-packages-to-npm:\n runs-on: blacksmith-4vcpu-ubuntu-2404\n if: >\n github.event_name == 'workflow_dispatch' ||\n contains(github.event.head_commit.message, 'ci: release v')\n needs: publish-fargate-worker-image\n permissions:\n contents: read\n packages: write\n outputs:\n ARTILLERY_VERSION: ${{ steps.get-artillery-version.outputs.ARTILLERY_VERSION }}\n env:\n NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}\n # this list should be kept in sync with create-release-pr.yml\n PACKAGES_TO_RELEASE: \"\\\n artillery-engine-playwright,\\\n artillery-plugin-apdex,\\\n artillery-plugin-ensure,\\\n artillery-plugin-expect,\\\n artillery-plugin-fake-data,\\\n artillery-plugin-slack,\\\n artillery-plugin-metrics-by-endpoint,\\\n artillery-plugin-publish-metrics,\\\n commons,\\\n core,\\\n artillery\"\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-node@v3\n with:\n node-version: '22.x'\n registry-url: 'https://registry.npmjs.org'\n scope: '@artilleryio'\n - run: node .github/workflows/scripts/replace-package-versions.js\n # It must be published in this specific order to account for order of dependencies (e.g. artillery depends on commons, core, etc), in case failures happen in publishing.\n - run: npm -w @artilleryio/int-commons publish\n - run: npm -w @artilleryio/int-core publish\n - run: npm -w artillery-plugin-expect publish\n - run: npm -w artillery-plugin-publish-metrics publish\n - run: npm -w artillery-plugin-metrics-by-endpoint publish\n - run: npm -w artillery-plugin-ensure publish\n - run: npm -w artillery-plugin-apdex publish\n - run: npm -w artillery-engine-playwright publish\n - run: npm -w artillery-plugin-fake-data publish\n - run: npm -w artillery-plugin-slack publish\n - run: npm -w artillery publish\n - id: get-artillery-version\n run: |\n ARTILLERY_VERSION=$(node -e \"console.log(require('./packages/artillery/package.json').version)\")\n echo \"ARTILLERY_VERSION=$ARTILLERY_VERSION\" >> $GITHUB_OUTPUT\n # # Skytrace is a Typescript Package and needs to install -> build -> publish\n # - run: npm install -w skytrace --ignore-scripts\n # - run: npm run build -w skytrace\n # - run: npm -w skytrace publish\n\n publish-official-docker-image:\n uses: ./.github/workflows/docker-publish-artillery.yml\n if: >\n github.event_name == 'workflow_dispatch' ||\n contains(github.event.head_commit.message, 'ci: release v')\n needs: publish-packages-to-npm\n with:\n COMMIT_SHA: ${{ github.sha }}\n secrets:\n DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}\n DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}\n\n run-distributed-tests:\n uses: ./.github/workflows/run-distributed-tests.yml\n needs: publish-packages-to-npm\n with:\n ARTILLERY_VERSION_OVERRIDE: ${{ needs.publish-packages-to-npm.outputs.ARTILLERY_VERSION }}\n HAS_ARM64_BUILD: true\n permissions:\n contents: read\n id-token: write\n secrets:\n ARTILLERY_CLOUD_ENDPOINT_TEST: ${{ secrets.ARTILLERY_CLOUD_ENDPOINT_TEST }}\n ARTILLERY_CLOUD_API_KEY_TEST: ${{ secrets.ARTILLERY_CLOUD_API_KEY_TEST }}\n DD_TESTS_API_KEY: ${{ secrets.DD_TESTS_API_KEY }}\n DD_TESTS_APP_KEY: ${{ secrets.DD_TESTS_APP_KEY }}\n AWS_TEST_EXECUTION_ROLE_ARN_TEST5: ${{ secrets.AWS_TEST_EXECUTION_ROLE_ARN_TEST5 }}\n \n publish-cloudformation-templates-to-s3:\n uses: ./.github/workflows/s3-publish-cf-templates.yml\n needs: run-distributed-tests\n with:\n canary: true\n permissions:\n contents: read\n id-token: write\n secrets:\n AWS_ASSET_UPLOAD_ROLE_ARN: ${{ secrets.AWS_ASSET_UPLOAD_ROLE_ARN }}\n" }, { "path": ".github/workflows/npm-publish-artillery-engine-posthog.yml", "content": "name: Publish artillery-engine-posthog to npm\non:\n push:\n branches:\n - main\n paths:\n - packages/artillery-engine-posthog/package.json\njobs:\n build:\n if: \"contains(github.event.head_commit.message, 'ci: release v')\"\n runs-on: blacksmith-4vcpu-ubuntu-2404\n permissions:\n contents: read\n packages: write\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-node@v3\n with:\n node-version: '22.x'\n registry-url: 'https://registry.npmjs.org'\n scope: '@artilleryio'\n - run: npm -w artillery-engine-posthog publish --tag latest\n env:\n NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}\n" }, { "path": ".github/workflows/npm-publish-artillery-plugin-memory-inspector.yml", "content": "name: Publish artillery-plugin-memory-inspector to npm\non:\n push:\n branches:\n - main\n paths:\n - packages/artillery-plugin-memory-inspector/package.json\njobs:\n build:\n if: \"contains(github.event.head_commit.message, 'ci: release v')\"\n runs-on: blacksmith-4vcpu-ubuntu-2404\n permissions:\n contents: read\n packages: write\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-node@v3\n with:\n node-version: '22.x'\n registry-url: 'https://registry.npmjs.org'\n scope: '@artilleryio'\n - run: npm -w artillery-plugin-memory-inspector publish\n env:\n NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}\n" }, { "path": ".github/workflows/npm-publish-artillery-types.yml", "content": "name: Publish @artilleryio/types to npm\non:\n push:\n branches:\n - main\n paths:\n - packages/types/package.json\njobs:\n build:\n if: \"contains(github.event.head_commit.message, 'ci: release v')\"\n runs-on: blacksmith-4vcpu-ubuntu-2404\n permissions:\n contents: read\n packages: write\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-node@v3\n with:\n node-version: '22.x'\n registry-url: 'https://registry.npmjs.org'\n scope: '@artilleryio'\n - run: node .github/workflows/scripts/replace-package-versions.js\n - run: npm ci\n - run: npm -w '@artilleryio/types' publish --access public\n env:\n NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}\n" }, { "path": ".github/workflows/npm-publish-specific-package.yml", "content": "name: Publish specific package to NPM\non:\n workflow_dispatch:\n inputs:\n CHANNEL:\n description: 'Channel to publish to. Can be \"latest\" or \"canary\".'\n type: choice\n options:\n - 'latest'\n - 'canary'\n default: 'canary'\n PACKAGE_FOLDER_NAME:\n description: 'Name of the package to publish (folder package).'\n required: true\n \njobs:\n publish-fargate-worker-image:\n uses: ./.github/workflows/docker-ecs-worker-image.yml\n if: ${{ inputs.PACKAGE_FOLDER_NAME == 'artillery' }}\n permissions:\n contents: read\n id-token: write\n with:\n COMMIT_SHA: ${{ github.sha }}\n SHOULD_BUILD_ARM64: true\n secrets:\n ECR_WORKER_IMAGE_PUSH_ROLE_ARN: ${{ secrets.ECR_WORKER_IMAGE_PUSH_ROLE_ARN }}\n\n publish-packages-to-npm:\n runs-on: blacksmith-4vcpu-ubuntu-2404\n needs: publish-fargate-worker-image\n permissions:\n contents: read\n packages: write\n env:\n NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-node@v3\n with:\n node-version: '22.x'\n registry-url: 'https://registry.npmjs.org'\n scope: '@artilleryio'\n - run: node .github/workflows/scripts/replace-package-versions.js\n if: ${{ inputs.CHANNEL == 'latest'}}\n - run: node .github/workflows/scripts/replace-package-versions.js\n env:\n COMMIT_SHA: ${{ github.sha }}\n if: ${{ inputs.CHANNEL == 'canary'}}\n\n - name: Get corresponding package name from package.json\n run: |\n PACKAGE_NAME=$(node -e \"console.log(require('./packages/${{ inputs.PACKAGE_FOLDER_NAME }}/package.json').name)\")\n echo \"PACKAGE_NAME=$PACKAGE_NAME\" >> \"$GITHUB_ENV\"\n \n - run: npm install -w skytrace --ignore-scripts && npm run build -w skytrace\n if: ${{ inputs.PACKAGE_FOLDER_NAME == 'skytrace'}}\n \n - run: npm -w ${{ env.PACKAGE_NAME }} publish --tag ${{ inputs.CHANNEL }}\n\n publish-official-docker-image:\n uses: ./.github/workflows/docker-publish-artillery.yml\n if: ${{ inputs.PACKAGE_FOLDER_NAME == 'artillery'}}\n needs: publish-packages-to-npm\n with:\n COMMIT_SHA: ${{ github.sha }}\n secrets:\n DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}\n DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}" }, { "path": ".github/workflows/run-aws-tests-on-pr.yml", "content": "name: Run AWS tests (on PR)\n\non:\n pull_request_target:\n branches: [main]\n #opened, reopened and synchronize will cause the workflow to fail on forks due to permissions\n #once labeled, that will then be overridden by the is-collaborator job\n types: [opened, labeled, synchronize, reopened]\n\njobs:\n is-collaborator:\n runs-on: blacksmith-4vcpu-ubuntu-2404\n steps:\n - name: Get User Permission\n id: checkAccess\n uses: actions-cool/check-user-permission@cd622002ff25c2311d2e7fb82107c0d24be83f9b\n with:\n require: write\n username: ${{ github.actor }}\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n - name: Check User Permission\n if: steps.checkAccess.outputs.require-result == 'false'\n run: |\n echo \"${{ github.actor }} does not have permissions on this repo.\"\n echo \"Current permission level is ${{ steps.checkAccess.outputs.user-permission }}\"\n exit 1\n\n publish-branch-image:\n if: contains( github.event.pull_request.labels.*.name, 'run-aws-tests' )\n needs: is-collaborator\n uses: ./.github/workflows/docker-ecs-worker-image.yml\n permissions:\n contents: read\n id-token: write\n secrets:\n ECR_WORKER_IMAGE_PUSH_ROLE_ARN: ${{ secrets.ECR_WORKER_IMAGE_PUSH_ROLE_ARN }}\n with:\n COMMIT_SHA: ${{ github.event.pull_request.head.sha || null }} # this should only be run with this ref if is-collaborator has been run and passed\n\n run-distributed-tests:\n needs: publish-branch-image\n uses: ./.github/workflows/run-distributed-tests.yml\n with:\n COMMIT_SHA: ${{ github.event.pull_request.head.sha || null }}\n permissions:\n contents: read\n id-token: write\n secrets:\n ARTILLERY_CLOUD_ENDPOINT_TEST: ${{ secrets.ARTILLERY_CLOUD_ENDPOINT_TEST }}\n ARTILLERY_CLOUD_API_KEY_TEST: ${{ secrets.ARTILLERY_CLOUD_API_KEY_TEST }}\n DD_TESTS_API_KEY: ${{ secrets.DD_TESTS_API_KEY }}\n DD_TESTS_APP_KEY: ${{ secrets.DD_TESTS_APP_KEY }}\n AWS_TEST_EXECUTION_ROLE_ARN_TEST5: ${{ secrets.AWS_TEST_EXECUTION_ROLE_ARN_TEST5 }}" }, { "path": ".github/workflows/run-distributed-tests.yml", "content": "name: Run distributed tests\n\non:\n workflow_call:\n inputs:\n COMMIT_SHA:\n type: string\n ARTILLERY_VERSION_OVERRIDE:\n type: string\n HAS_ARM64_BUILD:\n type: boolean\n default: false\n secrets:\n ARTILLERY_CLOUD_ENDPOINT_TEST: \n required: true\n description: 'The endpoint for the Artillery Cloud API'\n ARTILLERY_CLOUD_API_KEY_TEST:\n required: true\n description: 'The api key for the Artillery Cloud API'\n DD_TESTS_API_KEY:\n required: true\n description: 'The api key for the Datadog API'\n DD_TESTS_APP_KEY:\n required: true\n description: 'The app key for the Datadog API'\n AWS_TEST_EXECUTION_ROLE_ARN_TEST5:\n required: true\n description: 'The role to assume for the AWS tests'\n\npermissions:\n contents: read\n id-token: write\n\njobs:\n generate-test-matrix:\n runs-on: blacksmith-4vcpu-ubuntu-2404\n outputs:\n matrix: ${{ steps.generate-matrix.outputs.matrix }}\n steps:\n - uses: actions/checkout@v3\n with:\n ref: ${{ inputs.COMMIT_SHA || null }}\n - name: Use Node.js\n uses: actions/setup-node@v3\n with:\n node-version: 22.x\n - id: generate-matrix\n run: |\n RESULT=$(node .github/workflows/scripts/get-tests-in-package-location.js)\n echo $RESULT\n echo \"matrix=$RESULT\" >> $GITHUB_OUTPUT\n\n run-tests:\n needs: generate-test-matrix\n timeout-minutes: 20\n runs-on: blacksmith-4vcpu-ubuntu-2404\n strategy:\n fail-fast: false\n matrix:\n testName: ${{fromJson(needs.generate-test-matrix.outputs.matrix).names}}\n permissions:\n contents: read\n id-token: write\n env:\n ARTILLERY_CLOUD_ENDPOINT: ${{ secrets.ARTILLERY_CLOUD_ENDPOINT_TEST }}\n ARTILLERY_CLOUD_API_KEY: ${{ secrets.ARTILLERY_CLOUD_API_KEY_TEST }}\n DD_TESTS_API_KEY: ${{ secrets.DD_TESTS_API_KEY }}\n DD_TESTS_APP_KEY: ${{ secrets.DD_TESTS_APP_KEY }}\n GITHUB_REPO: ${{ github.repository }}\n GITHUB_ACTOR: ${{ github.actor }}\n HAS_ARM64_BUILD: ${{ inputs.HAS_ARM64_BUILD }}\n steps:\n - uses: actions/checkout@v3\n with:\n ref: ${{ inputs.COMMIT_SHA || null }} # in a PR we make a collaborator check, otherwise this would override pull_request_target\n - name: Configure AWS Credentials\n uses: aws-actions/configure-aws-credentials@v2\n env:\n SHOW_STACK_TRACE: true\n with:\n aws-region: eu-west-1\n role-to-assume: ${{ secrets.AWS_TEST_EXECUTION_ROLE_ARN_TEST5 }}\n role-session-name: OIDCSession\n mask-aws-account-id: true\n - name: Use Node.js\n uses: actions/setup-node@v2\n with:\n node-version: 22.x\n - run: .github/workflows/scripts/npm-command-retry.sh install\n - run: npm run build\n - name: Install Specific Artillery Version if needed\n if: ${{ inputs.ARTILLERY_VERSION_OVERRIDE || false }}\n run: mkdir __artillery__ && cd __artillery__ && npm init -y && ../.github/workflows/scripts/npm-command-retry.sh install artillery@${{ inputs.ARTILLERY_VERSION_OVERRIDE }}\n - name: Set A9_PATH\n if: ${{ inputs.ARTILLERY_VERSION_OVERRIDE || false }}\n run: echo \"A9_PATH=${{ github.workspace }}/__artillery__/node_modules/.bin/artillery\" >> $GITHUB_ENV\n - name: Set ECR Image Version if needed\n if: ${{ inputs.COMMIT_SHA }}\n run: |\n echo \"ECR_IMAGE_VERSION=${{ inputs.COMMIT_SHA }}\" >> $GITHUB_ENV\n echo \"LAMBDA_IMAGE_VERSION=${{ inputs.COMMIT_SHA }}\" >> $GITHUB_ENV\n # runs the single test file from `package` workspace in the `file`, as defined in the matrix output\n - run: npm run test:aws:ci --workspace ${{fromJson(needs.generate-test-matrix.outputs.matrix).namesToFiles[matrix.testName].packageName }} -- --files ${{ fromJson(needs.generate-test-matrix.outputs.matrix).namesToFiles[matrix.testName].file }}\n env:\n FORCE_COLOR: 1\n \n run-tests-windows:\n needs: generate-test-matrix\n timeout-minutes: 20\n runs-on: blacksmith-4vcpu-ubuntu-2404\n continue-on-error: true\n permissions:\n contents: read\n id-token: write\n env:\n ARTILLERY_CLOUD_ENDPOINT: ${{ secrets.ARTILLERY_CLOUD_ENDPOINT_TEST }}\n ARTILLERY_CLOUD_API_KEY: ${{ secrets.ARTILLERY_CLOUD_API_KEY_TEST }}\n DD_TESTS_API_KEY: ${{ secrets.DD_TESTS_API_KEY }}\n DD_TESTS_APP_KEY: ${{ secrets.DD_TESTS_APP_KEY }}\n GITHUB_REPO: ${{ github.repository }}\n GITHUB_ACTOR: ${{ github.actor }}\n HAS_ARM64_BUILD: ${{ inputs.HAS_ARM64_BUILD }}\n steps:\n - uses: actions/checkout@v3\n with:\n ref: ${{ inputs.COMMIT_SHA || null }} # in a PR we make a collaborator check, otherwise this would override pull_request_target\n - name: Configure AWS Credentials\n uses: aws-actions/configure-aws-credentials@v2\n env:\n SHOW_STACK_TRACE: true\n with:\n aws-region: eu-west-1\n role-to-assume: ${{ secrets.AWS_TEST_EXECUTION_ROLE_ARN_TEST5 }}\n role-session-name: OIDCSession\n mask-aws-account-id: true\n - name: Use Node.js\n uses: actions/setup-node@v2\n with:\n node-version: 22.x\n - run: .github/workflows/scripts/npm-command-retry.sh install\n - run: npm run build\n - name: Install Specific Artillery Version if needed\n if: ${{ inputs.ARTILLERY_VERSION_OVERRIDE || false }}\n run: mkdir __artillery__ && cd __artillery__ && npm init -y && ../.github/workflows/scripts/npm-command-retry.sh install artillery@${{ inputs.ARTILLERY_VERSION_OVERRIDE }}\n - name: Set A9_PATH\n if: ${{ inputs.ARTILLERY_VERSION_OVERRIDE || false }}\n run: echo \"A9_PATH=${{ github.workspace }}/__artillery__/node_modules/.bin/artillery\" >> $GITHUB_ENV\n - name: Set ECR Image Version if needed\n if: ${{ inputs.COMMIT_SHA }}\n run: |\n echo \"ECR_IMAGE_VERSION=${{ inputs.COMMIT_SHA }}\" >> $GITHUB_ENV\n echo \"LAMBDA_IMAGE_VERSION=${{ inputs.COMMIT_SHA }}\" >> $GITHUB_ENV\n - run: npm run test:aws:windows --workspace artillery\n env:\n FORCE_COLOR: 1" }, { "path": ".github/workflows/run-tests-windows.yml", "content": "name: Run Windows tests\n\non:\n workflow_dispatch:\n inputs:\n ECR_IMAGE_VERSION:\n description: 'ECR image version'\n\njobs:\n test:\n timeout-minutes: 60\n runs-on: windows-latest\n permissions:\n contents: read\n id-token: write\n steps:\n - uses: actions/checkout@v3\n - name: Use Node.js 22.x\n uses: actions/setup-node@v3\n with:\n node-version: 22.x\n - run: npm install\n - run: npm run build\n - name: Configure AWS Credentials\n uses: aws-actions/configure-aws-credentials@v2\n env:\n SHOW_STACK_TRACE: true\n with:\n aws-region: eu-west-1\n role-to-assume: ${{ secrets.AWS_TEST_EXECUTION_ROLE_ARN_TEST5 }}\n role-session-name: OIDCSession\n mask-aws-account-id: true\n - name: Run local windows tests\n run: npm run test:windows --workspace artillery\n env:\n FORCE_COLOR: 1\n - name: Run AWS windows tests\n run: npm run test:aws:windows --workspace artillery\n env:\n FORCE_COLOR: 1\n ARTILLERY_CLOUD_ENDPOINT: ${{ secrets.ARTILLERY_CLOUD_ENDPOINT_TEST }}\n ARTILLERY_CLOUD_API_KEY: ${{ secrets.ARTILLERY_CLOUD_API_KEY_TEST }}\n GITHUB_REPO: ${{ github.repository }}\n GITHUB_ACTOR: ${{ github.actor }}\n ECR_IMAGE_VERSION: ${{ inputs.ECR_IMAGE_VERSION || github.sha}}\n - name: Notify about failures\n if: failure() && github.ref == 'refs/heads/main'\n uses: 8398a7/action-slack@v3.15.1\n with:\n status: ${{ job.status }}\n fields: repo,message,commit,author,eventName,job,took,pullRequest\n env:\n SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}" }, { "path": ".github/workflows/run-tests.yml", "content": "name: Run tests\n\non:\n push:\n branches: [main]\n pull_request:\n branches: [main]\n workflow_dispatch:\n\njobs:\n generate-matrix-with-packages:\n runs-on: blacksmith-4vcpu-ubuntu-2404\n outputs:\n matrix: ${{ steps.generate-matrix.outputs.matrix }}\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-node@v3\n with:\n node-version: 22.x\n - id: generate-matrix\n run: |\n RESULT=$(node .github/workflows/scripts/get-all-packages-by-name.js)\n echo \"matrix=$RESULT\" >> $GITHUB_OUTPUT\n test:\n timeout-minutes: 30\n runs-on: blacksmith-4vcpu-ubuntu-2404\n needs: generate-matrix-with-packages\n permissions:\n contents: read\n strategy:\n matrix:\n node-version: [22.x, 24.x]\n package: ${{fromJson(needs.generate-matrix-with-packages.outputs.matrix)}}\n fail-fast: false\n steps:\n - uses: actions/checkout@v3\n - name: Use Node.js ${{ matrix.node-version }}\n uses: actions/setup-node@v3\n with:\n node-version: ${{ matrix.node-version }}\n - run: npm install\n - run: npm run build\n - name: Install Playwright Browsers\n if: matrix.package == 'artillery-engine-playwright'\n run: npm exec --workspace artillery-engine-playwright -- playwright install chromium --with-deps\n - run: npm run test --workspace ${{ matrix.package }}\n env:\n FORCE_COLOR: 1\n - name: Notify about failures\n if: failure() && github.ref == 'refs/heads/main'\n uses: 8398a7/action-slack@v3.15.1\n with:\n status: ${{ job.status }}\n fields: repo,message,commit,author,eventName,job,took,pullRequest\n env:\n SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}\n\n test-windows:\n timeout-minutes: 60\n runs-on: windows-latest\n needs: generate-matrix-with-packages\n continue-on-error: true\n permissions:\n contents: read\n id-token: write\n steps:\n - uses: actions/checkout@v3\n - name: Use Node.js 22.x\n uses: actions/setup-node@v3\n with:\n node-version: 22.x\n - run: npm install\n - run: npm run build\n - name: Run windows tests and capture exit code\n continue-on-error: true\n run: |\n npm run test:windows --workspace artillery\n echo \"HAS_PASSED=$?\" >> $env:GITHUB_ENV\n env:\n FORCE_COLOR: 1\n - name: Notify about failures\n if: env.HAS_PASSED == 'False'\n uses: 8398a7/action-slack@v3.15.1\n with:\n status: failure\n fields: repo,message,commit,author,eventName,job,took,pullRequest\n env:\n SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}\n" }, { "path": ".github/workflows/s3-publish-cf-templates.yml", "content": "name: Publish CloudFormation templates to AWS S3\n\non:\n workflow_call:\n inputs:\n canary:\n type: boolean\n default: false\n description: 'Whether to deploy the canary versions of the templates'\n secrets:\n AWS_ASSET_UPLOAD_ROLE_ARN:\n description: 'ARN of the IAM role to assume to upload assets to S3'\n required: true\n\n workflow_dispatch:\n inputs:\n canary:\n type: boolean\n default: false\n description: 'Whether to deploy the canary versions of the templates'\n\nenv:\n CF_LAMBDA_TEMPLATE: ${{ inputs.canary && 'aws-iam-lambda-cf-template-canary.yml' || 'aws-iam-lambda-cf-template.yml' }}\n CF_FARGATE_TEMPLATE: ${{ inputs.canary && 'aws-iam-fargate-cf-template-canary.yml' || 'aws-iam-fargate-cf-template.yml' }}\n GH_OIDC_LAMBDA_TEMPLATE: ${{ inputs.canary && 'gh-oidc-lambda-canary.yml' || 'gh-oidc-lambda.yml' }}\n GH_OIDC_FARGATE_TEMPLATE: ${{ inputs.canary && 'gh-oidc-fargate-canary.yml' || 'gh-oidc-fargate.yml' }}\njobs:\n put-cloudformation-templates:\n runs-on: blacksmith-4vcpu-ubuntu-2404\n\n permissions:\n id-token: write\n contents: read\n \n steps:\n - name: Checkout code\n uses: actions/checkout@v2\n\n - name: Configure AWS Credentials\n uses: aws-actions/configure-aws-credentials@v2\n env:\n SHOW_STACK_TRACE: true\n with:\n aws-region: us-east-1\n role-to-assume: ${{ secrets.AWS_ASSET_UPLOAD_ROLE_ARN }}\n role-session-name: OIDCSession\n mask-aws-account-id: true\n\n - name: Update IAM CloudFormation templates\n run: |\n aws s3 cp --acl public-read ./packages/artillery/lib/platform/aws/iam-cf-templates/aws-iam-fargate-cf-template.yml s3://artilleryio-cf-templates/${{ env.CF_FARGATE_TEMPLATE }}\n aws s3 cp --acl public-read ./packages/artillery/lib/platform/aws/iam-cf-templates/aws-iam-lambda-cf-template.yml s3://artilleryio-cf-templates/${{ env.CF_LAMBDA_TEMPLATE }}\n aws s3 cp --acl public-read ./packages/artillery/lib/platform/aws/iam-cf-templates/gh-oidc-lambda.yml s3://artilleryio-cf-templates/${{ env.GH_OIDC_LAMBDA_TEMPLATE }}\n aws s3 cp --acl public-read ./packages/artillery/lib/platform/aws/iam-cf-templates/gh-oidc-fargate.yml s3://artilleryio-cf-templates/${{ env.GH_OIDC_FARGATE_TEMPLATE }}" }, { "path": ".github/workflows/scripts/get-all-packages-by-name.js", "content": "const fs = require('node:fs');\n\nconst packageNames = [];\nfs.readdirSync('packages').forEach((pkg) => {\n if (fs.statSync(`packages/${pkg}`).isDirectory()) {\n const pkgJson = fs.readFileSync(`packages/${pkg}/package.json`, 'utf8');\n packageNames.push(JSON.parse(pkgJson).name);\n }\n});\n\nconsole.log(JSON.stringify(packageNames));\n" }, { "path": ".github/workflows/scripts/get-tests-in-package-location.js", "content": "const fs = require('node:fs');\nconst path = require('node:path');\n\n/**\n * This script is used to discover all the tests in different test directories that match a specific suffix\n * and generate a JSON file that can be used to run the tests in parallel leveraging Github Actions\n */\n\nconst testLocations = [\n {\n location: 'test/cloud-e2e/fargate',\n packageName: 'artillery',\n suffix: '.test.js'\n },\n {\n location: 'test/cloud-e2e/lambda',\n packageName: 'artillery',\n suffix: '.test.js'\n },\n {\n location: 'test',\n packageName: 'artillery-engine-playwright',\n suffix: '.aws.js'\n }\n];\n\nconst tests = {\n names: [],\n namesToFiles: {}\n};\n\nconst addTest = (fileName, baseLocation, packageName, suffix) => {\n if (!fileName.endsWith(suffix)) {\n return;\n }\n const testName = fileName.replace(suffix, '');\n const jobName = `${packageName}/${testName}`;\n tests.names.push(jobName);\n tests.namesToFiles[jobName] = {\n file: `${baseLocation}/${fileName}`,\n packageName: packageName\n };\n};\n\n// Recursively scan a directory to find files, and add tests to the tests object\nfunction scanDirectory(location, baseLocation, packageName, suffix) {\n fs.readdirSync(location).forEach((file) => {\n const absolute = path.join(location, file);\n if (fs.statSync(absolute).isDirectory()) {\n scanDirectory(absolute, baseLocation, packageName, suffix);\n } else {\n addTest(file, baseLocation, packageName, suffix);\n }\n });\n}\n\n// Scan all the test locations\nfor (const { packageName, location, suffix } of testLocations) {\n const fullLocation = `packages/${packageName}/${location}`;\n scanDirectory(fullLocation, location, packageName, suffix);\n}\n\n// Output the tests object as a JSON string to be used by Github Actions\nconsole.log(JSON.stringify(tests));\n" }, { "path": ".github/workflows/scripts/npm-command-retry.sh", "content": "#!/bin/bash\n\n# This is necessary because npm commands can fail intermittently due to network issues\n# The script retries an npm command up to 5 times with a 2-second delay between each attempt\nrun_npm_command() {\n local max_retries=5\n local retry_count=0\n local sleep_time=2\n local command=\"$@\"\n\n while [ $retry_count -lt $max_retries ]; do\n $command && break\n\n retry_count=$((retry_count + 1))\n echo \"Command attempt $retry_count failed. Retrying in $sleep_time seconds...\"\n sleep $sleep_time\n done\n\n if [ $retry_count -eq $max_retries ]; then\n echo \"Command failed after $max_retries attempts.\"\n exit 1\n else\n echo \"Command succeeded.\"\n fi\n}\n\nif [ $# -eq 0 ]; then\n echo \"No npm command provided.\"\n exit 1\nelse\n command=\"npm $@\"\nfi\n\nrun_npm_command \"$command\"" }, { "path": ".github/workflows/scripts/replace-package-versions.js", "content": "const fs = require('node:fs');\nconst path = require('node:path');\n\nconst packagesDir = '../../../packages';\nconst commitSha = process.env.COMMIT_SHA;\n\nconst getNewVersion = (version) => {\n if (!commitSha || commitSha === 'null') {\n return version;\n }\n\n const shortSha = commitSha.slice(0, 7);\n return `${version}-${shortSha}`;\n};\n\nconst versionMapping = {};\n\n/**\n * This script iterates through every folder in ./packages and replaces their package.version with VERSION-COMMIT_SHA.\n * It then replaces the versions of all dependencies that are in this repo with the new VERSION-COMMIT_SHA of the corresponding package.\n * It is only used by the npm-publish-all-packages-canary.yml script, for the purposes of releasing a canary version of every package scoped to the latest commit to main.\n */\nconst updatePackageVersions = () => {\n const packageFolders = fs\n .readdirSync(path.join(__dirname, packagesDir), { withFileTypes: true })\n .filter((dirent) => dirent.isDirectory())\n .map((dirent) => dirent.name);\n\n packageFolders.forEach((folder) => {\n const packageJsonRelativePath = `${packagesDir}/${folder}/package.json`;\n const packageJsonFullPath = path.join(__dirname, packageJsonRelativePath);\n\n if (!fs.existsSync(packageJsonFullPath)) {\n throw new Error(\n `Path ${packageJsonRelativePath} does not exist! Please ensure that it is a package!`\n );\n }\n\n const packageData = fs.readFileSync(packageJsonFullPath);\n const packageJson = JSON.parse(packageData);\n\n packageJson.version = getNewVersion(packageJson.version);\n\n versionMapping[packageJson.name] = {\n content: packageJson,\n path: packageJsonFullPath\n };\n });\n\n for (const pkg of Object.values(versionMapping)) {\n if (!process.env.REPLACE_MAIN_VERSION_ONLY) {\n updateDependencies(pkg);\n }\n saveUpdatedPackage(pkg);\n }\n};\n\nconst updateDependencies = (pkg) => {\n const {\n content: { dependencies }\n } = pkg;\n\n for (const packageNameToReplace of Object.keys(versionMapping)) {\n if (dependencies?.[packageNameToReplace]) {\n //replace the dependency we care about in this package with its corrected canary version\n dependencies[packageNameToReplace] =\n versionMapping[packageNameToReplace].content.version;\n\n console.log(\n `Updated dependency ${packageNameToReplace} in ${pkg.content.name} to ${dependencies[packageNameToReplace]}`\n );\n }\n }\n};\n\nconst saveUpdatedPackage = (pkg) => {\n fs.writeFileSync(pkg.path, JSON.stringify(pkg.content, null, 2));\n};\n\nupdatePackageVersions();\n" }, { "path": ".gitignore", "content": ".idea\n*.iml\nnpm-debug.log\ndump.rdb\nnode_modules\ncomponents\nbuild\n.tap\nresults.xml\nconfig.json\n.DS_Store\n*/.DS_Store\n*/*/.DS_Store\n._*\n*/._*\n*/*/._*\ncoverage.*\nlib-cov\n*scratch*\nartillery_report*\ncoverage/*\n.vagrant/\n.vscode\n.turbo\nbuild/**\ndist/**\n.next/**" }, { "path": ".npmignore", "content": "test/\n.idea\n*.iml\nnpm-debug.log\ndump.rdb\nnode_modules\ncomponents\nbuild\nresults.tap\nresults.xml\nconfig.json\n.DS_Store\n*/.DS_Store\n*/*/.DS_Store\n._*\n*/._*\n*/*/._*\ncoverage.*\nlib-cov\n*scratch*\ncoverage/*\nnode_modules\nexamples\npackages/\n" }, { "path": ".npmrc", "content": "ignore-scripts=true\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, religion, or sexual identity\nand orientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.\n\n## Our Standards\n\nExamples of behavior that contributes to a positive environment for our\ncommunity include:\n\n* Demonstrating empathy and kindness toward other people\n* Being respectful of differing opinions, viewpoints, and experiences\n* Giving and gracefully accepting constructive feedback\n* Accepting responsibility and apologizing to those affected by our mistakes,\n and learning from the experience\n* Focusing on what is best not just for us as individuals, but for the\n overall community\n\nExamples of unacceptable behavior include:\n\n* The use of sexualized language or imagery, and sexual attention or\n advances of any kind\n* Trolling, insulting or derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or email\n address, without their explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Enforcement Responsibilities\n\nCommunity leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.\n\n## Scope\n\nThis Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at\nteam@artillery.io.\nAll complaints will be reviewed and investigated promptly and fairly.\n\nAll community leaders are obligated to respect the privacy and security of the\nreporter of any incident.\n\n## Enforcement Guidelines\n\nCommunity leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:\n\n### 1. Correction\n\n**Community Impact**: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.\n\n### 2. Warning\n\n**Community Impact**: A violation through a single incident or series\nof actions.\n\n**Consequence**: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or\npermanent ban.\n\n### 3. Temporary Ban\n\n**Community Impact**: A serious violation of community standards, including\nsustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.\n\n### 4. Permanent Ban\n\n**Community Impact**: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within\nthe community.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage],\nversion 2.0, available at\nhttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.\n\nCommunity Impact Guidelines were inspired by [Mozilla's code of conduct\nenforcement ladder](https://github.com/mozilla/diversity).\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see the FAQ at\nhttps://www.contributor-covenant.org/faq. Translations are available at\nhttps://www.contributor-covenant.org/translations.\n" }, { "path": "CONTRIBUTING.md", "content": "# Artillery.io Contributors Guide\n\n## Need to get in touch?\n\nAll project discussions should happen in the [issue tracker](https://github.com/artilleryio/artillery/issues) or via [Discussions](https://github.com/artilleryio/artillery/discussions).\n\nIf you are a first-time contributor and want some help getting started, feel free to get in touch over email:\n\n* Hassy Veldstra - [h@artillery.io](mailto:h@artillery.io?subject=Artillery Contribution Help)\n\n## Guide for Contributions\n\n* We use the usual Fork+Pull model (more info here: [https://help.github.com/articles/using-pull-requests/](https://help.github.com/articles/using-pull-requests/)]\n* Pull requests that modify or add behavior should have tests, whether it's a new feature or a bug fix. If you're unsure how to structure a test, we can help.\n* We love PRs that fix bugs.\n* Do not add a new feature without discussing it via [Discussions](https://github.com/artilleryio/artillery/discussions) first. We've had to decline feature suggestions submitted via PRs in the past because they duplicate existing functionality, have limited utility to the wider user base, or carry too much maintenance burden. We don't want you to spend your time on something that we will not accept.\n* One logical change per commit please. We'll ask you to rebase PRs containing commits that change several unrelated things.\n* The smaller a PR is the better. Smaller PRs are much easier to review and provide feedback on. Always lean towards smaller PRs.\n* Before you write more than a few lines of code, please make sure:\n\n * If it's a new feature proposal - that it has been discussed and accepted\n * Let others know that you are working on the issue\n \n* Commit messages should follow this style (we use the [commitlint conventional](https://github.com/marionebl/commitlint/tree/master/%40commitlint/config-conventional) config):\n ```\n feat: A brief one-liner < 50 chars, use the imperative mood\n\n Followed by further explanation if needed, this should be wrapped at\n around 72 characters. Most commits should reference an existing\n issue, such as #101 above.\n ```\n\n Some reading on good commit messages: [http://chris.beams.io/posts/git-commit/](http://chris.beams.io/posts/git-commit/)\n* Once your first PR has been merged, please add yourself to `package.json` for the relevant module and open another PR.\n\n## Licensing\n\nBy sending a patch you certify that you have the rights to and agree for your contribution to be distributed under the terms of [MPL2](https://www.mozilla.org/en-US/MPL/2.0/).\n\nYou will also need to sign a CLA before your first PR is merged. A GitHub bot will guide you through that after a new PR is opened.\n" }, { "path": "LICENSE-BSL.txt", "content": "Business Source License\n=======================\n\nLicense text copyright (c) 2020 MariaDB Corporation Ab, All Rights Reserved.\n“Business Source License” is a trademark of MariaDB Corporation Ab.\n\nParameters\n\nLicensor: Artillery Software Inc\nLicensed Works: Azure-related code in Artillery. The Licensed Work is\n (c) 2024 Artillery Software Inc\nAdditional Use Grant: You may make use of the Licensed Work strictly for\n evaluation and/or non-production use only. Your use\n does not include offering the Licensed Work to third\n parties on a hosted or embedded basis.\nChange Date: Four years from the date the Licensed Work is published\nChange License: MPL 2.0\n\nFor information about commercial licensing arrangements for the Licensed Work,\nplease contact sales@artillery.io.\n\nNotice\n\nBusiness Source License 1.1\n\nTerms\n\nThe Licensor hereby grants you the right to copy, modify, create derivative\nworks, redistribute, and make non-production use of the Licensed Work. The\nLicensor may make an Additional Use Grant, above, permitting limited production use.\n\nEffective on the Change Date, or the fourth anniversary of the first publicly\navailable distribution of a specific version of the Licensed Work under this\nLicense, whichever comes first, the Licensor hereby grants you rights under\nthe terms of the Change License, and the rights granted in the paragraph\nabove terminate.\n\nIf your use of the Licensed Work does not comply with the requirements\ncurrently in effect as described in this License, you must purchase a\ncommercial license from the Licensor, its affiliated entities, or authorized\nresellers, or you must refrain from using the Licensed Work.\n\nAll copies of the original and modified Licensed Work, and derivative works\nof the Licensed Work, are subject to this License. This License applies\nseparately for each version of the Licensed Work and the Change Date may vary\nfor each version of the Licensed Work released by Licensor.\n\nYou must conspicuously display this License on each original or modified copy\nof the Licensed Work. If you receive the Licensed Work in original or\nmodified form from a third party, the terms and conditions set forth in this\nLicense apply to your use of that work.\n\nAny use of the Licensed Work in violation of this License will automatically\nterminate your rights under this License for the current and all other\nversions of the Licensed Work.\n\nThis License does not grant you any right in any trademark or logo of\nLicensor or its affiliates (provided that you may use a trademark or logo of\nLicensor as expressly required by this License).\n\nTO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON\nAN \"AS IS\" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,\nEXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND\nTITLE." }, { "path": "LICENSE.txt", "content": "Mozilla Public License, version 2.0\n\n1. Definitions\n\n1.1. “Contributor”\n\n means each individual or legal entity that creates, contributes to the\n creation of, or owns Covered Software.\n\n1.2. “Contributor Version”\n\n means the combination of the Contributions of others (if any) used by a\n Contributor and that particular Contributor’s Contribution.\n\n1.3. “Contribution”\n\n means Covered Software of a particular Contributor.\n\n1.4. “Covered Software”\n\n means Source Code Form to which the initial Contributor has attached the\n notice in Exhibit A, the Executable Form of such Source Code Form, and\n Modifications of such Source Code Form, in each case including portions\n thereof.\n\n1.5. “Incompatible With Secondary Licenses”\n means\n\n a. that the initial Contributor has attached the notice described in\n Exhibit B to the Covered Software; or\n\n b. that the Covered Software was made available under the terms of version\n 1.1 or earlier of the License, but not also under the terms of a\n Secondary License.\n\n1.6. “Executable Form”\n\n means any form of the work other than Source Code Form.\n\n1.7. “Larger Work”\n\n means a work that combines Covered Software with other material, in a separate\n file or files, that is not Covered Software.\n\n1.8. “License”\n\n means this document.\n\n1.9. “Licensable”\n\n means having the right to grant, to the maximum extent possible, whether at the\n time of the initial grant or subsequently, any and all of the rights conveyed by\n this License.\n\n1.10. “Modifications”\n\n means any of the following:\n\n a. any file in Source Code Form that results from an addition to, deletion\n from, or modification of the contents of Covered Software; or\n\n b. any new file in Source Code Form that contains any Covered Software.\n\n1.11. “Patent Claims” of a Contributor\n\n means any patent claim(s), including without limitation, method, process,\n and apparatus claims, in any patent Licensable by such Contributor that\n would be infringed, but for the grant of the License, by the making,\n using, selling, offering for sale, having made, import, or transfer of\n either its Contributions or its Contributor Version.\n\n1.12. “Secondary License”\n\n means either the GNU General Public License, Version 2.0, the GNU Lesser\n General Public License, Version 2.1, the GNU Affero General Public\n License, Version 3.0, or any later versions of those licenses.\n\n1.13. “Source Code Form”\n\n means the form of the work preferred for making modifications.\n\n1.14. “You” (or “Your”)\n\n means an individual or a legal entity exercising rights under this\n License. For legal entities, “You” includes any entity that controls, is\n controlled by, or is under common control with You. For purposes of this\n definition, “control” means (a) the power, direct or indirect, to cause\n the direction or management of such entity, whether by contract or\n otherwise, or (b) ownership of more than fifty percent (50%) of the\n outstanding shares or beneficial ownership of such entity.\n\n\n2. License Grants and Conditions\n\n2.1. Grants\n\n Each Contributor hereby grants You a world-wide, royalty-free,\n non-exclusive license:\n\n a. under intellectual property rights (other than patent or trademark)\n Licensable by such Contributor to use, reproduce, make available,\n modify, display, perform, distribute, and otherwise exploit its\n Contributions, either on an unmodified basis, with Modifications, or as\n part of a Larger Work; and\n\n b. under Patent Claims of such Contributor to make, use, sell, offer for\n sale, have made, import, and otherwise transfer either its Contributions\n or its Contributor Version.\n\n2.2. Effective Date\n\n The licenses granted in Section 2.1 with respect to any Contribution become\n effective for each Contribution on the date the Contributor first distributes\n such Contribution.\n\n2.3. Limitations on Grant Scope\n\n The licenses granted in this Section 2 are the only rights granted under this\n License. No additional rights or licenses will be implied from the distribution\n or licensing of Covered Software under this License. Notwithstanding Section\n 2.1(b) above, no patent license is granted by a Contributor:\n\n a. for any code that a Contributor has removed from Covered Software; or\n\n b. for infringements caused by: (i) Your and any other third party’s\n modifications of Covered Software, or (ii) the combination of its\n Contributions with other software (except as part of its Contributor\n Version); or\n\n c. under Patent Claims infringed by Covered Software in the absence of its\n Contributions.\n\n This License does not grant any rights in the trademarks, service marks, or\n logos of any Contributor (except as may be necessary to comply with the\n notice requirements in Section 3.4).\n\n2.4. Subsequent Licenses\n\n No Contributor makes additional grants as a result of Your choice to\n distribute the Covered Software under a subsequent version of this License\n (see Section 10.2) or under the terms of a Secondary License (if permitted\n under the terms of Section 3.3).\n\n2.5. Representation\n\n Each Contributor represents that the Contributor believes its Contributions\n are its original creation(s) or it has sufficient rights to grant the\n rights to its Contributions conveyed by this License.\n\n2.6. Fair Use\n\n This License is not intended to limit any rights You have under applicable\n copyright doctrines of fair use, fair dealing, or other equivalents.\n\n2.7. Conditions\n\n Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in\n Section 2.1.\n\n\n3. Responsibilities\n\n3.1. Distribution of Source Form\n\n All distribution of Covered Software in Source Code Form, including any\n Modifications that You create or to which You contribute, must be under the\n terms of this License. You must inform recipients that the Source Code Form\n of the Covered Software is governed by the terms of this License, and how\n they can obtain a copy of this License. You may not attempt to alter or\n restrict the recipients’ rights in the Source Code Form.\n\n3.2. Distribution of Executable Form\n\n If You distribute Covered Software in Executable Form then:\n\n a. such Covered Software must also be made available in Source Code Form,\n as described in Section 3.1, and You must inform recipients of the\n Executable Form how they can obtain a copy of such Source Code Form by\n reasonable means in a timely manner, at a charge no more than the cost\n of distribution to the recipient; and\n\n b. You may distribute such Executable Form under the terms of this License,\n or sublicense it under different terms, provided that the license for\n the Executable Form does not attempt to limit or alter the recipients’\n rights in the Source Code Form under this License.\n\n3.3. Distribution of a Larger Work\n\n You may create and distribute a Larger Work under terms of Your choice,\n provided that You also comply with the requirements of this License for the\n Covered Software. If the Larger Work is a combination of Covered Software\n with a work governed by one or more Secondary Licenses, and the Covered\n Software is not Incompatible With Secondary Licenses, this License permits\n You to additionally distribute such Covered Software under the terms of\n such Secondary License(s), so that the recipient of the Larger Work may, at\n their option, further distribute the Covered Software under the terms of\n either this License or such Secondary License(s).\n\n3.4. Notices\n\n You may not remove or alter the substance of any license notices (including\n copyright notices, patent notices, disclaimers of warranty, or limitations\n of liability) contained within the Source Code Form of the Covered\n Software, except that You may alter any license notices to the extent\n required to remedy known factual inaccuracies.\n\n3.5. Application of Additional Terms\n\n You may choose to offer, and to charge a fee for, warranty, support,\n indemnity or liability obligations to one or more recipients of Covered\n Software. However, You may do so only on Your own behalf, and not on behalf\n of any Contributor. You must make it absolutely clear that any such\n warranty, support, indemnity, or liability obligation is offered by You\n alone, and You hereby agree to indemnify every Contributor for any\n liability incurred by such Contributor as a result of warranty, support,\n indemnity or liability terms You offer. You may include additional\n disclaimers of warranty and limitations of liability specific to any\n jurisdiction.\n\n4. Inability to Comply Due to Statute or Regulation\n\n If it is impossible for You to comply with any of the terms of this License\n with respect to some or all of the Covered Software due to statute, judicial\n order, or regulation then You must: (a) comply with the terms of this License\n to the maximum extent possible; and (b) describe the limitations and the code\n they affect. Such description must be placed in a text file included with all\n distributions of the Covered Software under this License. Except to the\n extent prohibited by statute or regulation, such description must be\n sufficiently detailed for a recipient of ordinary skill to be able to\n understand it.\n\n5. Termination\n\n5.1. The rights granted under this License will terminate automatically if You\n fail to comply with any of its terms. However, if You become compliant,\n then the rights granted under this License from a particular Contributor\n are reinstated (a) provisionally, unless and until such Contributor\n explicitly and finally terminates Your grants, and (b) on an ongoing basis,\n if such Contributor fails to notify You of the non-compliance by some\n reasonable means prior to 60 days after You have come back into compliance.\n Moreover, Your grants from a particular Contributor are reinstated on an\n ongoing basis if such Contributor notifies You of the non-compliance by\n some reasonable means, this is the first time You have received notice of\n non-compliance with this License from such Contributor, and You become\n compliant prior to 30 days after Your receipt of the notice.\n\n5.2. If You initiate litigation against any entity by asserting a patent\n infringement claim (excluding declaratory judgment actions, counter-claims,\n and cross-claims) alleging that a Contributor Version directly or\n indirectly infringes any patent, then the rights granted to You by any and\n all Contributors for the Covered Software under Section 2.1 of this License\n shall terminate.\n\n5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user\n license agreements (excluding distributors and resellers) which have been\n validly granted by You or Your distributors under this License prior to\n termination shall survive termination.\n\n6. Disclaimer of Warranty\n\n Covered Software is provided under this License on an “as is” basis, without\n warranty of any kind, either expressed, implied, or statutory, including,\n without limitation, warranties that the Covered Software is free of defects,\n merchantable, fit for a particular purpose or non-infringing. The entire\n risk as to the quality and performance of the Covered Software is with You.\n Should any Covered Software prove defective in any respect, You (not any\n Contributor) assume the cost of any necessary servicing, repair, or\n correction. This disclaimer of warranty constitutes an essential part of this\n License. No use of any Covered Software is authorized under this License\n except under this disclaimer.\n\n7. Limitation of Liability\n\n Under no circumstances and under no legal theory, whether tort (including\n negligence), contract, or otherwise, shall any Contributor, or anyone who\n distributes Covered Software as permitted above, be liable to You for any\n direct, indirect, special, incidental, or consequential damages of any\n character including, without limitation, damages for lost profits, loss of\n goodwill, work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses, even if such party shall have been\n informed of the possibility of such damages. This limitation of liability\n shall not apply to liability for death or personal injury resulting from such\n party’s negligence to the extent applicable law prohibits such limitation.\n Some jurisdictions do not allow the exclusion or limitation of incidental or\n consequential damages, so this exclusion and limitation may not apply to You.\n\n8. Litigation\n\n Any litigation relating to this License may be brought only in the courts of\n a jurisdiction where the defendant maintains its principal place of business\n and such litigation shall be governed by laws of that jurisdiction, without\n reference to its conflict-of-law provisions. Nothing in this Section shall\n prevent a party’s ability to bring cross-claims or counter-claims.\n\n9. Miscellaneous\n\n This License represents the complete agreement concerning the subject matter\n hereof. If any provision of this License is held to be unenforceable, such\n provision shall be reformed only to the extent necessary to make it\n enforceable. Any law or regulation which provides that the language of a\n contract shall be construed against the drafter shall not be used to construe\n this License against a Contributor.\n\n\n10. Versions of the License\n\n10.1. New Versions\n\n Mozilla Foundation is the license steward. Except as provided in Section\n 10.3, no one other than the license steward has the right to modify or\n publish new versions of this License. Each version will be given a\n distinguishing version number.\n\n10.2. Effect of New Versions\n\n You may distribute the Covered Software under the terms of the version of\n the License under which You originally received the Covered Software, or\n under the terms of any subsequent version published by the license\n steward.\n\n10.3. Modified Versions\n\n If you create software not governed by this License, and you want to\n create a new license for such software, you may create and use a modified\n version of this License if you rename the license and remove any\n references to the name of the license steward (except to note that such\n modified license differs from this License).\n\n10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses\n If You choose to distribute Source Code Form that is Incompatible With\n Secondary Licenses under the terms of this version of the License, the\n notice described in Exhibit B of this License must be attached.\n\nExhibit A - Source Code Form License Notice\n\n This Source Code Form is subject to the\n terms of the Mozilla Public License, v.\n 2.0. If a copy of the MPL was not\n distributed with this file, You can\n obtain one at\n http://mozilla.org/MPL/2.0/.\n\nIf it is not possible or desirable to put the notice in a particular file, then\nYou may include the notice in a location (such as a LICENSE file in a relevant\ndirectory) where a recipient would be likely to look for such a notice.\n\nYou may add additional accurate notices of copyright ownership.\n\nExhibit B - “Incompatible With Secondary Licenses” Notice\n\n This Source Code Form is “Incompatible\n With Secondary Licenses”, as defined by\n the Mozilla Public License, v. 2.0.\n" }, { "path": "README.md", "content": "
\n \n

Artillery

\n

\n Docs | Discussions | @artilleryio\n

\n\n

\n \"npm\"\n

\n\n\n\n \n\n\n
\n\n## Features\n\n- **Test at cloud scale.** Cloud-native distributed load testing at scale, **out-of-the box and for free**.\n - Scale out your load tests on top of AWS Lambda or AWS Fargate. No DevOps needed, zero infrastructure to set up or manage.\n- **Test with Playwright**. Load test with real headless browsers.\n- **Batteries-included.** 20+ integrations for monitoring, observability, and CICD.\n- **Test anything**. HTTP, WebSocket, Socket.io, gRPC, Kinesis, and more.\n- **Powerful workload modeling**. Emulate complex user behavior with request chains, multiple steps, transactions, and more.\n- **Extensible & hackable**. Artillery has a plugin API to allow extending and customization.\n\n## License\n\n* Most of the code in this repository is licensed under the terms of the [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/) license.\n* Some Azure-specific modules are licensed under the terms of the [BSL license](https://mariadb.com/bsl-faq-adopting/). See [LICENSE-BSL.txt](./LICENSE-BSL.txt) for details. You may use Artillery on Azure for evaluation and proof-of-concept purposes, but commercial and/or production usage requires a commercial license.\n\n\n→ [Learn more](./packages/artillery#readme)\n\n\n" }, { "path": "SECURITY.md", "content": "# Security Policy\n\n## Supported Versions\n\nThe following versions of Artillery are currently being supported with security updates:\n\n| Version | Supported |\n| ------- | ------------------ |\n| 2.x.x | :white_check_mark: |\n| 1.7.x | :x: |\n| < 1.7 | :x: |\n\n## Reporting a Vulnerability\n\nPlease see the latest version of our security policy at\n\nhttps://www.artillery.io/security-policy\n" }, { "path": "biome.json", "content": "{\n \"$schema\": \"https://biomejs.dev/schemas/2.3.3/schema.json\",\n \"formatter\": {\n \"enabled\": false\n },\n \"linter\": {\n \"enabled\": true,\n \"rules\": {\n \"suspicious\": {\n \"noThenProperty\": \"off\",\n \"noExplicitAny\": \"off\"\n }\n }\n },\n \"files\": {\n \"includes\": [\n \"**\",\n \"!**/packages/types\",\n \"!**/packages/artillery-engine-playwright/test/**/*.ts\",\n \"!**/examples/browser-playwright-reuse-typescript/**/*.ts\",\n \"!**/node_modules\",\n \"!**/dist\",\n \"!**/build\"\n ]\n }\n}\n" }, { "path": "commitlint.config.js", "content": "const config = require('@commitlint/config-conventional');\n\nconst types = config.rules['type-enum'][2].concat(['dep']);\n\nmodule.exports = {\n extends: ['@commitlint/config-conventional'],\n rules: {\n 'type-enum': [2, 'always', types]\n }\n};\n" }, { "path": "examples/README.md", "content": "

\n\"artillery-examples\"\n

\n\n# Artillery Examples\n\nThis repo contains examples of how to use various features in Artillery. Every example is self-contained and can be run as-is without external dependencies (other than those in `package.json`).\n\n## Test scripts\n\n### Core features\n\n- [using-data-from-csv](./using-data-from-csv) - using data from an external CSV file in vuser scenarios\n- [scenario-weights](./scenario-weights) - set weights to change how often Artillery runs a scenario\n- [script-overrides](./script-overrides) - override parts of the script such as load phases dynamically at runtime\n- [multiple-scenario-specs](./multiple-scenario-specs) - organizing your Artillery test codebase into separate scenario files\n- [automated-checks](./automated-checks) - setting up automated checks with `ensure` and `apdex` plugins\n\n### How-tos\n\n- [refresh-auth-token](./refresh-auth-token/) - how to refresh an auth token used by a VU as the test is running\n\n### End-to-end examples\n\n- [socket-io](./socket-io) - testing a Socket.io service\n- [websockets](./websockets) - testing a WebSocket service\n- [graphql-api-server](./graphql-api-server) - testing a GraphQL API server\n- [browser-load-testing-playwright](./browser-load-testing-playwright) - load testing with real browsers\n- [functional testing](./functional-testing-with-expect-plugin) - use `artillery-plugin-expect` to run both load and functional tests\n- [CSV-driven functional testing](./table-driven-functional-tests) - define functional tests with a CSV file\n\n### HTTP-specific examples\n\n- [http-set-custom-header](./http-set-custom-header) - set an HTTP header in a `beforeRequest` hook\n- [using-cookies](./using-cookies) - using cookies with HTTP services\n- [file-uploads](./file-uploads) - HTTP file uploads with Artillery Pro\n\n### Plugins and extensions\n\n- [track-custom-metrics](./track-custom-metrics) - track custom metrics (counters and histograms)\n- [artillery-plugin-hello-world](./artillery-plugin-hello-world) - a \"hello world\" plugin\n\n## Running Artillery in CI/CD\n\n- [cicd examples](./cicd) - using Artillery with Github Actions, Gitlab CI, Azure DevOps, CircleCI and more\n\n## Starter kits\n\n- [starter-kit](./starter-kit) - @cfryerdev's Artillery starter kit - an example of how a few different bits fit together\n\n## Testing on Kubernetes\n\n- [k8s-testing-with-kubectl-artillery-](./k8s-testing-with-kubectl-artillery)\n\n# Contributing\n\nWould you like to share an example showing how to use a feature in Artillery with the community? Send us a PR 💜\n\n# License\n\nAll code in this repo is licensed under the terms of the [MPL2 license](https://www.mozilla.org/en-US/MPL/2.0/FAQ/).\n" }, { "path": "examples/artillery-engine-example/.gitignore", "content": ".idea\n*.iml\nnpm-debug.log\ndump.rdb\nnode_modules\ncomponents\nbuild\nresults.tap\nresults.xml\nconfig.json\n.DS_Store\n*/.DS_Store\n*/*/.DS_Store\n._*\n*/._*\n*/*/._*\ncoverage.*\nlib-cov\n*scratch*\nartillery_report*\ncoverage/*\n.vagrant/\n.vscode" }, { "path": "examples/artillery-engine-example/LICENSE", "content": "Mozilla Public License Version 2.0\n==================================\n\n1. Definitions\n--------------\n\n1.1. \"Contributor\"\n means each individual or legal entity that creates, contributes to\n the creation of, or owns Covered Software.\n\n1.2. \"Contributor Version\"\n means the combination of the Contributions of others (if any) used\n by a Contributor and that particular Contributor's Contribution.\n\n1.3. \"Contribution\"\n means Covered Software of a particular Contributor.\n\n1.4. \"Covered Software\"\n means Source Code Form to which the initial Contributor has attached\n the notice in Exhibit A, the Executable Form of such Source Code\n Form, and Modifications of such Source Code Form, in each case\n including portions thereof.\n\n1.5. \"Incompatible With Secondary Licenses\"\n means\n\n (a) that the initial Contributor has attached the notice described\n in Exhibit B to the Covered Software; or\n\n (b) that the Covered Software was made available under the terms of\n version 1.1 or earlier of the License, but not also under the\n terms of a Secondary License.\n\n1.6. \"Executable Form\"\n means any form of the work other than Source Code Form.\n\n1.7. \"Larger Work\"\n means a work that combines Covered Software with other material, in\n a separate file or files, that is not Covered Software.\n\n1.8. \"License\"\n means this document.\n\n1.9. \"Licensable\"\n means having the right to grant, to the maximum extent possible,\n whether at the time of the initial grant or subsequently, any and\n all of the rights conveyed by this License.\n\n1.10. \"Modifications\"\n means any of the following:\n\n (a) any file in Source Code Form that results from an addition to,\n deletion from, or modification of the contents of Covered\n Software; or\n\n (b) any new file in Source Code Form that contains any Covered\n Software.\n\n1.11. \"Patent Claims\" of a Contributor\n means any patent claim(s), including without limitation, method,\n process, and apparatus claims, in any patent Licensable by such\n Contributor that would be infringed, but for the grant of the\n License, by the making, using, selling, offering for sale, having\n made, import, or transfer of either its Contributions or its\n Contributor Version.\n\n1.12. \"Secondary License\"\n means either the GNU General Public License, Version 2.0, the GNU\n Lesser General Public License, Version 2.1, the GNU Affero General\n Public License, Version 3.0, or any later versions of those\n licenses.\n\n1.13. \"Source Code Form\"\n means the form of the work preferred for making modifications.\n\n1.14. \"You\" (or \"Your\")\n means an individual or a legal entity exercising rights under this\n License. For legal entities, \"You\" includes any entity that\n controls, is controlled by, or is under common control with You. For\n purposes of this definition, \"control\" means (a) the power, direct\n or indirect, to cause the direction or management of such entity,\n whether by contract or otherwise, or (b) ownership of more than\n fifty percent (50%) of the outstanding shares or beneficial\n ownership of such entity.\n\n2. License Grants and Conditions\n--------------------------------\n\n2.1. Grants\n\nEach Contributor hereby grants You a world-wide, royalty-free,\nnon-exclusive license:\n\n(a) under intellectual property rights (other than patent or trademark)\n Licensable by such Contributor to use, reproduce, make available,\n modify, display, perform, distribute, and otherwise exploit its\n Contributions, either on an unmodified basis, with Modifications, or\n as part of a Larger Work; and\n\n(b) under Patent Claims of such Contributor to make, use, sell, offer\n for sale, have made, import, and otherwise transfer either its\n Contributions or its Contributor Version.\n\n2.2. Effective Date\n\nThe licenses granted in Section 2.1 with respect to any Contribution\nbecome effective for each Contribution on the date the Contributor first\ndistributes such Contribution.\n\n2.3. Limitations on Grant Scope\n\nThe licenses granted in this Section 2 are the only rights granted under\nthis License. No additional rights or licenses will be implied from the\ndistribution or licensing of Covered Software under this License.\nNotwithstanding Section 2.1(b) above, no patent license is granted by a\nContributor:\n\n(a) for any code that a Contributor has removed from Covered Software;\n or\n\n(b) for infringements caused by: (i) Your and any other third party's\n modifications of Covered Software, or (ii) the combination of its\n Contributions with other software (except as part of its Contributor\n Version); or\n\n(c) under Patent Claims infringed by Covered Software in the absence of\n its Contributions.\n\nThis License does not grant any rights in the trademarks, service marks,\nor logos of any Contributor (except as may be necessary to comply with\nthe notice requirements in Section 3.4).\n\n2.4. Subsequent Licenses\n\nNo Contributor makes additional grants as a result of Your choice to\ndistribute the Covered Software under a subsequent version of this\nLicense (see Section 10.2) or under the terms of a Secondary License (if\npermitted under the terms of Section 3.3).\n\n2.5. Representation\n\nEach Contributor represents that the Contributor believes its\nContributions are its original creation(s) or it has sufficient rights\nto grant the rights to its Contributions conveyed by this License.\n\n2.6. Fair Use\n\nThis License is not intended to limit any rights You have under\napplicable copyright doctrines of fair use, fair dealing, or other\nequivalents.\n\n2.7. Conditions\n\nSections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted\nin Section 2.1.\n\n3. Responsibilities\n-------------------\n\n3.1. Distribution of Source Form\n\nAll distribution of Covered Software in Source Code Form, including any\nModifications that You create or to which You contribute, must be under\nthe terms of this License. You must inform recipients that the Source\nCode Form of the Covered Software is governed by the terms of this\nLicense, and how they can obtain a copy of this License. You may not\nattempt to alter or restrict the recipients' rights in the Source Code\nForm.\n\n3.2. Distribution of Executable Form\n\nIf You distribute Covered Software in Executable Form then:\n\n(a) such Covered Software must also be made available in Source Code\n Form, as described in Section 3.1, and You must inform recipients of\n the Executable Form how they can obtain a copy of such Source Code\n Form by reasonable means in a timely manner, at a charge no more\n than the cost of distribution to the recipient; and\n\n(b) You may distribute such Executable Form under the terms of this\n License, or sublicense it under different terms, provided that the\n license for the Executable Form does not attempt to limit or alter\n the recipients' rights in the Source Code Form under this License.\n\n3.3. Distribution of a Larger Work\n\nYou may create and distribute a Larger Work under terms of Your choice,\nprovided that You also comply with the requirements of this License for\nthe Covered Software. If the Larger Work is a combination of Covered\nSoftware with a work governed by one or more Secondary Licenses, and the\nCovered Software is not Incompatible With Secondary Licenses, this\nLicense permits You to additionally distribute such Covered Software\nunder the terms of such Secondary License(s), so that the recipient of\nthe Larger Work may, at their option, further distribute the Covered\nSoftware under the terms of either this License or such Secondary\nLicense(s).\n\n3.4. Notices\n\nYou may not remove or alter the substance of any license notices\n(including copyright notices, patent notices, disclaimers of warranty,\nor limitations of liability) contained within the Source Code Form of\nthe Covered Software, except that You may alter any license notices to\nthe extent required to remedy known factual inaccuracies.\n\n3.5. Application of Additional Terms\n\nYou may choose to offer, and to charge a fee for, warranty, support,\nindemnity or liability obligations to one or more recipients of Covered\nSoftware. However, You may do so only on Your own behalf, and not on\nbehalf of any Contributor. You must make it absolutely clear that any\nsuch warranty, support, indemnity, or liability obligation is offered by\nYou alone, and You hereby agree to indemnify every Contributor for any\nliability incurred by such Contributor as a result of warranty, support,\nindemnity or liability terms You offer. You may include additional\ndisclaimers of warranty and limitations of liability specific to any\njurisdiction.\n\n4. Inability to Comply Due to Statute or Regulation\n---------------------------------------------------\n\nIf it is impossible for You to comply with any of the terms of this\nLicense with respect to some or all of the Covered Software due to\nstatute, judicial order, or regulation then You must: (a) comply with\nthe terms of this License to the maximum extent possible; and (b)\ndescribe the limitations and the code they affect. Such description must\nbe placed in a text file included with all distributions of the Covered\nSoftware under this License. Except to the extent prohibited by statute\nor regulation, such description must be sufficiently detailed for a\nrecipient of ordinary skill to be able to understand it.\n\n5. Termination\n--------------\n\n5.1. The rights granted under this License will terminate automatically\nif You fail to comply with any of its terms. However, if You become\ncompliant, then the rights granted under this License from a particular\nContributor are reinstated (a) provisionally, unless and until such\nContributor explicitly and finally terminates Your grants, and (b) on an\nongoing basis, if such Contributor fails to notify You of the\nnon-compliance by some reasonable means prior to 60 days after You have\ncome back into compliance. Moreover, Your grants from a particular\nContributor are reinstated on an ongoing basis if such Contributor\nnotifies You of the non-compliance by some reasonable means, this is the\nfirst time You have received notice of non-compliance with this License\nfrom such Contributor, and You become compliant prior to 30 days after\nYour receipt of the notice.\n\n5.2. If You initiate litigation against any entity by asserting a patent\ninfringement claim (excluding declaratory judgment actions,\ncounter-claims, and cross-claims) alleging that a Contributor Version\ndirectly or indirectly infringes any patent, then the rights granted to\nYou by any and all Contributors for the Covered Software under Section\n2.1 of this License shall terminate.\n\n5.3. In the event of termination under Sections 5.1 or 5.2 above, all\nend user license agreements (excluding distributors and resellers) which\nhave been validly granted by You or Your distributors under this License\nprior to termination shall survive termination.\n\n************************************************************************\n* *\n* 6. Disclaimer of Warranty *\n* ------------------------- *\n* *\n* Covered Software is provided under this License on an \"as is\" *\n* basis, without warranty of any kind, either expressed, implied, or *\n* statutory, including, without limitation, warranties that the *\n* Covered Software is free of defects, merchantable, fit for a *\n* particular purpose or non-infringing. The entire risk as to the *\n* quality and performance of the Covered Software is with You. *\n* Should any Covered Software prove defective in any respect, You *\n* (not any Contributor) assume the cost of any necessary servicing, *\n* repair, or correction. This disclaimer of warranty constitutes an *\n* essential part of this License. No use of any Covered Software is *\n* authorized under this License except under this disclaimer. *\n* *\n************************************************************************\n\n************************************************************************\n* *\n* 7. Limitation of Liability *\n* -------------------------- *\n* *\n* Under no circumstances and under no legal theory, whether tort *\n* (including negligence), contract, or otherwise, shall any *\n* Contributor, or anyone who distributes Covered Software as *\n* permitted above, be liable to You for any direct, indirect, *\n* special, incidental, or consequential damages of any character *\n* including, without limitation, damages for lost profits, loss of *\n* goodwill, work stoppage, computer failure or malfunction, or any *\n* and all other commercial damages or losses, even if such party *\n* shall have been informed of the possibility of such damages. This *\n* limitation of liability shall not apply to liability for death or *\n* personal injury resulting from such party's negligence to the *\n* extent applicable law prohibits such limitation. Some *\n* jurisdictions do not allow the exclusion or limitation of *\n* incidental or consequential damages, so this exclusion and *\n* limitation may not apply to You. *\n* *\n************************************************************************\n\n8. Litigation\n-------------\n\nAny litigation relating to this License may be brought only in the\ncourts of a jurisdiction where the defendant maintains its principal\nplace of business and such litigation shall be governed by laws of that\njurisdiction, without reference to its conflict-of-law provisions.\nNothing in this Section shall prevent a party's ability to bring\ncross-claims or counter-claims.\n\n9. Miscellaneous\n----------------\n\nThis License represents the complete agreement concerning the subject\nmatter hereof. If any provision of this License is held to be\nunenforceable, such provision shall be reformed only to the extent\nnecessary to make it enforceable. Any law or regulation which provides\nthat the language of a contract shall be construed against the drafter\nshall not be used to construe this License against a Contributor.\n\n10. Versions of the License\n---------------------------\n\n10.1. New Versions\n\nMozilla Foundation is the license steward. Except as provided in Section\n10.3, no one other than the license steward has the right to modify or\npublish new versions of this License. Each version will be given a\ndistinguishing version number.\n\n10.2. Effect of New Versions\n\nYou may distribute the Covered Software under the terms of the version\nof the License under which You originally received the Covered Software,\nor under the terms of any subsequent version published by the license\nsteward.\n\n10.3. Modified Versions\n\nIf you create software not governed by this License, and you want to\ncreate a new license for such software, you may create and use a\nmodified version of this License if you rename the license and remove\nany references to the name of the license steward (except to note that\nsuch modified license differs from this License).\n\n10.4. Distributing Source Code Form that is Incompatible With Secondary\nLicenses\n\nIf You choose to distribute Source Code Form that is Incompatible With\nSecondary Licenses under the terms of this version of the License, the\nnotice described in Exhibit B of this License must be attached.\n\nExhibit A - Source Code Form License Notice\n-------------------------------------------\n\n This Source Code Form is subject to the terms of the Mozilla Public\n License, v. 2.0. If a copy of the MPL was not distributed with this\n file, You can obtain one at http://mozilla.org/MPL/2.0/.\n\nIf it is not possible or desirable to put the notice in a particular\nfile, then You may include the notice in a location (such as a LICENSE\nfile in a relevant directory) where a recipient would be likely to look\nfor such a notice.\n\nYou may add additional accurate notices of copyright ownership.\n\nExhibit B - \"Incompatible With Secondary Licenses\" Notice\n---------------------------------------------------------\n\n This Source Code Form is \"Incompatible With Secondary Licenses\", as\n defined by the Mozilla Public License, v. 2.0.\n" }, { "path": "examples/artillery-engine-example/README.md", "content": "# Artillery Engine Example\n\nThis repo contains the code for a simple \"hello world\" Artillery engine that shows how Artillery's\nengine API works, and can serve as a starting point for a custom engine.\n\n## Usage\n\n- Install dependencies with `npm install`\n- Set up parent folder as `NODE_PATH` so this engine is loaded by Artillery: `export NODE_PATH=$(pwd)/..`\n- Run the example script using this engine: `artillery run example.yaml`\n### License\n\n[MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/)\n" }, { "path": "examples/artillery-engine-example/example.yaml", "content": "config:\n target: \"system-under-test-endpoint\"\n example:\n mandatoryString: \"a configuration setting for our engine\"\n phases:\n - arrivalRate: 1\n duration: 1\n engines:\n example: {}\nscenarios:\n - name: \"custom_example_engine_scenario\"\n engine: example\n flow:\n - doSomething:\n id: 123\n - doSomething:\n id: 456\n" }, { "path": "examples/artillery-engine-example/index.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst A = require('async');\nconst debug = require('debug')('engine:example');\n\n// Simple example engine that recieves a prop and prints it when a 'doSomething'\n// action is found.\n// Serves as a modifiable example to build on top of for new engines\nclass ExampleEngine {\n // Artillery initializes each engine with the following arguments:\n //\n // - script is the entire script object, with .config and .scenarios properties\n // - events is an EventEmitter we can use to subscribe to events from Artillery, and\n // to report custom metrics\n // - helpers is a collection of utility functions\n constructor(script, ee, helpers) {\n this.script = script;\n this.ee = ee;\n this.helpers = helpers;\n\n // This would typically be the endpoint we're testing\n this.target = script.config.target;\n\n const opts = { ...this.script.config.example };\n\n // We can add custom validations on those props\n if (!opts.mandatoryString) {\n throw new Error('mandatoryString setting must be set');\n }\n }\n\n // For each scenario in the script using this engine, Artillery calls this function\n // to create a VU function\n createScenario(scenarioSpec, ee) {\n const tasks = scenarioSpec.flow.map((rs) => this.step(rs, ee));\n\n return function scenario(initialContext, callback) {\n ee.emit('started');\n\n function vuInit(callback) {\n // we can run custom VU-specific init code here\n return callback(null, initialContext);\n }\n\n const steps = [vuInit].concat(tasks);\n\n A.waterfall(steps, function done(err, context) {\n if (err) {\n debug(err);\n }\n\n return callback(err, context);\n });\n };\n }\n\n // This is a convenience function where we delegate common actions like loop, log, and think,\n // and handle actions which are custom for our engine, i.e. the \"doSomething\" action in this case\n step(rs, ee) {\n const self = this;\n\n if (rs.loop) {\n const steps = rs.loop.map((loopStep) => this.step(loopStep, ee));\n\n return this.helpers.createLoopWithCount(rs.count || -1, steps, {});\n }\n\n if (rs.log) {\n return function log(context, callback) {\n return process.nextTick(() => {\n callback(null, context);\n });\n };\n }\n\n if (rs.think) {\n return this.helpers.createThink(rs, self.config?.defaults?.think || {});\n }\n\n if (rs.function) {\n return (context, callback) => {\n const func = self.script.config.processor[rs.function];\n if (!func) {\n return process.nextTick(() => {\n callback(null, context);\n });\n }\n\n return func(context, ee, () => callback(null, context));\n };\n }\n\n //\n // This is our custom action:\n //\n if (rs.doSomething) {\n return function example(context, callback) {\n console.log(\n 'doSomething action with id:',\n self.helpers.template(rs.doSomething.id, context, true)\n );\n console.log('target is:', self.target);\n\n // Emit a metric to count the number of example actions performed:\n ee.emit('counter', 'example.action_count', 1);\n return callback(null, context);\n };\n }\n\n //\n // Ignore any unrecognized actions:\n //\n return function doNothing(context, callback) {\n return callback(null, context);\n };\n }\n}\n\nmodule.exports = ExampleEngine;\n" }, { "path": "examples/artillery-engine-example/package.json", "content": "{\n \"name\": \"artillery-engine-example\",\n \"version\": \"0.0.1\",\n \"description\": \"Engine template/example for Artillery\",\n \"main\": \"index.js\",\n \"scripts\": {\n \"test\": \"node test/index.js\"\n },\n \"keywords\": [\n \"artillery\",\n \"engine\",\n \"load\"\n ],\n \"author\": \"Juan Gil \",\n \"license\": \"MPL-2.0\",\n \"devDependencies\": {\n \"tap\": \"^18.6.1\",\n \"tape\": \"^5.6.1\"\n },\n \"dependencies\": {\n \"async\": \"^3.2.4\",\n \"debug\": \"^4.3.4\"\n }\n}\n" }, { "path": "examples/artillery-engine-example/test/index.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst { test } = require('tap');\nconst EventEmitter = require('node:events');\n\nconst ExampleEngine = require('..');\n\nconst script = {\n config: {\n target: 'my-endpoint',\n example: {\n mandatoryString: 'hello-world'\n }\n },\n scenarios: [\n {\n name: 'test scenario',\n engine: 'example',\n flow: [\n {\n doSomething: {\n id: 123\n }\n }\n ]\n }\n ]\n};\n\ntest('Engine interface', async (t) => {\n const events = new EventEmitter();\n const engine = new ExampleEngine(script, events, {});\n const scenario = engine.createScenario(script.scenarios[0], events);\n\n t.match(engine.script, script, 'Engine constructor sets script');\n t.type(scenario, 'function', 'Engine.createScenario returns a function');\n});\n" }, { "path": "examples/artillery-plugin-hello-world/README.md", "content": "# artillery-hello-world-plugin\n\nThis is a \"hello world\" plugin for Artillery which shows:\n\n- Artillery's plugin interface\n- How a barebones plugin is constructed\n- How to inspect test script properties in a plugin\n- How to attach custom hooks to scenarios in a plugin to do something interesting\n\n## Run the example scenario 👋\n\nBy default Artillery will look in Node.js package path for the plugin package (which is expected to have an `artillery-plugin-` prefix, so the package for the `hello-world` plugin is expected to be named `artillery-plugin-hello-world`).\n\nWe can add an extra look-up location with `ARTILLERY_PLUGIN_PATH`. This is useful when developing plugins.\n\nFrom the folder where this README is located, run:\n\n```sh\nARTILLERY_PLUGIN_PATH=`pwd`/.. DEBUG=plugin:hello-world artillery run test.yml\n```\n\nAnd we should see our greeting, debug messages from the plugin, and the counter in Artillery's output:\n\n![greeting](./images/screenshot1.png)\n![custom counter](./images/screenshot2.png)\n\n## Learn more 📖\n\nCheck out these plugins for ideas of how to do more things:\n\n- https://github.com/artilleryio/artillery-plugin-publish-metrics\n- https://github.com/artilleryio/artillery-plugin-hls\n- https://github.com/artilleryio/artillery-plugin-fuzzer\n- https://github.com/artilleryio/artillery-plugin-expect\n\nArtillery's extension APIs:\n\nhttps://artillery.io/docs/guides/guides/extension-apis\n\nBlog post on creating a custom plugin:\n\nhttps://artillery.io/blog/extend-artillery-by-creating-your-own-plugins\n\n## Write a plugin (and let us know!) ⚡\n\nArtillery's plugin interface + the power of Node.js (there's an npm package for everything!) make it easy to extend Artillery with new functionality.\n\nIf you write a new plugin, let us know!\n\n- Github Discussion board: https://github.com/artilleryio/artillery/discussions\n\n💜\n" }, { "path": "examples/artillery-plugin-hello-world/index.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst debug = require('debug')('plugin:hello-world');\n\nmodule.exports.Plugin = ArtilleryHelloWorldPlugin;\n\nfunction ArtilleryHelloWorldPlugin(script, events) {\n // This is the entirety of the test script - config and\n // scenarios\n this.script = script;\n // This is an EventEmitter, we can subscribe to:\n // 'stats' - fired when a new batch of metrics is available\n // 'done' - fired when all VUs are done\n // We can also use this EventEmitter to emit custom\n // metrics:\n // https://artillery.io/docs/guides/guides/extending.html#Tracking-custom-metrics\n this.events = events;\n\n // We can read our plugin's configuration:\n const pluginConfig = script.config.plugins['hello-world'];\n this.greeting = pluginConfig.greeting || 'hello, world';\n\n // But we could also read anything else defined in the test\n // script, e.g.:\n debug('target is:', script.config.target);\n\n //\n // Let's attach a beforeRequest hook to all scenarios\n // which will print a greeting before a request is made\n //\n // Create processor object if needed to hold our custom function:\n script.config.processor = script.config.processor || {};\n // Add our custom function:\n script.config.processor.pluginHelloWorldBeforeRequestHook = (\n _req,\n _vuContext,\n events,\n next\n ) => {\n // This a beforeRequest handler function:\n // https://artillery.io/docs/guides/guides/http-reference.html#beforeRequest\n\n console.log(this.greeting); // print greeting\n events.emit('counter', 'greeting_count', 1); // increase custom counter\n return next(); // the hook is done, go on to the next one (or let Artillery make the request)\n };\n // Attach the function to every scenario as a scenario-level hook:\n script.scenarios.forEach((scenario) => {\n scenario.beforeRequest = scenario.beforeRequest || [];\n scenario.beforeRequest.push('pluginHelloWorldBeforeRequestHook');\n });\n\n return this;\n}\n\n// Artillery will call this before it exits to give plugins\n// a chance to clean up, e.g. by flushing any in-flight data,\n// writing something to disk etc.\nArtilleryHelloWorldPlugin.prototype.cleanup = (done) => {\n debug('cleaning up');\n done(null);\n};\n" }, { "path": "examples/artillery-plugin-hello-world/package.json", "content": "{\n \"name\": \"artillery-plugin-hello-world\",\n \"version\": \"1.0.0\",\n \"description\": \"This is a \\\"hello world\\\" plugin for Artillery which shows:\",\n \"main\": \"index.js\",\n \"scripts\": {\n \"test\": \"echo \\\"Error: no test specified\\\" && exit 1\"\n },\n \"keywords\": [],\n \"author\": \"\",\n \"license\": \"MPL-2.0\",\n \"dependencies\": {\n \"debug\": \"^4.3.1\"\n }\n}\n" }, { "path": "examples/artillery-plugin-hello-world/test.yml", "content": "config:\n target: \"http://asciiart.artillery.io:8080\"\n phases:\n - arrivalRate: 1\n duration: 10\n plugins:\n hello-world:\n greeting: \"Hello world! 👋\"\nscenarios:\n - flow:\n - get:\n url: \"/\"" }, { "path": "examples/automated-checks/README.md", "content": "# Using automated checks\n\nThis is an example Artillery load test that includes:\n\n1. A load configuration with 3 distinct phases that create a burst of traffic after a warm up period\n2. Configuration for [`apdex`](https://docs.art/reference/extensions/apdex) and [`ensure`](https://docs.art/reference/extensions/ensure) plugins to set up automated scoring and checking of performance results from the test\n3. Use of `metrics-by-endpoint` plugin to enable reporting of metrics for each individual URL in the test\n\nRun the script with:\n\n```\nartillery run test-with-automated-checks.yml\n```\n" }, { "path": "examples/automated-checks/load-test-with-automated-checks.yml", "content": "# This an example Artillery load test that includes:\n# - A load configuration with 3 distinct phases that create\n# a burst of traffic after a warm up period\n# - How to use built-in \"apdex\" and \"ensure\" plugins to set up\n# automated scoring and checking of performance results from the test\n# - Using metrics-by-endpoint plugin to enable reporting of metrics\n# for each individual URL in the test\nconfig:\n # This is a test server run by team Artillery\n # It's designed to be highly scalable and withstand\n # traffic spikes of millions of requests per second\n target: http://asciiart.artillery.io:8080\n phases:\n - duration: 60\n arrivalRate: 1\n rampTo: 5\n name: Warm up phase\n - duration: 60\n arrivalRate: 5\n rampTo: 10\n name: Ramp up load\n - duration: 30\n arrivalRate: 10\n rampTo: 30\n name: Spike phase\n # Load a couple of useful plugins\n # https://docs.art/reference/extensions\n plugins:\n ensure: {}\n apdex: {}\n metrics-by-endpoint: {}\n # Set a threshold of 25ms for calculating Apdex scores\n # https://docs.art/reference/extensions/apdex\n apdex:\n threshold: 100\n # Configure automated checks\n # https://docs.art/reference/extensions/ensure\n ensure:\n thresholds:\n - http.response_time.p99: 100\n - http.response_time.p95: 75\nscenarios:\n - flow:\n - loop:\n - get:\n url: \"/dino\"\n - get:\n url: \"/pony\"\n - get:\n url: \"/armadillo\"\n count: 100\n" }, { "path": "examples/browser-load-testing-playwright/README.md", "content": "# Load testing and smoke testing with headless browsers\n\nArtillery can run Playwright scripts as performance tests. This example shows you how to run a simple load test, a smoke test, and how to track custom metrics for part of the flow.\n\n- [Why load test with headless browsers?](https://www.artillery.io/docs/playwright#why-load-test-with-headless-browsers)\n\n> [!TIP]\n> Artillery's uses YAML as its default configuration format, but Playwright tests can be written as TypeScript. The examples below are shown as both TypeScript-only, and YAML + TypeScript.\n\n## Example 1: A simple load test\n\nRun a simple load test using a plain Playwright script (recorded with `playwright codegen` - no Artillery-specific changes required):\n\n\n```sh\n# Run the TypeScript example:\nnpx artillery run browser-load-test.ts\n```\n\n```sh\n# The same example configured with a separate YAML config file:\nnpx artillery run browser-load-test.yml\n```\n\nThat's it! Artillery will create headless Chrome browsers that will run Playwright scenarios you provide.\n\n## Example 2: A smoke test\n\nThis example shows how we can implement a smoke test (or a synthetic check) using a headless browser.\n\nWe make use of Artillery's [CSV payload](https://artillery.io/docs/guides/guides/test-script-reference.html#Payload-files) feature to specify the URLs we want to check, and [custom metric API](https://artillery.io/docs/guides/guides/extending.html#Tracking-custom-metrics) to track custom metrics.\n\nFor every row in the CSV file, we'll load the URL from the first column, and check that the page contains the text specified in the second column.\n\nThe test will load each page specified in the CSV file, and check that it contains the text\n\n```sh\n# Run the TypeScript example:\nnpx artillery run browser-smoke-test.ts\n```\n\n```sh\n# The same example configured with a separate YAML config file:\nnpx artillery run browser-smoke-test.yml\n```\n\n## Example 3: Tracking custom metrics for part of the flow\n\nA common usage scenario is reporting performance metrics only for one part of a test flow. For example, you may be testing an ecommerce app with the following steps:\n\n1. Go to the homepage\n2. Search for a product\n3. Navigate to product page\n4. Add product to cart\n5. Login\n6. Complete checkout:\n - Enter a discount code\n - Update billing info\n - Check out\n\nYou may want to report performance metrics only for part 6 of the flow. Artillery lets you do that with its [custom metrics API](https://www.artillery.io/docs/guides/guides/extension-apis#tracking-custom-metrics).\n\nSee the example in [./advanced-custom-metric-for-subflow.yml](./advanced-custom-metric-for-subflow.yml) and specifically the `multistepWithCustomMetrics()` test in [flows.js](./flows.js) for details.\n\n\n## Creating Playwright scripts\n\nYou can use the built-in `playwright codegen` tool to generate test scripts quickly by performing user actions in the real browser. That's how the code in `flows.js` in this example was created. It's just a Playwright script, there's nothing Artillery specific about it. **Speed up test creation time by 10x.**\n\n## Front-end AND back-end metrics\n\nArtillery will emit both backend and browser-level performance metrics when running this test, so that you can see both how long resources such as static assets took to load, as well as page-level metrics, such as how long it took for pages to become interactive.\n\n```\nvusers.created_by_name.Dev account signup: .................. 10\nvusers.created.total: ....................................... 10\nvusers.completed: ........................................... 10\nvusers.session_length:\n min: ...................................................... 3884.2\n max: ...................................................... 13846.2\n median: ................................................... 12711.5\n p95: ...................................................... 12968.3\n p99: ...................................................... 12968.3\nbrowser.page_domcontentloaded: ........................... 20\nbrowser.response_time:\n min: ...................................................... 0\n max: ...................................................... 1778.8\n median: ................................................... 37.7\n p95: ...................................................... 3828.5\n p99: ...................................................... 3828.5\nbrowser.page_domcontentloaded.dominteractive:\n min: ...................................................... 297\n max: ...................................................... 2247\n median: ................................................... 1002.4\n p95: ...................................................... 1939.5\n p99: ...................................................... 1939.5\nbrowser.page_domcontentloaded.dominteractive.https://artillery.io/:\n min: ...................................................... 427\n max: ...................................................... 2247\n median: ................................................... 1130.2\n p95: ...................................................... 1939.5\n p99: ...................................................... 1939.5\nbrowser.page_domcontentloaded.dominteractive.https://artillery.io/pro/:\n min: ...................................................... 297\n max: ...................................................... 1927\n median: ................................................... 596\n p95: ...................................................... 1380.5\n p99: ...................................................... 1380.5\n```\n\n## Scaling browser tests\n\nRunning headless browsers in parallel will quickly exhaust CPU and memory of a single machine.\n\nArtillery has built-in support for cloud-native distributed load testing on AWS Fargate or Azure Container Instances.\n\nSee our guide for [Distributed load testing](https://www.artillery.io/docs/load-testing-at-scale) for more information.\n" }, { "path": "examples/browser-load-testing-playwright/browser-load-test.ts", "content": "export const config = {\n target: 'https://www.artillery.io',\n phases: [\n {\n arrivalRate: 1,\n duration: 10\n }\n ],\n engines: {\n playwright: {\n trace: true\n }\n }\n};\n\nexport const before = {\n engine: 'playwright',\n testFunction: async function beforeFunctionHook(_page, userContext, _events) {\n // Any scenario variables we add via userContext.vars in this before hook will be available in every VU\n userContext.vars.testStartTime = new Date();\n }\n};\n\nexport const scenarios = [\n {\n engine: 'playwright',\n name: 'check_out_core_concepts_scenario',\n testFunction: async function checkOutArtilleryCoreConceptsFlow(\n page,\n _userContext,\n _events,\n test\n ) {\n await test.step('Go to Artillery', async () => {\n const requestPromise = page.waitForRequest('https://artillery.io/');\n await page.goto('https://artillery.io/');\n const _req = await requestPromise;\n });\n await test.step('Go to docs', async () => {\n await page.getByRole('link', { name: 'Docs' }).first().click();\n await page.waitForURL('https://www.artillery.io/docs');\n });\n\n await test.step('Go to core concepts', async () => {\n await page\n .getByRole('link', {\n name: 'Start a new GitHub Discussion'\n })\n .click();\n\n await page.waitForURL(\n 'https://github.com/artilleryio/artillery/discussions'\n );\n });\n }\n }\n];\n" }, { "path": "examples/browser-load-testing-playwright/browser-load-test.yml", "content": "config:\n target: \"https://www.artillery.io\"\n phases:\n - arrivalRate: 1\n duration: 10\n engines:\n playwright: {}\n processor: ./flows.js\nscenarios:\n - name: \"check_out_core_concepts_scenario\"\n engine: playwright\n flowFunction: \"checkOutArtilleryCoreConceptsFlow\"\n" }, { "path": "examples/browser-load-testing-playwright/browser-smoke-test.ts", "content": "import { checkPage } from './flows';\nexport const config = {\n target: 'https://www.artillery.io',\n phases: [\n {\n arrivalCount: 1,\n duration: 1\n }\n ],\n payload: {\n path: './pages.csv',\n fields: ['url', 'title'],\n loadAll: true,\n name: 'pageChecks'\n },\n engines: {\n playwright: {}\n }\n};\n\nexport const scenarios = [\n {\n name: 'smoke_test_page',\n engine: 'playwright',\n testFunction: checkPage\n }\n];\n" }, { "path": "examples/browser-load-testing-playwright/browser-smoke-test.yml", "content": "config:\n target: \"https://www.artillery.io\"\n payload:\n - path: ./pages.csv\n fields:\n - \"url\"\n - \"title\"\n loadAll: true\n name: pageChecks\n engines:\n playwright: {}\n processor: ./flows.js\nscenarios:\n - name: smoke_test_page\n engine: playwright\n flowFunction: checkPage\n" }, { "path": "examples/browser-load-testing-playwright/browser-test-with-steps.yml", "content": "config:\n target: \"https://www.artillery.io\"\n phases:\n - arrivalRate: 1\n duration: 10\n engines:\n playwright: {}\n processor: ./flows.js\nscenarios:\n - name: flow_with_multiple_steps\n engine: playwright\n flowFunction: \"multistepWithCustomMetrics\"\n" }, { "path": "examples/browser-load-testing-playwright/flows.js", "content": "//\n// The code in this function was generated with\n// playwright codegen\n// https://playwright.dev/docs/codegen\n//\nasync function checkOutArtilleryCoreConceptsFlow(\n page,\n _userContext,\n _events,\n test\n) {\n await test.step('Go to Artillery', async () => {\n const requestPromise = page.waitForRequest('https://artillery.io/');\n await page.goto('https://artillery.io/');\n const _req = await requestPromise;\n });\n await test.step('Go to docs', async () => {\n await page.getByRole('link', { name: 'Docs' }).first().click();\n await page.waitForURL('https://www.artillery.io/docs');\n });\n\n await test.step('Go to core concepts', async () => {\n await page\n .getByRole('link', {\n name: 'Review core concepts'\n })\n .click();\n\n await page.waitForURL(\n 'https://www.artillery.io/docs/get-started/core-concepts'\n );\n });\n}\n\n//\n// A simple smoke test using a headless browser:\n//\nasync function checkPage(page, userContext, events) {\n // The pageChecks variable is created via the config.payload\n // section in the YML config file\n for (const { url, title } of userContext.vars.pageChecks) {\n const response = await page.goto(url);\n if (response.status() !== 200) {\n events.emit('counter', `user.status_check_failed.${url}`, 1);\n } else {\n events.emit('counter', `user.status_check_ok.${url}`, 1);\n }\n\n const isElementVisible = await page.getByText(title).isVisible();\n\n if (!isElementVisible) {\n events.emit('counter', `user.element_check_failed.${title}`, 1);\n }\n\n await page.reload();\n }\n}\n\nasync function multistepWithCustomMetrics(page, _userContext, _events, test) {\n //1. we get the convenience step() helper from the test object.\n //More information: https://www.artillery.io/docs/reference/engines/playwright#teststep-argument\n const { step } = test;\n\n //2. We can now wrap parts of our Playwright script in step() calls\n await step('go_to_artillery_io', async () => {\n await page.goto('https://www.artillery.io');\n });\n\n await step('go_to_cloud_page', async () => {\n await page.goto('https://www.artillery.io/cloud');\n });\n\n await step('go_to_docs', async () => {\n await page.goto('https://www.artillery.io/docs');\n });\n\n // 3. latency metrics will be emitted automatically throughout the test for each step.\n // For more information on custom metrics, please see: https://www.artillery.io/docs/guides/guides/extension-apis#tracking-custom-metrics\n}\n\nmodule.exports = {\n checkOutArtilleryCoreConceptsFlow,\n checkPage,\n multistepWithCustomMetrics\n};\n" }, { "path": "examples/browser-load-testing-playwright/pages.csv", "content": "https://www.artillery.io/,trademark of Artillery Software Inc\nhttps://www.artillery.io/docs,Get started\nhttps://www.artillery.io/changelog,Feature updates and improvements to Artillery" }, { "path": "examples/browser-playwright-reuse-authentication/README.md", "content": "# Reuse Authentication in Playwright tests\n\nPlaywright allows you to use `sessionStorage` to reuse authentication in your tests. This can be especially useful in Load Testing, where you might be interested in testing other parts of the application at scale, without having to exercise the login backend (which is sometimes third-party) with every VU.\n\nThis example shows you how to do that.\n\n## Pre-requisites\n\nBefore running the example, install Artillery:\n\n```sh\nnpm install artillery\n```\n\n## Example\n\nThe example leverages [`storageState`] similarly to [Playwright documentation](https://playwright.dev/docs/auth#basic-shared-account-in-all-tests). It's simple to set this up with Artillery, but there are some small differences:\n\n* You set the `storageState` path in [`config.engines.playwright.contextOptions`](https://www.artillery.io/docs/reference/engines/playwright#configuration), instead of a Playwright config file. Note that the [`$dirname` utility](https://www.artillery.io/docs/reference/test-script#test-level-variables) is needed to resolve the full path for Playwright.\n* A [before hook](https://www.artillery.io/docs/reference/test-script#before-and-after-sections) will run the setup function (`loginUserAndSaveStorage` in this example), rather than referencing it as a Playwright project.\n* You will need to create the storageState JSON (`storage.json` in this example) file first as an empty object (`{}`), in the same directory where you run the test from. This is because the first time Artillery runs, it will run the `before` hook, and the file referenced in `config` won't be available.\n\nThat's it!\n\nTo run the fully configured example, run:\n\n```sh \nnpx artillery run scenario.yml\n```\n\n*Note: this example runs with headless disabled, so you can easily observe the login being reused.*\n\n## Running the example in Fargate\n\nWant to run 1,000 browsers at the same time? 10,000? more? Run your load tests on AWS Fargate with [built-in support in Artillery](https://www.artillery.io/docs/load-testing-at-scale/aws-fargate). Just make sure to tell Artillery to include the `storage.json` file. For example:\n\n```yaml\n config:\n ...\n includeFiles:\n - ./storage.json\n```\n\nThis ensures the file is bundled to Fargate workers correctly. You will also need to make sure the test is running using headless mode. Then, run the test:\n\n```sh \nnpx artillery run:fargate scenario.yml --count 2\n```\n\n*Note: `before` hooks run once per Fargate worker, so the authentication step will run as many times as the `--count` you set.*\n\n## Playwright Version Compatibility\n\nIt's important to note that Artillery uses specific versions of Playwright, which are listed in our [documentation](https://www.artillery.io/docs/reference/engines/playwright#playwright-compatibility).\n\nThe `@playwright/test` version installed in your package.json should ideally match the version Artillery is currently using." }, { "path": "examples/browser-playwright-reuse-authentication/flow.js", "content": "const { expect } = require('@playwright/test');\nconst fs = require('node:fs');\n\nasync function loginUserAndSaveStorage(page, context) {\n // NOTE: we use the $dirname utility so Playwright can resolve the full path\n const storageState = JSON.parse(\n fs.readFileSync(`${context.vars.$dirname}/storage.json`, 'utf8')\n );\n if (Object.keys(storageState).length > 0) {\n console.log('Already logged in. Skipping login.');\n return;\n }\n\n //1. navigate to page and assert that we are not logged in\n await page.goto(context.vars.target);\n await expect(page.getByText('Authentication example')).toBeVisible();\n\n //2. click login button and make sure we are redirected to `/login`\n await page.getByRole('link', { name: 'Login' }).click();\n await page.waitForURL('**/login');\n\n //3. fill in your github username and click login button\n await page.getByLabel('username').fill(context.vars.githubUsername);\n await page.getByRole('button', { name: 'Login' }).click();\n\n //4. ensure we are redirected to profile page and logged in\n await page.waitForURL('**/profile-sg');\n await expect(page.getByText('Your GitHub profile')).toBeVisible();\n\n //5. save iron session cookie to storage.json\n // NOTE: we use the $dirname utility so Playwright can resolve the full path\n await page\n .context()\n .storageState({ path: `${context.vars.$dirname}/storage.json` });\n}\n\nasync function goToProfilePageAndLogout(page, context, _events, test) {\n const { step } = test;\n const profileHeaderText = 'Profile (Static Generation, recommended)';\n\n await step('go_to_page', async () => {\n await page.goto(context.vars.target);\n await expect(page.getByText(profileHeaderText)).toBeVisible();\n });\n\n await step('go_to_profile_page', async () => {\n await page.getByRole('link', { name: profileHeaderText }).click();\n await page.waitForURL('**/profile-sg');\n await expect(page.getByText('Your Github Profile')).toBeVisible();\n });\n\n await step('logout', async () => {\n await page.getByRole('link', { name: 'Logout' }).click();\n await page.waitForURL('**/login');\n });\n}\n\nmodule.exports = {\n loginUserAndSaveStorage,\n goToProfilePageAndLogout\n};\n" }, { "path": "examples/browser-playwright-reuse-authentication/package.json", "content": "{\n \"name\": \"browser-playwright-reuse-authentication\",\n \"version\": \"1.0.0\",\n \"description\": \"Playwright allows you to use `sessionStorage` to reuse authentication in your tests. This can be especially useful in Load Testing, where you might be interested in testing other parts of the application at scale, without having to exercise the login backend (which is sometimes third-party) with every VU.\",\n \"main\": \"flow.js\",\n \"scripts\": {\n \"test\": \"echo \\\"Error: no test specified\\\" && exit 1\"\n },\n \"keywords\": [],\n \"author\": \"\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"@playwright/test\": \"1.45.3\"\n }\n}\n" }, { "path": "examples/browser-playwright-reuse-authentication/scenario.yml", "content": "config:\n target: https://iron-session-example.vercel.app/\n phases:\n - arrivalRate: 1\n duration: 10\n engines:\n playwright:\n launchOptions:\n headless: false\n contextOptions:\n # NOTE: we use the $dirname utility so Playwright can resolve the full path\n storageState: \"{{ $dirname }}/storage.json\"\n processor: ./flow.js\n variables:\n githubUsername: \"bernardobridge\"\n # NOTE: add this if you want to run the test in fargate. make sure to remove headless:false too\n # includeFiles:\n # - ./storage.json\n\nbefore:\n engine: playwright\n flowFunction: loginUserAndSaveStorage\n\nscenarios:\n - name: go_to_profile_page_and_logout\n engine: playwright\n flowFunction: goToProfilePageAndLogout\n" }, { "path": "examples/browser-playwright-reuse-authentication/storage.json", "content": "{}\n" }, { "path": "examples/browser-playwright-reuse-typescript/README.md", "content": "# Reusing Typescript Playwright code as Artillery code\n\nThis example shows you how you can reuse a pure Playwright codebase written in Typescript as Artillery tests.\n\nThe `e2e/` folder contains the Playwright test (`e2e/tests/get-issues.spec.ts`). The logic in that test has been abstracted to a helper in `e2e/helpers/index.ts`.\n\nThe `performance` folder contains the Artillery/Playwright test. Using the same helper, we can construct an Artillery test by importing it in our processor file (`./performance/processor.ts`) and calling it as the `testFunction` in our test (`./performance/search-for-ts-doc.yml`). The `target` used matches the `baseURL` from the playwright config in `e2e/playwright.config.ts`.\n\n## Running the tests\n\nFirst, run `npm install`.\n\nTo run the pure Playwright example:\n`cd e2e && npx playwright run`\n\nTo run the same test as an Artillery test:\n`cd performance && npx artillery run search-for-ts-doc.yml`\n\n## Using a Page Object Model\n\nIn this example we didn't use a [Page Object Model](https://playwright.dev/docs/pom). However, similar concepts can be applied. You can have a centralised Page Object Model with methods for most UI actions, or even specific user flows, and then just call those as appropriate in both Playwright and Artillery tests.\n\n## Playwright Version Compatibility\n\nIt's important to note that Artillery uses specific versions of Playwright, which are listed in our [documentation](https://www.artillery.io/docs/reference/engines/playwright#playwright-compatibility).\n\nYour regular Playwright tests must use features that are compatible with the versions used by Artillery.\n\nThe `@playwright/test` version installed in your package.json should ideally match the version Artillery is currently using." }, { "path": "examples/browser-playwright-reuse-typescript/e2e/.gitignore", "content": "playwright-report/\ntest-results/" }, { "path": "examples/browser-playwright-reuse-typescript/e2e/helpers/index.ts", "content": "import { type Page, expect } from '@playwright/test';\n\nexport const goToDocsAndSearch = async (page: Page, step) => {\n await step('go_to_artillery_io', async () => {\n await page.goto('/');\n });\n\n await step('go_to_docs', async () => {\n await page.getByRole('link', { name: 'Docs' }).first().click();\n await expect(page).toHaveURL('/docs');\n await expect(page.getByText('Get started')).toBeVisible();\n });\n\n await step('search_for_ts_doc_and_goto', async () => {\n await page\n .getByRole('searchbox', { name: 'Search documentationâ€Ļ' })\n .click();\n await page.keyboard.type('typescript', { delay: 100 });\n await page\n .getByRole('link', { name: 'processor - load custom code' })\n .click();\n await expect(page.getByText('processor - load custom code')).toBeVisible();\n });\n};\n" }, { "path": "examples/browser-playwright-reuse-typescript/e2e/playwright.config.ts", "content": "import { defineConfig, devices } from '@playwright/test';\n\nexport default defineConfig({\n testDir: 'tests',\n reporter: 'html',\n use: {\n baseURL: 'https://www.artillery.io/'\n },\n projects: [\n {\n name: 'chromium',\n use: { ...devices['Desktop Chrome'] }\n }\n ]\n});\n" }, { "path": "examples/browser-playwright-reuse-typescript/e2e/tests/get-issues.spec.ts", "content": "import { goToDocsAndSearch } from '../helpers';\nimport { test } from '@playwright/test';\n\ntest('search and go to doc page', async ({ page }) => {\n await goToDocsAndSearch(page, test.step);\n});\n" }, { "path": "examples/browser-playwright-reuse-typescript/package.json", "content": "{\n \"name\": \"browser-playwright-reuse-typescript\",\n \"version\": \"1.0.0\",\n \"description\": \"This example shows you how you can reuse a pure Playwright codebase written in Typescript as Artillery tests.\",\n \"main\": \"index.js\",\n \"scripts\": {\n \"test\": \"echo \\\"Error: no test specified\\\" && exit 1\"\n },\n \"keywords\": [],\n \"author\": \"\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"@playwright/test\": \"1.45.3\"\n }\n}\n" }, { "path": "examples/browser-playwright-reuse-typescript/performance/processor.ts", "content": "import { goToDocsAndSearch } from '../e2e/helpers';\n\nexport async function playwrightTest(page, vuContext, events, test) {\n const { step } = test;\n\n await goToDocsAndSearch(page, step);\n}\n" }, { "path": "examples/browser-playwright-reuse-typescript/performance/search-for-ts-doc.yml", "content": "config:\n target: \"https://www.artillery.io/\"\n phases:\n - duration: 1\n arrivalRate: 1\n name: \"Phase 1\"\n processor: \"./processor.ts\"\n engines:\n playwright: {}\n\nscenarios:\n - engine: playwright\n testFunction: \"playwrightTest\"" }, { "path": "examples/cicd/README.md", "content": "# Artillery CI/CD Examples\n\nThis repo contains examples of how to integrate [Artillery](https://artillery.io/) with different continuous integration and continuous delivery services.\n\n## CI/CD examples\n\n- [github-actions](./github-actions) - a GitHub Actions workflow for running Artillery load tests\n- [azure-devops](./azure-devops) - an Azure Pipelines setup for running Artillery load tests\n- [circleci](./circleci) - a CircleCI workflow for running Artillery load tests\n- [gitlab-ci-cd](./gitlab-ci-cd) - a GitLab CI/CD setup for running Artillery load tests\n- [jenkins](./jenkins) - a Jenkins Pipeline for running Artillery load tests\n- [aws-codebuild](./aws-codebuild) - an AWS CodeBuild buildspec for running Artillery load tests\n\n# Contributing\n\nWould you like to share an example showing how to integrate Artillery with a CI/CD service not covered here? Send us a PR 💜\n" }, { "path": "examples/cicd/aws-codebuild/README.md", "content": "# Load Testing With Artillery and AWS CodeBuild\n\nThis repo contains an example for running [Artillery](https://artillery.io/) load tests on AWS CodeBuild.\n\nFor more details, read the [\"Integrating Artillery with AWS CodeBuild\"](https://artillery.io/docs/guides/integration-guides/aws-codebuild.html) section in the Artillery documentation.\n\n## Artillery test script\n\nThe [example Artillery script](tests/performance/socket-io.yml) will test a running Socket.IO server. You can run the test script and see it in action: https://repl.artillery.io/?s=4ae41a53-1fa7-4256-9d1c-2a80202c1ca2&hR=true\n\n## AWS CodeBuild buildspec\n\nThe [included AWS CodeBuild buildspec configuration file](buildspec.yml) is set up to run the load test, generate an HTML report, and store the artifact in an S3 bucket for later retrieval. You can also schedule the load test to run on a recurring schedule using Amazon EventBridge, as explained in the Artillery documentation.\n" }, { "path": "examples/cicd/aws-codebuild/buildspec.yml", "content": "version: 0.2\n\nphases:\n install:\n commands:\n - npm install -g artillery@latest\n pre_build:\n commands:\n - mkdir reports\n build:\n commands:\n - artillery run --output reports/report.json tests/performance/socket-io.yml\n\nartifacts:\n files:\n - 'reports/*'\n name: artifacts/$CODEBUILD_BUILD_NUMBER\n" }, { "path": "examples/cicd/aws-codebuild/tests/performance/socket-io.yml", "content": "config:\n target: \"http://lab.artillery.io\"\n # As an example, we'll only run a single virtual user in this\n # test script. For real-world load testing, you'll want to\n # adjust your load phases according to your needs.\n phases:\n - duration: 1\n arrivalRate: 1\n ensure:\n maxErrorRate: 1\n max: 500\n\nscenarios:\n - name: \"emit_an_event\"\n engine: \"socketio\"\n flow:\n - emit:\n channel: \"echo\"\n data: \"Hello from Artillery\"\n response:\n channel: \"echoResponse\"\n data: \"Hello from Artillery\"\n" }, { "path": "examples/cicd/azure-devops/README.md", "content": "# Load Testing With Artillery and Azure DevOps\n\nThis repo contains an example for running [Artillery](https://artillery.io/) load tests on [Azure DevOps](https://azure.microsoft.com/en-us/services/devops/) using [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/).\n\nFor more details, read the [\"Integrating Artillery with Azure DevOps\"](https://artillery.io/docs/guides/integration-guides/azure-devops.html) section in the Artillery documentation.\n\n## Artillery test script\n\nThe [example Artillery script](tests/performance/socket-io.yml) will test a running Socket.IO server. You can run the test script and see it in action: https://repl.artillery.io/?s=4ae41a53-1fa7-4256-9d1c-2a80202c1ca2&hR=true\n\n## Azure Pipelines setup\n\nThe [included Azure Pipelines YAML file](azure-pipelines.yml) will trigger the load test after any code push to the `main` branch of the repository, and is set up to run on a schedule every day at 12:00 AM (UTC). The setup will also generate an HTML report and store the artifact for later retrieval.\n" }, { "path": "examples/cicd/azure-devops/azure-pipelines.yml", "content": "trigger:\n- main\n\nschedules:\n- cron: \"0 0 * * *\"\n displayName: 'Midnight (UTC) performance test'\n branches:\n include:\n - main\n\npool:\n vmImage: ubuntu-latest\n\nsteps:\n- task: NodeTool@0\n inputs:\n versionSpec: '12.x'\n displayName: 'Install Node.js v12.x'\n\n- script: npm install -g artillery@latest\n displayName: 'Install Artillery'\n\n- script: mkdir $(System.DefaultWorkingDirectory)/reports\n displayName: 'Make reports directory'\n\n- script: artillery run --output reports/report.json tests/performance/socket-io.yml\n displayName: 'Execute load tests'\n\n- publish: $(System.DefaultWorkingDirectory)/reports\n artifact: artillery-test-report\n" }, { "path": "examples/cicd/azure-devops/tests/performance/socket-io.yml", "content": "config:\n target: \"http://lab.artillery.io\"\n # As an example, we'll only run a single virtual user in this\n # test script. For real-world load testing, you'll want to\n # adjust your load phases according to your needs.\n phases:\n - duration: 1\n arrivalRate: 1\n ensure:\n maxErrorRate: 1\n max: 500\n\nscenarios:\n - name: \"emit_an_event\"\n engine: \"socketio\"\n flow:\n - emit:\n channel: \"echo\"\n data: \"Hello from Artillery\"\n response:\n channel: \"echoResponse\"\n data: \"Hello from Artillery\"\n" }, { "path": "examples/cicd/circleci/.circleci/config.yml", "content": "version: 2.1\n\njobs:\n artillery:\n docker:\n - image: artilleryio/artillery:latest\n steps:\n - checkout\n\n - run:\n name: Make reports directory\n command: mkdir reports\n\n - run:\n name: Execute load tests\n command: /home/node/artillery/bin/artillery run --output reports/report.json tests/performance/socket-io.yml\n\n - store_artifacts:\n path: reports\n\nworkflows:\n load-tests:\n jobs:\n - artillery:\n filters:\n branches:\n only: main\n nightly:\n jobs:\n - artillery\n triggers:\n - schedule:\n cron: \"0 0 * * *\"\n filters:\n branches:\n only:\n - main\n" }, { "path": "examples/cicd/circleci/README.md", "content": "# Load Testing With Artillery and CircleCI\n\nThis repo contains an example for running [Artillery](https://artillery.io/) load tests on CircleCI.\n\nFor more details, read the [\"Integrating Artillery with CircleCI\"](https://artillery.io/docs/guides/integration-guides/circleci.html) section in the Artillery documentation.\n\n## Artillery test script\n\nThe [example Artillery script](tests/performance/socket-io.yml) will test a running Socket.IO server. You can run the test script and see it in action: https://repl.artillery.io/?s=4ae41a53-1fa7-4256-9d1c-2a80202c1ca2&hR=true\n\n## CircleCI workflow\n\nThe [included CircleCI configuration file](.circleci/config.yml) will trigger the load test after any code push to the `main` branch of the repository, and is set up to run on a schedule every day at 12:00 AM (UTC) against the `main` branch. The workflow will also generate an HTML report and store the artifact for later retrieval.\n" }, { "path": "examples/cicd/circleci/tests/performance/socket-io.yml", "content": "config:\n target: \"http://lab.artillery.io\"\n # As an example, we'll only run a single virtual user in this\n # test script. For real-world load testing, you'll want to\n # adjust your load phases according to your needs.\n phases:\n - duration: 1\n arrivalRate: 1\n ensure:\n maxErrorRate: 1\n max: 500\n\nscenarios:\n - name: \"emit_an_event\"\n engine: \"socketio\"\n flow:\n - emit:\n channel: \"echo\"\n data: \"Hello from Artillery\"\n response:\n channel: \"echoResponse\"\n data: \"Hello from Artillery\"\n" }, { "path": "examples/cicd/github-actions/.github/workflows/load-test.yml", "content": "name: Artillery Socket.IO Load Test\n\non:\n push:\n branches:\n - main\n schedule:\n - cron: '0 0 * * *'\n\njobs:\n artillery:\n runs-on: ubuntu-latest\n\n container: artilleryio/artillery:latest\n\n steps:\n - name: Checkout repository\n uses: actions/checkout@v2\n\n - name: Make reports directory\n run: mkdir reports\n\n - name: Execute load tests\n run: /home/node/artillery/bin/run run --output reports/report.json tests/performance/socket-io.yml\n\n - name: Generate HTML report\n run: /home/node/artillery/bin/run report --output reports/report.html reports/report.json\n\n - name: Archive test report\n uses: actions/upload-artifact@v2\n with:\n name: artillery-test-report\n path: reports/*\n" }, { "path": "examples/cicd/github-actions/README.md", "content": "# Load Testing With Artillery and GitHub Actions\n\nThis repo contains an example for running [Artillery](https://artillery.io/) load tests on GitHub Actions.\n\nFor more details, read the [\"Integrating Artillery with GitHub Actions\"](https://artillery.io/docs/guides/integration-guides/github-actions.html) section in the Artillery documentation.\n\n## Artillery test script\n\nThe [example Artillery script](tests/performance/socket-io.yml) will test a running Socket.IO server. You can run the test script and see it in action: https://repl.artillery.io/?s=4ae41a53-1fa7-4256-9d1c-2a80202c1ca2&hR=true\n\n## GitHub Actions workflow\n\nThe [included GitHub Actions workflow](.github/workflows/load-test.yml) will trigger the load test after any code push to the `main` branch of the repository, and is set up to run on a schedule every day at 12:00 AM (UTC). The workflow will also generate an HTML report and store the artifact for later retrieval.\n" }, { "path": "examples/cicd/github-actions/tests/performance/socket-io.yml", "content": "config:\n target: \"http://lab.artillery.io\"\n # As an example, we'll only run a single virtual user in this\n # test script. For real-world load testing, you'll want to\n # adjust your load phases according to your needs.\n phases:\n - duration: 1\n arrivalRate: 1\n ensure:\n maxErrorRate: 1\n max: 500\n\nscenarios:\n - name: \"emit_an_event\"\n engine: \"socketio\"\n flow:\n - emit:\n channel: \"echo\"\n data: \"Hello from Artillery\"\n response:\n channel: \"echoResponse\"\n data: \"Hello from Artillery\"\n" }, { "path": "examples/cicd/gitlab-ci-cd/.gitlab-ci.yml", "content": "artillery:\n image:\n name: artilleryio/artillery:latest\n entrypoint: [\"\"]\n script: |\n mkdir reports\n /home/node/artillery/bin/artillery run --output reports/report.json tests/performance/socket-io.yml\n artifacts:\n paths:\n - reports\n" }, { "path": "examples/cicd/gitlab-ci-cd/README.md", "content": "# Load Testing With Artillery and GitLab CI/CD\n\nThis repo contains an example for running [Artillery](https://artillery.io/) load tests on GitLab CI/CD.\n\nFor more details, read the [\"Integrating Artillery with GitLab CI/CD\"](https://artillery.io/docs/guides/integration-guides/gitlab-ci-cd.html) section in the Artillery documentation.\n\n## Artillery test script\n\nThe [example Artillery script](tests/performance/socket-io.yml) will test a running Socket.IO server. You can run the test script and see it in action: https://repl.artillery.io/?s=4ae41a53-1fa7-4256-9d1c-2a80202c1ca2&hR=true\n\n## GitHub Actions workflow\n\nThe [included GitLab CI/CD configuration file](.gitlab-ci.yml) will trigger the load test after any code push to the repository, generate an HTML report and store the artifact for later retrieval.\n" }, { "path": "examples/cicd/gitlab-ci-cd/tests/performance/socket-io.yml", "content": "config:\n target: \"http://lab.artillery.io\"\n # As an example, we'll only run a single virtual user in this\n # test script. For real-world load testing, you'll want to\n # adjust your load phases according to your needs.\n phases:\n - duration: 1\n arrivalRate: 1\n ensure:\n maxErrorRate: 1\n max: 500\n\nscenarios:\n - name: \"emit_an_event\"\n engine: \"socketio\"\n flow:\n - emit:\n channel: \"echo\"\n data: \"Hello from Artillery\"\n response:\n channel: \"echoResponse\"\n data: \"Hello from Artillery\"\n" }, { "path": "examples/cicd/jenkins/Jenkinsfile", "content": "pipeline {\n agent {\n docker {\n image 'artilleryio/artillery:latest'\n args '-u root:root -i --entrypoint='\n }\n }\n\n triggers {\n cron('0 0 * * *')\n }\n\n stages {\n stage('Load Test') {\n steps {\n sh 'mkdir reports'\n sh '/home/node/artillery/bin/artillery run --output reports/report.json tests/performance/socket-io.yml'\n }\n }\n }\n\n post {\n success {\n archiveArtifacts 'reports/*'\n }\n }\n}\n" }, { "path": "examples/cicd/jenkins/README.md", "content": "# Load Testing With Artillery and Jenkins\n\nThis repo contains an example for running [Artillery](https://artillery.io/) load tests on Jenkins.\n\nFor more details, read the [\"Integrating Artillery with Jenkins\"](https://artillery.io/docs/guides/integration-guides/jenkins.html) section in the Artillery documentation.\n\n## Artillery test script\n\nThe [example Artillery script](tests/performance/socket-io.yml) will test a running Socket.IO server. You can run the test script and see it in action: https://repl.artillery.io/?s=4ae41a53-1fa7-4256-9d1c-2a80202c1ca2&hR=true\n\n## Jenkins Pipline\n\nThe [included Jenkins Pipeline configuration](Jenkinsfile) is set up to run the load test on a schedule every day at 12:00 AM (based on the Jenkins server timezone). The Pipeline will also generate an HTML report and store the artifact for later retrieval.\n" }, { "path": "examples/cicd/jenkins/tests/performance/socket-io.yml", "content": "config:\n target: \"http://lab.artillery.io\"\n # As an example, we'll only run a single virtual user in this\n # test script. For real-world load testing, you'll want to\n # adjust your load phases according to your needs.\n phases:\n - duration: 1\n arrivalRate: 1\n ensure:\n maxErrorRate: 1\n max: 500\n\nscenarios:\n - name: \"emit_an_event\"\n engine: \"socketio\"\n flow:\n - emit:\n channel: \"echo\"\n data: \"Hello from Artillery\"\n response:\n channel: \"echoResponse\"\n data: \"Hello from Artillery\"\n" }, { "path": "examples/functional-testing-with-expect-plugin/.gitignore", "content": "node_modules\n" }, { "path": "examples/functional-testing-with-expect-plugin/README.md", "content": "# Functional testing on Artillery\n\nThis example shows you how to run both load and functional tests with a single Artillery test script using the `artillery-plugin-expect` plugin.\n\n## Running the API server\n\nThis example includes an Express.js application running an HTTP API using an in-memory SQLite 3 database.\n\nFirst, install the server dependencies:\n\n```shell\nnpm install\n```\n\nAfter installing the dependencies, start the API server:\n\n```shell\nnode app.js\n```\n\nThis command will start a server listening at http://localhost:3000/.\n\n## Running Artillery tests\n\nThis directory contains a test script (`functional-load-tests.yml`) which defines two environments:\n\n- `load` - this defines a load phase that generates 25 virtual users per second for 10 minutes.\n- `functional` - this enables the `artillery-plugin-expect` plugin. We don't want to enable it in the `load` phase as it would generate a lot of console output\n\nOnce the API server is up and running, you can run either load tests or functional tests using the same test script, using the `--environment` flag.\n\nTo run load tests:\n\n```shell\nnpx artillery run --environment load functional-load-tests.yml\n```\n\nTo run functional tests:\n\n```shell\nnpx artillery run --environment functional functional-load-tests.yml\n```\n" }, { "path": "examples/functional-testing-with-expect-plugin/app.js", "content": "const express = require('express');\nconst app = express();\nconst port = 3000;\n\nconst sqlite3 = require('sqlite3').verbose();\nconst db = new sqlite3.Database(':memory:');\n\napp.use(express.json());\n\napp.post('/users', (req, res) => {\n if (req.body.username === '') {\n res.status(422).send({ error: 'username is missing' });\n return;\n }\n\n db.run(\n 'INSERT INTO users (username) VALUES (?)',\n [req.body.username],\n function (err) {\n if (err === null) {\n res.status(201).send({ id: this.lastID, username: req.body.username });\n } else {\n res.status(500).send(err);\n }\n }\n );\n});\n\napp.get('/users/:id', (req, res) => {\n db.get('SELECT * FROM users WHERE id = ?', [req.params.id], (err, row) => {\n if (err !== null) {\n res.status(500).send(err);\n return;\n }\n\n if (row === undefined) {\n res.status(404).send({ error: 'User not found' });\n } else {\n res.status(200).send(row);\n }\n });\n});\n\napp.delete('/users/:id', (req, res) => {\n db.run('DELETE FROM users WHERE id = ?', [req.params.id], function (err) {\n if (err !== null) {\n res.status(500).send(err);\n return;\n }\n\n if (this.changes === 0) {\n res.status(404).send({ error: 'User not found' });\n } else {\n res.sendStatus(204);\n }\n });\n});\n\napp.listen(port, () => {\n db.run(`CREATE TABLE users (\n id INTEGER PRIMARY KEY,\n username TEXT NOT NULL UNIQUE\n )`);\n console.log(`App listening at http://localhost:${port}`);\n});\n" }, { "path": "examples/functional-testing-with-expect-plugin/functional-load-tests.yml", "content": "config:\n target: \"http://localhost:3000\"\n environments:\n load:\n phases:\n - duration: 10min\n arrivalRate: 25\n functional:\n # We don't need to specify a phase here. Artillery will\n # launch a single VU when there is no phase definition.\n plugins:\n expect: {}\n\nscenarios:\n - flow:\n - post:\n url: \"/users\"\n json:\n username: \"new-user\"\n capture:\n - json: \"$.id\"\n as: id\n expect:\n - statusCode: 201\n - contentType: json\n - hasProperty: username\n - equals:\n - \"new-user\"\n\n - get:\n url: \"/users/{{ id }}\"\n expect:\n - statusCode: 200\n - contentType: json\n - hasProperty: username\n - equals:\n - \"new-user\"\n\n - delete:\n url: \"/users/{{ id }}\"\n expect:\n - statusCode: 204\n" }, { "path": "examples/functional-testing-with-expect-plugin/package.json", "content": "{\n \"name\": \"load-and-functional-tests\",\n \"version\": \"1.0.0\",\n \"description\": \"Running load and functional tests from a single Artillery test script\",\n \"main\": \"app.js\",\n \"scripts\": {\n \"test:load\": \"artillery run --environment load functional-load-tests.yml\",\n \"test:functional\": \"artillery run --environment functional functional-load-tests.yml\"\n },\n \"author\": \"Dennis Martinez\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"express\": \"^4.17.1\",\n \"sqlite3\": \"^5.0.2\"\n }\n}\n" }, { "path": "examples/generating-vu-tokens/README.md", "content": "# generating-vu-tokens\n\nA common use-case when testing stateful APIs with Artillery is to generate a token that VUs can use for authentication (e.g. to use with an [OAuth2 Credentials Flow](https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow)). This example shows the basic structure of how that can be done with Artillery:\n\n- We can use a `before` block and a custom JS function to generate a token that will be shared by all VUs in the test (`sharedToken`)\n- We can use a `function` step with a custom JS function to generate a token unique to each VU (`vuToken`)\n- We can use a value stored in a variable (`sharedToken` or `vuToken`) in a request header for authentication (e.g. as a [Bearer token](https://oauth.net/2/bearer-tokens/#:~:text=Bearer%20Tokens%20are%20the%20predominant,such%20as%20JSON%20Web%20Tokens.))\n\nRun the script with:\n\n```\nartillery run auth-with-token.yml\n```\n\nThe output will look similar to the screenshot below. The value of `sharedToken` generated in the `before` block will be the same for every VU, whereas the value of VU-specific token in `vuToken` will differ between VUs.\n\n![auth tokens artillery](./screenshot.png)\n\nTo turn this into a working test-case for your API, replace the example implementation of one (or both) of the custom JS functions to implement the token generation logic you need, and tweak the way in which those tokens are sent as appropriate for your API.\n" }, { "path": "examples/generating-vu-tokens/auth-with-token.yml", "content": "config:\n target: http://asciiart.artillery.io:8080\n processor: \"./helpers.js\"\n phases:\n - arrivalCount: 10\n duration: 1\n \nbefore:\n flow:\n - function: \"generateSharedToken\"\n\nscenarios:\n - flow:\n - function: \"generateVUToken\"\n - log: \"VU id: {{ $uuid }}\"\n - log: \" shared token is: {{ sharedToken }}\"\n - log: \" VU-specific token is: {{ vuToken }}\"\n - get:\n headers:\n x-auth-one: \"{{ sharedToken }}\"\n x-auth-two: \"{{ vuToken }}\"\n url: \"/\"\n" }, { "path": "examples/generating-vu-tokens/helpers.js", "content": "module.exports = {\n generateSharedToken,\n generateVUToken\n};\n\nfunction generateSharedToken(context, _events, done) {\n context.vars.sharedToken = `shared-token-${Date.now()}`;\n return done();\n}\n\nfunction generateVUToken(context, _events, done) {\n context.vars.vuToken = `vu-token-${Date.now()}`;\n return done();\n}\n" }, { "path": "examples/graphql-api-server/.gitignore", "content": "node_modules/\nprisma/dev.db\nprisma/dev.db-journal\n" }, { "path": "examples/graphql-api-server/README.md", "content": "# Load testing an GraphQL service with Artillery\n\n\"graphql-load-testing-gh\"\n\nThis example shows you how to run load tests on a GraphQL API using Artillery.\n\n📖 See the companion blog post: [Using Artillery to load test GraphQL APIs](https://artillery.io/blog/using-artillery-to-load-test-graphql-apis/).\n\n## Running the GraphQL server\n\nThis example runs a GraphQL server using [Apollo Server](https://www.apollographql.com/docs/apollo-server/) and [Prisma](https://www.prisma.io/) with a SQLite 3 database for data persistence.\n\nFirst, install the server dependencies:\n\n```shell\nnpm install\n```\n\nNext, create the SQLite database and set up the required database tables by running the initial Prisma database migration:\n\n```shell\nnpx prisma migrate dev\n```\n\nAfter installing the dependencies and setting up the database, start the GraphQL server:\n\n```shell\nnode app.js\n```\n\nThis command will start the GraphQL API server listening at http://localhost:4000/. Once the server is up and running, you can explore the server using the [Apollo Sandbox](https://studio.apollographql.com/sandbox/).\n\n## Running Artillery test\n\nThis directory contains a test script (`graphql.yml`) which demonstrates how to use Artillery scenarios against a GraphQL server. The test script contains a scenario executing various queries and mutations on the GraphQL server.\n\nOnce the GraphQL server is up and running, execute the test script:\n\n```\nnpx artillery run graphql.yml\n```\n" }, { "path": "examples/graphql-api-server/app.js", "content": "const { ApolloServer, gql } = require('apollo-server');\nconst { PrismaClient } = require('@prisma/client');\n\nconst prisma = new PrismaClient();\n\nconst typeDefs = gql`\n input UserInput {\n username: String\n email: String\n }\n\n type User {\n id: ID!\n username: String\n email: String\n }\n\n type Query {\n users: [User]\n user(id: ID!): User\n userByUsername(username: String!): User\n userByEmail(username: String!): User\n }\n\n type Mutation {\n createUser(input: UserInput): User\n updateUser(id: ID!, input: UserInput): User\n deleteUser(id: ID!): User\n }\n`;\n\nconst resolvers = {\n Query: {\n users: async () => {\n return await prisma.user.findMany();\n },\n\n user: async (_, { id }) => {\n return await prisma.user.findUnique({\n where: { id: parseInt(id, 10) }\n });\n },\n\n userByEmail: async (_, { email }) => {\n return await prisma.user.findUnique({\n where: { email }\n });\n },\n\n userByUsername: async (_, { username }) => {\n return await prisma.user.findUnique({\n where: { username }\n });\n }\n },\n\n Mutation: {\n createUser: async (_, { input }) => {\n return await prisma.user.create({\n data: input\n });\n },\n\n updateUser: async (_, { id, input }) => {\n return await prisma.user.update({\n where: { id: parseInt(id, 10) },\n data: input\n });\n },\n\n deleteUser: async (_, { id }) => {\n return await prisma.user.delete({\n where: { id: parseInt(id, 10) }\n });\n }\n }\n};\n\nconst server = new ApolloServer({ typeDefs, resolvers });\n\nserver.listen().then(({ url }) => {\n console.log(`🚀 Server ready at ${url}`);\n});\n" }, { "path": "examples/graphql-api-server/graphql.yaml", "content": "config:\n target: \"http://localhost:4000/\"\n phases:\n - duration: 60\n arrivalRate: 25\n\nscenarios:\n - name: \"crud_from_db_scenario\"\n flow:\n - post:\n url: \"/\"\n json:\n query: |\n mutation CreateUserMutation($createUserInput: UserInput) {\n createUser(input: $createUserInput) {\n id\n }\n }\n variables:\n createUserInput:\n username: \"{{ $randomString() }}\"\n email: \"user-{{ $randomString() }}@artillery.io\"\n capture:\n json: \"$.data.createUser.id\"\n as: \"userId\"\n\n - post:\n url: \"/\"\n json:\n query: |\n query UserQuery($userId: ID!) {\n user(id: $userId) {\n username\n email\n }\n }\n variables:\n userId: \"{{ userId }}\"\n\n - post:\n url: \"/\"\n json:\n query: |\n mutation UpdateUserMutation($userId: ID!, $updateUserInput: UserInput) {\n updateUser(id: $userId, input: $updateUserInput) {\n username\n email\n }\n }\n variables:\n userId: \"{{ userId }}\"\n updateUserInput:\n email: \"user-{{ $randomString() }}@artillery.io\"\n\n - post:\n url: \"/\"\n json:\n query: |\n mutation DeleteUserMutation($userId: ID!) {\n deleteUser(id: $userId) {\n id\n }\n }\n variables:\n userId: \"{{ userId }}\"\n" }, { "path": "examples/graphql-api-server/package.json", "content": "{\n \"name\": \"graphql-api-server\",\n \"version\": \"1.0.0\",\n \"description\": \"Load testing a GraphQL API using Artillery\",\n \"main\": \"app.js\",\n \"scripts\": {\n \"test\": \"echo \\\"Error: no test specified\\\" && exit 1\"\n },\n \"author\": \"Dennis Martinez\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"@prisma/client\": \"^3.1.1\",\n \"apollo-server\": \"^3.3.0\",\n \"graphql\": \"^15.6.0\"\n },\n \"devDependencies\": {\n \"prisma\": \"^3.1.1\"\n }\n}\n" }, { "path": "examples/graphql-api-server/prisma/migrations/20211005051218_init/migration.sql", "content": "-- CreateTable\nCREATE TABLE \"User\" (\n \"id\" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,\n \"username\" TEXT NOT NULL,\n \"email\" TEXT NOT NULL\n);\n\n-- CreateIndex\nCREATE UNIQUE INDEX \"User_username_key\" ON \"User\"(\"username\");\n\n-- CreateIndex\nCREATE UNIQUE INDEX \"User_email_key\" ON \"User\"(\"email\");\n" }, { "path": "examples/graphql-api-server/prisma/migrations/migration_lock.toml", "content": "# Please do not edit this file manually\n# It should be added in your version-control system (i.e. Git)\nprovider = \"sqlite\"" }, { "path": "examples/graphql-api-server/prisma/schema.prisma", "content": "datasource db {\n provider = \"sqlite\"\n url = \"file:./dev.db\"\n}\n\ngenerator client {\n provider = \"prisma-client-js\"\n}\n\nmodel User {\n id Int @id @default(autoincrement())\n username String @unique\n email String @unique\n}\n" }, { "path": "examples/http-file-uploads/.gitignore", "content": "node_modules\nuploads/*\n!uploads/.keep\n" }, { "path": "examples/http-file-uploads/README.md", "content": "# HTTP file uploads\n\nThis example shows you how to perform HTTP file uploads from an Artillery test script.\n\n## Running the HTTP server\n\nThis example includes an Express.js application running an HTTP server.\n\nFirst, install the server dependencies:\n\n```shell\nnpm install\n```\n\nAfter installing the dependencies, start the HTTP server:\n\n```shell\nnpm run app:start\n```\n\nThis command will start an HTTP server listening at http://localhost:3000/.\n\n## Running Artillery tests\n\nThis directory contains a test script (`file-uploads.yml`) which demonstrates how you can upload files in your scenarios.\n\nOnce the HTTP server is up and running, execute the test script:\n\n```\nartillery run file-uploads.yml\n```\n\n## Cleaning up uploaded files\n\nDuring the test run, Artillery will upload files to the HTTP server, which get stored in the `uploads` directory. For convenience, you can clean the directory by executing the following command:\n\n```\nnpm run uploads:clean\n```\n" }, { "path": "examples/http-file-uploads/app.js", "content": "const express = require('express');\nconst app = express();\nconst upload = require('multer')({ dest: 'uploads/', preservePath: true });\nconst port = 3000;\n\napp.post('/upload', upload.single('document'), (req, res) => {\n const { originalname, mimetype, size } = req.file;\n res.json({ originalname, mimetype, size });\n});\n\napp.listen(port, () => {\n console.log(`App listening at http://localhost:${port}`);\n});\n" }, { "path": "examples/http-file-uploads/file-uploads.yml", "content": "config:\n target: \"http://localhost:3000\"\n phases:\n - duration: 10min\n arrivalRate: 25\n\n # To randomize the files to upload during the test scenario,\n # set up variables with the names of the files to use. These\n # files are placed in the `/files` directory.\n variables:\n filename:\n - \"artillery-logo.jpg\"\n - \"artillery-installation.pdf\"\n - \"sre-fundamental-rules.png\"\n\nscenarios:\n - flow:\n # The HTTP server has an endpoint (POST /upload) that accepts files\n # through the `document` field.\n - post:\n url: \"/upload\"\n formData:\n document:\n # The `fromFile` attribute tells Artillery to upload the\n # specified file. If the file cannot be read, this scenario\n # will report an ENOENT error.\n fromFile: \"./files/{{ filename }}\"\n" }, { "path": "examples/http-file-uploads/package.json", "content": "{\n \"name\": \"file-uploads\",\n \"version\": \"1.0.0\",\n \"description\": \"How to load-test HTTP file uploads with Artillery Pro\",\n \"main\": \"app.js\",\n \"scripts\": {\n \"test\": \"artillery run file-uploads.yml\",\n \"app:start\": \"node app.js\",\n \"uploads:clean\": \"del-cli 'uploads/*' '!uploads/.keep'\"\n },\n \"author\": \"Dennis Martinez\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"del-cli\": \"^4.0.1\",\n \"express\": \"^4.17.1\",\n \"multer\": \"^1.4.2\"\n }\n}\n" }, { "path": "examples/http-file-uploads/uploads/.keep", "content": "" }, { "path": "examples/http-metrics-by-endpoint/endpoint-metrics.yml", "content": "config:\n target: http://asciiart.artillery.io:8080\n phases:\n - duration: 20\n arrivalRate: 1\n plugins:\n metrics-by-endpoint: {}\nscenarios:\n - flow:\n - get:\n url: \"/dino\"\n - get:\n url: \"/armadillo\"\n - get:\n url: \"/pony\"\n" }, { "path": "examples/http-set-custom-header/README.md", "content": "# Set custom HTTP header via custom JS function\n\nThis example shows how an HTTP header can be set via a hook function.\n\n---\n\nTo test, run `nc` in server mode with:\n\n```shell\nnc -l 31337\n```\n\nand then run Artillery:\n\n```shell\nartillery run set-header.yml\n```\n\nYou should see custom header `X-Dino` being set:\n\n![Artillery custom HTTP header](./custom-header-artillery.png)\n\nTada! 🎉" }, { "path": "examples/http-set-custom-header/helpers.js", "content": "const https = require('node:https');\n\n// Set the value of a header to a custom value, which\n// in this example comes from an HTTP call to another\n// API\nfunction setCustomHeader(req, _userContext, _ee, next) {\n let data = '';\n\n https\n .get('https://api.artillery.io/v1/dino', (res) => {\n res.on('data', (d) => {\n data += d;\n });\n\n res.on('end', () => {\n // Extract a string composed of letters + spaces + punctuation:\n const val = data.match(/^<([A-Za-z!\\s]+)/m)[1].trim();\n // Use that as the value of our custom header:\n req.headers['x-dino'] = val;\n return next();\n });\n })\n .on('error', (e) => {\n return next(e);\n });\n}\n\nmodule.exports = {\n setCustomHeader\n};\n" }, { "path": "examples/http-set-custom-header/set-header.yml", "content": "config:\n target: \"http://localhost:31337\"\n processor: \"./helpers.js\"\n phases:\n - duration: 1\n arrivalCount: 1\nscenarios:\n - name: set_custom_header\n flow:\n - get:\n url: \"/\"\n qs:\n foo: bar\n headers:\n content-type: application/json\n accept: application/json\n json: {}\n beforeRequest: setCustomHeader" }, { "path": "examples/http-socketio-server/.gitignore", "content": "node_modules/\n" }, { "path": "examples/http-socketio-server/README.md", "content": "# HTTP and Socket.IO server\n\n## Running the server\n\nFirst, install the server dependencies:\n\n```shell\nnpm install\n```\n\nAfter installing the dependencies, start the server:\n\n```shell\nnpm start\n```\n\n##### HTTP\n\n`GET /movies`\n\nreturns a list of all the movies\n\n```json\n[\n {\n \"id\": 1,\n \"releaseDate\": \"Dec 18 1985\",\n \"director\": \"Terry Gilliam\",\n \"title\": \"Brazil\",\n \"genre\": \"Black Comedy\",\n \"imdbRating\": 8,\n \"runningTimeMin\": 136\n },\n {\n \"id\": 2,\n \"releaseDate\": \"Feb 16 1996\",\n \"director\": \"Harold Becker\",\n \"title\": \"City Hall\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 111\n }\n ...\n]\n```\n\n`GET /movies/:id`\n\nreturns a single movie by its id\n\n```json\n{\n \"id\": 35,\n \"releaseDate\": \"Oct 01 1999\",\n \"director\": \"David O. Russell\",\n \"title\": \"Three Kings\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 115\n}\n```\n\n##### socket.io\n\nThe socket.io server listens to `echo` events and emits `echoResponse` events to the client, passing the received payload back\n" }, { "path": "examples/http-socketio-server/app.js", "content": "const http = require('node:http');\nconst app = require('./http');\nconst socketio = require('./socketio');\n\nconst { log } = console;\n\nconst PORT = process.env.PORT || 3000;\nconst server = http.createServer(app);\n\nsocketio(server);\n\nserver.listen(PORT, () => {\n log(`Server listening on port ${PORT}`);\n});\n" }, { "path": "examples/http-socketio-server/data/movies.json", "content": "[\n {\n \"id\": 1,\n \"releaseDate\": \"Dec 18 1985\",\n \"director\": \"Terry Gilliam\",\n \"title\": \"Brazil\",\n \"genre\": \"Black Comedy\",\n \"imdbRating\": 8,\n \"runningTimeMin\": 136\n },\n {\n \"id\": 2,\n \"releaseDate\": \"Feb 16 1996\",\n \"director\": \"Harold Becker\",\n \"title\": \"City Hall\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 111\n },\n {\n \"id\": 3,\n \"releaseDate\": \"Jul 12 1996\",\n \"director\": \"Edward Zwick\",\n \"title\": \"Courage Under Fire\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 115\n },\n {\n \"id\": 4,\n \"releaseDate\": \"May 31 1996\",\n \"director\": \"Rob Cohen\",\n \"title\": \"Dragonheart\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 108\n },\n {\n \"id\": 5,\n \"releaseDate\": \"Jan 19 1996\",\n \"director\": \"Robert Rodriguez\",\n \"title\": \"From Dusk Till Dawn\",\n \"genre\": \"Horror\",\n \"imdbRating\": 7.1,\n \"runningTimeMin\": 107\n },\n {\n \"id\": 6,\n \"releaseDate\": \"Mar 08 1996\",\n \"director\": \"Joel Coen\",\n \"title\": \"Fargo\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 8.3,\n \"runningTimeMin\": 87\n },\n {\n \"id\": 7,\n \"releaseDate\": \"Oct 11 1996\",\n \"director\": \"Stephen Hopkins\",\n \"title\": \"The Ghost and the Darkness\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 109\n },\n {\n \"id\": 8,\n \"releaseDate\": \"Feb 16 1996\",\n \"director\": \"Dennis Dugan\",\n \"title\": \"Happy Gilmore\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.9,\n \"runningTimeMin\": 92\n },\n {\n \"id\": 9,\n \"releaseDate\": \"Jul 02 1996\",\n \"director\": \"Roland Emmerich\",\n \"title\": \"Independence Day\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.5,\n \"runningTimeMin\": 145\n },\n {\n \"id\": 10,\n \"releaseDate\": \"Jun 13 1980\",\n \"director\": \"Michael Ritchie\",\n \"title\": \"The Island\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.9,\n \"runningTimeMin\": 138\n },\n {\n \"id\": 11,\n \"releaseDate\": \"Jul 26 1996\",\n \"director\": \"Bobby Farrelly\",\n \"title\": \"Kingpin\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.7,\n \"runningTimeMin\": 113\n },\n {\n \"id\": 12,\n \"releaseDate\": \"Oct 11 1996\",\n \"director\": \"Renny Harlin\",\n \"title\": \"The Long Kiss Goodnight\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 120\n },\n {\n \"id\": 13,\n \"releaseDate\": \"Jul 18 1986\",\n \"director\": \"James Cameron\",\n \"title\": \"Aliens\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.5,\n \"runningTimeMin\": 137\n },\n {\n \"id\": 14,\n \"releaseDate\": \"Dec 13 1996\",\n \"director\": \"Tim Burton\",\n \"title\": \"Mars Attacks!\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.3,\n \"runningTimeMin\": 110\n },\n {\n \"id\": 15,\n \"releaseDate\": \"Nov 15 1996\",\n \"director\": \"Barbra Streisand\",\n \"title\": \"The Mirror Has Two Faces\",\n \"genre\": \"Romantic Comedy\",\n \"imdbRating\": 6,\n \"runningTimeMin\": 127\n },\n {\n \"id\": 16,\n \"releaseDate\": \"May 21 1996\",\n \"director\": \"Brian De Palma\",\n \"title\": \"Mission: Impossible\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.9,\n \"runningTimeMin\": 110\n },\n {\n \"id\": 17,\n \"releaseDate\": \"Nov 15 1996\",\n \"director\": \"Anthony Minghella\",\n \"title\": \"The English Patient\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 160\n },\n {\n \"id\": 18,\n \"releaseDate\": \"Jul 05 1996\",\n \"director\": \"Jon Turteltaub\",\n \"title\": \"Phenomenon\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.3,\n \"runningTimeMin\": 124\n },\n {\n \"id\": 19,\n \"releaseDate\": \"Nov 08 1996\",\n \"director\": \"Ron Howard\",\n \"title\": \"Ransom\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 121\n },\n {\n \"id\": 20,\n \"releaseDate\": \"Nov 01 1996\",\n \"director\": \"Baz Luhrmann\",\n \"title\": \"Romeo+Juliet\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.5,\n \"runningTimeMin\": 120\n },\n {\n \"id\": 21,\n \"releaseDate\": \"Jun 07 1996\",\n \"director\": \"Michael Bay\",\n \"title\": \"The Rock\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.2,\n \"runningTimeMin\": 136\n },\n {\n \"id\": 22,\n \"releaseDate\": \"Nov 22 1996\",\n \"director\": \"Scott Hicks\",\n \"title\": \"Shine\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.6,\n \"runningTimeMin\": 105\n },\n {\n \"id\": 23,\n \"releaseDate\": \"Nov 06 1996\",\n \"director\": \"F. Gary Gray\",\n \"title\": \"Set It Off\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.3,\n \"runningTimeMin\": 120\n },\n {\n \"id\": 24,\n \"releaseDate\": \"Oct 18 1996\",\n \"director\": \"Barry Levinson\",\n \"title\": \"Sleepers\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 105\n },\n {\n \"id\": 25,\n \"releaseDate\": \"Aug 06 2004\",\n \"director\": \"Ryan Little\",\n \"title\": \"Saints and Soldiers\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7,\n \"runningTimeMin\": 90\n },\n {\n \"id\": 26,\n \"releaseDate\": \"Aug 16 1996\",\n \"director\": \"Ron Shelton\",\n \"title\": \"Tin Cup\",\n \"genre\": \"Romantic Comedy\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 105\n },\n {\n \"id\": 27,\n \"releaseDate\": \"Jul 19 1996\",\n \"director\": \"Danny Boyle\",\n \"title\": \"Trainspotting\",\n \"genre\": \"Drama\",\n \"imdbRating\": 8.2,\n \"runningTimeMin\": 94\n },\n {\n \"id\": 28,\n \"releaseDate\": \"Jul 24 1996\",\n \"director\": \"Joel Schumacher\",\n \"title\": \"A Time to Kill\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.1,\n \"runningTimeMin\": 150\n },\n {\n \"id\": 29,\n \"releaseDate\": \"Oct 04 1996\",\n \"director\": \"Tom Hanks\",\n \"title\": \"That Thing You Do!\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.7,\n \"runningTimeMin\": 110\n },\n {\n \"id\": 30,\n \"releaseDate\": \"May 10 1996\",\n \"director\": \"Jan De Bont\",\n \"title\": \"Twister\",\n \"genre\": \"Action\",\n \"imdbRating\": 6,\n \"runningTimeMin\": 117\n },\n {\n \"id\": 31,\n \"releaseDate\": \"Apr 23 2004\",\n \"director\": \"Gary Winick\",\n \"title\": \"13 Going On 30\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 98\n },\n {\n \"id\": 32,\n \"releaseDate\": \"Nov 13 2009\",\n \"director\": \"Roland Emmerich\",\n \"title\": 2012,\n \"genre\": \"Action\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 158\n },\n {\n \"id\": 33,\n \"releaseDate\": \"Jun 27 2003\",\n \"director\": \"Danny Boyle\",\n \"title\": \"28 Days Later...\",\n \"genre\": \"Horror\",\n \"imdbRating\": 7.6,\n \"runningTimeMin\": 113\n },\n {\n \"id\": 34,\n \"releaseDate\": \"Mar 09 2007\",\n \"director\": \"Zack Snyder\",\n \"title\": 300,\n \"genre\": \"Action\",\n \"imdbRating\": 7.8,\n \"runningTimeMin\": 117\n },\n {\n \"id\": 35,\n \"releaseDate\": \"Oct 01 1999\",\n \"director\": \"David O. Russell\",\n \"title\": \"Three Kings\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 115\n },\n {\n \"id\": 36,\n \"releaseDate\": \"Sep 02 2007\",\n \"director\": \"James Mangold\",\n \"title\": \"3:10 to Yuma\",\n \"genre\": \"Western\",\n \"imdbRating\": 7.9,\n \"runningTimeMin\": 117\n },\n {\n \"id\": 37,\n \"releaseDate\": \"Aug 19 2005\",\n \"director\": \"Judd Apatow\",\n \"title\": \"The 40 Year-old Virgin\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7.5,\n \"runningTimeMin\": 111\n },\n {\n \"id\": 38,\n \"releaseDate\": \"Aug 12 2005\",\n \"director\": \"John Singleton\",\n \"title\": \"Four Brothers\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.8,\n \"runningTimeMin\": 109\n },\n {\n \"id\": 39,\n \"releaseDate\": \"Feb 13 2004\",\n \"director\": \"Peter Segal\",\n \"title\": \"50 First Dates\",\n \"genre\": \"Romantic Comedy\",\n \"imdbRating\": 6.8,\n \"runningTimeMin\": 99\n },\n {\n \"id\": 40,\n \"releaseDate\": \"Nov 08 2002\",\n \"director\": \"Curtis Hanson\",\n \"title\": \"8 Mile\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.7,\n \"runningTimeMin\": 110\n },\n {\n \"id\": 41,\n \"releaseDate\": \"May 17 2002\",\n \"director\": \"Paul Weitz\",\n \"title\": \"About a Boy\",\n \"genre\": \"Romantic Comedy\",\n \"imdbRating\": 7.4,\n \"runningTimeMin\": 101\n },\n {\n \"id\": 42,\n \"releaseDate\": \"Nov 20 1998\",\n \"director\": \"John Lasseter\",\n \"title\": \"A Bug's Life\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 96\n },\n {\n \"id\": 43,\n \"releaseDate\": \"Feb 14 1997\",\n \"director\": \"Clint Eastwood\",\n \"title\": \"Absolute Power\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 6.5,\n \"runningTimeMin\": 120\n },\n {\n \"id\": 44,\n \"releaseDate\": \"Nov 12 2004\",\n \"director\": \"Brett Ratner\",\n \"title\": \"After the Sunset\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 97\n },\n {\n \"id\": 45,\n \"releaseDate\": \"Nov 10 2006\",\n \"director\": \"Ridley Scott\",\n \"title\": \"A Good Year\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.8,\n \"runningTimeMin\": 118\n },\n {\n \"id\": 46,\n \"releaseDate\": \"Jul 25 1997\",\n \"director\": \"Wolfgang Petersen\",\n \"title\": \"Air Force One\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.3,\n \"runningTimeMin\": 124\n },\n {\n \"id\": 47,\n \"releaseDate\": \"Sep 22 2006\",\n \"director\": \"Steven Zaillian\",\n \"title\": \"All the King's Men\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6,\n \"runningTimeMin\": 128\n },\n {\n \"id\": 48,\n \"releaseDate\": \"Dec 25 2001\",\n \"director\": \"Michael Mann\",\n \"title\": \"Ali\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 159\n },\n {\n \"id\": 49,\n \"releaseDate\": \"Nov 26 1997\",\n \"director\": \"Jean-Pierre Jeunet\",\n \"title\": \"Alien: Resurrection\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 108\n },\n {\n \"id\": 50,\n \"releaseDate\": \"Sep 15 2000\",\n \"director\": \"Cameron Crowe\",\n \"title\": \"Almost Famous\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 8,\n \"runningTimeMin\": 123\n },\n {\n \"id\": 51,\n \"releaseDate\": \"May 23 2003\",\n \"director\": \"Tom Shadyac\",\n \"title\": \"Bruce Almighty\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 101\n },\n {\n \"id\": 52,\n \"releaseDate\": \"Apr 06 2001\",\n \"director\": \"Lee Tamahori\",\n \"title\": \"Along Came a Spider\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 103\n },\n {\n \"id\": 53,\n \"releaseDate\": \"Sep 15 1999\",\n \"director\": \"Sam Mendes\",\n \"title\": \"American Beauty\",\n \"genre\": \"Drama\",\n \"imdbRating\": 8.6,\n \"runningTimeMin\": 118\n },\n {\n \"id\": 54,\n \"releaseDate\": \"Nov 02 2001\",\n \"director\": \"Jean-Pierre Jeunet\",\n \"title\": \"Le Fabuleux destin d'AmÈlie Poulain\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 8.5,\n \"runningTimeMin\": 122\n },\n {\n \"id\": 55,\n \"releaseDate\": \"Nov 02 2007\",\n \"director\": \"Ridley Scott\",\n \"title\": \"American Gangster\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.9,\n \"runningTimeMin\": 157\n },\n {\n \"id\": 56,\n \"releaseDate\": \"Dec 12 1997\",\n \"director\": \"Steven Spielberg\",\n \"title\": \"Amistad\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.1,\n \"runningTimeMin\": 152\n },\n {\n \"id\": 57,\n \"releaseDate\": \"Jul 09 1999\",\n \"director\": \"Paul Weitz\",\n \"title\": \"American Pie\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.9,\n \"runningTimeMin\": 95\n },\n {\n \"id\": 58,\n \"releaseDate\": \"Nov 14 1997\",\n \"director\": \"Don Bluth\",\n \"title\": \"Anastasia\",\n \"genre\": \"Musical\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 94\n },\n {\n \"id\": 59,\n \"releaseDate\": \"Jul 09 2004\",\n \"director\": \"Adam McKay\",\n \"title\": \"Anchorman: The Legend of Ron Burgundy\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7,\n \"runningTimeMin\": 104\n },\n {\n \"id\": 60,\n \"releaseDate\": \"Apr 11 2003\",\n \"director\": \"Peter Segal\",\n \"title\": \"Anger Management\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 106\n },\n {\n \"id\": 61,\n \"releaseDate\": \"Dec 17 1999\",\n \"director\": \"Andy Tennant\",\n \"title\": \"Anna and the King\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.5,\n \"runningTimeMin\": 147\n },\n {\n \"id\": 62,\n \"releaseDate\": \"Mar 05 1999\",\n \"director\": \"Harold Ramis\",\n \"title\": \"Analyze This\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 103\n },\n {\n \"id\": 63,\n \"releaseDate\": \"Oct 02 1998\",\n \"director\": \"Tim Johnson\",\n \"title\": \"Antz\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.8,\n \"runningTimeMin\": 83\n },\n {\n \"id\": 64,\n \"releaseDate\": \"Dec 08 2006\",\n \"director\": \"Mel Gibson\",\n \"title\": \"Apocalypto\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 7.9,\n \"runningTimeMin\": 136\n },\n {\n \"id\": 65,\n \"releaseDate\": \"Dec 17 1997\",\n \"director\": \"Robert Duvall\",\n \"title\": \"The Apostle\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.1,\n \"runningTimeMin\": 148\n },\n {\n \"id\": 66,\n \"releaseDate\": \"Jul 01 1998\",\n \"director\": \"Michael Bay\",\n \"title\": \"Armageddon\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 150\n },\n {\n \"id\": 67,\n \"releaseDate\": \"Jul 07 2004\",\n \"director\": \"Antoine Fuqua\",\n \"title\": \"King Arthur\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 126\n },\n {\n \"id\": 68,\n \"releaseDate\": \"Jun 29 2001\",\n \"director\": \"Steven Spielberg\",\n \"title\": \"Artificial Intelligence: AI\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.9,\n \"runningTimeMin\": 146\n },\n {\n \"id\": 69,\n \"releaseDate\": \"Oct 23 2009\",\n \"director\": \"David Bowers\",\n \"title\": \"Astro Boy\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 94\n },\n {\n \"id\": 70,\n \"releaseDate\": \"Feb 23 2007\",\n \"director\": \"Michael Polish\",\n \"title\": \"The Astronaut Farmer\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 109\n },\n {\n \"id\": 71,\n \"releaseDate\": \"Dec 24 1997\",\n \"director\": \"James L. Brooks\",\n \"title\": \"As Good as it Gets\",\n \"genre\": \"Romantic Comedy\",\n \"imdbRating\": 7.8,\n \"runningTimeMin\": 138\n },\n {\n \"id\": 72,\n \"releaseDate\": \"Dec 11 1998\",\n \"director\": \"Sam Raimi\",\n \"title\": \"A Simple Plan\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.6,\n \"runningTimeMin\": 121\n },\n {\n \"id\": 73,\n \"releaseDate\": \"Jun 11 2010\",\n \"director\": \"Joe Carnahan\",\n \"title\": \"The A-Team\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.2,\n \"runningTimeMin\": 119\n },\n {\n \"id\": 74,\n \"releaseDate\": \"Jun 08 2001\",\n \"director\": \"Gary Trousdale\",\n \"title\": \"Atlantis: The Lost Empire\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 96\n },\n {\n \"id\": 75,\n \"releaseDate\": \"Dec 07 2007\",\n \"director\": \"Joe Wright\",\n \"title\": \"Atonement\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.9,\n \"runningTimeMin\": 130\n },\n {\n \"id\": 76,\n \"releaseDate\": \"Jun 10 1999\",\n \"director\": \"Jay Roach\",\n \"title\": \"Austin Powers: The Spy Who Shagged Me\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 95\n },\n {\n \"id\": 77,\n \"releaseDate\": \"Jul 25 2002\",\n \"director\": \"Jay Roach\",\n \"title\": \"Austin Powers in Goldmember\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 94\n },\n {\n \"id\": 78,\n \"releaseDate\": \"May 02 1997\",\n \"director\": \"Jay Roach\",\n \"title\": \"Austin Powers: International Man of Mystery\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7.1,\n \"runningTimeMin\": 89\n },\n {\n \"id\": 79,\n \"releaseDate\": \"Dec 17 2004\",\n \"director\": \"Martin Scorsese\",\n \"title\": \"The Aviator\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.6,\n \"runningTimeMin\": 170\n },\n {\n \"id\": 80,\n \"releaseDate\": \"Jun 05 2009\",\n \"director\": \"Sam Mendes\",\n \"title\": \"Away We Go\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 98\n },\n {\n \"id\": 81,\n \"releaseDate\": \"Nov 25 1998\",\n \"director\": \"George Miller\",\n \"title\": \"Babe: Pig in the City\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 75\n },\n {\n \"id\": 82,\n \"releaseDate\": \"Jul 18 2003\",\n \"director\": \"Michael Bay\",\n \"title\": \"Bad Boys II\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 147\n },\n {\n \"id\": 83,\n \"releaseDate\": \"Mar 28 2003\",\n \"director\": \"John McTiernan\",\n \"title\": \"Basic\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 6.3,\n \"runningTimeMin\": 98\n },\n {\n \"id\": 84,\n \"releaseDate\": \"Jun 15 2005\",\n \"director\": \"Christopher Nolan\",\n \"title\": \"Batman Begins\",\n \"genre\": \"Action\",\n \"imdbRating\": 8.3,\n \"runningTimeMin\": 140\n },\n {\n \"id\": 85,\n \"releaseDate\": \"Jul 18 2008\",\n \"director\": \"Christopher Nolan\",\n \"title\": \"The Dark Knight\",\n \"genre\": \"Action\",\n \"imdbRating\": 8.9,\n \"runningTimeMin\": 152\n },\n {\n \"id\": 86,\n \"releaseDate\": \"Jun 27 2001\",\n \"director\": \"John Singleton\",\n \"title\": \"Baby Boy\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 130\n },\n {\n \"id\": 87,\n \"releaseDate\": \"Dec 25 2008\",\n \"director\": \"David Fincher\",\n \"title\": \"The Curious Case of Benjamin Button\",\n \"genre\": \"Drama\",\n \"imdbRating\": 8,\n \"runningTimeMin\": 167\n },\n {\n \"id\": 88,\n \"releaseDate\": \"Oct 10 2008\",\n \"director\": \"Ridley Scott\",\n \"title\": \"Body of Lies\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 7.2,\n \"runningTimeMin\": 129\n },\n {\n \"id\": 89,\n \"releaseDate\": \"Dec 08 2006\",\n \"director\": \"Edward Zwick\",\n \"title\": \"Blood Diamond\",\n \"genre\": \"Action\",\n \"imdbRating\": 8,\n \"runningTimeMin\": 143\n },\n {\n \"id\": 90,\n \"releaseDate\": \"Dec 20 1996\",\n \"director\": \"Mike Judge\",\n \"title\": \"Beavis and Butt-head Do America\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 80\n },\n {\n \"id\": 91,\n \"releaseDate\": \"Mar 12 2003\",\n \"director\": \"Gurinder Chadha\",\n \"title\": \"Bend it Like Beckham\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.9,\n \"runningTimeMin\": 112\n },\n {\n \"id\": 92,\n \"releaseDate\": \"Nov 23 2001\",\n \"director\": \"Todd Field\",\n \"title\": \"In the Bedroom\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.5,\n \"runningTimeMin\": 130\n },\n {\n \"id\": 93,\n \"releaseDate\": \"Nov 02 2007\",\n \"director\": \"Steve Hickner\",\n \"title\": \"Bee Movie\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.3,\n \"runningTimeMin\": 90\n },\n {\n \"id\": 94,\n \"releaseDate\": \"Oct 29 1999\",\n \"director\": \"Spike Jonze\",\n \"title\": \"Being John Malkovich\",\n \"genre\": \"Black Comedy\",\n \"imdbRating\": 7.9,\n \"runningTimeMin\": 112\n },\n {\n \"id\": 95,\n \"releaseDate\": \"Nov 16 2007\",\n \"director\": \"Robert Zemeckis\",\n \"title\": \"Beowulf\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 115\n },\n {\n \"id\": 96,\n \"releaseDate\": \"Dec 10 2003\",\n \"director\": \"Tim Burton\",\n \"title\": \"Big Fish\",\n \"genre\": \"Drama\",\n \"imdbRating\": 8.1,\n \"runningTimeMin\": 125\n },\n {\n \"id\": 97,\n \"releaseDate\": \"Mar 06 1998\",\n \"director\": \"Joel Coen\",\n \"title\": \"The Big Lebowski\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 8.2,\n \"runningTimeMin\": 127\n },\n {\n \"id\": 98,\n \"releaseDate\": \"Dec 28 2001\",\n \"director\": \"Ridley Scott\",\n \"title\": \"Black Hawk Down\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.7,\n \"runningTimeMin\": 144\n },\n {\n \"id\": 99,\n \"releaseDate\": \"Oct 13 2000\",\n \"director\": \"Stephen Daldry\",\n \"title\": \"Billy Elliot\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.7,\n \"runningTimeMin\": 110\n },\n {\n \"id\": 100,\n \"releaseDate\": \"Dec 17 1999\",\n \"director\": \"Chris Columbus\",\n \"title\": \"Bicentennial Man\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 132\n },\n {\n \"id\": 101,\n \"releaseDate\": \"Aug 21 1998\",\n \"director\": \"Stephen Norrington\",\n \"title\": \"Blade\",\n \"genre\": \"Action\",\n \"imdbRating\": 7,\n \"runningTimeMin\": 121\n },\n {\n \"id\": 102,\n \"releaseDate\": \"Feb 12 1999\",\n \"director\": \"Hugh Wilson\",\n \"title\": \"Blast from the Past\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 111\n },\n {\n \"id\": 103,\n \"releaseDate\": \"Aug 09 2002\",\n \"director\": \"Clint Eastwood\",\n \"title\": \"Blood Work\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 6.3,\n \"runningTimeMin\": 110\n },\n {\n \"id\": 104,\n \"releaseDate\": \"Jul 13 2001\",\n \"director\": \"Robert Luketic\",\n \"title\": \"Legally Blonde\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 97\n },\n {\n \"id\": 105,\n \"releaseDate\": \"Apr 06 2001\",\n \"director\": \"Ted Demme\",\n \"title\": \"Blow\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.4,\n \"runningTimeMin\": 123\n },\n {\n \"id\": 106,\n \"releaseDate\": \"Dec 21 2001\",\n \"director\": \"Ron Howard\",\n \"title\": \"A Beautiful Mind\",\n \"genre\": \"Drama\",\n \"imdbRating\": 8,\n \"runningTimeMin\": 135\n },\n {\n \"id\": 107,\n \"releaseDate\": \"Oct 12 2001\",\n \"director\": \"Barry Levinson\",\n \"title\": \"Bandits\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.5,\n \"runningTimeMin\": 123\n },\n {\n \"id\": 108,\n \"releaseDate\": \"Nov 17 2006\",\n \"director\": \"Emilio Estevez\",\n \"title\": \"Bobby\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.1,\n \"runningTimeMin\": 120\n },\n {\n \"id\": 109,\n \"releaseDate\": \"Nov 05 1999\",\n \"director\": \"Phillip Noyce\",\n \"title\": \"The Bone Collector\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 6.3,\n \"runningTimeMin\": 118\n },\n {\n \"id\": 110,\n \"releaseDate\": \"Oct 10 1997\",\n \"director\": \"Paul Thomas Anderson\",\n \"title\": \"Boogie Nights\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.9,\n \"runningTimeMin\": 152\n },\n {\n \"id\": 111,\n \"releaseDate\": \"Nov 03 2006\",\n \"director\": \"Larry Charles\",\n \"title\": \"Borat\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7.7,\n \"runningTimeMin\": 83\n },\n {\n \"id\": 112,\n \"releaseDate\": \"Jun 14 2002\",\n \"director\": \"Doug Liman\",\n \"title\": \"The Bourne Identity\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.7,\n \"runningTimeMin\": 110\n },\n {\n \"id\": 113,\n \"releaseDate\": \"Jul 23 2004\",\n \"director\": \"Paul Greengrass\",\n \"title\": \"The Bourne Supremacy\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.6,\n \"runningTimeMin\": 108\n },\n {\n \"id\": 114,\n \"releaseDate\": \"Aug 03 2007\",\n \"director\": \"Paul Greengrass\",\n \"title\": \"The Bourne Ultimatum\",\n \"genre\": \"Action\",\n \"imdbRating\": 8.2,\n \"runningTimeMin\": 114\n },\n {\n \"id\": 115,\n \"releaseDate\": \"Oct 22 1999\",\n \"director\": \"Martin Scorsese\",\n \"title\": \"Bringing Out The Dead\",\n \"genre\": \"Black Comedy\",\n \"imdbRating\": 6.8,\n \"runningTimeMin\": 120\n },\n {\n \"id\": 116,\n \"releaseDate\": \"Dec 09 2005\",\n \"director\": \"Ang Lee\",\n \"title\": \"Brokeback Mountain\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.8,\n \"runningTimeMin\": 134\n },\n {\n \"id\": 117,\n \"releaseDate\": \"Sep 13 2002\",\n \"director\": \"Tim Story\",\n \"title\": \"Barbershop\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 103\n },\n {\n \"id\": 118,\n \"releaseDate\": \"Sep 27 2000\",\n \"director\": \"Christopher Guest\",\n \"title\": \"Best in Show\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7.4,\n \"runningTimeMin\": 90\n },\n {\n \"id\": 119,\n \"releaseDate\": \"Nov 26 2003\",\n \"director\": \"Terry Zwigoff\",\n \"title\": \"Bad Santa\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 91\n },\n {\n \"id\": 120,\n \"releaseDate\": \"Aug 21 2009\",\n \"director\": \"Quentin Tarantino\",\n \"title\": \"Inglourious Basterds\",\n \"genre\": \"Action\",\n \"imdbRating\": 8.4,\n \"runningTimeMin\": 152\n },\n {\n \"id\": 121,\n \"releaseDate\": \"May 15 1998\",\n \"director\": \"Warren Beatty\",\n \"title\": \"Bulworth\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.8,\n \"runningTimeMin\": 107\n },\n {\n \"id\": 122,\n \"releaseDate\": \"Aug 13 1999\",\n \"director\": \"Frank Oz\",\n \"title\": \"Bowfinger\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 96\n },\n {\n \"id\": 123,\n \"releaseDate\": \"Dec 22 2000\",\n \"director\": \"Robert Zemeckis\",\n \"title\": \"Cast Away\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.5,\n \"runningTimeMin\": 144\n },\n {\n \"id\": 124,\n \"releaseDate\": \"Sep 10 2004\",\n \"director\": \"David R. Ellis\",\n \"title\": \"Cellular\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 6.5,\n \"runningTimeMin\": 94\n },\n {\n \"id\": 125,\n \"releaseDate\": \"Oct 10 2008\",\n \"director\": \"Gil Kenan\",\n \"title\": \"City of Ember\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 94\n },\n {\n \"id\": 126,\n \"releaseDate\": \"Jul 15 2005\",\n \"director\": \"Tim Burton\",\n \"title\": \"Charlie and the Chocolate Factory\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7.1,\n \"runningTimeMin\": 115\n },\n {\n \"id\": 127,\n \"releaseDate\": \"Oct 27 2006\",\n \"director\": \"Phillip Noyce\",\n \"title\": \"Catch a Fire\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 6.8,\n \"runningTimeMin\": 101\n },\n {\n \"id\": 128,\n \"releaseDate\": \"Dec 27 2002\",\n \"director\": \"Rob Marshall\",\n \"title\": \"Chicago\",\n \"genre\": \"Musical\",\n \"imdbRating\": 7.2,\n \"runningTimeMin\": 113\n },\n {\n \"id\": 129,\n \"releaseDate\": \"Jun 21 2000\",\n \"director\": \"Nick Park\",\n \"title\": \"Chicken Run\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 84\n },\n {\n \"id\": 130,\n \"releaseDate\": \"Dec 25 2006\",\n \"director\": \"Alfonso Cuaron\",\n \"title\": \"Children of Men\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 8.1,\n \"runningTimeMin\": 114\n },\n {\n \"id\": 131,\n \"releaseDate\": \"Nov 16 2007\",\n \"director\": \"Mike Newell\",\n \"title\": \"Love in the Time of Cholera\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 139\n },\n {\n \"id\": 132,\n \"releaseDate\": \"Dec 15 2000\",\n \"director\": \"Lasse Hallstrom\",\n \"title\": \"Chocolat\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 122\n },\n {\n \"id\": 133,\n \"releaseDate\": \"Dec 15 2006\",\n \"director\": \"Gary Winick\",\n \"title\": \"Charlotte's Web\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.7,\n \"runningTimeMin\": 98\n },\n {\n \"id\": 134,\n \"releaseDate\": \"Jun 03 2005\",\n \"director\": \"Ron Howard\",\n \"title\": \"Cinderella Man\",\n \"genre\": \"Drama\",\n \"imdbRating\": 8,\n \"runningTimeMin\": 144\n },\n {\n \"id\": 135,\n \"releaseDate\": \"Apr 10 1998\",\n \"director\": \"Brad Silberling\",\n \"title\": \"City of Angels\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 117\n },\n {\n \"id\": 136,\n \"releaseDate\": \"Dec 25 1998\",\n \"director\": \"Steven Zaillian\",\n \"title\": \"A Civil Action\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 112\n },\n {\n \"id\": 137,\n \"releaseDate\": \"Dec 25 2003\",\n \"director\": \"Anthony Minghella\",\n \"title\": \"Cold Mountain\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 152\n },\n {\n \"id\": 138,\n \"releaseDate\": \"Feb 18 2005\",\n \"director\": \"Francis Lawrence\",\n \"title\": \"Constantine\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.7,\n \"runningTimeMin\": 122\n },\n {\n \"id\": 139,\n \"releaseDate\": \"Aug 06 2004\",\n \"director\": \"Michael Mann\",\n \"title\": \"Collateral\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.8,\n \"runningTimeMin\": 120\n },\n {\n \"id\": 140,\n \"releaseDate\": \"Jun 06 1997\",\n \"director\": \"Simon West\",\n \"title\": \"Con Air\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 115\n },\n {\n \"id\": 141,\n \"releaseDate\": \"Aug 08 1997\",\n \"director\": \"Richard Donner\",\n \"title\": \"Conspiracy Theory\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 6.5,\n \"runningTimeMin\": 135\n },\n {\n \"id\": 142,\n \"releaseDate\": \"Jul 11 1997\",\n \"director\": \"Robert Zemeckis\",\n \"title\": \"Contact\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 150\n },\n {\n \"id\": 143,\n \"releaseDate\": \"Aug 15 1997\",\n \"director\": \"James Mangold\",\n \"title\": \"Cop Land\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.9,\n \"runningTimeMin\": 105\n },\n {\n \"id\": 144,\n \"releaseDate\": \"Dec 21 2006\",\n \"director\": \"Yimou Zhang\",\n \"title\": \"Man cheng jin dai huang jin jia\",\n \"genre\": \"Action\",\n \"imdbRating\": 7,\n \"runningTimeMin\": 113\n },\n {\n \"id\": 145,\n \"releaseDate\": \"May 06 2005\",\n \"director\": \"Paul Haggis\",\n \"title\": \"Crash\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 107\n },\n {\n \"id\": 146,\n \"releaseDate\": \"Jan 25 2002\",\n \"director\": \"Kevin Reynolds\",\n \"title\": \"The Count of Monte Cristo\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.6,\n \"runningTimeMin\": 131\n },\n {\n \"id\": 147,\n \"releaseDate\": \"Mar 05 1999\",\n \"director\": \"Roger Kumble\",\n \"title\": \"Cruel Intentions\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.7,\n \"runningTimeMin\": 95\n },\n {\n \"id\": 148,\n \"releaseDate\": \"Apr 16 2010\",\n \"director\": \"James Ivory\",\n \"title\": \"The City of Your Final Destination\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 114\n },\n {\n \"id\": 149,\n \"releaseDate\": \"Sep 18 2009\",\n \"director\": \"Phil Lord\",\n \"title\": \"Cloudy with a Chance of Meatballs\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7.2,\n \"runningTimeMin\": 90\n },\n {\n \"id\": 150,\n \"releaseDate\": \"Mar 19 2004\",\n \"director\": \"Zack Snyder\",\n \"title\": \"Dawn of the Dead\",\n \"genre\": \"Horror\",\n \"imdbRating\": 7.4,\n \"runningTimeMin\": 100\n }\n]\n" }, { "path": "examples/http-socketio-server/http-socket.yml", "content": "config:\n target: \"http://localhost:3000\"\n phases:\n - duration: 30\n arrivalRate: 5\n\nbefore:\n flow:\n - post:\n url: /login\n json:\n username: doesnt\n password: matter\n\n\nscenarios:\n - engine: socketio\n flow:\n - get:\n url: /movies\n capture:\n json: \"$[{{ $randomNumber(1, 150) }}]\" #pick a random movie from array of 150\n as: chosenMovie\n - get:\n url: /movies/{{ chosenMovie.id }}\n capture:\n json: \"$.title\"\n as: chosenMovieTitle\n - emit:\n channel: \"echo\"\n data: \"{{ chosenMovieTitle }}\"\n response:\n channel: \"echoResponse\"\n data: \"{{ chosenMovieTitle }}\"\n\n\nafter:\n flow:\n - post:\n url: /logout" }, { "path": "examples/http-socketio-server/http.js", "content": "const express = require('express');\nconst cookieParser = require('cookie-parser');\n\nconst app = express();\n\nconst response = require('./data/movies.json');\n\napp.use(express.json());\napp.use(cookieParser());\n\napp.post('/login', (req, res) => {\n const { username, password } = req.body;\n\n if (username && password) {\n res.cookie('username', username);\n res.json({ success: true });\n } else {\n res.status(422).json({ error: 'Username and password are required' });\n }\n});\n\napp.delete('/logout', (_, res) => {\n res.clearCookie('username');\n res.sendStatus(204);\n});\n\napp.get('/account', (req, res) => {\n res.json({ user: req.cookies });\n});\n\napp.get('/movies', (_, res) => {\n res.json(response);\n});\n\napp.get('/movies/:id', (req, res) => {\n const id = parseInt(req.params.id, 10);\n\n res.json(response.filter((movie) => movie.id === id).pop());\n});\n\nmodule.exports = app;\n" }, { "path": "examples/http-socketio-server/package.json", "content": "{\n \"name\": \"test-endpoints\",\n \"version\": \"1.0.0\",\n \"description\": \"Artillery.io - HTTP and Socket.IO test server\",\n \"main\": \"app.js\",\n \"scripts\": {\n \"test\": \"echo \\\"Error: no test specified\\\" && exit 1\",\n \"start\": \"node app.js\"\n },\n \"author\": \"\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"cookie-parser\": \"^1.4.5\",\n \"express\": \"^4.17.1\",\n \"socket.io\": \"^3.1.2\"\n }\n}\n" }, { "path": "examples/http-socketio-server/socketio.js", "content": "const socketio = require('socket.io');\n\nconst { log } = console;\n\nmodule.exports = (server) => {\n const io = socketio(server);\n\n io.on('connect', (client) => {\n function onEcho(m) {\n log('Echo message', m);\n\n client.emit('echoResponse', m);\n }\n\n function onDisconnect() {\n log(`Received: disconnect event from client: ${client.id}`);\n\n client.removeListener('echo', onEcho);\n client.removeListener('disconnect', onDisconnect);\n }\n\n client.on('disconnect', onDisconnect);\n client.on('echo', onEcho);\n });\n\n io.on('connect_error', (err) => {\n log('connectError, ', err);\n });\n\n return io;\n};\n" }, { "path": "examples/k8s-testing-with-kubectl-artillery/.dockerignore", "content": ".eslintrc.js\n/node_modules\n" }, { "path": "examples/k8s-testing-with-kubectl-artillery/.gitignore", "content": "node_modules/\n" }, { "path": "examples/k8s-testing-with-kubectl-artillery/Dockerfile", "content": "FROM node:16-alpine\n\nWORKDIR /app\n\nCOPY package.json package-lock.json ./\n\nRUN npm --production install\n\nCOPY . .\n\nEXPOSE 3001\n\nCMD [\"node\", \"app.js\"]\n" }, { "path": "examples/k8s-testing-with-kubectl-artillery/Makefile", "content": "THIS_FILE := $(lastword $(MAKEFILE_LIST))\n\n# VERSION defines the project version for the bundle.\n# Update this value when you upgrade the version of your project.\n# To re-generate a bundle for another specific version without changing the standard setup, you can:\n# - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)\n# - use environment variables to overwrite this value (e.g export VERSION=0.0.2)\nVERSION ?= latest\n\nIMAGE_REPO_OWNER ?= artilleryio\n\nIMAGE_PLATFORM ?= linux/amd64\nCOMMIT_TAG := $(shell git log -1 --pretty=%H)\nAPP_IMAGE_NAME ?= movie-browser-test-endpoints\n\n# Image URL to use all building/pushing image targets\nAPP_IMG ?= $(IMAGE_REPO_OWNER)/$(APP_IMAGE_NAME):$(VERSION)\n\n\n# Setting SHELL to bash allows bash commands to be executed by recipes.\n# Options are set to exit when a recipe line exits non-zero or a piped command fails.\nSHELL = /usr/bin/env bash -o pipefail\n.SHELLFLAGS = -ec\n\nall: help\n\n##@ General\n\n# The help target prints out all targets with their descriptions organized\n# beneath their categories. The categories are represented by '##@' and the\n# target descriptions by '##'. The awk commands is responsible for reading the\n# entire set of makefiles included in this invocation, looking for lines of the\n# file as xyz: ## something, and then pretty-format the target and help. Then,\n# if there's a line with ##@ something, that gets pretty-printed as a category.\n# More info on the usage of ANSI control characters for terminal formatting:\n# https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters\n# More info on the awk command:\n# http://linuxcommand.org/lc3_adv_awk.php\n\nhelp: ## Display this help.\n\t@awk 'BEGIN {FS = \":.*##\"; printf \"\\nUsage:\\n make \\033[36m\\033[0m\\n\"} /^[a-zA-Z_0-9-]+:.*?##/ { printf \" \\033[36m%-15s\\033[0m %s\\n\", $$1, $$2 } /^##@/ { printf \"\\n\\033[1m%s\\033[0m\\n\", substr($$0, 5) } ' $(MAKEFILE_LIST)\n\n##@ Build API docker image\n\ndocker-build: ## Build docker image with the api.\n\tdocker build -f Dockerfile --platform \"${IMAGE_PLATFORM}\" -t \"${APP_IMAGE_NAME}:${COMMIT_TAG}\" .\n\tdocker tag \"${APP_IMAGE_NAME}:${COMMIT_TAG}\" ${APP_IMG}\n\ndocker-push: ## Push docker image with the api.\n\tdocker push ${APP_IMG}\n" }, { "path": "examples/k8s-testing-with-kubectl-artillery/README.md", "content": "# Kubernetes testing with kubectl-artillery\n\nThis example uses the [kubectl-artillery](https://github.com/artilleryio/kubectl-artillery) plugin to bootstrap Artillery tests on Kubernetes.\n\nThe plugin can scaffold new Artillery test-scripts from running Kubernetes [Services](https://kubernetes.io/docs/concepts/services-networking/service/). For this to work, a Service will need to have access to the underlying [Pod's](https://kubernetes.io/docs/concepts/workloads/pods/) [liveness HTTP probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-liveness-http-request) check endpoint. \n\nAnd, the plugin can also generate a Job that wraps a test-script to run Artillery test workers on Kubernetes. \n\n## Trying it out\n\nWe will be using the [Movie Browser HTTP test server](app.js) to demonstrate how this works. To make this easy we already have a [containerized version](https://github.com/orgs/artilleryio/packages/container/package/movie-browser-test-endpoints) ready to go. \n\nThis is configured to run on Kubernetes as defined in this [YAML manifest](k8s-deploy.yaml).\n\n[KinD](https://kind.sigs.k8s.io/docs/user/quick-start/) is bundled to help you get and running with a Kubernetes cluster as soon as possible. It runs on [Docker](https://docs.docker.com/get-docker/), so be sure to install it if you're going to use a `KinD` cluster. \n\n### Install the plugin\n\n[Follow the plugin installation instructions](https://github.com/artilleryio/kubectl-artillery#installation) to install the plugin for your target OS.\n\n### Prepare your Kubernetes cluster\n\nMake sure you have a cluster to deploy to.\n\nIf you don't, run this shell script to get up and running with a KinD cluster locally on your machine.\n\n```shell\n./hack/kind/kind-with-registry.sh\n```\n\n### Deploy to Kubernetes\n\nGet the `Movie Browser HTTP test server` running on Kubernetes,\n\n```shell\nkubectl apply -f k8s-deploy.yaml\n```\n\nEnsure the server is running.\n\n```shell\nkubectl get all -l app=movie-browser\n# NAME READY STATUS RESTARTS AGE\n# pod/movie-browser-75f47f84f4-xcxkv 1/1 Running 2 5m25s\n\n# NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE\n# service/movie-browser-service ClusterIP 10.96.105.65 80/TCP 5m25s\n\n# NAME READY UP-TO-DATE AVAILABLE AGE\n# deployment.apps/movie-browser 1/1 1 1 5m25s\n\n# NAME DESIRED CURRENT READY AGE\n# replicaset.apps/movie-browser-75f47f84f4 1 1 1 5m25s\n```\n\n### Scaffold a test-script\n\nThe `movie-browser-service` Kubernetes Service exposes an underlying Pod configured with an HTTP Liveness Probe.\n\nThe `kubectl-artillery` plugin will use this to scaffold an Artillery test-script from the Service.\n\n```shell\nkubectl artillery scaffold movie-browser-service\n# artillery-scripts/test-script_movie-browser-service.yaml generated\n```\n\nThis produces this test-script, \n\n```yaml\nconfig:\n target: http://movie-browser-service:80/\n environments:\n functional:\n phases:\n - duration: 1\n arrivalCount: 1\n plugins:\n expect: {}\nscenarios:\n - flow:\n - get:\n url: http://movie-browser-service:80/healthz\n expect:\n - statusCode: 200\n\n```\n\nThe health check under test is an endpoint already provided by the `Movie Browser HTTP test server` in the [http.js](http.js) file.\n\n```javascript\napp.get('/healthz', (req, res) => {\n if (response.length > 0) {\n res.status(200).send('Ok');\n } else {\n res.status(500).send('Movie data is missing');\n }\n});\n```\n\nFeel free to update the test-script with any other tests you'd like to run.\n\n### Generate a test\n\nNow that we have a test-script, `artillery-scripts/test-script_movie-browser-service.yaml`, we can generate a Kubernetes [Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/) that mounts the test-script as a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) all packaged with [Kustomize](https://kustomize.io).\n\n```shell\nkubectl artillery generate movie-browser-service -s artillery-scripts/test-script_movie-browser-service.yaml\n# artillery-manifests/test-job.yaml generated\n# artillery-manifests/kustomization.yaml generated\n```\n\nThis produces this Job manifest `artillery-manifests/test-job.yaml`,\n\n```yaml\napiVersion: batch/v1\nkind: Job\nmetadata:\n labels:\n artillery.io/component: test-worker-master\n artillery.io/part-of: artilleryio-test\n artillery.io/test-name: movie-browser-service\n name: movie-browser-service\n namespace: default\n...\n...\n```\n\nAnd Kustomize manifest,\n\n```yaml\nkind: Kustomization\napiVersion: kustomize.config.k8s.io/v1beta1\nnamespace: default\nresources:\n - test-job.yaml\nconfigMapGenerator:\n - name: movie-browser-service-test-script\n files:\n - test-script_movie-browser-service.yaml\ngeneratorOptions:\n labels:\n artillery.io/component: artilleryio-test-config\n artillery.io/part-of: artilleryio-test\n disableNameSuffixHash: true\n```\n\nHere we use Kustomize to create a ConfigMap, `movie-browser-service-test-script`, that will mount our test-script into our cluster.\n\n### Run a test\n\nDeploying the generated manifests to our cluster will actually run Artillery test workers on Kubernetes.\n\n```shell\nkubectl apply -k artillery-manifests\n# configmap/movie-browser-service-test-script created\n# job.batch/movie-browser-service created\n```\n\nGetting the job, `job.batch/movie-browser-service`, and test worker, `pod/movie-browser-service-9xnsn`, statuses.\n\n```shell\nkubectl get all -l artillery.io/part-of=artilleryio-test\n# NAME READY STATUS RESTARTS AGE\n# pod/movie-browser-service-9xnsn 0/1 Completed 0 44s\n\n# NAME COMPLETIONS DURATION AGE\n# job.batch/movie-browser-service 1/1 24s 45s\n```\n\nAnd the test results can be viewed from the test worker's logs,\n\n```shell\nkubectl logs pod/movie-browser-service-9xnsn\n# Phase started: unnamed (index: 0, duration: 1s) 12:17:50(+0000)\n\n# Phase completed: unnamed (index: 0, duration: 1s) 12:17:51(+0000)\n\n# --------------------------------------\n# Metrics for period to: 12:18:00(+0000) (width: 0.12s)\n# --------------------------------------\n\n# http.codes.200: ................................................................ 1\n# http.request_rate: ............................................................. 1/sec\n# http.requests: ................................................................. 1\n# http.response_time:\n# min: ......................................................................... 16\n# max: ......................................................................... 16\n# median: ...................................................................... 16\n# p95: ......................................................................... 16\n# p99: ......................................................................... 16\n# http.responses: ................................................................ 1\n# vusers.completed: .............................................................. 1\n# vusers.created: ................................................................ 1\n# vusers.created_by_name.0: ...................................................... 1\n# vusers.failed: ................................................................. 0\n# vusers.session_length:\n# min: ......................................................................... 119.3\n# max: ......................................................................... 119.3\n# median: ...................................................................... 120.3\n# p95: ......................................................................... 120.3\n# p99: ......................................................................... 120.3\n\n\n# All VUs finished. Total time: 4 seconds\n\n# --------------------------------\n# Summary report @ 12:17:52(+0000)\n# --------------------------------\n\n# http.codes.200: ................................................................ 1\n# http.request_rate: ............................................................. 1/sec\n# http.requests: ................................................................. 1\n# http.response_time:\n# min: ......................................................................... 16\n# max: ......................................................................... 16\n# median: ...................................................................... 16\n# p95: ......................................................................... 16\n# p99: ......................................................................... 16\n# http.responses: ................................................................ 1\n# vusers.completed: .............................................................. 1\n# vusers.created: ................................................................ 1\n# vusers.created_by_name.0: ...................................................... 1\n# vusers.failed: ................................................................. 0\n# vusers.session_length:\n# min: ......................................................................... 119.3\n# max: ......................................................................... 119.3\n# median: ...................................................................... 120.3\n# p95: ......................................................................... 120.3\n# p99: ......................................................................... 120.3\n```\n" }, { "path": "examples/k8s-testing-with-kubectl-artillery/app.js", "content": "const http = require('node:http');\nconst app = require('./http');\n\nconst { log } = console;\n\nconst PORT = process.env.PORT || 3001;\nconst server = http.createServer(app);\n\nserver.listen(PORT, () => {\n log(`Server listening on port ${PORT}`);\n});\n" }, { "path": "examples/k8s-testing-with-kubectl-artillery/data/movies.json", "content": "[\n {\n \"id\": 1,\n \"releaseDate\": \"Dec 18 1985\",\n \"director\": \"Terry Gilliam\",\n \"title\": \"Brazil\",\n \"genre\": \"Black Comedy\",\n \"imdbRating\": 8,\n \"runningTimeMin\": 136\n },\n {\n \"id\": 2,\n \"releaseDate\": \"Feb 16 1996\",\n \"director\": \"Harold Becker\",\n \"title\": \"City Hall\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 111\n },\n {\n \"id\": 3,\n \"releaseDate\": \"Jul 12 1996\",\n \"director\": \"Edward Zwick\",\n \"title\": \"Courage Under Fire\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 115\n },\n {\n \"id\": 4,\n \"releaseDate\": \"May 31 1996\",\n \"director\": \"Rob Cohen\",\n \"title\": \"Dragonheart\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 108\n },\n {\n \"id\": 5,\n \"releaseDate\": \"Jan 19 1996\",\n \"director\": \"Robert Rodriguez\",\n \"title\": \"From Dusk Till Dawn\",\n \"genre\": \"Horror\",\n \"imdbRating\": 7.1,\n \"runningTimeMin\": 107\n },\n {\n \"id\": 6,\n \"releaseDate\": \"Mar 08 1996\",\n \"director\": \"Joel Coen\",\n \"title\": \"Fargo\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 8.3,\n \"runningTimeMin\": 87\n },\n {\n \"id\": 7,\n \"releaseDate\": \"Oct 11 1996\",\n \"director\": \"Stephen Hopkins\",\n \"title\": \"The Ghost and the Darkness\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 109\n },\n {\n \"id\": 8,\n \"releaseDate\": \"Feb 16 1996\",\n \"director\": \"Dennis Dugan\",\n \"title\": \"Happy Gilmore\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.9,\n \"runningTimeMin\": 92\n },\n {\n \"id\": 9,\n \"releaseDate\": \"Jul 02 1996\",\n \"director\": \"Roland Emmerich\",\n \"title\": \"Independence Day\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.5,\n \"runningTimeMin\": 145\n },\n {\n \"id\": 10,\n \"releaseDate\": \"Jun 13 1980\",\n \"director\": \"Michael Ritchie\",\n \"title\": \"The Island\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.9,\n \"runningTimeMin\": 138\n },\n {\n \"id\": 11,\n \"releaseDate\": \"Jul 26 1996\",\n \"director\": \"Bobby Farrelly\",\n \"title\": \"Kingpin\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.7,\n \"runningTimeMin\": 113\n },\n {\n \"id\": 12,\n \"releaseDate\": \"Oct 11 1996\",\n \"director\": \"Renny Harlin\",\n \"title\": \"The Long Kiss Goodnight\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 120\n },\n {\n \"id\": 13,\n \"releaseDate\": \"Jul 18 1986\",\n \"director\": \"James Cameron\",\n \"title\": \"Aliens\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.5,\n \"runningTimeMin\": 137\n },\n {\n \"id\": 14,\n \"releaseDate\": \"Dec 13 1996\",\n \"director\": \"Tim Burton\",\n \"title\": \"Mars Attacks!\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.3,\n \"runningTimeMin\": 110\n },\n {\n \"id\": 15,\n \"releaseDate\": \"Nov 15 1996\",\n \"director\": \"Barbra Streisand\",\n \"title\": \"The Mirror Has Two Faces\",\n \"genre\": \"Romantic Comedy\",\n \"imdbRating\": 6,\n \"runningTimeMin\": 127\n },\n {\n \"id\": 16,\n \"releaseDate\": \"May 21 1996\",\n \"director\": \"Brian De Palma\",\n \"title\": \"Mission: Impossible\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.9,\n \"runningTimeMin\": 110\n },\n {\n \"id\": 17,\n \"releaseDate\": \"Nov 15 1996\",\n \"director\": \"Anthony Minghella\",\n \"title\": \"The English Patient\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 160\n },\n {\n \"id\": 18,\n \"releaseDate\": \"Jul 05 1996\",\n \"director\": \"Jon Turteltaub\",\n \"title\": \"Phenomenon\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.3,\n \"runningTimeMin\": 124\n },\n {\n \"id\": 19,\n \"releaseDate\": \"Nov 08 1996\",\n \"director\": \"Ron Howard\",\n \"title\": \"Ransom\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 121\n },\n {\n \"id\": 20,\n \"releaseDate\": \"Nov 01 1996\",\n \"director\": \"Baz Luhrmann\",\n \"title\": \"Romeo+Juliet\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.5,\n \"runningTimeMin\": 120\n },\n {\n \"id\": 21,\n \"releaseDate\": \"Jun 07 1996\",\n \"director\": \"Michael Bay\",\n \"title\": \"The Rock\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.2,\n \"runningTimeMin\": 136\n },\n {\n \"id\": 22,\n \"releaseDate\": \"Nov 22 1996\",\n \"director\": \"Scott Hicks\",\n \"title\": \"Shine\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.6,\n \"runningTimeMin\": 105\n },\n {\n \"id\": 23,\n \"releaseDate\": \"Nov 06 1996\",\n \"director\": \"F. Gary Gray\",\n \"title\": \"Set It Off\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.3,\n \"runningTimeMin\": 120\n },\n {\n \"id\": 24,\n \"releaseDate\": \"Oct 18 1996\",\n \"director\": \"Barry Levinson\",\n \"title\": \"Sleepers\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 105\n },\n {\n \"id\": 25,\n \"releaseDate\": \"Aug 06 2004\",\n \"director\": \"Ryan Little\",\n \"title\": \"Saints and Soldiers\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7,\n \"runningTimeMin\": 90\n },\n {\n \"id\": 26,\n \"releaseDate\": \"Aug 16 1996\",\n \"director\": \"Ron Shelton\",\n \"title\": \"Tin Cup\",\n \"genre\": \"Romantic Comedy\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 105\n },\n {\n \"id\": 27,\n \"releaseDate\": \"Jul 19 1996\",\n \"director\": \"Danny Boyle\",\n \"title\": \"Trainspotting\",\n \"genre\": \"Drama\",\n \"imdbRating\": 8.2,\n \"runningTimeMin\": 94\n },\n {\n \"id\": 28,\n \"releaseDate\": \"Jul 24 1996\",\n \"director\": \"Joel Schumacher\",\n \"title\": \"A Time to Kill\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.1,\n \"runningTimeMin\": 150\n },\n {\n \"id\": 29,\n \"releaseDate\": \"Oct 04 1996\",\n \"director\": \"Tom Hanks\",\n \"title\": \"That Thing You Do!\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.7,\n \"runningTimeMin\": 110\n },\n {\n \"id\": 30,\n \"releaseDate\": \"May 10 1996\",\n \"director\": \"Jan De Bont\",\n \"title\": \"Twister\",\n \"genre\": \"Action\",\n \"imdbRating\": 6,\n \"runningTimeMin\": 117\n },\n {\n \"id\": 31,\n \"releaseDate\": \"Apr 23 2004\",\n \"director\": \"Gary Winick\",\n \"title\": \"13 Going On 30\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 98\n },\n {\n \"id\": 32,\n \"releaseDate\": \"Nov 13 2009\",\n \"director\": \"Roland Emmerich\",\n \"title\": 2012,\n \"genre\": \"Action\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 158\n },\n {\n \"id\": 33,\n \"releaseDate\": \"Jun 27 2003\",\n \"director\": \"Danny Boyle\",\n \"title\": \"28 Days Later...\",\n \"genre\": \"Horror\",\n \"imdbRating\": 7.6,\n \"runningTimeMin\": 113\n },\n {\n \"id\": 34,\n \"releaseDate\": \"Mar 09 2007\",\n \"director\": \"Zack Snyder\",\n \"title\": 300,\n \"genre\": \"Action\",\n \"imdbRating\": 7.8,\n \"runningTimeMin\": 117\n },\n {\n \"id\": 35,\n \"releaseDate\": \"Oct 01 1999\",\n \"director\": \"David O. Russell\",\n \"title\": \"Three Kings\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 115\n },\n {\n \"id\": 36,\n \"releaseDate\": \"Sep 02 2007\",\n \"director\": \"James Mangold\",\n \"title\": \"3:10 to Yuma\",\n \"genre\": \"Western\",\n \"imdbRating\": 7.9,\n \"runningTimeMin\": 117\n },\n {\n \"id\": 37,\n \"releaseDate\": \"Aug 19 2005\",\n \"director\": \"Judd Apatow\",\n \"title\": \"The 40 Year-old Virgin\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7.5,\n \"runningTimeMin\": 111\n },\n {\n \"id\": 38,\n \"releaseDate\": \"Aug 12 2005\",\n \"director\": \"John Singleton\",\n \"title\": \"Four Brothers\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.8,\n \"runningTimeMin\": 109\n },\n {\n \"id\": 39,\n \"releaseDate\": \"Feb 13 2004\",\n \"director\": \"Peter Segal\",\n \"title\": \"50 First Dates\",\n \"genre\": \"Romantic Comedy\",\n \"imdbRating\": 6.8,\n \"runningTimeMin\": 99\n },\n {\n \"id\": 40,\n \"releaseDate\": \"Nov 08 2002\",\n \"director\": \"Curtis Hanson\",\n \"title\": \"8 Mile\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.7,\n \"runningTimeMin\": 110\n },\n {\n \"id\": 41,\n \"releaseDate\": \"May 17 2002\",\n \"director\": \"Paul Weitz\",\n \"title\": \"About a Boy\",\n \"genre\": \"Romantic Comedy\",\n \"imdbRating\": 7.4,\n \"runningTimeMin\": 101\n },\n {\n \"id\": 42,\n \"releaseDate\": \"Nov 20 1998\",\n \"director\": \"John Lasseter\",\n \"title\": \"A Bug's Life\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 96\n },\n {\n \"id\": 43,\n \"releaseDate\": \"Feb 14 1997\",\n \"director\": \"Clint Eastwood\",\n \"title\": \"Absolute Power\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 6.5,\n \"runningTimeMin\": 120\n },\n {\n \"id\": 44,\n \"releaseDate\": \"Nov 12 2004\",\n \"director\": \"Brett Ratner\",\n \"title\": \"After the Sunset\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 97\n },\n {\n \"id\": 45,\n \"releaseDate\": \"Nov 10 2006\",\n \"director\": \"Ridley Scott\",\n \"title\": \"A Good Year\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.8,\n \"runningTimeMin\": 118\n },\n {\n \"id\": 46,\n \"releaseDate\": \"Jul 25 1997\",\n \"director\": \"Wolfgang Petersen\",\n \"title\": \"Air Force One\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.3,\n \"runningTimeMin\": 124\n },\n {\n \"id\": 47,\n \"releaseDate\": \"Sep 22 2006\",\n \"director\": \"Steven Zaillian\",\n \"title\": \"All the King's Men\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6,\n \"runningTimeMin\": 128\n },\n {\n \"id\": 48,\n \"releaseDate\": \"Dec 25 2001\",\n \"director\": \"Michael Mann\",\n \"title\": \"Ali\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 159\n },\n {\n \"id\": 49,\n \"releaseDate\": \"Nov 26 1997\",\n \"director\": \"Jean-Pierre Jeunet\",\n \"title\": \"Alien: Resurrection\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 108\n },\n {\n \"id\": 50,\n \"releaseDate\": \"Sep 15 2000\",\n \"director\": \"Cameron Crowe\",\n \"title\": \"Almost Famous\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 8,\n \"runningTimeMin\": 123\n },\n {\n \"id\": 51,\n \"releaseDate\": \"May 23 2003\",\n \"director\": \"Tom Shadyac\",\n \"title\": \"Bruce Almighty\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 101\n },\n {\n \"id\": 52,\n \"releaseDate\": \"Apr 06 2001\",\n \"director\": \"Lee Tamahori\",\n \"title\": \"Along Came a Spider\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 103\n },\n {\n \"id\": 53,\n \"releaseDate\": \"Sep 15 1999\",\n \"director\": \"Sam Mendes\",\n \"title\": \"American Beauty\",\n \"genre\": \"Drama\",\n \"imdbRating\": 8.6,\n \"runningTimeMin\": 118\n },\n {\n \"id\": 54,\n \"releaseDate\": \"Nov 02 2001\",\n \"director\": \"Jean-Pierre Jeunet\",\n \"title\": \"Le Fabuleux destin d'AmÈlie Poulain\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 8.5,\n \"runningTimeMin\": 122\n },\n {\n \"id\": 55,\n \"releaseDate\": \"Nov 02 2007\",\n \"director\": \"Ridley Scott\",\n \"title\": \"American Gangster\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.9,\n \"runningTimeMin\": 157\n },\n {\n \"id\": 56,\n \"releaseDate\": \"Dec 12 1997\",\n \"director\": \"Steven Spielberg\",\n \"title\": \"Amistad\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.1,\n \"runningTimeMin\": 152\n },\n {\n \"id\": 57,\n \"releaseDate\": \"Jul 09 1999\",\n \"director\": \"Paul Weitz\",\n \"title\": \"American Pie\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.9,\n \"runningTimeMin\": 95\n },\n {\n \"id\": 58,\n \"releaseDate\": \"Nov 14 1997\",\n \"director\": \"Don Bluth\",\n \"title\": \"Anastasia\",\n \"genre\": \"Musical\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 94\n },\n {\n \"id\": 59,\n \"releaseDate\": \"Jul 09 2004\",\n \"director\": \"Adam McKay\",\n \"title\": \"Anchorman: The Legend of Ron Burgundy\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7,\n \"runningTimeMin\": 104\n },\n {\n \"id\": 60,\n \"releaseDate\": \"Apr 11 2003\",\n \"director\": \"Peter Segal\",\n \"title\": \"Anger Management\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 106\n },\n {\n \"id\": 61,\n \"releaseDate\": \"Dec 17 1999\",\n \"director\": \"Andy Tennant\",\n \"title\": \"Anna and the King\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.5,\n \"runningTimeMin\": 147\n },\n {\n \"id\": 62,\n \"releaseDate\": \"Mar 05 1999\",\n \"director\": \"Harold Ramis\",\n \"title\": \"Analyze This\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 103\n },\n {\n \"id\": 63,\n \"releaseDate\": \"Oct 02 1998\",\n \"director\": \"Tim Johnson\",\n \"title\": \"Antz\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.8,\n \"runningTimeMin\": 83\n },\n {\n \"id\": 64,\n \"releaseDate\": \"Dec 08 2006\",\n \"director\": \"Mel Gibson\",\n \"title\": \"Apocalypto\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 7.9,\n \"runningTimeMin\": 136\n },\n {\n \"id\": 65,\n \"releaseDate\": \"Dec 17 1997\",\n \"director\": \"Robert Duvall\",\n \"title\": \"The Apostle\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.1,\n \"runningTimeMin\": 148\n },\n {\n \"id\": 66,\n \"releaseDate\": \"Jul 01 1998\",\n \"director\": \"Michael Bay\",\n \"title\": \"Armageddon\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 150\n },\n {\n \"id\": 67,\n \"releaseDate\": \"Jul 07 2004\",\n \"director\": \"Antoine Fuqua\",\n \"title\": \"King Arthur\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 126\n },\n {\n \"id\": 68,\n \"releaseDate\": \"Jun 29 2001\",\n \"director\": \"Steven Spielberg\",\n \"title\": \"Artificial Intelligence: AI\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.9,\n \"runningTimeMin\": 146\n },\n {\n \"id\": 69,\n \"releaseDate\": \"Oct 23 2009\",\n \"director\": \"David Bowers\",\n \"title\": \"Astro Boy\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 94\n },\n {\n \"id\": 70,\n \"releaseDate\": \"Feb 23 2007\",\n \"director\": \"Michael Polish\",\n \"title\": \"The Astronaut Farmer\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 109\n },\n {\n \"id\": 71,\n \"releaseDate\": \"Dec 24 1997\",\n \"director\": \"James L. Brooks\",\n \"title\": \"As Good as it Gets\",\n \"genre\": \"Romantic Comedy\",\n \"imdbRating\": 7.8,\n \"runningTimeMin\": 138\n },\n {\n \"id\": 72,\n \"releaseDate\": \"Dec 11 1998\",\n \"director\": \"Sam Raimi\",\n \"title\": \"A Simple Plan\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.6,\n \"runningTimeMin\": 121\n },\n {\n \"id\": 73,\n \"releaseDate\": \"Jun 11 2010\",\n \"director\": \"Joe Carnahan\",\n \"title\": \"The A-Team\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.2,\n \"runningTimeMin\": 119\n },\n {\n \"id\": 74,\n \"releaseDate\": \"Jun 08 2001\",\n \"director\": \"Gary Trousdale\",\n \"title\": \"Atlantis: The Lost Empire\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 96\n },\n {\n \"id\": 75,\n \"releaseDate\": \"Dec 07 2007\",\n \"director\": \"Joe Wright\",\n \"title\": \"Atonement\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.9,\n \"runningTimeMin\": 130\n },\n {\n \"id\": 76,\n \"releaseDate\": \"Jun 10 1999\",\n \"director\": \"Jay Roach\",\n \"title\": \"Austin Powers: The Spy Who Shagged Me\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 95\n },\n {\n \"id\": 77,\n \"releaseDate\": \"Jul 25 2002\",\n \"director\": \"Jay Roach\",\n \"title\": \"Austin Powers in Goldmember\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 94\n },\n {\n \"id\": 78,\n \"releaseDate\": \"May 02 1997\",\n \"director\": \"Jay Roach\",\n \"title\": \"Austin Powers: International Man of Mystery\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7.1,\n \"runningTimeMin\": 89\n },\n {\n \"id\": 79,\n \"releaseDate\": \"Dec 17 2004\",\n \"director\": \"Martin Scorsese\",\n \"title\": \"The Aviator\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.6,\n \"runningTimeMin\": 170\n },\n {\n \"id\": 80,\n \"releaseDate\": \"Jun 05 2009\",\n \"director\": \"Sam Mendes\",\n \"title\": \"Away We Go\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 98\n },\n {\n \"id\": 81,\n \"releaseDate\": \"Nov 25 1998\",\n \"director\": \"George Miller\",\n \"title\": \"Babe: Pig in the City\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 75\n },\n {\n \"id\": 82,\n \"releaseDate\": \"Jul 18 2003\",\n \"director\": \"Michael Bay\",\n \"title\": \"Bad Boys II\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 147\n },\n {\n \"id\": 83,\n \"releaseDate\": \"Mar 28 2003\",\n \"director\": \"John McTiernan\",\n \"title\": \"Basic\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 6.3,\n \"runningTimeMin\": 98\n },\n {\n \"id\": 84,\n \"releaseDate\": \"Jun 15 2005\",\n \"director\": \"Christopher Nolan\",\n \"title\": \"Batman Begins\",\n \"genre\": \"Action\",\n \"imdbRating\": 8.3,\n \"runningTimeMin\": 140\n },\n {\n \"id\": 85,\n \"releaseDate\": \"Jul 18 2008\",\n \"director\": \"Christopher Nolan\",\n \"title\": \"The Dark Knight\",\n \"genre\": \"Action\",\n \"imdbRating\": 8.9,\n \"runningTimeMin\": 152\n },\n {\n \"id\": 86,\n \"releaseDate\": \"Jun 27 2001\",\n \"director\": \"John Singleton\",\n \"title\": \"Baby Boy\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 130\n },\n {\n \"id\": 87,\n \"releaseDate\": \"Dec 25 2008\",\n \"director\": \"David Fincher\",\n \"title\": \"The Curious Case of Benjamin Button\",\n \"genre\": \"Drama\",\n \"imdbRating\": 8,\n \"runningTimeMin\": 167\n },\n {\n \"id\": 88,\n \"releaseDate\": \"Oct 10 2008\",\n \"director\": \"Ridley Scott\",\n \"title\": \"Body of Lies\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 7.2,\n \"runningTimeMin\": 129\n },\n {\n \"id\": 89,\n \"releaseDate\": \"Dec 08 2006\",\n \"director\": \"Edward Zwick\",\n \"title\": \"Blood Diamond\",\n \"genre\": \"Action\",\n \"imdbRating\": 8,\n \"runningTimeMin\": 143\n },\n {\n \"id\": 90,\n \"releaseDate\": \"Dec 20 1996\",\n \"director\": \"Mike Judge\",\n \"title\": \"Beavis and Butt-head Do America\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 80\n },\n {\n \"id\": 91,\n \"releaseDate\": \"Mar 12 2003\",\n \"director\": \"Gurinder Chadha\",\n \"title\": \"Bend it Like Beckham\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.9,\n \"runningTimeMin\": 112\n },\n {\n \"id\": 92,\n \"releaseDate\": \"Nov 23 2001\",\n \"director\": \"Todd Field\",\n \"title\": \"In the Bedroom\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.5,\n \"runningTimeMin\": 130\n },\n {\n \"id\": 93,\n \"releaseDate\": \"Nov 02 2007\",\n \"director\": \"Steve Hickner\",\n \"title\": \"Bee Movie\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.3,\n \"runningTimeMin\": 90\n },\n {\n \"id\": 94,\n \"releaseDate\": \"Oct 29 1999\",\n \"director\": \"Spike Jonze\",\n \"title\": \"Being John Malkovich\",\n \"genre\": \"Black Comedy\",\n \"imdbRating\": 7.9,\n \"runningTimeMin\": 112\n },\n {\n \"id\": 95,\n \"releaseDate\": \"Nov 16 2007\",\n \"director\": \"Robert Zemeckis\",\n \"title\": \"Beowulf\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 115\n },\n {\n \"id\": 96,\n \"releaseDate\": \"Dec 10 2003\",\n \"director\": \"Tim Burton\",\n \"title\": \"Big Fish\",\n \"genre\": \"Drama\",\n \"imdbRating\": 8.1,\n \"runningTimeMin\": 125\n },\n {\n \"id\": 97,\n \"releaseDate\": \"Mar 06 1998\",\n \"director\": \"Joel Coen\",\n \"title\": \"The Big Lebowski\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 8.2,\n \"runningTimeMin\": 127\n },\n {\n \"id\": 98,\n \"releaseDate\": \"Dec 28 2001\",\n \"director\": \"Ridley Scott\",\n \"title\": \"Black Hawk Down\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.7,\n \"runningTimeMin\": 144\n },\n {\n \"id\": 99,\n \"releaseDate\": \"Oct 13 2000\",\n \"director\": \"Stephen Daldry\",\n \"title\": \"Billy Elliot\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.7,\n \"runningTimeMin\": 110\n },\n {\n \"id\": 100,\n \"releaseDate\": \"Dec 17 1999\",\n \"director\": \"Chris Columbus\",\n \"title\": \"Bicentennial Man\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 132\n },\n {\n \"id\": 101,\n \"releaseDate\": \"Aug 21 1998\",\n \"director\": \"Stephen Norrington\",\n \"title\": \"Blade\",\n \"genre\": \"Action\",\n \"imdbRating\": 7,\n \"runningTimeMin\": 121\n },\n {\n \"id\": 102,\n \"releaseDate\": \"Feb 12 1999\",\n \"director\": \"Hugh Wilson\",\n \"title\": \"Blast from the Past\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 111\n },\n {\n \"id\": 103,\n \"releaseDate\": \"Aug 09 2002\",\n \"director\": \"Clint Eastwood\",\n \"title\": \"Blood Work\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 6.3,\n \"runningTimeMin\": 110\n },\n {\n \"id\": 104,\n \"releaseDate\": \"Jul 13 2001\",\n \"director\": \"Robert Luketic\",\n \"title\": \"Legally Blonde\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 97\n },\n {\n \"id\": 105,\n \"releaseDate\": \"Apr 06 2001\",\n \"director\": \"Ted Demme\",\n \"title\": \"Blow\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.4,\n \"runningTimeMin\": 123\n },\n {\n \"id\": 106,\n \"releaseDate\": \"Dec 21 2001\",\n \"director\": \"Ron Howard\",\n \"title\": \"A Beautiful Mind\",\n \"genre\": \"Drama\",\n \"imdbRating\": 8,\n \"runningTimeMin\": 135\n },\n {\n \"id\": 107,\n \"releaseDate\": \"Oct 12 2001\",\n \"director\": \"Barry Levinson\",\n \"title\": \"Bandits\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.5,\n \"runningTimeMin\": 123\n },\n {\n \"id\": 108,\n \"releaseDate\": \"Nov 17 2006\",\n \"director\": \"Emilio Estevez\",\n \"title\": \"Bobby\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.1,\n \"runningTimeMin\": 120\n },\n {\n \"id\": 109,\n \"releaseDate\": \"Nov 05 1999\",\n \"director\": \"Phillip Noyce\",\n \"title\": \"The Bone Collector\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 6.3,\n \"runningTimeMin\": 118\n },\n {\n \"id\": 110,\n \"releaseDate\": \"Oct 10 1997\",\n \"director\": \"Paul Thomas Anderson\",\n \"title\": \"Boogie Nights\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.9,\n \"runningTimeMin\": 152\n },\n {\n \"id\": 111,\n \"releaseDate\": \"Nov 03 2006\",\n \"director\": \"Larry Charles\",\n \"title\": \"Borat\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7.7,\n \"runningTimeMin\": 83\n },\n {\n \"id\": 112,\n \"releaseDate\": \"Jun 14 2002\",\n \"director\": \"Doug Liman\",\n \"title\": \"The Bourne Identity\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.7,\n \"runningTimeMin\": 110\n },\n {\n \"id\": 113,\n \"releaseDate\": \"Jul 23 2004\",\n \"director\": \"Paul Greengrass\",\n \"title\": \"The Bourne Supremacy\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.6,\n \"runningTimeMin\": 108\n },\n {\n \"id\": 114,\n \"releaseDate\": \"Aug 03 2007\",\n \"director\": \"Paul Greengrass\",\n \"title\": \"The Bourne Ultimatum\",\n \"genre\": \"Action\",\n \"imdbRating\": 8.2,\n \"runningTimeMin\": 114\n },\n {\n \"id\": 115,\n \"releaseDate\": \"Oct 22 1999\",\n \"director\": \"Martin Scorsese\",\n \"title\": \"Bringing Out The Dead\",\n \"genre\": \"Black Comedy\",\n \"imdbRating\": 6.8,\n \"runningTimeMin\": 120\n },\n {\n \"id\": 116,\n \"releaseDate\": \"Dec 09 2005\",\n \"director\": \"Ang Lee\",\n \"title\": \"Brokeback Mountain\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.8,\n \"runningTimeMin\": 134\n },\n {\n \"id\": 117,\n \"releaseDate\": \"Sep 13 2002\",\n \"director\": \"Tim Story\",\n \"title\": \"Barbershop\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 103\n },\n {\n \"id\": 118,\n \"releaseDate\": \"Sep 27 2000\",\n \"director\": \"Christopher Guest\",\n \"title\": \"Best in Show\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7.4,\n \"runningTimeMin\": 90\n },\n {\n \"id\": 119,\n \"releaseDate\": \"Nov 26 2003\",\n \"director\": \"Terry Zwigoff\",\n \"title\": \"Bad Santa\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 91\n },\n {\n \"id\": 120,\n \"releaseDate\": \"Aug 21 2009\",\n \"director\": \"Quentin Tarantino\",\n \"title\": \"Inglourious Basterds\",\n \"genre\": \"Action\",\n \"imdbRating\": 8.4,\n \"runningTimeMin\": 152\n },\n {\n \"id\": 121,\n \"releaseDate\": \"May 15 1998\",\n \"director\": \"Warren Beatty\",\n \"title\": \"Bulworth\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.8,\n \"runningTimeMin\": 107\n },\n {\n \"id\": 122,\n \"releaseDate\": \"Aug 13 1999\",\n \"director\": \"Frank Oz\",\n \"title\": \"Bowfinger\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 96\n },\n {\n \"id\": 123,\n \"releaseDate\": \"Dec 22 2000\",\n \"director\": \"Robert Zemeckis\",\n \"title\": \"Cast Away\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.5,\n \"runningTimeMin\": 144\n },\n {\n \"id\": 124,\n \"releaseDate\": \"Sep 10 2004\",\n \"director\": \"David R. Ellis\",\n \"title\": \"Cellular\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 6.5,\n \"runningTimeMin\": 94\n },\n {\n \"id\": 125,\n \"releaseDate\": \"Oct 10 2008\",\n \"director\": \"Gil Kenan\",\n \"title\": \"City of Ember\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 94\n },\n {\n \"id\": 126,\n \"releaseDate\": \"Jul 15 2005\",\n \"director\": \"Tim Burton\",\n \"title\": \"Charlie and the Chocolate Factory\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7.1,\n \"runningTimeMin\": 115\n },\n {\n \"id\": 127,\n \"releaseDate\": \"Oct 27 2006\",\n \"director\": \"Phillip Noyce\",\n \"title\": \"Catch a Fire\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 6.8,\n \"runningTimeMin\": 101\n },\n {\n \"id\": 128,\n \"releaseDate\": \"Dec 27 2002\",\n \"director\": \"Rob Marshall\",\n \"title\": \"Chicago\",\n \"genre\": \"Musical\",\n \"imdbRating\": 7.2,\n \"runningTimeMin\": 113\n },\n {\n \"id\": 129,\n \"releaseDate\": \"Jun 21 2000\",\n \"director\": \"Nick Park\",\n \"title\": \"Chicken Run\",\n \"genre\": \"Adventure\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 84\n },\n {\n \"id\": 130,\n \"releaseDate\": \"Dec 25 2006\",\n \"director\": \"Alfonso Cuaron\",\n \"title\": \"Children of Men\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 8.1,\n \"runningTimeMin\": 114\n },\n {\n \"id\": 131,\n \"releaseDate\": \"Nov 16 2007\",\n \"director\": \"Mike Newell\",\n \"title\": \"Love in the Time of Cholera\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.2,\n \"runningTimeMin\": 139\n },\n {\n \"id\": 132,\n \"releaseDate\": \"Dec 15 2000\",\n \"director\": \"Lasse Hallstrom\",\n \"title\": \"Chocolat\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 122\n },\n {\n \"id\": 133,\n \"releaseDate\": \"Dec 15 2006\",\n \"director\": \"Gary Winick\",\n \"title\": \"Charlotte's Web\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.7,\n \"runningTimeMin\": 98\n },\n {\n \"id\": 134,\n \"releaseDate\": \"Jun 03 2005\",\n \"director\": \"Ron Howard\",\n \"title\": \"Cinderella Man\",\n \"genre\": \"Drama\",\n \"imdbRating\": 8,\n \"runningTimeMin\": 144\n },\n {\n \"id\": 135,\n \"releaseDate\": \"Apr 10 1998\",\n \"director\": \"Brad Silberling\",\n \"title\": \"City of Angels\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 117\n },\n {\n \"id\": 136,\n \"releaseDate\": \"Dec 25 1998\",\n \"director\": \"Steven Zaillian\",\n \"title\": \"A Civil Action\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.4,\n \"runningTimeMin\": 112\n },\n {\n \"id\": 137,\n \"releaseDate\": \"Dec 25 2003\",\n \"director\": \"Anthony Minghella\",\n \"title\": \"Cold Mountain\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 152\n },\n {\n \"id\": 138,\n \"releaseDate\": \"Feb 18 2005\",\n \"director\": \"Francis Lawrence\",\n \"title\": \"Constantine\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.7,\n \"runningTimeMin\": 122\n },\n {\n \"id\": 139,\n \"releaseDate\": \"Aug 06 2004\",\n \"director\": \"Michael Mann\",\n \"title\": \"Collateral\",\n \"genre\": \"Action\",\n \"imdbRating\": 7.8,\n \"runningTimeMin\": 120\n },\n {\n \"id\": 140,\n \"releaseDate\": \"Jun 06 1997\",\n \"director\": \"Simon West\",\n \"title\": \"Con Air\",\n \"genre\": \"Action\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 115\n },\n {\n \"id\": 141,\n \"releaseDate\": \"Aug 08 1997\",\n \"director\": \"Richard Donner\",\n \"title\": \"Conspiracy Theory\",\n \"genre\": \"Thriller/Suspense\",\n \"imdbRating\": 6.5,\n \"runningTimeMin\": 135\n },\n {\n \"id\": 142,\n \"releaseDate\": \"Jul 11 1997\",\n \"director\": \"Robert Zemeckis\",\n \"title\": \"Contact\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.3,\n \"runningTimeMin\": 150\n },\n {\n \"id\": 143,\n \"releaseDate\": \"Aug 15 1997\",\n \"director\": \"James Mangold\",\n \"title\": \"Cop Land\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.9,\n \"runningTimeMin\": 105\n },\n {\n \"id\": 144,\n \"releaseDate\": \"Dec 21 2006\",\n \"director\": \"Yimou Zhang\",\n \"title\": \"Man cheng jin dai huang jin jia\",\n \"genre\": \"Action\",\n \"imdbRating\": 7,\n \"runningTimeMin\": 113\n },\n {\n \"id\": 145,\n \"releaseDate\": \"May 06 2005\",\n \"director\": \"Paul Haggis\",\n \"title\": \"Crash\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.1,\n \"runningTimeMin\": 107\n },\n {\n \"id\": 146,\n \"releaseDate\": \"Jan 25 2002\",\n \"director\": \"Kevin Reynolds\",\n \"title\": \"The Count of Monte Cristo\",\n \"genre\": \"Drama\",\n \"imdbRating\": 7.6,\n \"runningTimeMin\": 131\n },\n {\n \"id\": 147,\n \"releaseDate\": \"Mar 05 1999\",\n \"director\": \"Roger Kumble\",\n \"title\": \"Cruel Intentions\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.7,\n \"runningTimeMin\": 95\n },\n {\n \"id\": 148,\n \"releaseDate\": \"Apr 16 2010\",\n \"director\": \"James Ivory\",\n \"title\": \"The City of Your Final Destination\",\n \"genre\": \"Drama\",\n \"imdbRating\": 6.6,\n \"runningTimeMin\": 114\n },\n {\n \"id\": 149,\n \"releaseDate\": \"Sep 18 2009\",\n \"director\": \"Phil Lord\",\n \"title\": \"Cloudy with a Chance of Meatballs\",\n \"genre\": \"Comedy\",\n \"imdbRating\": 7.2,\n \"runningTimeMin\": 90\n },\n {\n \"id\": 150,\n \"releaseDate\": \"Mar 19 2004\",\n \"director\": \"Zack Snyder\",\n \"title\": \"Dawn of the Dead\",\n \"genre\": \"Horror\",\n \"imdbRating\": 7.4,\n \"runningTimeMin\": 100\n }\n]\n" }, { "path": "examples/k8s-testing-with-kubectl-artillery/hack/kind/kind-with-registry.sh", "content": "#!/bin/bash\nset -o errexit\nset -o posix\n\n# full directory name of the script no matter where it is being called from\nscript_dir=\"$( cd -- \"$( dirname -- \"${BASH_SOURCE[0]}\" )\" &> /dev/null && pwd )\"\n\n# create registry container unless it already exists\nreg_name='kind-registry'\nreg_port='5000'\nrunning=\"$(docker inspect -f '{{.State.Running}}' \"${reg_name}\" 2>/dev/null || true)\"\n\nif [ \"${running}\" != 'true' ]; then\n docker run \\\n -d --restart=always -p \"127.0.0.1:${reg_port}:5000\" --name \"${reg_name}\" \\\n registry:2\nfi\necho \"Ran registry ${reg_name}:${reg_port}\"\n\n# create data directory to mount volumes - ignored by git and docker\nmkdir -p ${script_dir}/data\n\n# create a cluster with the local registry enabled in containerd\ncat < {\n const { username, password } = req.body;\n\n if (username && password) {\n res.cookie('username', username);\n res.json({ success: true });\n } else {\n res.status(422).json({ error: 'Username and password are required' });\n }\n});\n\napp.delete('/logout', (_, res) => {\n res.clearCookie('username');\n res.sendStatus(204);\n});\n\napp.get('/account', (req, res) => {\n res.json({ user: req.cookies });\n});\n\napp.get('/movies', (_, res) => {\n res.json(response);\n});\n\napp.get('/movies/:id', (req, res) => {\n const id = parseInt(req.params.id, 10);\n\n res.json(response.filter((movie) => movie.id === id).pop());\n});\n\napp.get('/healthz', (_req, res) => {\n if (response.length > 0) {\n res.status(200).send('Ok');\n } else {\n res.status(500).send('Movie data is missing');\n }\n});\n\nmodule.exports = app;\n" }, { "path": "examples/k8s-testing-with-kubectl-artillery/k8s-deploy.yaml", "content": "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: movie-browser\n labels:\n app: movie-browser\nspec:\n replicas: 1\n selector:\n matchLabels:\n app: movie-browser\n template:\n metadata:\n labels:\n app: movie-browser\n spec:\n containers:\n - name: nginx\n image: ghcr.io/artilleryio/movie-browser-test-endpoints:latest\n ports:\n - containerPort: 3001\n livenessProbe:\n initialDelaySeconds: 1\n periodSeconds: 2\n timeoutSeconds: 1\n successThreshold: 1\n failureThreshold: 1\n httpGet:\n path: /healthz\n httpHeaders:\n - name: Host\n value: myapplication1.com\n port: 3001\n---\n\napiVersion: v1\nkind: Service\nmetadata:\n labels:\n app: movie-browser\n name: movie-browser-service\n namespace: default\nspec:\n ports:\n - name: nginx-http-port\n port: 80\n targetPort: 3001\n selector:\n app: movie-browser\n sessionAffinity: None\n type: ClusterIP\n" }, { "path": "examples/k8s-testing-with-kubectl-artillery/package.json", "content": "{\n \"name\": \"movie-browser-test-endpoints\",\n \"version\": \"1.0.0\",\n \"description\": \"Artillery.io - Movie Browser HTTP test server\",\n \"main\": \"app.js\",\n \"scripts\": {\n \"test\": \"echo \\\"Error: no test specified\\\" && exit 1\",\n \"start\": \"node app.js\"\n },\n \"author\": \"\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"cookie-parser\": \"^1.4.5\",\n \"express\": \"^4.17.1\"\n }\n}\n" }, { "path": "examples/multiple-scenario-specs/README.md", "content": "# Separating scenarios into separate files\n\nThis example shows how an Artillery test suite can be organized into individual scenario specs, and how those specs can be run one at a time, and all together at the same time.\n\n## Artillery's `--config` flag\n\nThis example makes use of the `--config` flag availale in `run` and `aws:run` commands. ([docs](https://www.artillery.io/docs/guides/guides/command-line#run---run-a-test-script))\n\nThis flag allows us to extract the `config` section of an Artillery's test script into a separate file and provide it to Artillery when we run a test through the flag.\n\nWe can take this one step further, and also extract our scenarios into separate files for a tidier codebase. ✨\n\n## Code layout\n\nOur code in this example is laid out as follows:\n\n```\n├── README.md\n├── common-config.yml\n└── scenarios\n ├── armadillo.yml\n ├── dino.yml\n └── pony.yml\n```\n\n- the `common-config.yml` contains configuration for our test\n- the `scenarios/` directory contains 3 scenarios\n\n## Service we're testing\n\nWe're testing a simple service that returns ASCII pictures of various animals.\n\nFor example, to see a picture of an armadillo, send a GET request to http://asciizoo.artillery.io:8080/armadillo:\n\n```sh\nskytrace probe http://asciizoo.artillery.io:8080/armadillo -b\n```\n\n![armadillo](./artillery-probe.png)\n\n## Running one scenario\n\nTo run one scenario, e.g. the scenario that tests the `/armadillo` endpoint, run:\n\n```sh\nartillery run --config common-config.yml scenarios/armadillo.yml\n```\n\n## Running multiple scenarios at once\n\nArtillery CLI does not support running multiple scenarios with one command yet, but we can use a short shell script to iterate through the scenario files for us, and run Artillery on each of them in sequence.\n\nOn a Mac/Linux system it would look like this:\n\n```sh\nfor scenarioFile in `ls scenarios/*.yml` ; do\n artillery run --config common-config.yml scenarios/$scenarioFile\ndone\n```\n\nThe script looks for files with the `yml` extension under `scenarios/` and runs Artillery with each of those one after another.\n" }, { "path": "examples/multiple-scenario-specs/common-config.yml", "content": "config:\n target: http://asciizoo.artillery.io:8080\n plugins:\n metrics-by-endpoint: {}\n expect: {}" }, { "path": "examples/multiple-scenario-specs/scenarios/armadillo.yml", "content": "scenarios:\n - name: armadillo\n flow:\n - get:\n url: \"/armadillo\"\n expect:\n statusCode: 200" }, { "path": "examples/multiple-scenario-specs/scenarios/dino.yml", "content": "scenarios:\n - name: dino\n flow:\n - get:\n url: \"/dino\"\n expect:\n statusCode: 200" }, { "path": "examples/multiple-scenario-specs/scenarios/pony.yml", "content": "scenarios:\n - name: pony\n flow:\n - get:\n url: \"/pony\"\n expect:\n statusCode: 200" }, { "path": "examples/prometheus-grafana-dashboards/README.md", "content": "# Prometheus Grafana Dashboards\n\nThis a collection of Grafana dashboards that visualise Artillery test result data collected using the \n[Prometheus](https://www.artillery.io/docs/guides/plugins/plugin-publish-metrics#prometheus-pushgateway) \ntarget of the [publish-metrics](https://www.artillery.io/docs/guides/plugins/plugin-publish-metrics) plugin.\n\nThe dashboards were exported as JSON and [can be easily imported into Grafana](https://grafana.com/docs/grafana/latest/dashboards/export-import/#import-dashboard).\n\n__NOTE__\n\nThe data is collected by Prometheus using the Pushgateway, this caches the data so the graphs never reset to zero.\n\nThis means as a user viewing the data, the last value will keep repeating indefinitely.\n\nGenerally, this is the expected behaviour when using the Pushgateway.\n\nSee, [Should I be using the Pushgateway](https://prometheus.io/docs/practices/pushing/).\nAnd this [Stack Overflow ticket](https://stackoverflow.com/questions/60039289/how-to-display-zero-instead-of-last-value-in-prometheus-grafana).\n\n## vusers metrics\n\nThis dashboard, `dashboard-vusers-metrics-1652971366368.json`, visualizes `vusers` metrics. \n\n## http metrics\n\nThis dashboard, `dashboard-http-metrics-1652971310916.json`, visualizes `http` metrics. \n" }, { "path": "examples/prometheus-grafana-dashboards/dashboard-http-metrics-1652971310916.json", "content": "{\n \"__inputs\": [\n {\n \"name\": \"DS_PROMETHEUS\",\n \"label\": \"Prometheus\",\n \"description\": \"\",\n \"type\": \"datasource\",\n \"pluginId\": \"prometheus\",\n \"pluginName\": \"Prometheus\"\n }\n ],\n \"__elements\": [],\n \"__requires\": [\n {\n \"type\": \"panel\",\n \"id\": \"barchart\",\n \"name\": \"Bar chart\",\n \"version\": \"\"\n },\n {\n \"type\": \"grafana\",\n \"id\": \"grafana\",\n \"name\": \"Grafana\",\n \"version\": \"8.4.5\"\n },\n {\n \"type\": \"datasource\",\n \"id\": \"prometheus\",\n \"name\": \"Prometheus\",\n \"version\": \"1.0.0\"\n },\n {\n \"type\": \"panel\",\n \"id\": \"timeseries\",\n \"name\": \"Time series\",\n \"version\": \"\"\n }\n ],\n \"annotations\": {\n \"list\": [\n {\n \"builtIn\": 1,\n \"datasource\": \"-- Grafana --\",\n \"enable\": true,\n \"hide\": true,\n \"iconColor\": \"rgba(0, 211, 255, 1)\",\n \"name\": \"Annotations & Alerts\",\n \"target\": {\n \"limit\": 100,\n \"matchAny\": false,\n \"tags\": [],\n \"type\": \"dashboard\"\n },\n \"type\": \"dashboard\"\n }\n ]\n },\n \"description\": \"http metrics\",\n \"editable\": true,\n \"fiscalYearStartMonth\": 0,\n \"graphTooltip\": 0,\n \"id\": null,\n \"iteration\": 1652970863157,\n \"links\": [],\n \"liveNow\": false,\n \"panels\": [\n {\n \"description\": \"Metrics for http.codes\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisLabel\": \"Count\",\n \"axisPlacement\": \"left\",\n \"axisSoftMin\": 0,\n \"axisWidth\": 30,\n \"fillOpacity\": 14,\n \"gradientMode\": \"none\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"lineWidth\": 1,\n \"scaleDistribution\": {\n \"log\": 10,\n \"type\": \"log\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\",\n \"value\": null\n },\n {\n \"color\": \"red\",\n \"value\": 80\n }\n ]\n }\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 11,\n \"w\": 18,\n \"x\": 3,\n \"y\": 0\n },\n \"id\": 2,\n \"interval\": \"10s\",\n \"options\": {\n \"barRadius\": 0,\n \"barWidth\": 1,\n \"groupWidth\": 0.7,\n \"legend\": {\n \"calcs\": [],\n \"displayMode\": \"list\",\n \"placement\": \"bottom\"\n },\n \"orientation\": \"auto\",\n \"showValue\": \"auto\",\n \"stacking\": \"none\",\n \"text\": {\n \"valueSize\": 0\n },\n \"tooltip\": {\n \"mode\": \"single\",\n \"sort\": \"none\"\n },\n \"xField\": \"Time\",\n \"xTickLabelMaxLength\": 1,\n \"xTickLabelRotation\": 0,\n \"xTickLabelSpacing\": -100\n },\n \"pluginVersion\": \"8.4.5\",\n \"targets\": [\n {\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${DS_PROMETHEUS}\"\n },\n \"exemplar\": true,\n \"expr\": \"artillery_counters{test_id=~\\\"$test_id\\\", metric=~\\\"http_codes_$http_codes\\\"}\",\n \"format\": \"time_series\",\n \"instant\": false,\n \"interval\": \"\",\n \"intervalFactor\": 1,\n \"legendFormat\": \"\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"http.codes.$http_codes\",\n \"transformations\": [],\n \"type\": \"barchart\"\n },\n {\n \"description\": \"Metrics for http.requests\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisLabel\": \"Count\",\n \"axisPlacement\": \"left\",\n \"axisSoftMin\": 0,\n \"axisWidth\": 30,\n \"fillOpacity\": 14,\n \"gradientMode\": \"none\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"lineWidth\": 1,\n \"scaleDistribution\": {\n \"log\": 10,\n \"type\": \"log\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\",\n \"value\": null\n },\n {\n \"color\": \"red\",\n \"value\": 80\n }\n ]\n }\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 11,\n \"w\": 18,\n \"x\": 3,\n \"y\": 11\n },\n \"id\": 3,\n \"interval\": \"10s\",\n \"options\": {\n \"barRadius\": 0,\n \"barWidth\": 1,\n \"groupWidth\": 0.7,\n \"legend\": {\n \"calcs\": [],\n \"displayMode\": \"list\",\n \"placement\": \"bottom\"\n },\n \"orientation\": \"auto\",\n \"showValue\": \"auto\",\n \"stacking\": \"none\",\n \"text\": {\n \"valueSize\": 0\n },\n \"tooltip\": {\n \"mode\": \"single\",\n \"sort\": \"none\"\n },\n \"xField\": \"Time\",\n \"xTickLabelMaxLength\": 1,\n \"xTickLabelRotation\": 0,\n \"xTickLabelSpacing\": -100\n },\n \"pluginVersion\": \"8.4.5\",\n \"targets\": [\n {\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${DS_PROMETHEUS}\"\n },\n \"exemplar\": true,\n \"expr\": \"artillery_counters{test_id=~\\\"$test_id\\\", metric=\\\"http_requests\\\"}\",\n \"format\": \"table\",\n \"instant\": false,\n \"interval\": \"\",\n \"intervalFactor\": 1,\n \"legendFormat\": \"\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"http.requests\",\n \"transformations\": [],\n \"type\": \"barchart\"\n },\n {\n \"description\": \"Metrics for http.response_time\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisLabel\": \"\",\n \"axisPlacement\": \"auto\",\n \"barAlignment\": 0,\n \"drawStyle\": \"line\",\n \"fillOpacity\": 25,\n \"gradientMode\": \"none\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"lineInterpolation\": \"linear\",\n \"lineWidth\": 1,\n \"pointSize\": 5,\n \"scaleDistribution\": {\n \"type\": \"linear\"\n },\n \"showPoints\": \"auto\",\n \"spanNulls\": false,\n \"stacking\": {\n \"group\": \"A\",\n \"mode\": \"normal\"\n },\n \"thresholdsStyle\": {\n \"mode\": \"off\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\",\n \"value\": null\n },\n {\n \"color\": \"red\",\n \"value\": 80\n }\n ]\n }\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 12,\n \"w\": 18,\n \"x\": 3,\n \"y\": 22\n },\n \"id\": 5,\n \"interval\": \"10s\",\n \"options\": {\n \"legend\": {\n \"calcs\": [],\n \"displayMode\": \"list\",\n \"placement\": \"bottom\"\n },\n \"tooltip\": {\n \"mode\": \"single\",\n \"sort\": \"none\"\n }\n },\n \"pluginVersion\": \"8.4.5\",\n \"targets\": [\n {\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${DS_PROMETHEUS}\"\n },\n \"exemplar\": true,\n \"expr\": \"artillery_summaries{test_id=~\\\"$test_id\\\", metric=\\\"http_response_time_min\\\"}\",\n \"format\": \"time_series\",\n \"hide\": false,\n \"instant\": false,\n \"interval\": \"\",\n \"intervalFactor\": 1,\n \"legendFormat\": \"min\",\n \"refId\": \"A\"\n },\n {\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${DS_PROMETHEUS}\"\n },\n \"exemplar\": true,\n \"expr\": \"artillery_summaries{test_id=~\\\"$test_id\\\", metric=\\\"http_response_time_max\\\"}\",\n \"format\": \"time_series\",\n \"hide\": false,\n \"instant\": false,\n \"interval\": \"\",\n \"intervalFactor\": 1,\n \"legendFormat\": \"max\",\n \"refId\": \"B\"\n },\n {\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${DS_PROMETHEUS}\"\n },\n \"exemplar\": true,\n \"expr\": \"artillery_summaries{test_id=~\\\"$test_id\\\", metric=\\\"http_response_time_p95\\\"}\",\n \"format\": \"time_series\",\n \"hide\": false,\n \"instant\": false,\n \"interval\": \"\",\n \"intervalFactor\": 1,\n \"legendFormat\": \"p95\",\n \"refId\": \"C\"\n },\n {\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${DS_PROMETHEUS}\"\n },\n \"exemplar\": true,\n \"expr\": \"artillery_summaries{test_id=~\\\"$test_id\\\", metric=\\\"http_response_time_p99\\\"}\",\n \"format\": \"time_series\",\n \"hide\": false,\n \"instant\": false,\n \"interval\": \"\",\n \"intervalFactor\": 1,\n \"legendFormat\": \"p99\",\n \"refId\": \"D\"\n }\n ],\n \"title\": \"http.response_time\",\n \"transformations\": [],\n \"type\": \"timeseries\"\n },\n {\n \"description\": \"Metrics for http.responses\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisLabel\": \"Count\",\n \"axisPlacement\": \"left\",\n \"axisSoftMin\": 0,\n \"axisWidth\": 30,\n \"fillOpacity\": 14,\n \"gradientMode\": \"none\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"lineWidth\": 1,\n \"scaleDistribution\": {\n \"log\": 10,\n \"type\": \"log\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\",\n \"value\": null\n },\n {\n \"color\": \"red\",\n \"value\": 80\n }\n ]\n }\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 11,\n \"w\": 18,\n \"x\": 3,\n \"y\": 34\n },\n \"id\": 6,\n \"interval\": \"10s\",\n \"options\": {\n \"barRadius\": 0,\n \"barWidth\": 1,\n \"groupWidth\": 0.7,\n \"legend\": {\n \"calcs\": [],\n \"displayMode\": \"list\",\n \"placement\": \"bottom\"\n },\n \"orientation\": \"auto\",\n \"showValue\": \"auto\",\n \"stacking\": \"none\",\n \"text\": {\n \"valueSize\": 0\n },\n \"tooltip\": {\n \"mode\": \"single\",\n \"sort\": \"none\"\n },\n \"xField\": \"Time\",\n \"xTickLabelMaxLength\": 1,\n \"xTickLabelRotation\": 0,\n \"xTickLabelSpacing\": -100\n },\n \"pluginVersion\": \"8.4.5\",\n \"targets\": [\n {\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${DS_PROMETHEUS}\"\n },\n \"exemplar\": true,\n \"expr\": \"artillery_counters{test_id=~\\\"$test_id\\\", metric=\\\"http_responses\\\"}\",\n \"format\": \"table\",\n \"instant\": false,\n \"interval\": \"\",\n \"intervalFactor\": 1,\n \"legendFormat\": \"\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"http.responses\",\n \"transformations\": [],\n \"type\": \"barchart\"\n }\n ],\n \"schemaVersion\": 35,\n \"style\": \"dark\",\n \"tags\": [],\n \"templating\": {\n \"list\": [\n {\n \"current\": {},\n \"definition\": \"artillery_counters\",\n \"description\": \"Test Ids as tagged in the artillery.io test-script.yaml\",\n \"hide\": 0,\n \"includeAll\": false,\n \"label\": \"Select test_id\",\n \"multi\": false,\n \"name\": \"test_id\",\n \"options\": [],\n \"query\": {\n \"query\": \"artillery_counters\",\n \"refId\": \"StandardVariableQuery\"\n },\n \"refresh\": 1,\n \"regex\": \"/test_id=\\\"(?[^\\\"]+)/g\",\n \"skipUrlSync\": false,\n \"sort\": 0,\n \"type\": \"query\",\n \"datasource\": \"${DS_PROMETHEUS}\"\n },\n {\n \"current\": {},\n \"definition\": \"artillery_counters\",\n \"hide\": 0,\n \"includeAll\": false,\n \"label\": \"Select http_code\",\n \"multi\": false,\n \"name\": \"http_codes\",\n \"options\": [],\n \"query\": {\n \"query\": \"artillery_counters\",\n \"refId\": \"StandardVariableQuery\"\n },\n \"refresh\": 1,\n \"regex\": \"/.*http_codes_(.*)\\\".*,/\",\n \"skipUrlSync\": false,\n \"sort\": 0,\n \"type\": \"query\",\n \"datasource\": \"${DS_PROMETHEUS}\"\n }\n ]\n },\n \"time\": {\n \"from\": \"now-6h\",\n \"to\": \"now\"\n },\n \"timepicker\": {},\n \"timezone\": \"\",\n \"title\": \"Artillery - http metrics\",\n \"uid\": \"hsGnZJunz\",\n \"version\": 11,\n \"weekStart\": \"\"\n}\n" }, { "path": "examples/prometheus-grafana-dashboards/dashboard-vusers-metrics-1652971366368.json", "content": "{\n \"__inputs\": [\n {\n \"name\": \"DS_PROMETHEUS\",\n \"label\": \"Prometheus\",\n \"description\": \"\",\n \"type\": \"datasource\",\n \"pluginId\": \"prometheus\",\n \"pluginName\": \"Prometheus\"\n }\n ],\n \"__elements\": [],\n \"__requires\": [\n {\n \"type\": \"panel\",\n \"id\": \"barchart\",\n \"name\": \"Bar chart\",\n \"version\": \"\"\n },\n {\n \"type\": \"grafana\",\n \"id\": \"grafana\",\n \"name\": \"Grafana\",\n \"version\": \"8.4.5\"\n },\n {\n \"type\": \"datasource\",\n \"id\": \"prometheus\",\n \"name\": \"Prometheus\",\n \"version\": \"1.0.0\"\n },\n {\n \"type\": \"panel\",\n \"id\": \"timeseries\",\n \"name\": \"Time series\",\n \"version\": \"\"\n }\n ],\n \"annotations\": {\n \"list\": [\n {\n \"builtIn\": 1,\n \"datasource\": \"-- Grafana --\",\n \"enable\": true,\n \"hide\": true,\n \"iconColor\": \"rgba(0, 211, 255, 1)\",\n \"name\": \"Annotations & Alerts\",\n \"target\": {\n \"limit\": 100,\n \"matchAny\": false,\n \"tags\": [],\n \"type\": \"dashboard\"\n },\n \"type\": \"dashboard\"\n }\n ]\n },\n \"description\": \"vusers metrics\",\n \"editable\": true,\n \"fiscalYearStartMonth\": 0,\n \"graphTooltip\": 0,\n \"id\": null,\n \"iteration\": 1652971357928,\n \"links\": [],\n \"liveNow\": true,\n \"panels\": [\n {\n \"description\": \"Metrics for vusers.completed\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisLabel\": \"Count\",\n \"axisPlacement\": \"left\",\n \"axisSoftMin\": 0,\n \"axisWidth\": 30,\n \"fillOpacity\": 14,\n \"gradientMode\": \"none\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"lineWidth\": 1,\n \"scaleDistribution\": {\n \"log\": 10,\n \"type\": \"log\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\",\n \"value\": null\n },\n {\n \"color\": \"red\",\n \"value\": 80\n }\n ]\n }\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 11,\n \"w\": 18,\n \"x\": 2,\n \"y\": 0\n },\n \"id\": 3,\n \"interval\": \"10s\",\n \"options\": {\n \"barRadius\": 0,\n \"barWidth\": 1,\n \"groupWidth\": 0.7,\n \"legend\": {\n \"calcs\": [],\n \"displayMode\": \"list\",\n \"placement\": \"bottom\"\n },\n \"orientation\": \"auto\",\n \"showValue\": \"auto\",\n \"stacking\": \"none\",\n \"text\": {\n \"valueSize\": 0\n },\n \"tooltip\": {\n \"mode\": \"single\",\n \"sort\": \"none\"\n },\n \"xField\": \"Time\",\n \"xTickLabelMaxLength\": 1,\n \"xTickLabelRotation\": 0,\n \"xTickLabelSpacing\": -100\n },\n \"pluginVersion\": \"8.4.5\",\n \"targets\": [\n {\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${DS_PROMETHEUS}\"\n },\n \"exemplar\": true,\n \"expr\": \"artillery_counters{test_id=~\\\"$test_id\\\", metric=\\\"vusers_completed\\\"}\",\n \"format\": \"time_series\",\n \"instant\": false,\n \"interval\": \"\",\n \"intervalFactor\": 1,\n \"legendFormat\": \"\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"vusers.completed\",\n \"transformations\": [],\n \"type\": \"barchart\"\n },\n {\n \"description\": \"Metrics for vusers.created\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisLabel\": \"Count\",\n \"axisPlacement\": \"left\",\n \"axisSoftMin\": 0,\n \"axisWidth\": 30,\n \"fillOpacity\": 14,\n \"gradientMode\": \"none\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"lineWidth\": 1,\n \"scaleDistribution\": {\n \"log\": 10,\n \"type\": \"log\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\",\n \"value\": null\n },\n {\n \"color\": \"red\",\n \"value\": 80\n }\n ]\n }\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 12,\n \"w\": 18,\n \"x\": 2,\n \"y\": 11\n },\n \"id\": 4,\n \"interval\": \"10s\",\n \"options\": {\n \"barRadius\": 0,\n \"barWidth\": 1,\n \"groupWidth\": 0.7,\n \"legend\": {\n \"calcs\": [],\n \"displayMode\": \"list\",\n \"placement\": \"bottom\"\n },\n \"orientation\": \"auto\",\n \"showValue\": \"auto\",\n \"stacking\": \"none\",\n \"text\": {\n \"valueSize\": 0\n },\n \"tooltip\": {\n \"mode\": \"single\",\n \"sort\": \"none\"\n },\n \"xField\": \"Time\",\n \"xTickLabelMaxLength\": 1,\n \"xTickLabelRotation\": 0,\n \"xTickLabelSpacing\": -100\n },\n \"pluginVersion\": \"8.4.5\",\n \"targets\": [\n {\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${DS_PROMETHEUS}\"\n },\n \"exemplar\": true,\n \"expr\": \"artillery_counters{test_id=~\\\"$test_id\\\", metric=\\\"vusers_created\\\"}\",\n \"format\": \"time_series\",\n \"instant\": false,\n \"interval\": \"\",\n \"intervalFactor\": 1,\n \"legendFormat\": \"\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"vusers.created\",\n \"transformations\": [],\n \"type\": \"barchart\"\n },\n {\n \"description\": \"\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisLabel\": \"Count\",\n \"axisPlacement\": \"left\",\n \"axisSoftMin\": 0,\n \"axisWidth\": 30,\n \"fillOpacity\": 14,\n \"gradientMode\": \"none\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"lineWidth\": 1,\n \"scaleDistribution\": {\n \"log\": 10,\n \"type\": \"log\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\",\n \"value\": null\n },\n {\n \"color\": \"red\",\n \"value\": 80\n }\n ]\n }\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 11,\n \"w\": 18,\n \"x\": 2,\n \"y\": 23\n },\n \"id\": 2,\n \"interval\": \"10s\",\n \"options\": {\n \"barRadius\": 0,\n \"barWidth\": 1,\n \"groupWidth\": 0.7,\n \"legend\": {\n \"calcs\": [],\n \"displayMode\": \"list\",\n \"placement\": \"bottom\"\n },\n \"orientation\": \"auto\",\n \"showValue\": \"auto\",\n \"stacking\": \"none\",\n \"text\": {\n \"valueSize\": 0\n },\n \"tooltip\": {\n \"mode\": \"single\",\n \"sort\": \"none\"\n },\n \"xField\": \"Time\",\n \"xTickLabelMaxLength\": 1,\n \"xTickLabelRotation\": 0,\n \"xTickLabelSpacing\": -100\n },\n \"pluginVersion\": \"8.4.5\",\n \"targets\": [\n {\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${DS_PROMETHEUS}\"\n },\n \"exemplar\": true,\n \"expr\": \"artillery_counters{test_id=~\\\"$test_id\\\", metric=~\\\"vusers_created_by_name_$vusers_created_by_name\\\"}\",\n \"format\": \"time_series\",\n \"instant\": false,\n \"interval\": \"\",\n \"intervalFactor\": 1,\n \"legendFormat\": \"\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"vusers_created_by_name(_$vusers_created_by_name)\",\n \"transformations\": [],\n \"type\": \"barchart\"\n },\n {\n \"description\": \"Metrics for vusers_failed\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisLabel\": \"Count\",\n \"axisPlacement\": \"left\",\n \"axisSoftMin\": 0,\n \"axisWidth\": 30,\n \"fillOpacity\": 14,\n \"gradientMode\": \"none\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"lineWidth\": 1,\n \"scaleDistribution\": {\n \"log\": 10,\n \"type\": \"log\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\",\n \"value\": null\n },\n {\n \"color\": \"red\",\n \"value\": 80\n }\n ]\n }\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 12,\n \"w\": 18,\n \"x\": 2,\n \"y\": 34\n },\n \"id\": 5,\n \"interval\": \"10s\",\n \"options\": {\n \"barRadius\": 0,\n \"barWidth\": 1,\n \"groupWidth\": 0.7,\n \"legend\": {\n \"calcs\": [],\n \"displayMode\": \"list\",\n \"placement\": \"bottom\"\n },\n \"orientation\": \"auto\",\n \"showValue\": \"auto\",\n \"stacking\": \"none\",\n \"text\": {\n \"valueSize\": 0\n },\n \"tooltip\": {\n \"mode\": \"single\",\n \"sort\": \"none\"\n },\n \"xField\": \"Time\",\n \"xTickLabelMaxLength\": 1,\n \"xTickLabelRotation\": 0,\n \"xTickLabelSpacing\": -100\n },\n \"pluginVersion\": \"8.4.5\",\n \"targets\": [\n {\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${DS_PROMETHEUS}\"\n },\n \"exemplar\": true,\n \"expr\": \"artillery_counters{test_id=~\\\"$test_id\\\", metric=\\\"vusers_failed\\\"}\",\n \"format\": \"time_series\",\n \"instant\": false,\n \"interval\": \"\",\n \"intervalFactor\": 1,\n \"legendFormat\": \"\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"vusers.failed\",\n \"transformations\": [],\n \"type\": \"barchart\"\n },\n {\n \"description\": \"Metrics for vusers.session_length\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisLabel\": \"\",\n \"axisPlacement\": \"auto\",\n \"barAlignment\": 0,\n \"drawStyle\": \"line\",\n \"fillOpacity\": 25,\n \"gradientMode\": \"none\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"lineInterpolation\": \"linear\",\n \"lineWidth\": 1,\n \"pointSize\": 5,\n \"scaleDistribution\": {\n \"type\": \"linear\"\n },\n \"showPoints\": \"auto\",\n \"spanNulls\": false,\n \"stacking\": {\n \"group\": \"A\",\n \"mode\": \"normal\"\n },\n \"thresholdsStyle\": {\n \"mode\": \"off\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\",\n \"value\": null\n },\n {\n \"color\": \"red\",\n \"value\": 80\n }\n ]\n }\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 12,\n \"w\": 18,\n \"x\": 2,\n \"y\": 46\n },\n \"id\": 6,\n \"interval\": \"10s\",\n \"options\": {\n \"legend\": {\n \"calcs\": [],\n \"displayMode\": \"list\",\n \"placement\": \"bottom\"\n },\n \"tooltip\": {\n \"mode\": \"single\",\n \"sort\": \"none\"\n }\n },\n \"pluginVersion\": \"8.4.5\",\n \"targets\": [\n {\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${DS_PROMETHEUS}\"\n },\n \"exemplar\": true,\n \"expr\": \"artillery_summaries{test_id=~\\\"$test_id\\\", metric=\\\"vusers_session_length_min\\\"}\",\n \"format\": \"time_series\",\n \"hide\": false,\n \"instant\": false,\n \"interval\": \"\",\n \"intervalFactor\": 1,\n \"legendFormat\": \"min\",\n \"refId\": \"A\"\n },\n {\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${DS_PROMETHEUS}\"\n },\n \"exemplar\": true,\n \"expr\": \"artillery_summaries{test_id=~\\\"$test_id\\\", metric=\\\"vusers_session_length_max\\\"}\",\n \"format\": \"time_series\",\n \"hide\": false,\n \"instant\": false,\n \"interval\": \"\",\n \"intervalFactor\": 1,\n \"legendFormat\": \"max\",\n \"refId\": \"B\"\n },\n {\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${DS_PROMETHEUS}\"\n },\n \"exemplar\": true,\n \"expr\": \"artillery_summaries{test_id=~\\\"$test_id\\\", metric=\\\"vusers_session_length_p95\\\"}\",\n \"format\": \"time_series\",\n \"hide\": false,\n \"instant\": false,\n \"interval\": \"\",\n \"intervalFactor\": 1,\n \"legendFormat\": \"p95\",\n \"refId\": \"C\"\n },\n {\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${DS_PROMETHEUS}\"\n },\n \"exemplar\": true,\n \"expr\": \"artillery_summaries{test_id=~\\\"$test_id\\\", metric=\\\"vusers_session_length_p99\\\"}\",\n \"format\": \"time_series\",\n \"hide\": false,\n \"instant\": false,\n \"interval\": \"\",\n \"intervalFactor\": 1,\n \"legendFormat\": \"p99\",\n \"refId\": \"D\"\n }\n ],\n \"title\": \"vusers.session_length\",\n \"transformations\": [],\n \"type\": \"timeseries\"\n }\n ],\n \"refresh\": false,\n \"schemaVersion\": 35,\n \"style\": \"dark\",\n \"tags\": [],\n \"templating\": {\n \"list\": [\n {\n \"current\": {},\n \"definition\": \"artillery_counters\",\n \"description\": \"Test Ids as tagged in the artillery.io test-script.yaml\",\n \"hide\": 0,\n \"includeAll\": false,\n \"label\": \"Select test_id\",\n \"multi\": false,\n \"name\": \"test_id\",\n \"options\": [],\n \"query\": {\n \"query\": \"artillery_counters\",\n \"refId\": \"StandardVariableQuery\"\n },\n \"refresh\": 1,\n \"regex\": \"/test_id=\\\"(?[^\\\"]+)/g\",\n \"skipUrlSync\": false,\n \"sort\": 0,\n \"type\": \"query\",\n \"datasource\": \"${DS_PROMETHEUS}\"\n },\n {\n \"current\": {},\n \"definition\": \"artillery_counters\",\n \"hide\": 0,\n \"includeAll\": false,\n \"label\": \"Select vusers_created_by_name\",\n \"multi\": false,\n \"name\": \"vusers_created_by_name\",\n \"options\": [],\n \"query\": {\n \"query\": \"artillery_counters\",\n \"refId\": \"StandardVariableQuery\"\n },\n \"refresh\": 1,\n \"regex\": \"/.*vusers_created_by_name_(.*)\\\".*,/\",\n \"skipUrlSync\": false,\n \"sort\": 0,\n \"type\": \"query\",\n \"datasource\": \"${DS_PROMETHEUS}\"\n }\n ]\n },\n \"time\": {\n \"from\": \"now-5m\",\n \"to\": \"now\"\n },\n \"timepicker\": {\n \"hidden\": true\n },\n \"timezone\": \"\",\n \"title\": \"Artillery - vusers metrics\",\n \"uid\": \"siOy7cXnk\",\n \"version\": 22,\n \"weekStart\": \"\"\n}\n" }, { "path": "examples/refresh-auth-token/README.md", "content": "# refresh-auth-token example\n\nThis example shows how you can refresh an authentication token used by individual VUs as they're running.\n\nIt's a solution to the problem of the VUs needing to use a short-lived authentication token (or another short-lived value) in a test that runs longer than the expiration window of the token.\n\nIt works as follows:\n\n1. A `refreshTokenIfNeeded` function is set to be called before each request\n in a scenario. The function checks whether a token has already been created,\n and if it needs to be refreshed. The expiry window is set to 5s in this example.\n2. If a token needs to be created for the first time or refreshed, the `fetchToken()` function is called, and the result is stored in the `authToken` template variable.\n3. The `authToken` template variable is used as the value of `x-auth-token` header on the requests in the scenario.\n4. The VU scenario includes a 10s pause that will cause the existing token to expire and get refreshed before the last call to the `/armadillo` endpoint is made.\n\nTo adapt the example for your use-case:\n\n1. Increase the value of `TOKEN_REFRESH_INTERVAL` to match the expiry window of the tokens in your application.\n2. Update `fetchToken()` function with the logic to fetch a token, e.g. by making a HTTP call to an external API endpoint.\n\nRun the example:\n\n```sh\nDEBUG=http artillery run refresh.yml\n```\n\nYou should see output that looks similar to:\n\n```\nTest run id: tdhbk_bm63epyfgx8yt4atfethqmea34pxm_h9t9\nFetching new token\n expiry time: 1716981850536\n new token: token-1716981845535\n2024-05-29T11:24:05.840Z http request: {\n \"url\": \"http://asciizoo.artillery.io:8080/dino\",\n \"method\": \"GET\",\n \"headers\": {\n \"user-agent\": \"Artillery (https://artillery.io)\",\n \"x-auth-token\": \"token-1716981845535\"\n }\n}\n2024-05-29T11:24:05.913Z http request: {\n \"url\": \"http://asciizoo.artillery.io:8080/pony\",\n \"method\": \"GET\",\n \"headers\": {\n \"user-agent\": \"Artillery (https://artillery.io)\",\n \"x-auth-token\": \"token-1716981845535\"\n }\n}\nUsed auth token: token-1716981845535\nFetching new token\n expiry time: 1716981860917\n new token: token-1716981855917\n2024-05-29T11:24:16.627Z http request: {\n \"url\": \"http://asciizoo.artillery.io:8080/armadillo\",\n \"method\": \"GET\",\n \"headers\": {\n \"user-agent\": \"Artillery (https://artillery.io)\",\n \"x-auth-token\": \"token-1716981855917\"\n }\n}\nNow used a refreshed auth token: token-1716981855917\n```\n\nYou can see that a new token was created before any requests were made by the VU, and that the first two requests (to `/dino` and `/pony` endpoints) used that token.\n\nBecause of the 10s pause in the VU scenario the token was deemed as expired, and was refreshed before the third call to `/armadillo` endpoint was made. The call to `/armadillo` endpoint used the refreshed value of the token.\n" }, { "path": "examples/refresh-auth-token/refresh.mjs", "content": "const TOKEN_REFRESH_INTERVAL = 1000 * 5; // 5 seconds\n\nexport async function refreshTokenIfNeeded(_requestParams, vuContext, _events) {\n if (!vuContext.tokenExpiryTime || vuContext.tokenExpiryTime < Date.now()) {\n console.log('Fetching new token');\n const token = await fetchToken();\n vuContext.tokenExpiryTime = Date.now() + TOKEN_REFRESH_INTERVAL;\n vuContext.vars.authToken = token;\n console.log(' expiry time:', vuContext.tokenExpiryTime);\n console.log(' new token:', vuContext.vars.authToken);\n }\n}\n\nasync function fetchToken() {\n // Return a dummy token for the sake of this example. A real-world\n // implementation would usually fetch a token from an external endpoint.\n return `token-${Date.now()}`;\n}\n" }, { "path": "examples/refresh-auth-token/refresh.yml", "content": "config:\n target: http://asciizoo.artillery.io:8080\n processor: ./refresh.mjs\nscenarios:\n - name: \"refresh_auth_token\"\n beforeRequest: \"refreshTokenIfNeeded\"\n flow:\n - get:\n url: \"/dino\"\n headers:\n x-auth-token: \"{{ authToken}}\"\n - get:\n url: \"/pony\"\n headers:\n x-auth-token: \"{{ authToken}}\"\n - log: \"Used auth token: {{ authToken}}\"\n\n # Pause for 10 seconds. This will cause the \"refreshTokenIfNeeded\"\n # function to refresh it before the next request to /armadillo is\n # made\n - think: 10\n # This request will use a refreshed auth token\n - get:\n url: \"/armadillo\"\n headers:\n x-auth-token: \"{{ authToken }}\"\n - log: \"Now used a refreshed auth token: {{ authToken}}\"\n" }, { "path": "examples/rpc-twirp-with-custom-function/README.md", "content": "# Load testing an RPC service created with Twirp\n\n[Twirp](https://github.com/twitchtv/twirp) is a simple RPC framework for service-to-service communication. In the following example, we will use the clients auto-generated from [Twirpscript](https://github.com/tatethurston/TwirpScript), a NodeJS implementation of Twirp, to load test a server using Twirp.\n\nWhile we could build [a dedicated engine](https://www.artillery.io/blog/extend-artillery-by-creating-your-own-engines), you can also use custom functions and leverage the existing default engine. This example shows you how to do that.\n\n## Pre-requisites\n\n- Protobuf [installed](https://github.com/tatethurston/TwirpScript?tab=readme-ov-file#installation-)\n\n## How the example works\n\nThis example imports the auto-generated `.pb.js` file into a processor, and calls the `MakeHat` client method, which will call the server. We also emit [custom metrics](https://www.artillery.io/docs/reference/extension-apis#custom-metrics-api) from the function to track the number of requests and responses, as well as the time taken in the RPC call.\n\n```\ntwirp.requests: ................................................................ 300\ntwirp.response_time:\n min: ......................................................................... 1.1\n max: ......................................................................... 60.7\n mean: ........................................................................ 5.4\n median: ...................................................................... 2.2\n p95: ......................................................................... 22.4\n p99: ......................................................................... 55.2\ntwirp.responses: ............................................................... 300\ntwirp.responses.success: ....................................................... 300\n```\n\n## Running the Twirp server\n\nFirst, install the dependencies:\n```\ncd twirp && npm install\n```\n\nThen, start the server with `npm start`\n\n## Running Artillery test\n\nOnce the server is up and running, execute the test script:\n\n```\nnpx artillery run ./test/scenario.yml\n```\n" }, { "path": "examples/rpc-twirp-with-custom-function/test/processor.mjs", "content": "import { client } from 'twirpscript';\nimport { MakeHat } from '../twirp/protos/haberdasher.pb.js';\n\nclient.baseURL = 'http://localhost:8080';\n\nfunction recordMetrics(startedAt, ee, error) {\n //you can add more domain specific metrics here dependant on the response\n ee.emit('counter', 'twirp.requests', 1);\n ee.emit('counter', 'twirp.responses', 1);\n if (error) {\n ee.emit('counter', 'twirp.responses.error', 1);\n ee.emit('counter', `twirp.codes.${error.code}`, 1);\n } else {\n ee.emit('counter', 'twirp.responses.success', 1);\n }\n \n const took = Number(process.hrtime.bigint() - startedAt) / 1e6;\n ee.emit('histogram', 'twirp.response_time', took);\n}\n\nexport async function callRpcServer(_context, ee, _next) {\n const startedAt = process.hrtime.bigint();\n try {\n const res = await MakeHat({ inches: 15, potato: true });\n console.log(res);\n recordMetrics(startedAt, ee);\n } catch (error) {\n recordMetrics(startedAt, ee, error);\n }\n}\n" }, { "path": "examples/rpc-twirp-with-custom-function/test/scenario.yml", "content": "config:\n target: \"http://localhost:8080\"\n phases:\n - duration: 10\n arrivalRate: 30\n name: \"Phase 1\"\n processor: \"./processor.mjs\"\n\nscenarios:\n - flow:\n - function: \"callRpcServer\"" }, { "path": "examples/rpc-twirp-with-custom-function/twirp/package.json", "content": "{\n \"name\": \"twirp\",\n \"version\": \"1.0.0\",\n \"description\": \"\",\n \"type\": \"module\",\n \"scripts\": {\n \"start\": \"node ./server/index.js\"\n },\n \"keywords\": [],\n \"author\": \"\",\n \"license\": \"ISC\"\n}\n" }, { "path": "examples/rpc-twirp-with-custom-function/twirp/protos/haberdasher.pb.js", "content": "// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.\n// Source: example/protos/haberdasher.proto\n\nimport * as protoscript from 'protoscript';\nimport { JSONrequest, PBrequest } from 'twirpscript';\n\n// This is the minimum version supported by the current runtime.\n// If this line fails typechecking, breaking changes have been introduced and this\n// file needs to be regenerated by running `npx twirpscript`.\nexport { MIN_SUPPORTED_VERSION_0_0_56 } from 'twirpscript';\n\n//========================================//\n// Haberdasher Protobuf Client //\n//========================================//\n\n/**\n * MakeHat produces a hat of mysterious, randomly-selected color!\n */\nexport async function MakeHat(size, config) {\n const response = await PBrequest(\n '/Haberdasher/MakeHat',\n Size.encode(size),\n config\n );\n return Hat.decode(response);\n}\n\n//========================================//\n// Haberdasher JSON Client //\n//========================================//\n\n/**\n * MakeHat produces a hat of mysterious, randomly-selected color!\n */\nexport async function MakeHatJSON(size, config) {\n const response = await JSONrequest(\n '/Haberdasher/MakeHat',\n SizeJSON.encode(size),\n config\n );\n return HatJSON.decode(response);\n}\n\nexport function createHaberdasher(service) {\n return {\n name: 'Haberdasher',\n methods: {\n MakeHat: {\n name: 'MakeHat',\n handler: service.MakeHat,\n input: { protobuf: Size, json: SizeJSON },\n output: { protobuf: Hat, json: HatJSON }\n }\n }\n };\n}\n\n//========================================//\n// Protobuf Encode / Decode //\n//========================================//\n\nexport const Size = {\n /**\n * Serializes Size to protobuf.\n */\n encode: (msg) =>\n Size._writeMessage(msg, new protoscript.BinaryWriter()).getResultBuffer(),\n\n /**\n * Deserializes Size from protobuf.\n */\n decode: (bytes) =>\n Size._readMessage(Size.initialize(), new protoscript.BinaryReader(bytes)),\n\n /**\n * Initializes Size with all fields set to their default value.\n */\n initialize: (msg) => ({\n inches: 0,\n ...msg\n }),\n\n /**\n * @private\n */\n _writeMessage: (msg, writer) => {\n if (msg.inches) {\n writer.writeInt32(1, msg.inches);\n }\n return writer;\n },\n\n /**\n * @private\n */\n _readMessage: (msg, reader) => {\n while (reader.nextField()) {\n const field = reader.getFieldNumber();\n switch (field) {\n case 1: {\n msg.inches = reader.readInt32();\n break;\n }\n default: {\n reader.skipField();\n break;\n }\n }\n }\n return msg;\n }\n};\n\nexport const Hat = {\n /**\n * Serializes Hat to protobuf.\n */\n encode: (msg) =>\n Hat._writeMessage(msg, new protoscript.BinaryWriter()).getResultBuffer(),\n\n /**\n * Deserializes Hat from protobuf.\n */\n decode: (bytes) =>\n Hat._readMessage(Hat.initialize(), new protoscript.BinaryReader(bytes)),\n\n /**\n * Initializes Hat with all fields set to their default value.\n */\n initialize: (msg) => ({\n inches: 0,\n color: '',\n name: '',\n ...msg\n }),\n\n /**\n * @private\n */\n _writeMessage: (msg, writer) => {\n if (msg.inches) {\n writer.writeInt32(1, msg.inches);\n }\n if (msg.color) {\n writer.writeString(2, msg.color);\n }\n if (msg.name) {\n writer.writeString(3, msg.name);\n }\n return writer;\n },\n\n /**\n * @private\n */\n _readMessage: (msg, reader) => {\n while (reader.nextField()) {\n const field = reader.getFieldNumber();\n switch (field) {\n case 1: {\n msg.inches = reader.readInt32();\n break;\n }\n case 2: {\n msg.color = reader.readString();\n break;\n }\n case 3: {\n msg.name = reader.readString();\n break;\n }\n default: {\n reader.skipField();\n break;\n }\n }\n }\n return msg;\n }\n};\n\n//========================================//\n// JSON Encode / Decode //\n//========================================//\n\nexport const SizeJSON = {\n /**\n * Serializes Size to JSON.\n */\n encode: (msg) => JSON.stringify(SizeJSON._writeMessage(msg)),\n\n /**\n * Deserializes Size from JSON.\n */\n decode: (json) =>\n SizeJSON._readMessage(SizeJSON.initialize(), JSON.parse(json)),\n\n /**\n * Initializes Size with all fields set to their default value.\n */\n initialize: (msg) => ({\n inches: 0,\n ...msg\n }),\n\n /**\n * @private\n */\n _writeMessage: (msg) => {\n const json = {};\n if (msg.inches) {\n json.inches = msg.inches;\n }\n return json;\n },\n\n /**\n * @private\n */\n _readMessage: (msg, json) => {\n const _inches_ = json.inches;\n if (_inches_) {\n msg.inches = protoscript.parseNumber(_inches_);\n }\n return msg;\n }\n};\n\nexport const HatJSON = {\n /**\n * Serializes Hat to JSON.\n */\n encode: (msg) => JSON.stringify(HatJSON._writeMessage(msg)),\n\n /**\n * Deserializes Hat from JSON.\n */\n decode: (json) =>\n HatJSON._readMessage(HatJSON.initialize(), JSON.parse(json)),\n\n /**\n * Initializes Hat with all fields set to their default value.\n */\n initialize: (msg) => ({\n inches: 0,\n color: '',\n name: '',\n ...msg\n }),\n\n /**\n * @private\n */\n _writeMessage: (msg) => {\n const json = {};\n if (msg.inches) {\n json.inches = msg.inches;\n }\n if (msg.color) {\n json.color = msg.color;\n }\n if (msg.name) {\n json.name = msg.name;\n }\n return json;\n },\n\n /**\n * @private\n */\n _readMessage: (msg, json) => {\n const _inches_ = json.inches;\n if (_inches_) {\n msg.inches = protoscript.parseNumber(_inches_);\n }\n const _color_ = json.color;\n if (_color_) {\n msg.color = _color_;\n }\n const _name_ = json.name;\n if (_name_) {\n msg.name = _name_;\n }\n return msg;\n }\n};\n" }, { "path": "examples/rpc-twirp-with-custom-function/twirp/protos/haberdasher.proto", "content": "syntax = \"proto3\";\n\n// Haberdasher service makes hats for clients.\nservice Haberdasher {\n // MakeHat produces a hat of mysterious, randomly-selected color!\n rpc MakeHat(Size) returns (Hat);\n}\n\n// Size of a Hat, in inches.\nmessage Size {\n int32 inches = 1; // must be > 0\n}\n\n// A Hat is a piece of headwear made by a Haberdasher.\nmessage Hat {\n int32 inches = 1;\n string color = 2; // anything but \"invisible\"\n string name = 3; // i.e. \"bowler\"\n}" }, { "path": "examples/rpc-twirp-with-custom-function/twirp/server/haberdasher/index.js", "content": "import { createHaberdasher } from '../../../../../examples/rpc-twirp-with-custom-function/twirp/protos/haberdasher.pb.js';\n\nfunction choose(list) {\n return list[Math.floor(Math.random() * list.length)];\n}\n\nexport const haberdasher = {\n MakeHat: (size) => {\n return {\n inches: size.inches,\n color: choose(['red', 'green', 'blue', 'purple']),\n name: choose(['beanie', 'fedora', 'top hat', 'cowboy', 'beret'])\n };\n }\n};\n\nexport const habderdasherHandler = createHaberdasher(haberdasher);\n" }, { "path": "examples/rpc-twirp-with-custom-function/twirp/server/index.js", "content": "import { createServer } from 'node:http';\nimport { createTwirpServer } from 'twirpscript';\nimport { habderdasherHandler } from './haberdasher/index.js';\n\nconst PORT = 8080;\n\nconst app = createTwirpServer([habderdasherHandler]);\n\n// CORS\napp.use(async (req, _ctx, next) => {\n if (req.method === 'OPTIONS') {\n return {\n statusCode: 204,\n headers: {\n 'access-control-allow-origin': '*',\n 'access-control-request-method': '*',\n 'access-control-allow-methods': '*',\n 'access-control-allow-headers': '*',\n 'content-type': 'application/json'\n },\n body: ''\n };\n }\n\n const { statusCode, headers, body } = await next();\n return {\n statusCode,\n body,\n headers: {\n 'access-control-allow-origin': '*',\n ...headers\n }\n };\n});\n\ncreateServer(app).listen(PORT, () =>\n console.log(`Server listening on port ${PORT}`)\n);\n" }, { "path": "examples/scenario-weights/.gitignore", "content": "node_modules\n" }, { "path": "examples/scenario-weights/README.md", "content": "# Setting scenario weights\n\nThis example shows how you can modify how Artillery selects a scenario for a virtual user during load testing. In Artillery, each VU will be assigned to one of the defined scenarios. By default, each scenario has a weight of 1, meaning each scenario has the same probability of getting assigned to a VU. By specifying a weight in a scenario, you'll increase the chances of Artillery assigning the scenario for a VU. The probability of a scenario getting chosen depends on the total weight for all scenarios.\n\nTo learn more, read the Artillery documentation on scenario weights: https://artillery.io/docs/guides/guides/test-script-reference.html#Scenario-weights\n\n## Running the HTTP server\n\nThis example includes an Express.js application running an HTTP server.\n\nFirst, install the server dependencies:\n\n```shell\nnpm install\n```\n\nAfter installing the dependencies, start the HTTP server:\n\n```shell\nnpm run app:start\n```\n\nThis command will start an HTTP server listening at http://localhost:3000/.\n\n## Running Artillery tests\n\nThis directory contains a test script (`scenario-weights.yml`) which demonstrates how to set different scenario weights.\n\nOnce the HTTP server is up and running, execute the test script:\n\n```\nartillery run scenario-weights.yml\n```\n" }, { "path": "examples/scenario-weights/app.js", "content": "const express = require('express');\nconst app = express();\nconst port = 3000;\n\napp.use(express.json());\n\napp.get('/common', (_, res) => {\n res.send({ route: '/common' });\n});\n\napp.get('/average', (_, res) => {\n res.send({ route: '/average' });\n});\n\napp.get('/rare', (_, res) => {\n res.send({ route: '/rare' });\n});\n\napp.listen(port, () => {\n console.log(`App listening at http://localhost:${port}`);\n});\n" }, { "path": "examples/scenario-weights/package.json", "content": "{\n \"name\": \"scenario-weights\",\n \"version\": \"1.0.0\",\n \"description\": \"See how to change how often a scenario is run in your Artillery tests\",\n \"main\": \"app.js\",\n \"scripts\": {\n \"app:start\": \"node app.js\",\n \"test\": \"artillery run scenario-weights.yml\"\n },\n \"author\": \"Dennis Martinez\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"express\": \"^4.17.1\"\n }\n}\n" }, { "path": "examples/scenario-weights/scenario-weights.yml", "content": "# In Artillery, each VU will be assigned to one of the defined\n# scenarios. By default, each scenario has a weight of 1, meaning\n# each scenario has the same probability of getting assigned to a\n# VU.\n#\n# By specifying a weight in a scenario, you'll increase the chances\n# of Artillery assigning the scenario for a VU. The probability of\n# a scenario getting chosen depends on the total weight for all\n# scenarios.\n#\n# To learn more, read the Artillery documentation on scenario weights:\n# https://artillery.io/docs/guides/guides/test-script-reference.html#Scenario-weights\n\nconfig:\n target: \"http://localhost:3000\"\n phases:\n - duration: 10min\n arrivalRate: 25\n\nscenarios:\n # Approximately 60% of all VUs will access this scenario.\n - name: \"access_common_route\"\n weight: 6\n flow:\n - get:\n url: \"/common\"\n\n # Approximately 30% of all VUs will access this scenario.\n - name: \"access_average_route\"\n weight: 3\n flow:\n - get:\n url: \"/average\"\n\n # Approximately 10% of all VUs will access this scenario.\n - name: \"access_rare_route\"\n weight: 1\n flow:\n - get:\n url: \"/rare\"\n" }, { "path": "examples/script-overrides/README.md", "content": "# Overriding values dynamically\n\nThis example shows how values in an Artillery script can be changed dynamically.\n\nA typical use-case is running Artillery in CI and being able to change the load generated dynamically, e.g. by overriding Input Parameters to a job in Jenkins or AWS CodeBuild.\n\n\nThe example test script defines 3 environments with different load phases:\n\n- `smoke` - a low TPS short phase for smoke testing, with hardcoded values\n- `preprod` - a higher TPS longer phase for preprod testing, with hardcoded values\n- `dynamic` - a load phase that can be set at runtime\n\n## Running the example\n\nRun the test at low TPS with the `smoke` config environment:\n\n```sh\nnpx artillery run -e smoke test.yaml\n```\n\nRun the test at higher TPS with the `preprod` environment:\n\n```sh\nnpx artillery run -e preprod test.yaml\n```\n\nIf the test script is used in a Jenkins job, those environment names could be an input themselves to allow the user to choose between pre-configured load profiles.\n\nFinally, to override the load phase completely at runtime we need to set `ARRIVAL_RATE` and `DURATION` environment variables before running Artillery, such as:\n\n```sh\nARRIVAL_RATE=20 DURATION=600 artillery run -e dynamic test.yaml\n```\n" }, { "path": "examples/script-overrides/test.yaml", "content": "config:\n target: http://asciiart.artillery.io:8080\n environments:\n # Informal short run:\n smoke:\n phases:\n - arrivalRate: 1\n duration: 10\n # Long-running job:\n preprod:\n phases:\n - arrivalRate: 5\n duration: 20\n dynamic:\n phases:\n - arrivalRate: \"{{ $processEnvironment.ARRIVAL_RATE }}\"\n duration: \"{{ $processEnvironment.DURATION }}\"\nscenarios:\n - flow:\n - get:\n url: \"/\"\n" }, { "path": "examples/soap-with-custom-function/README.md", "content": "# SOAP Load Testing Example\n\nArtillery doesn't have an official SOAP engine, but it's still possible to test SOAP with it. While building [a dedicated engine](https://www.artillery.io/blog/extend-artillery-by-creating-your-own-engines) is one option, you can also use custom functions and leverage the existing HTTP engine. This example shows you how to do that.\n\n## What the example does\n\nThis example calls the SOAP server by using a SOAP client (node-soap) in a custom function. That custom function gets called with each VU execution. We also emit [custom metrics](https://www.artillery.io/docs/reference/extension-apis#custom-metrics-api) from the function to track the number of requests and responses, as well as the time taken to make the SOAP request.\n\n```\nsoap.addNumbers.requests: ...................................................... 8\nsoap.addNumbers.response_time:\n min: ......................................................................... 2\n max: ......................................................................... 9\n mean: ........................................................................ 4.9\n median: ...................................................................... 2\n p95: ......................................................................... 7.9\n p99: ......................................................................... 7.9\nsoap.addNumbers.responses: ..................................................... 8\n```\n\nNotes:\n- The `callSoapOperation` function has been abstracted to allow calling other operations, should you wish to extend this example.\n- The creation of the client is also cached to prevent creating it for every virtual user.\n\n## Running the SOAP server\n\nWe provide a very simple SOAP server for this example, containing the `AddNumbersService` with a single `addNumbers` operation.\n\nFirst, install the server dependencies:\n\n```\ncd server && npm install\n```\n\nAfter installing the dependencies, start the SOAP server:\n\n```\nnode app.js\n```\n\nThis command will start a Socket.IO server listening at http://localhost:8000/.\n\n## Running Artillery test\n\nOnce the SOAP server is up and running, execute the test script:\n\n```\nnpx artillery run soap.yml\n```\n" }, { "path": "examples/soap-with-custom-function/package.json", "content": "{\n \"name\": \"soap-with-custom-function\",\n \"version\": \"1.0.0\",\n \"description\": \"\",\n \"scripts\": {\n \"test\": \"npx artillery run soap.yml\"\n },\n \"author\": \"\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"soap\": \"^1.0.0\"\n }\n}\n" }, { "path": "examples/soap-with-custom-function/processor.js", "content": "const soap = require('soap');\n\nlet client;\nconst setupSoapClientIfNeeded = async (context) => {\n const url = `${context.vars.target}/wsdl?wsdl`;\n\n //caches client to avoid creating a new one for each VU\n if (!client) {\n client = await soap.createClientAsync(url);\n }\n};\n\nconst callSoapOperation = async (operationName, events) => {\n const args = { number1: 5, number2: 3 };\n events.emit('counter', `soap.${operationName}.requests`, 1);\n const timeBefore = Date.now();\n await client[`${operationName}Async`](args);\n const timeTaken = Date.now() - timeBefore;\n events.emit('counter', `soap.${operationName}.responses`, 1);\n events.emit('histogram', `soap.${operationName}.response_time`, timeTaken);\n};\n\nmodule.exports = {\n sendSOAPRequest: async (context, events, done) => {\n try {\n await setupSoapClientIfNeeded(context);\n\n await callSoapOperation('addNumbers', events);\n\n done();\n } catch (err) {\n console.error('SOAP Request Error:', err);\n done(err);\n }\n }\n};\n" }, { "path": "examples/soap-with-custom-function/server/MyService.wsdl", "content": "\n\n \n \n \n \n\n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n\n \n This service adds two numbers.\n \n \n \n \n\n\n" }, { "path": "examples/soap-with-custom-function/server/app.js", "content": "const soap = require('soap');\nconst express = require('express');\nconst bodyParser = require('body-parser');\n\nconst service = {\n AddNumbersService: {\n AddNumbersPort: {\n addNumbers: (args) => {\n console.log('RECEIVED REQUEST', args);\n return { sum: Number(args.number1) + Number(args.number2) };\n }\n }\n }\n};\n\nconst xml = require('node:fs').readFileSync('MyService.wsdl', 'utf8');\n\nconst app = express();\napp.use(\n bodyParser.raw({\n type: () => true,\n limit: '5mb'\n })\n);\napp.listen(8000, () => {\n soap.listen(app, '/wsdl', service, xml);\n console.log('Server running on port 8000');\n});\n" }, { "path": "examples/soap-with-custom-function/server/package.json", "content": "{\n \"name\": \"server\",\n \"version\": \"1.0.0\",\n \"description\": \"\",\n \"main\": \"app.js\",\n \"scripts\": {\n \"test\": \"echo \\\"Error: no test specified\\\" && exit 1\"\n },\n \"author\": \"\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"body-parser\": \"^1.20.2\",\n \"express\": \"^4.18.2\",\n \"soap\": \"^1.0.0\"\n }\n}\n" }, { "path": "examples/soap-with-custom-function/soap.yml", "content": "config:\n target: \"http://localhost:8000\"\n phases:\n - duration: 2\n arrivalRate: 4\n name: \"Phase 1\"\n processor: \"./processor.js\"\n\nscenarios:\n - flow:\n - function: \"sendSOAPRequest\"" }, { "path": "examples/socket-io/.gitignore", "content": "node_modules/\n" }, { "path": "examples/socket-io/README.md", "content": "# Socket.IO load testing example\n\nThis example shows you how to test a [Socket.IO](https://socket.io/) server using Artillery's built-in Socket.IO engine.\n\n⚠ī¸ _**Note:** This Socket.IO server in this example uses Socket.IO v3.x, as the official Artillery engine now uses 3.x. For extended v3.x support, check out the [artillery-engine-socketio-v3 plugin](https://github.com/ptejada/artillery-engine-socketio-v3)._\n\n## Running the Socket.IO server\n\nFirst, install the server dependencies:\n\n```\nnpm install\n```\n\nAfter installing the dependencies, start the Socket.IO server:\n\n```\nnode app.js\n```\n\nThis command will start a Socket.IO server listening at http://localhost:8080/.\n\n## Running Artillery test\n\nThis directory contains a test script (`socket-io.yml`) which demonstrates different test scenarios for load testing a Socket.IO implementation.\n\nOnce the Socket.IO server is up and running, execute the test script:\n\n```\nnpx artillery run socket-io.yml\n```\n" }, { "path": "examples/socket-io/app.js", "content": "const io = require('socket.io')(8080, {\n path: '/',\n serveClient: false\n});\n\nconst personalisedNamespace = io.of('/personalised');\n\npersonalisedNamespace.on('connection', (socket) => {\n socket.on('echo', (msg) => {\n socket.emit('echoResponse', msg);\n });\n\n socket.on('userDetails', (_, callback) => {\n callback({\n name: 'Artillery'\n });\n });\n});\n\nconsole.log('Socket.IO server listening at http://localhost:8080/');\n" }, { "path": "examples/socket-io/package.json", "content": "{\n \"name\": \"socket-io\",\n \"version\": \"1.0.0\",\n \"description\": \"Artillery.io - Socket.IO example\",\n \"main\": \"app.js\",\n \"scripts\": {\n \"test\": \"echo \\\"Error: no test specified\\\" && exit 1\"\n },\n \"author\": \"\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"socket.io\": \"^3.1.2\"\n }\n}\n" }, { "path": "examples/socket-io/public/index.html", "content": "\n\n \n \n Artillery.io - Socket.IO example\n \n \n \n

Artillery.io - Socket.IO example

\n \n\n \n \n\n" }, { "path": "examples/socket-io/socket-io.yml", "content": "config:\n target: \"http://localhost:8080\"\n phases:\n - duration: 60\n arrivalRate: 25\n\nscenarios:\n - name: \"emit_and_validate_response\"\n engine: socketio\n flow:\n - namespace: /personalised\n emit:\n channel: \"echo\"\n data: \"Hello from Artillery\"\n response:\n channel: \"echoResponse\"\n data: \"Hello from Artillery\"\n\n - name: \"emit_and_validate_acknowledgment\"\n engine: socketio\n flow:\n - namespace: /personalised\n emit:\n channel: \"userDetails\"\n acknowledge:\n match:\n json: \"$.0.name\"\n value: \"Artillery\"\n" }, { "path": "examples/starter-kit/.gitignore", "content": "node_modules\nreports/**" }, { "path": "examples/starter-kit/package.json", "content": "{\n \"name\": \"artillery-starter-kit\",\n \"version\": \"1.0.0\",\n \"description\": \"Artillery.io Starter Kit\",\n \"scripts\": {\n \"sample_task_01\": \"npx artillery run ./scenarios/sample_task_01.yaml -o ./reports/sample_report_01.json\",\n \"sample_task_02\": \"npx artillery run ./scenarios/sample_task_02.yaml -o ./reports/sample_report_02.json\"\n },\n \"author\": \"\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"faker\": \"^5.5.3\"\n }\n}\n" }, { "path": "examples/starter-kit/processors/_baseProcessor.js", "content": "var faker = require('faker');\n\nmodule.exports = {\n generateRandomData: (userContext, _events, done) => {\n userContext.vars.name = faker.name.findName();\n userContext.vars.id = faker.datatype.number({\n min: 543200000,\n max: 555550000\n });\n return done();\n },\n generateRandomTiming: (userContext, _events, done) => {\n userContext.vars.timing = faker.datatype.number({\n min: 100,\n max: 3000\n });\n return done();\n },\n printStatus: (_requestParams, response, _context, _ee, next) => {\n console.log(\n `ENDPOINT: [${response.request.method}] ${response.request.uri.path}: ${response.statusCode}`\n );\n if (response.statusCode >= 400) {\n console.warn(response.body);\n }\n return next();\n }\n};\n" }, { "path": "examples/starter-kit/processors/sample_task_01.js", "content": "var _faker = require('faker');\nvar base = require('./_baseProcessor');\n\nmodule.exports = {\n doSomething: (userContext, _events, done) => {\n userContext.vars.something = 'do';\n return done();\n },\n printStatus: base.printStatus,\n generateRandomTiming: base.generateRandomTiming\n};\n" }, { "path": "examples/starter-kit/processors/sample_task_02.js", "content": "var _faker = require('faker');\nvar base = require('./_baseProcessor');\n\nmodule.exports = {\n doSomethingElse: (userContext, _events, done) => {\n userContext.vars.something = 'do';\n return done();\n },\n printStatus: base.printStatus,\n generateRandomData: base.generateRandomData\n};\n" }, { "path": "examples/starter-kit/reports/.gitkeep", "content": "" }, { "path": "examples/starter-kit/scenarios/sample_task_01.yaml", "content": "version: 1\r\nconfig:\r\n target: \"https://run.mocky.io\"\r\n phases:\r\n - duration: 30\r\n arrivalRate: 3\r\n maxVusers: 10\r\n processor: \"../processors/sample_task_01.js\"\r\nscenarios:\r\n - flow:\r\n - function: \"generateRandomTiming\"\r\n - get:\r\n url: \"/v3/0eff1291-866e-4afd-a462-e3711607caa4?mocky-delay={{ timing }}ms\"\r\n afterResponse: \"printStatus\"" }, { "path": "examples/starter-kit/scenarios/sample_task_02.yaml", "content": "version: 1\r\nconfig:\r\n target: \"https://api.somewebsite.com\"\r\n phases:\r\n - duration: 30\r\n arrivalRate: 3\r\n maxVusers: 10\r\n processor: \"../processors/sample_task_02.js\"\r\nscenarios:\r\n - flow:\r\n - function: \"generateRandomData\"\r\n - get:\r\n url: \"/members/list\"\r\n afterResponse: \"printStatus\"\r\n - post:\r\n url: \"members/create\"\r\n afterResponse: \"printStatus\"\r\n json:\r\n id: \"{{ id }}\"\r\n name: \"{{ name }}\"\r\n - get:\r\n url: \"/members/{{ id }}\"\r\n afterResponse: \"printStatus\"\r\n " }, { "path": "examples/starter-kit/scenarios/sample_task_03.yaml", "content": "version: 1\r\nconfig:\r\n target: \"https://api.someservice.com\"\r\n phases:\r\n - name: \"Warming up the application\"\r\n duration: 5\r\n arrivalRate: 1\r\n - name: \"Mild load on the application\"\r\n duration: 10\r\n rampTo: 30\r\n - name: \"Putting load on the application\"\r\n duration: 180\r\n arrivalRate: 3\r\n maxVusers: 120\r\n payload:\r\n - path: \"../data/users.csv\"\r\n fields: \r\n - \"firstName\"\r\n - \"lastName\"\r\n - \"emailAddress\"\r\n order: sequence\r\n skipHeader: true\r\n ensure:\r\n p95: 200\r\n maxErrorRate: 1\r\n defaults:\r\n headers:\r\n x-api-key: \"{{ $processEnvironment.SERVICE_API_KEY }}\"\r\n Content-Type: \"application/json\"\r\n Accept: \"application/json\"\r\n tls:\r\n rejectUnauthorized: false\r\n http:\r\n pool: 10\r\n timeout: 15\r\n maxSockets: 6\r\n environments:\r\n production:\r\n target: \"http://wontresolve.prod:44321\"\r\n phases:\r\n - duration: 10\r\n arrivalRate: 10\r\n local:\r\n target: \"http://127.0.0.1:3003\"\r\n phases:\r\n - duration: 60\r\n arrivalRate: 20\r\n variables:\r\n postcode:\r\n - \"SE1\"\r\n - \"EC1\"\r\n - \"E8\"\r\n - \"WH9\"\r\n id:\r\n - \"8731\"\r\n - \"9965\"\r\n - \"2806\"\r\n processor: \"../functions.js\"\r\nscenarios:\r\n - name: \"The first flow\"\r\n flow:\r\n - function: \"generateRandomData\"\r\n - get:\r\n url: \"/members/{{ id }}\"\r\n afterResponse: \"printStatus\"\r\n - post:\r\n url: \"/members/member\"\r\n afterResponse: \"printStatus\"\r\n json:\r\n id: \"{{ id }}\"\r\n name: \"{{ name }}\"\r\n description: \"Some randomly generated user\"\r\n salary: 666000\r\n - name: \"The second flow\"\r\n flow:\r\n - function: \"generateRandomData\"\r\n - get:\r\n url: \"/members/{{ id }}\"\r\n afterResponse: \"printStatus\"\r\n - post:\r\n url: \"/members/member\"\r\n afterResponse: \"printStatus\"\r\n json:\r\n id: \"{{ id }}\"\r\n name: \"{{ name }}\"\r\n description: \"Some randomly generated user\"\r\n salary: 666000" }, { "path": "examples/table-driven-functional-tests/README.md", "content": "# Table-driven functional tests with Artillery\n\nThis example shows how you can drive functional testing with Artillery with a simple CSV file.\n\nWe define a CSV file which contains URLs + a status code expectation for each URL:\n\n```csv\n/,200\n/docs,302\n/dinosaur,404\n```\n\nAn Artillery script uses the data in the CSV file to make a request to each URL and check the assertions.\n\nThis makes it easy to add new test cases without having to modify the Artillery script itself.\n\n## Run the example\n\nTo run the example:\n\n```sh\n# install dependencies:\nnpm install\n# run the Artillery test:\nnpm run functional-test\n```\n\nYou can also run the Artillery test with:\n\n```sh\nnpx artillery run --solo -q functional-test.yml\n```" }, { "path": "examples/table-driven-functional-tests/functional-test.yml", "content": "config:\n target: http://asciiart.artillery.io:8080\n payload:\n - path: ./request-response.csv\n fields: [url, code]\n # NOTE: loadAll requires Artillery v2.0.0-19 or later\n loadAll: true\n name: data\n plugins:\n expect: {}\nscenarios:\n - flow:\n # Loop over each element in the data variable, with loop-over\n # Each element in the \"data\" array can be accessed via the special\n # $loopElement variable.\n # https://artillery.io/docs/guides/guides/http-reference.html#Looping-through-an-array\n - loop:\n - get:\n url: \"{{ $loopElement.url }}\"\n followRedirect: false\n expect:\n statusCode: \"{{ $loopElement.code }}\"\n over: \"data\"" }, { "path": "examples/table-driven-functional-tests/package.json", "content": "{\n \"name\": \"table-driven-functional-tests\",\n \"version\": \"1.0.0\",\n \"description\": \"\",\n \"main\": \"index.js\",\n \"scripts\": {\n \"func-test\": \"npx artillery run --solo -q functional-test.yml\",\n \"test\": \"echo \\\"Error: no test specified\\\" && exit 1\"\n },\n \"keywords\": [],\n \"author\": \"\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"csv-parse\": \"^4.16.0\"\n }\n}\n" }, { "path": "examples/table-driven-functional-tests/request-response.csv", "content": "/,200\n/dino,200\nhttps://play.artillery.io/notapath,404\n" }, { "path": "examples/tracetest/README.md", "content": "# Tracetest\n\n[Tracetest.io](https://tracetest.io/) is a modern testing tool that leverages distributed tracing to run observability-enabled tests, allowing to assert on whether your system is working correctly at a deeper level.\n\n## Why is this important?\n\nWith Performance Testing, it can sometimes be difficult to assert that everything is working correctly in a distributed system. For example, let's say your API responds within your SLO, but fails to send a message to a message queue at large scale (which another internal component needs). Your Performance test may be passing, but your system as a whole would still have a broken component. This is where combining Artillery with Tracetest comes in - you can make sure your entire system still functions as expected under load (even components that aren't user-facing).\n\n## Examples\n\n### Playwright\n\nPlease follow this example created by the Tracetest team: https://docs.tracetest.io/examples-tutorials/recipes/running-playwright-performance-tests-with-artillery-and-tracetest\n\n\nIn the example above, you'll be able to create a Playwright scenario to run with Artillery's Playwright engine. The scenario will also generate a distributed trace per virtual user that can be tested using Tracetest. \n\n### HTTP Engine\n\nPlease follow the example available in the Tracetest documentation: https://docs.tracetest.io/tools-and-integrations/artillery-plugin\n\nIn the example above, you'll be creating an HTTP scenario and running it with Artillery, also publishing metrics by using the `publish-metrics` OpenTelemetry reporter. The scenario will also generate a distributed trace per virtual user that can be tested using Tracetest, allowing you to test things like database processing time.\n\n## Questions\n\nFor any questions on integrating Artillery with Tracetest, please reach out to the [Tracetest team](https://tracetest.io/community) or reach out to Artillery on [Github](https://github.com/artilleryio/artillery/discussions).\n\n" }, { "path": "examples/track-custom-metrics/.gitignore", "content": "node_modules\n" }, { "path": "examples/track-custom-metrics/README.md", "content": "# Tracking custom metrics example\n\nThis example shows you how to track custom metrics when testing an API using Artillery's built-in HTTP engine.\n\n## Running the API server\n\nFirst, install the server dependencies:\n\n```\nnpm install\n```\n\nAfter installing the dependencies, start the API server:\n\n```\nnode app.js\n```\n\nThis command will start a server listening at http://localhost:3000/.\n\n## Running Artillery test\n\nThis directory contains a test script (`custom-metrics.yml`) which loads a custom JS function to track of two custom metrics using an `afterResponse` hook:\n\n- A counter to keep track of the number of requests made.\n- A histogram of the request latency returned via a response header.\n\nOnce the API server is up and running, execute the test script:\n\n```\nartillery run custom-metrics.yml\n```\n" }, { "path": "examples/track-custom-metrics/app.js", "content": "const express = require('express');\nconst serverTiming = require('server-timing');\nconst app = express();\nconst port = 3000;\n\napp.use(express.json());\napp.use(serverTiming());\n\napp.post('/pets', (req, res) => {\n res.startTime('pets', 'Creating pet');\n\n setTimeout(\n () => {\n res.endTime('pets');\n res.json({\n species: req.body.species,\n name: req.body.name\n });\n },\n Math.ceil(Math.random() * 500)\n );\n});\n\napp.listen(port, () => {\n console.log(`App listening at http://localhost:${port}`);\n});\n" }, { "path": "examples/track-custom-metrics/custom-metrics.yml", "content": "config:\n target: \"http://localhost:3000\"\n processor: \"./metrics.js\"\n phases:\n - arrivalRate: 25\n duration: 60\n\nscenarios:\n - afterResponse: \"trackPets\"\n flow:\n - post:\n url: \"/pets\"\n json:\n species: \"pony\"\n name: \"Tiki\"\n" }, { "path": "examples/track-custom-metrics/metrics.js", "content": "module.exports = { trackPets };\n\nfunction trackPets(_req, res, _context, events, done) {\n // After every response, increment the 'pets_created' counter by 1.\n events.emit('counter', 'pets_created', 1);\n\n // Parse the 'server-timing' header and look for the 'pets' metric,\n // and add it to 'pet_creation_latency' histogram.\n const latency = parseServerTimingLatency(\n res.headers['server-timing'],\n 'pets'\n );\n events.emit('histogram', 'pet_creation_latency', latency);\n\n return done();\n}\n\nfunction parseServerTimingLatency(header, timingMetricName) {\n const serverTimings = header.split(',');\n\n for (const timing of serverTimings) {\n const timingDetails = timing.split(';');\n if (timingDetails[0] === timingMetricName) {\n return parseFloat(timingDetails[1].split('=')[1]);\n }\n }\n}\n" }, { "path": "examples/track-custom-metrics/package.json", "content": "{\n \"name\": \"track-custom-metrics\",\n \"version\": \"1.0.0\",\n \"description\": \"Artillery.io - Custom metrics example\",\n \"main\": \"app.js\",\n \"author\": \"Dennis Martinez\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"express\": \"^4.17.1\",\n \"server-timing\": \"^3.3.1\"\n }\n}\n" }, { "path": "examples/using-cookies/.gitignore", "content": "node_modules\n" }, { "path": "examples/using-cookies/README.md", "content": "# Using cookies when testing HTTP services\n\nThis example shows you how Artillery works with cookies when testing HTTP services.\n\n## Running the HTTP server\n\nThis example includes an Express.js application running an HTTP server.\n\nFirst, install the server dependencies:\n\n```shell\nnpm install\n```\n\nAfter installing the dependencies, start the HTTP server:\n\n```shell\nnpm run app:start\n```\n\nThis command will start an HTTP server listening at http://localhost:3000/.\n\n## Running Artillery tests\n\nThis directory contains a test script (`cookies.yml`) which demonstrates the different ways to work with cookies when testing an HTTP service:\n\n- Using cookies set by the HTTP service.\n- Manually setting a custom cookie in an Artillery request.\n\nOnce the HTTP server is up and running, execute the test script:\n\n```\nartillery run cookies.yml\n```\n" }, { "path": "examples/using-cookies/app.js", "content": "const express = require('express');\nconst cookieParser = require('cookie-parser');\nconst app = express();\nconst port = 3000;\n\napp.use(express.json());\napp.use(cookieParser());\n\napp.post('/login', (req, res) => {\n const { email, password } = req.body;\n\n if (email && password) {\n res.cookie('email', email);\n res.json({ success: true, email });\n } else {\n res\n .status(422)\n .json({ success: false, error: 'Email and password are required' });\n }\n});\n\napp.get('/account', (req, res) => {\n res.json({ user: req.cookies });\n});\n\napp.post('/set-state', (_req, res) => {\n // Cookie will be set from the request, just send a 200 OK response.\n res.sendStatus(200);\n});\n\napp.get('/state', (req, res) => {\n const { state } = req.cookies;\n res.json({ currentState: state });\n});\n\napp.listen(port, () => {\n console.log(`App listening at http://localhost:${port}`);\n});\n" }, { "path": "examples/using-cookies/cookies.yml", "content": "config:\n target: \"http://localhost:3000\"\n phases:\n - duration: 10min\n arrivalRate: 25\n variables:\n email:\n - \"testuser1@artillery.io\"\n - \"testuser2@artillery.io\"\n - \"testuser3@artillery.io\"\n - \"testuser4@artillery.io\"\n - \"testuser5@artillery.io\"\n\nscenarios:\n # In this scenario, the request to /login will capture the user's\n # email and set it in a cookie, which will get returned in the response.\n # The subsequent request to /account will return the value of the\n # email from the saved cookie.\n - name: \"login_and_verify_cookie\"\n flow:\n - post:\n url: \"/login\"\n json:\n email: \"{{ email }}\"\n password: \"test-password-123\"\n - get:\n url: \"/account\"\n match:\n json: \"$.user.email\"\n value: \"{{ email }}\"\n\n # In this scenario, we'll manually set cookie values when making a\n # request to /set-state, and validating the value saved in the cookie\n # in a request to /state.\n - name: \"set_cookie_values\"\n flow:\n - post:\n url: \"/login\"\n json:\n email: \"{{ email }}\"\n password: \"test-password-123\"\n - post:\n url: \"/set-state\"\n cookie:\n state: \"online\"\n - get:\n url: \"/state\"\n match:\n json: \"$.currentState\"\n value: \"online\"\n - post:\n url: \"/set-state\"\n cookie:\n state: \"busy\"\n - get:\n url: \"/state\"\n match:\n json: \"$.currentState\"\n value: \"busy\"\n" }, { "path": "examples/using-cookies/package.json", "content": "{\n \"name\": \"using-cookies\",\n \"version\": \"1.0.0\",\n \"description\": \"Using cookies when testing HTTP services with Artillery\",\n \"main\": \"app.js\",\n \"scripts\": {\n \"test\": \"artillery run cookies.yml\",\n \"app:start\": \"node app.js\"\n },\n \"author\": \"Dennis Martinez\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"cookie-parser\": \"^1.4.5\",\n \"express\": \"^4.17.1\"\n }\n}\n" }, { "path": "examples/using-data-from-csv/csv/urls.csv", "content": "/\n/dino\n/pony\n/armadillo" }, { "path": "examples/using-data-from-csv/website-test.yml", "content": "config:\n target: http://asciiart.artillery.io:8080\n phases:\n - arrivalCount: 300\n duration: 5min\n payload:\n - path: \"./csv/urls.csv\"\n fields:\n - url\n plugins:\n ensure:\n maxErrorRate: 0\n expect:\n reportFailuresAsErrors: true\n\nscenarios:\n - flow:\n - loop:\n - get:\n url: \"{{ url }}\"\n expect:\n statusCode: 200\n - think: 1\n count: 100" }, { "path": "examples/using-data-from-redis/README.md", "content": "# Using Data from Redis\n\nDue to Artillery's concurrent nature, there is no way to guarantee that test data used (e.g. using CSV) is uniquely accessed by your virtual users, especially running distributed load tests.\n\nIn some cases, you may require users to be unique. In those cases, using Redis is a simple alternative. You can use your own Redis (e.g. AWS Elasticache), or use a managed solution like Upstash. We recommend Upstash due to its simplicity and serverless nature.\n\nThis example will show you how to connect an Artillery test to an Upstash Redis instance, and pull a unique user each time.\n\n## Pre-requisites\n\n- Create an Upstash account\n- Follow the simple guide to create an [Upstash Redis instance](https://upstash.com/docs/redis/overall/getstarted)\n- Obtain the `endpoint` and `token` from the UI\n\n## How it works\n\nWe'll first seed a Redis database with auto-generated users. Using a [`beforeScenario`](https://www.artillery.io/docs/reference/engines/http#function-actions-and-beforescenario--afterscenario-hooks) hook we pull a unique user per VU from Redis (`using Redis lpop`), and save its username and password in `context.vars`. \n\nThe scenario is then simply logging the username and password to the console to demonstrate that they are unique.\n\n## Running the example\n\n- First, create a `.env` file in this directory, with the same contents as `.env.sample`, filling in the information with your endpoint and token.\n- Run `npm install` in this directory to install the needed dependencies\n- Run `npm run seed` to seed the Redis instance with 100 auto-generated users (username and password)\n\nYou can now run your Artillery test with `npm run test`. You'll see the users printed to the console.\n\n## Additional thoughts\n\n- We seed the database in a separate script. However, you could easily run the seeding step as part of a [`before`](https://www.artillery.io/docs/reference/test-script#before-and-after-sections) hook if desired\n- If you're interested in the additional overhead of pulling the user from Redis, you can run the test with the `SHOW_TIMING=true` variable. Redis is very fast, and typically each call should only add <30 ms to each VU execution (depending on factors like instance sizes, size of the load test, network, etc)" }, { "path": "examples/using-data-from-redis/package.json", "content": "{\n \"name\": \"using-data-from-redis\",\n \"version\": \"1.0.0\",\n \"description\": \"\",\n \"main\": \"processor.js\",\n \"scripts\": {\n \"seed\": \"node scripts/seed-redis-with-users.js\",\n \"test\": \"npx artillery run scenario.yml --dotenv .env\"\n },\n \"author\": \"\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"@upstash/redis\": \"^1.29.0\"\n },\n \"devDependencies\": {\n \"@ngneat/falso\": \"^7.2.0\",\n \"dotenv\": \"^16.4.5\"\n }\n}\n" }, { "path": "examples/using-data-from-redis/processor.js", "content": "const { Redis } = require('@upstash/redis');\n\nconst redis = new Redis({\n url: process.env.UPSTASH_REDIS_URL,\n token: process.env.UPSTASH_REDIS_TOKEN\n});\n\nasync function getUser(context, _events) {\n const initialTime = Date.now();\n const res = await redis.lpop('users', 1);\n\n if (res.length === 0) {\n console.error('No users found in Redis');\n throw new Error('err_no_users_found_in_redis');\n }\n context.vars.username = res[0].username;\n context.vars.password = res[0].password;\n const finalTime = Date.now();\n\n if (process.env.SHOW_TIMING) {\n console.log(`Time taken: ${finalTime - initialTime}ms`);\n }\n}\n\nmodule.exports = {\n getUser\n};\n" }, { "path": "examples/using-data-from-redis/scenario.yml", "content": "config:\n target: \"http://doesntmatter\"\n phases:\n - duration: 10\n arrivalRate: 10\n name: \"Phase 1\"\n processor: \"./processor.js\"\n\nscenarios:\n - beforeScenario: getUser\n flow:\n - log: \"Username: {{ username }} | Password: {{ password }}\"" }, { "path": "examples/using-data-from-redis/scripts/seed-redis-with-users.js", "content": "const { Redis } = require('@upstash/redis');\nconst falso = require('@ngneat/falso');\nconst dotenv = require('dotenv');\ndotenv.config();\n\n// Configuration\nconst USERS_COUNT = 100;\nconst BATCH_SIZE = 5;\n\n// Initialize Upstash Redis\nconst redis = new Redis({\n url: process.env.UPSTASH_REDIS_URL,\n token: process.env.UPSTASH_REDIS_TOKEN,\n })\n\n// Generate a random username and password\nfunction generateUser() {\n return {\n username: falso.randUserName(),\n password: falso.randPassword(),\n };\n}\n\nasync function storeUsersInRedis(users) {\n const pipeline = redis.pipeline();\n users.forEach(user => {\n if (user) {\n pipeline.lpush('users', JSON.stringify(user));\n }\n });\n await pipeline.exec();\n }\n\n// Main function to seed users\nasync function seedUsers() {\n for (let i = 0; i < USERS_COUNT; i += BATCH_SIZE) {\n // Generate users\n const users = Array.from({ length: BATCH_SIZE }, generateUser);\n await storeUsersInRedis(users);\n console.log(users);\n console.log(`Batch ${i / BATCH_SIZE + 1} completed.`);\n }\n console.log('All users have been seeded and stored in Redis.');\n process.exit(0);\n}\n\nseedUsers();\n" }, { "path": "examples/websockets/.gitignore", "content": "node_modules/\n" }, { "path": "examples/websockets/README.md", "content": "# WebSockets load testing example\n\nThis example shows you how to test a [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) server using Artillery's built-in WebSockets engine.\n\n## Running the WebSockets server\n\nFirst, install the server dependencies:\n\n```\nnpm install\n```\n\nAfter installing the dependencies, start the WebSockets server:\n\n```\nnpm run server\n```\n\nThis command will start a WebSockets server listening at ws://localhost:8888.\n\n## Running Artillery test\n\nThis directory contains a test script (`test.yml`) which demonstrates different test scenarios for load testing a WebSockets implementation.\n\nOnce the WebSockets server is up and running, execute the test script:\n\n```\nnpx artillery run test.yml\n```\n" }, { "path": "examples/websockets/app.js", "content": "const WebSocket = require('ws');\n\nconst wss = new WebSocket.Server({ port: 8888 });\n\nwss.on('connection', (ws) => {\n ws.on('message', (msg) => {\n ws.send(msg);\n });\n});\n\nconsole.log('WebSockets server listening at ws://localhost:8888');\n" }, { "path": "examples/websockets/my-functions.js", "content": "module.exports = { createRandomScore };\n\nfunction createRandomScore(userContext, _events, done) {\n const data = {\n timestamp: Date.now(),\n score: Math.floor(Math.random() * 100)\n };\n\n // set the \"data\" variable for the virtual user to use in the subsequent action\n userContext.vars.data = data;\n\n return done();\n}\n" }, { "path": "examples/websockets/package.json", "content": "{\n \"name\": \"websockets\",\n \"version\": \"1.0.0\",\n \"description\": \"Artillery.io - WebSockets example\",\n \"main\": \"app.js\",\n \"scripts\": {\n \"server\": \"node app.js\",\n \"test\": \"npx artillery run test.yml\"\n },\n \"license\": \"ISC\",\n \"dependencies\": {\n \"ws\": \"^7.4.6\"\n }\n}\n" }, { "path": "examples/websockets/test.yml", "content": "config:\n target: 'ws://localhost:8888/'\n processor: './my-functions.js'\n phases:\n - duration: 60\n arrivalRate: 25\n\nscenarios:\n - name: 'sending_a_string'\n engine: ws\n flow:\n - send: 'Artillery'\n\n - name: 'sending_object_from_function'\n engine: ws\n flow:\n - function: 'createRandomScore'\n - send: '{{ data }}'\n" }, { "path": "package.json", "content": "{\n \"name\": \"artillery-monorepo\",\n \"packageManager\": \"^npm@10.8.2\",\n \"workspaces\": [\n \"packages/*\"\n ],\n \"scripts\": {\n \"build\": \"turbo run build\",\n \"test\": \"turbo run test\",\n \"lint\": \"turbo run lint --continue\",\n \"lint-fix\": \"turbo run lint-fix --continue\",\n \"format\": \"npx prettier -w ./packages/**/*.{js,ts,json}\",\n \"prepare\": \"npx simple-git-hooks\"\n },\n \"devDependencies\": {\n \"@biomejs/biome\": \"^2.3.3\",\n \"@commitlint/cli\": \"^9.1.2\",\n \"@commitlint/config-conventional\": \"^7.6.0\",\n \"lint-staged\": \"^13.2.3\",\n \"prettier\": \"^2.8.8\",\n \"simple-git-hooks\": \"^2.8.1\",\n \"turbo\": \"2.0.11\"\n },\n \"simple-git-hooks\": {\n \"commit-msg\": \"npx commitlint --edit $1\",\n \"pre-commit\": \"npx lint-staged\"\n },\n \"lint-staged\": {\n \"**/*.{js,jsx,ts,tsx}\": [\n \"npx @biomejs/biome check --write --files-ignore-unknown=true --no-errors-on-unmatched\",\n \"prettier --write\"\n ],\n \"**/*.json\": [\n \"prettier --write\"\n ]\n },\n \"prettier\": {\n \"semi\": true,\n \"singleQuote\": true,\n \"useTabs\": false,\n \"trailingComma\": \"none\",\n \"overrides\": [\n {\n \"files\": \"*.(yaml|yml)\",\n \"options\": {\n \"singleQuote\": false\n }\n }\n ]\n }\n}\n" }, { "path": "packages/artillery/Dockerfile", "content": "FROM node:22-bookworm-slim\nLABEL maintainer=\"team@artillery.io\"\n\nWORKDIR /home/node/artillery\n\nCOPY package*.json ./\nRUN npm --ignore-scripts --production install\nRUN npx playwright install --with-deps chromium\n\nCOPY . ./\nENV PATH=\"/home/node/artillery/bin:${PATH}\"\n\nENTRYPOINT [\"/home/node/artillery/bin/run\"]\n" }, { "path": "packages/artillery/Makefile", "content": "man:\n\tronn man/artillery.1.md --roff --organization=artillery.io\n\nman-docker:\n\tcat man/artillery.1.md | docker run --rm -i kadock/ronn > man/artillery.1\n\n.PHONY: man\n" }, { "path": "packages/artillery/README.md", "content": "
\n \n

Artillery

\n

\n Docs | Discussions\n

\n\n

\n \"npm\"\n

\n\n\n\n \n\n\n
\n\n## Features\n\n- **Test at cloud scale.** Cloud-native distributed load testing at scale, **out-of-the box**. Scale out with AWS Lambda, AWS Fargate or Azure ACI. No DevOps needed, zero infrastructure to set up or manage.\n- **Test with Playwright**. Reuse existing Playwright tests and load test with real headless browsers.\n- **Batteries-included.** 20+ integrations for monitoring, observability, and CICD.\n- **Test anything**. HTTP, WebSocket, Socket.io, gRPC, Kinesis, and more.\n- **Powerful workload modeling**. Emulate complex user behavior with request chains, multiple steps, transactions, and more.\n- **Extensible & hackable**. Artillery has a plugin API to allow extending and customization.\n\n## Get started\n\n### Install Artillery\n\n```\nnpm install -g artillery\n```\n\n### Run your first test\n\nFollow our 5-minute guide to run your first load test - https://www.artillery.io/docs/get-started/first-test\n\n## Learn more\n\n### Docs and guides\n\n- [Load testing with Playwright](https://www.artillery.io/docs/playwright)\n- Distributed load testing with Artillery on [AWS Lambda](https://docs.art/lambda), [AWS Fargate](https://docs.art/fargate), or [Azure ACI](https://docs.art/azure)\n- Set [API response expectations](https://docs.art/expect), automate [SLO checks](https://docs.art/ensure), and report [Apdex scores](https://docs.art/apdex)\n- [Publishing metrics](https://docs.art/o11y) to Datadog, New Relic, Honeycomb, and any other OTel-compatible platform\n\n### Integrations and plugins\n\nWe maintain a list of official and community-built [integrations and plugins](https://www.artillery.io/integrations) on our website: https://www.artillery.io/integrations.\n\n### Example tests\n\nYou can find a list of ready-to-run Artillery examples under [`examples/`](https://github.com/artilleryio/artillery/tree/master/examples#readme).\n" }, { "path": "packages/artillery/bin/run", "content": "#!/usr/bin/env node\n\n/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\n const oclif = require('@oclif/core');\n const { createGlobalObject } = require('../lib/artillery-global');\n\n const { rainbow } = require('../util');\n const banner = require('../lib/cli/banner');\n const setupConsoleCapture = require('../lib/console-capture');\n\n async function main() {\n await createGlobalObject();\n await setupConsoleCapture();\n\n if (!process.argv.slice(2).length) {\n console.log(Math.random() * 100 > 34 ?\n banner :\n rainbow(banner));\n } else if (process.argv.slice(2).length === 1 && process.argv.slice(2)[0] === '-V') {\n process.argv[2] = 'version';\n }\n\n oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'));\n }\n\n main();\n" }, { "path": "packages/artillery/bin/run.cmd", "content": "@echo off\n\nnode \"%~dp0\\run\" %*\n" }, { "path": "packages/artillery/console-reporter.js", "content": "module.exports = require('./lib/console-reporter');\n" }, { "path": "packages/artillery/doc/CLA.md", "content": "In order to clarify the intellectual property license granted with Contributions from any person or entity, Artillery Software Inc. (\"Artillery\") must have a Contributor License Agreement (\"CLA\") on file that has been signed by each Contributor, indicating agreement to the license terms below. This license does not change your rights to use your own Contributions for any other purpose.\n\nYou accept and agree to the following terms and conditions for Your present and future Contributions submitted to Artillery.\n\nExcept for the license granted herein to Artillery and recipients of software distributed by Artillery, You reserve all right, title, and interest in and to Your Contributions.\n\n1. Definitions. \"You\" (or \"Your\") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with Artillery. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. \"Contribution\" shall mean any original work of authorship, including any modifications or additions to an existing work, that is or previously has been intentionally submitted by You to Artillery for inclusion in, or documentation of, any of the products owned or managed by Artillery (the \"Work\"). For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to Artillery or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Artillery for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as \"Not a Contribution.\"\n\n2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to Artillery and to recipients of software distributed by Artillery a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.\n\n3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to Artillery and to recipients of software distributed by Artillery a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.\n\n4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that you will have received permission from your current and future employers for all future Contributions, that your applicable employer has waived such rights for all of your current and future Contributions to Artillery, or that your employer has executed a separate Corporate CLA with Artillery.\n\n5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions.\n\n6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON- INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.\n\n\n7. Should You wish to submit work that is not Your original creation, You may submit it to Artillery separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as \"Submitted on behalf of a third-party: [named here]\".\n\n8. You agree to notify Artillery of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.\n" }, { "path": "packages/artillery/lib/artillery-global.js", "content": "const version = require('../package.json').version;\nconst telemetry = require('./telemetry');\n\nconst { updateGlobalObject } = require('@artilleryio/int-core');\n\nasync function createGlobalObject(_opts) {\n await updateGlobalObject({\n version,\n telemetry\n });\n\n global.artillery.runtimeOptions = global.artillery.runtimeOptions || {};\n global.artillery.runtimeOptions.legacyReporting =\n typeof process.env.ARTILLERY_USE_LEGACY_REPORT_FORMAT !== 'undefined';\n global.artillery._workerThreadSend =\n global.artillery._workerThreadSend || null;\n\n global.artillery.__createReporter = require('./console-reporter');\n\n global.artillery._exitCode = 0;\n\n global.artillery.shutdown =\n global.artillery.shutdown ||\n (\n async () => {\n // TODO: Move graceful shutdown logic into here\n process.exit(global.artillery.suggestedExitCode);\n });\n}\n\nmodule.exports = {\n createGlobalObject\n};\n" }, { "path": "packages/artillery/lib/cli/banner.js", "content": "module.exports = `\n ___ __ _ ____\n _____/ | _____/ /_(_) / /__ _______ __ ___\n /____/ /| | / ___/ __/ / / / _ \\\\/ ___/ / / /____/\n/____/ ___ |/ / / /_/ / / / __/ / / /_/ /____/\n /_/ |_/_/ \\\\__/_/_/_/\\\\___/_/ \\\\__ /\n /____/\n`;\n" }, { "path": "packages/artillery/lib/cli/common-flags.js", "content": "const { Flags } = require('@oclif/core');\n\nconst CommonRunFlags = {\n target: Flags.string({\n char: 't',\n description:\n 'Set target endpoint. Overrides the target already set in the test script'\n }),\n config: Flags.string({\n char: 'c',\n description: 'Read configuration for the test from the specified file'\n }),\n // TODO: Replace with --profile\n environment: Flags.string({\n char: 'e',\n description: 'Use one of the environments specified in config.environments'\n }),\n 'scenario-name': Flags.string({\n description: 'Name of the specific scenario to run'\n }),\n output: Flags.string({\n char: 'o',\n description: 'Write a JSON report to file'\n }),\n dotenv: Flags.string({\n description: 'Path to a dotenv file to load environment variables from',\n aliases: ['env-file']\n }),\n variables: Flags.string({\n char: 'v',\n description:\n 'Set variables available to vusers during the test; a JSON object'\n }),\n overrides: Flags.string({\n description: 'Dynamically override values in the test script; a JSON object'\n }),\n insecure: Flags.boolean({\n char: 'k',\n description: 'Allow insecure TLS connections; do not use in production'\n }),\n quiet: Flags.boolean({\n char: 'q',\n description: 'Quiet mode'\n }),\n // multiple allows multiple arguments for the -i flag, which means that e.g.:\n // artillery -i one.yml -i two.yml main.yml\n // does not work as expected. Instead of being considered an argument, \"main.yml\"\n // is considered to be input for \"-i\" and oclif then complains about missing\n // argument\n input: Flags.string({\n char: 'i',\n description: 'Input script file',\n multiple: true,\n hidden: true\n }),\n\n //Artillery Cloud options:\n\n name: Flags.string({\n description:\n 'Name of the test run. This name will be shown in the Artillery Cloud dashboard. Equivalent to setting a \"name\" tag.'\n }),\n tags: Flags.string({\n description:\n 'Comma-separated list of tags in key:value format to tag the test run with in Artillery Cloud, for example: --tags team:sqa,service:foo'\n }),\n note: Flags.string({\n description: 'Add a note/annotation to the test run'\n }),\n record: Flags.boolean({\n description: 'Record test run to Artillery Cloud'\n }),\n key: Flags.string({\n description: 'API key for Artillery Cloud'\n })\n};\n\nmodule.exports = {\n CommonRunFlags\n};\n" }, { "path": "packages/artillery/lib/cli/hooks/version.js", "content": "const banner = require('../banner');\nconst version = require('../../../package.json').version;\n\nasync function versionHook() {\n if (['-v', '-V', '--version', 'version'].includes(process.argv[2])) {\n console.log(banner);\n\n console.log(`\nVERSION INFO:\n\nArtillery: ${version}\nNode.js: ${process.version}\nOS: ${process.platform}\n`);\n\n return process.exit(0);\n }\n}\n\nmodule.exports = versionHook;\n" }, { "path": "packages/artillery/lib/cmds/dino.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst { Command, Flags } = require('@oclif/core');\nconst { rainbow } = require('../util');\n\nclass DinoCommand extends Command {\n async run() {\n const { flags } = await this.parse(DinoCommand);\n let output = '';\n const message = flags.message\n ? flags.message\n : flags.quiet\n ? \"You can't silence me!\"\n : 'Artillery!';\n const n = message.length + 2;\n const balloon = ` ${'-'.repeat(n)}\\n< ${message} >\\n ${'-'.repeat(n)}\\n`;\n\n output += `${balloon} \\\\\\n \\\\\\n`;\n\n const i = Math.floor(Math.random() * dinos.length);\n output += dinos[i];\n\n if (flags.rainbow) {\n console.log(rainbow(output));\n } else {\n console.log(output);\n }\n }\n}\n\nDinoCommand.description = 'here be dinosaurs';\nDinoCommand.flags = {\n message: Flags.string({\n char: 'm',\n description: 'Tell dinosaur what to say'\n }),\n rainbow: Flags.boolean({\n char: 'r',\n description: 'Add some color'\n }),\n quiet: Flags.boolean({\n char: 'q',\n description: 'Quiet mode'\n })\n};\n\nconst dinos = [\n ' __' +\n '\\n' +\n ' / _)' +\n '\\n' +\n ' _/\\\\/\\\\/\\\\_/ /' +\n '\\n' +\n ' _| /' +\n '\\n' +\n ' _| ( | ( |' +\n '\\n' +\n \"/__.-'|_|--|_|\" +\n '\\n',\n\n ' __ \\n' +\n ' / _) \\n' +\n ' .-^^^-/ / \\n' +\n ' __/ / \\n' +\n '<__.|_|-|_|',\n\n ' .@\\n' +\n ' @.+\\n' +\n ' @,\\n' +\n \" @'\\n\" +\n \" @'\\n\" +\n ' @;\\n' +\n ' `@;\\n' +\n ' @+;\\n' +\n \" .@#;'\\n\" +\n \" #@###@;'.\\n\" +\n ' :#@@@@@;.\\n' +\n \" @@@+;'@@:\\n\" +\n \" `@@@';;;@@\\n\" +\n ' @;:@@;;;;+#\\n' +\n '`@;` ,@@,, @@`\\n' +\n ' @`@ @`+\\n' +\n ' @ , @ @\\n' +\n ' @ @ @ @',\n\n ' ..`\\n' +\n \" ;:,'+;\\n\" +\n ' ,;;,,;,\\n' +\n \" #:;':\\n\" +\n \" @';'+;\\n\" +\n \" `::;''';\\n\" +\n \" '; ,:'+;;\\n\" +\n \" `,,` .;';'+;'\\n\" +\n \" ; `'+;;;::';++':,;\\n\" +\n \" `+++++##+'';#\\n\" +\n \" .;+##+''';\\n\" +\n \" '+##'''#'\\n\" +\n \" ++# +;'.##\\n\" +\n ' ##, `: .#,\\n' +\n \" :# '+\\n\" +\n \" #. '\\n\" +\n ' # +\\n' +\n \" :+ #'\\n\" +\n \" #+` ';.\"\n];\n\nmodule.exports = DinoCommand;\n" }, { "path": "packages/artillery/lib/cmds/quick.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\n\n\nconst RunCommand = require('./run');\nconst parse = require('node:url').parse;\nconst fs = require('node:fs');\nconst _ = require('lodash');\nconst _debug = require('debug')('commands:quick');\n\nconst { Command, Flags, Args } = require('@oclif/core');\n\nclass QuickCommand extends Command {\n async run() {\n const { flags, args } = await this.parse(QuickCommand);\n const url = args.target;\n\n const script = {\n config: {\n target: '',\n phases: [],\n mode: 'uniform',\n __createdByQuickCommand: true\n },\n scenarios: [\n {\n flow: []\n }\n ]\n };\n\n const p = parse(url);\n const target = `${p.protocol}//${p.host}`;\n script.config.target = target;\n\n if (flags.insecure && p.protocol.match(/https/)) {\n script.config.tls = {\n rejectUnauthorized: false\n };\n }\n\n script.config.phases.push({\n duration: 1,\n arrivalCount: flags.count\n });\n\n let requestSpec = {};\n if (p.protocol.match('http')) {\n requestSpec.get = { url: url };\n } else if (p.protocol.match('ws')) {\n requestSpec.send = 'hello from Artillery!';\n } else {\n console.error('Unknown protocol in target:', args.target);\n console.error('Supported protocols: HTTP(S) and WS(S)');\n process.exit(1);\n }\n\n if (flags.num > 1) {\n requestSpec = {\n loop: [requestSpec],\n count: flags.num\n };\n }\n\n script.scenarios[0].flow.push(requestSpec);\n if (p.protocol.match(/ws/)) {\n script.scenarios[0].engine = 'ws';\n }\n\n const temporaryFile = (await import('tempy')).temporaryFile;\n const tmpf = temporaryFile({ extension: 'yml' });\n fs.writeFileSync(tmpf, JSON.stringify(script, null, 2), { flag: 'w' });\n\n const runArgs = [];\n if (flags.output) {\n runArgs.push('--output');\n runArgs.push(flags.output);\n }\n if (flags.quiet) {\n runArgs.push('--quiet');\n }\n\n runArgs.push(tmpf);\n\n RunCommand.run(runArgs);\n }\n}\n\nQuickCommand.description = 'run a simple test without writing a test script';\nQuickCommand.flags = {\n count: Flags.string({\n char: 'c',\n description: 'Number of VUs to create',\n parse: (input) => parseInt(input, 10),\n default: 10\n }),\n num: Flags.string({\n char: 'n',\n description: 'Number of requests/messages that each VU will send',\n parse: (input) => parseInt(input, 10),\n default: 10\n }),\n output: Flags.string({\n char: 'o',\n description: 'Filename of the JSON report'\n }),\n insecure: Flags.boolean({\n char: 'k',\n description: 'Allow insecure TLS connections'\n }),\n quiet: Flags.boolean({\n char: 'q',\n description: 'Quiet mode'\n })\n};\nQuickCommand.args = {\n target: Args.string()\n};\n\nmodule.exports = QuickCommand;\n" }, { "path": "packages/artillery/lib/cmds/report.js", "content": "const { Command, Flags, Args } = require('@oclif/core');\n\nconst chalk = require('chalk');\n\nclass ReportCommand extends Command {\n async run() {\n console.error(deprecationNotice);\n }\n}\n\nReportCommand.description =\n 'generate a HTML report from a JSON log produced with artillery run';\n\nReportCommand.flags = {\n output: Flags.string({\n char: 'o',\n description: 'Write HTML report to specified location'\n })\n};\n\nconst deprecationNotice = `\n┌───────────────────────────────────────────────────────────────────────┐\n| ${chalk.blue(\n 'The \"report\" command has been deprecated and is no longer supported'\n)} |\n| |\n| You can use Artillery Cloud (https://app.artillery.io) to visualize |\n| test results, create custom reports, and share them with your team. |\n└───────────────────────────────────────────────────────────────────────┘\n`;\n\nReportCommand.args = { file: Args.string() };\n\nmodule.exports = ReportCommand;\n" }, { "path": "packages/artillery/lib/cmds/run-aci.js", "content": "// Copyright (c) Artillery Software Inc.\n// SPDX-License-Identifier: BUSL-1.1\n//\n// Non-evaluation use of Artillery on Azure requires a commercial license\n\nconst { Command, Flags, Args } = require('@oclif/core');\nconst { CommonRunFlags } = require('../cli/common-flags');\n\nconst RunCommand = require('./run');\n\nclass RunACICommand extends Command {\n static aliases = ['run:aci'];\n static strict = false;\n\n async run() {\n const { flags, argv, args } = await this.parse(RunACICommand);\n flags.platform = 'az:aci';\n\n flags['platform-opt'] = [\n `region=${flags.region}`,\n `count=${flags.count}`,\n `cpu=${flags.cpu}`,\n `memory=${flags.memory}`,\n `tenant-id=${flags['tenant-id']}`,\n `subscription-id=${flags['subscription-id']}`,\n `storage-account=${flags['storage-account']}`,\n `blob-container=${flags['blob-container']}`,\n `resource-group=${flags['resource-group']}`\n ];\n\n RunCommand.runCommandImplementation(flags, argv, args);\n }\n}\n\nRunACICommand.description = `launch a test using Azure ACI\nLaunch a test on Azure ACI\n\nExamples:\n\n To run a test script in my-test.yml on Azure ACI in eastus region\n with 10 workers:\n\n $ artillery run:aci --region eastus --count 10 my-test.yml\n`;\nRunACICommand.flags = {\n ...CommonRunFlags,\n count: Flags.string({\n default: '1'\n }),\n region: Flags.string({\n description: 'Azure region to run the test in',\n default: 'eastus'\n }),\n cpu: Flags.string({\n description:\n 'Number of CPU cores per worker (defaults to 4 CPUs). A number between 1-4.'\n }),\n memory: Flags.string({\n description:\n 'Memory in GB per worker (defaults to 8 GB). A number between 1-16.'\n }),\n 'tenant-id': Flags.string({\n description:\n 'Azure tenant ID. May also be set via AZURE_TENANT_ID environment variable.'\n }),\n 'subscription-id': Flags.string({\n description:\n 'Azure subscription ID. May also be set via AZURE_SUBSCRIPTION_ID environment variable.'\n }),\n 'storage-account': Flags.string({\n description:\n 'Azure Blob Storage account name. May also be set via AZURE_STORAGE_ACCOUNT environment variable.'\n }),\n 'blob-container': Flags.string({\n description:\n 'Azure Blob Storage container name. May also be set via AZURE_STORAGE_BLOB_CONTAINER environment variable.'\n }),\n 'resource-group': Flags.string({\n description:\n 'Azure Resource Group name. May also be set via AZURE_RESOURCE_GROUP environment variable.'\n })\n};\n\nRunACICommand.args = {\n script: Args.string({\n name: 'script',\n required: true\n })\n};\n\nmodule.exports = RunACICommand;\n" }, { "path": "packages/artillery/lib/cmds/run-fargate.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst { Command, Flags, Args } = require('@oclif/core');\nconst { CommonRunFlags } = require('../cli/common-flags');\nconst telemetry = require('../telemetry');\n\nconst runCluster = require('../platform/aws-ecs/legacy/run-cluster');\nconst { supportedRegions } = require('../platform/aws-ecs/legacy/util');\nconst PlatformECS = require('../platform/aws-ecs/ecs');\nconst { ECS_WORKER_ROLE_NAME } = require('../platform/aws/constants');\nconst { Plugin: CloudPlugin } = require('../platform/cloud/cloud');\nconst generateId = require('../util/generate-id');\nconst dotenv = require('dotenv');\nconst path = require('node:path');\nconst fs = require('node:fs');\nclass RunCommand extends Command {\n static aliases = ['run:fargate', 'run:ecs', 'run-ecs'];\n // Enable multiple args:\n static strict = false;\n\n async run() {\n const { flags, _argv, args } = await this.parse(RunCommand);\n flags['platform-opt'] = [`region=${flags.region}`];\n\n flags.platform = 'aws:ecs';\n\n if (flags.dotenv) {\n const dotEnvPath = path.resolve(process.cwd(), flags.dotenv);\n try {\n fs.statSync(dotEnvPath);\n } catch (_err) {\n console.log(`WARNING: could not read dotenv file: ${flags.dotenv}`);\n }\n dotenv.config({ path: dotEnvPath });\n }\n\n const testRunId = process.env.ARTILLERY_TEST_RUN_ID || generateId('t');\n global.artillery.testRunId = testRunId;\n\n const cloud = new CloudPlugin(null, null, { flags });\n global.artillery.cloudEnabled = cloud.enabled;\n if (cloud.enabled) {\n try {\n await cloud.init();\n } catch (err) {\n if (err.name === 'CloudAPIKeyMissing') {\n console.error(\n 'Error: API key is required to record test results to Artillery Cloud'\n );\n console.error(\n 'See https://docs.art/get-started-cloud for more information'\n );\n\n process.exit(7);\n } else if (err.name === 'APIKeyUnauthorized') {\n console.error(\n 'Error: API key is not recognized or is not authorized to record tests'\n );\n\n process.exit(7);\n } else if (err.name === 'PingFailed') {\n console.error(\n 'Error: unable to reach Artillery Cloud API. This could be due to firewall restrictions on your network'\n );\n console.log('Please see https://docs.art/cloud/err-ping');\n process.exit(7);\n } else {\n console.error(\n 'Error: something went wrong connecting to Artillery Cloud'\n );\n console.error('Check https://status.artillery.io for status updates');\n console.error(err);\n }\n }\n }\n\n flags.taskRoleName = flags['task-role-name'] || ECS_WORKER_ROLE_NAME;\n\n const ECS = new PlatformECS(\n null,\n null,\n {},\n {\n testRunId: 'foo',\n region: flags.region,\n taskRoleName: flags.taskRoleName\n }\n );\n await ECS.init();\n\n process.env.USE_NOOP_BACKEND_STORE = 'true';\n\n telemetry.capture('run:fargate', {\n region: flags.region,\n count: flags.count\n });\n\n // Delegate the rest to existing implementation:\n runCluster(args.script, flags);\n }\n}\n\nRunCommand.description = `launch a test using AWS ECS/Fargate\n\nExamples:\n\n To launch a test with 10 load generating workers using AWS Fargate in us-east-1:\n\n $ artillery run:fargate --count 10 --region us-east-1 my-test.yml\n`;\n\nRunCommand.flags = {\n ...CommonRunFlags,\n count: Flags.integer({\n description: 'Number of load generator workers to launch'\n }),\n cluster: Flags.string({\n description: 'Name of the Fargate/ECS cluster to run the test on'\n }),\n region: Flags.string({\n char: 'r',\n description: 'The AWS region to run in',\n options: supportedRegions,\n default: 'us-east-1'\n }),\n secret: Flags.string({\n multiple: true,\n description:\n 'Make secrets available to workers. The secret must exist in SSM parameter store for the given region, under /artilleryio/'\n }),\n 'launch-type': Flags.string({\n description: 'The launch type to use for the test. Defaults to Fargate.',\n options: ['ecs:fargate', 'ecs:ec2']\n }),\n spot: Flags.boolean({\n description:\n 'Use Fargate Spot (https://docs.art/fargate-spot) Ignored when --launch-type is set to ecs:ec2'\n }),\n 'launch-config': Flags.string({\n description:\n 'JSON to customize launch configuration of ECS/Fargate tasks (see https://www.artillery.io/docs/reference/cli/run-fargate#using---launch-config)'\n }),\n 'container-dns-servers': Flags.string({\n description:\n 'Comma-separated list of DNS servers for Artillery container. Maps to dnsServers parameter in ECS container definition'\n }),\n 'task-ephemeral-storage': Flags.string({\n description:\n 'Ephemeral storage in GiB for the worker task. Maps to ephemeralStorage parameter in ECS container definition. Fargate-only.',\n type: 'integer'\n }),\n\n 'subnet-ids': Flags.string({\n description:\n 'Comma-separated list of AWS VPC subnet IDs to launch Fargate tasks in'\n }),\n 'security-group-ids': Flags.string({\n description:\n 'Comma-separated list of AWS VPC security group IDs to launch Fargate tasks in'\n }),\n 'task-role-name': Flags.string({\n description: 'Custom IAM role name for Fargate containers to assume'\n }),\n cpu: Flags.string({\n description:\n 'Set task vCPU on Fargate (defaults to 4 vCPU). Value may be set as a number of vCPUs between 1-16 (e.g. 4), or as number of vCPU units (e.g. 4096).'\n }),\n memory: Flags.string({\n description:\n 'Set task memory on Fargate (defaults to 8 GB). Value may be set as number of GB between 1-120 (e.g. 8), or as MiB (e.g. 8192)'\n }),\n packages: Flags.string({\n description:\n 'Path to package.json file which lists dependencies for the test script'\n }),\n 'max-duration': Flags.string({\n description: 'Maximum duration of the test run'\n }),\n 'no-assign-public-ip': Flags.boolean({\n description:\n 'Turn off the default behavior of assigning public IPs to Fargate worker tasks. When this option is used you must make sure tasks have a route to the internet, i.e. via a NAT gateway attached to a private subnet',\n default: false\n })\n};\n\nRunCommand.args = {\n script: Args.string()\n};\n\nmodule.exports = RunCommand;\n" }, { "path": "packages/artillery/lib/cmds/run-lambda.js", "content": "const { Command, Flags, Args } = require('@oclif/core');\nconst { CommonRunFlags } = require('../cli/common-flags');\n\nconst RunCommand = require('./run');\n\nclass RunLambdaCommand extends Command {\n static aliases = ['run:lambda'];\n static strict = false;\n\n async run() {\n const { flags, argv, args } = await this.parse(RunLambdaCommand);\n\n flags['platform-opt'] = [\n `region=${flags.region}`,\n `memory-size=${flags['memory-size']}`,\n `architecture=${flags.architecture}`\n ];\n\n delete flags.region;\n delete flags['memory-size'];\n delete flags.architecture;\n\n if (flags['lambda-role-arn']) {\n flags['platform-opt'].push(`lambda-role-arn=${flags['lambda-role-arn']}`);\n }\n\n if (flags['security-group-ids']) {\n flags['platform-opt'].push(\n `security-group-ids=${flags['security-group-ids']}`\n );\n }\n\n if (flags['subnet-ids']) {\n flags['platform-opt'].push(`subnet-ids=${flags['subnet-ids']}`);\n }\n\n flags.platform = 'aws:lambda';\n\n RunCommand.runCommandImplementation(flags, argv, args);\n }\n}\n\nRunLambdaCommand.description = `launch a test using AWS Lambda\nLaunch a test on AWS Lambda\n\nExamples:\n\n To run a test script in my-test.yml on AWS Lambda in us-east-1 region\n distributed across 10 Lambda functions:\n\n $ artillery run:lambda --region us-east-1 --count 10 my-test.yml\n`;\nRunLambdaCommand.flags = {\n ...CommonRunFlags,\n payload: Flags.string({\n char: 'p',\n description: 'Specify a CSV file for dynamic data'\n }),\n count: Flags.string({\n // locally defaults to number of CPUs with mode = distribute\n default: '1'\n }),\n architecture: Flags.string({\n description: 'Architecture of the Lambda function',\n default: 'arm64',\n options: ['arm64', 'x86_64']\n }),\n 'memory-size': Flags.string({\n description: 'Memory size of the Lambda function',\n default: '4096'\n }),\n region: Flags.string({\n description: 'AWS region to run the test in',\n default: 'us-east-1'\n }),\n 'lambda-role-arn': Flags.string({\n description: 'ARN of the IAM role to use for the Lambda function'\n }),\n 'security-group-ids': Flags.string({\n description:\n 'Comma-separated list of security group IDs to use for the Lambda function'\n }),\n 'subnet-ids': Flags.string({\n description:\n 'Comma-separated list of subnet IDs to use for the Lambda function'\n })\n};\n\nRunLambdaCommand.args = {\n script: Args.string({\n name: 'script',\n required: true\n })\n};\n\nmodule.exports = RunLambdaCommand;\n" }, { "path": "packages/artillery/lib/cmds/run.js", "content": "const { Command, Flags, Args } = require('@oclif/core');\nconst { CommonRunFlags } = require('../cli/common-flags');\n\nconst p = require('node:util').promisify;\nconst _csv = require('csv-parse');\nconst debug = require('debug')('commands:run');\nconst dotenv = require('dotenv');\nconst _ = require('lodash');\n\nconst fs = require('node:fs');\nconst path = require('node:path');\nconst crypto = require('node:crypto');\nconst os = require('node:os');\nconst createLauncher = require('../launch-platform');\nconst createConsoleReporter = require('../../console-reporter');\n\nconst moment = require('moment');\n\nconst { SSMS } = require('@artilleryio/int-core').ssms;\nconst telemetry = require('../telemetry');\n\nconst { Plugin: CloudPlugin } = require('../platform/cloud/cloud');\n\nconst parseTagString = require('../util/parse-tag-string');\n\nconst generateId = require('../util/generate-id');\nconst prepareTestExecutionPlan = require('../util/prepare-test-execution-plan');\n\nclass RunCommand extends Command {\n static aliases = ['run'];\n // Enable multiple args:\n static strict = false;\n\n async run() {\n const { flags, argv, args } = await this.parse(RunCommand);\n\n if (flags.platform === 'aws:ecs') {\n // Delegate to existing implementation\n const RunFargateCommand = require('./run-fargate');\n return await RunFargateCommand.run(argv);\n }\n\n await RunCommand.runCommandImplementation(flags, argv, args);\n }\n\n // async catch(err) {\n // throw err;\n // }\n}\n\n// Line no. 2 onwards is the description in help output\nRunCommand.description = `run a test script locally or on AWS Lambda\nRun a test script\n\nExamples:\n\n To run a test script in my-test.yml to completion from the local machine:\n\n $ artillery run my-test.yml\n\n To run a test script but override target dynamically:\n\n $ artillery run -t https://app2.acmecorp.internal my-test.yml\n`;\n\n// TODO: Link to an Examples section in the docs\n\nRunCommand.flags = {\n ...CommonRunFlags,\n // TODO: Deprecation notices for commands below:\n payload: Flags.string({\n char: 'p',\n description: 'Specify a CSV file for dynamic data'\n }),\n solo: Flags.boolean({\n char: 's',\n description: 'Create only one virtual user'\n }),\n platform: Flags.string({\n description: 'Runtime platform',\n default: 'local',\n options: ['local', 'aws:lambda', 'az:aci']\n }),\n 'platform-opt': Flags.string({\n description:\n 'Set a platform-specific option, e.g. --platform-opt region=eu-west-1 for AWS Lambda',\n multiple: true\n }),\n count: Flags.string({\n // locally defaults to number of CPUs with mode = distribute\n default: '1'\n })\n};\n\nRunCommand.args = {\n script: Args.string({\n name: 'script',\n required: true\n })\n};\n\nlet cloud;\nRunCommand.runCommandImplementation = async (flags, argv, args) => {\n // Collect all input files for reading/parsing - via args, --config, or -i\n const inputFiles = argv.concat(flags.input || [], flags.config || []);\n\n const tagResult = parseTagString(flags.tags);\n if (tagResult.errors.length > 0) {\n console.log(\n 'WARNING: could not parse some tags:',\n tagResult.errors.join(', ')\n );\n }\n\n if (tagResult.tags.length > 10) {\n console.log('A maximum of 10 tags is supported');\n process.exit(1);\n }\n\n // TODO: Move into PlatformLocal\n if (flags.dotenv) {\n const dotEnvPath = path.resolve(process.cwd(), flags.dotenv);\n try {\n fs.statSync(dotEnvPath);\n } catch (_err) {\n console.log(`WARNING: could not read dotenv file: ${flags.dotenv}`);\n }\n dotenv.config({ path: dotEnvPath });\n }\n\n if (flags.output) {\n if (!checkDirExists(flags.output)) {\n console.error('Path does not exist:', flags.output);\n process.exit(1);\n }\n }\n\n const testRunId = process.env.ARTILLERY_TEST_RUN_ID || generateId('t');\n console.log('Test run id:', testRunId);\n global.artillery.testRunId = testRunId;\n cloud = new CloudPlugin(null, null, { flags });\n global.artillery.cloudEnabled = cloud.enabled;\n\n if (cloud.enabled) {\n try {\n await cloud.init();\n } catch (err) {\n if (err.name === 'CloudAPIKeyMissing') {\n console.error(\n 'Error: API key is required to record test results to Artillery Cloud'\n );\n console.error(\n 'See https://docs.art/get-started-cloud for more information'\n );\n\n await gracefulShutdown({ exitCode: 7 });\n } else if (err.name === 'APIKeyUnauthorized') {\n console.error(\n 'Error: API key is not recognized or is not authorized to record tests'\n );\n\n await gracefulShutdown({ exitCode: 7 });\n } else if (err.name === 'PingFailed') {\n console.error(\n 'Error: unable to reach Artillery Cloud API. This could be due to firewall restrictions on your network'\n );\n console.log('https://docs.art/cloud/err-ping');\n await gracefulShutdown({ exitCode: 7 });\n } else {\n console.error(\n 'Error: something went wrong connecting to Artillery Cloud'\n );\n console.error('Check https://status.artillery.io for status updates');\n console.error(err);\n }\n }\n }\n\n let script;\n try {\n script = await prepareTestExecutionPlan(inputFiles, flags, args);\n } catch (err) {\n console.error('Error:', err.message);\n await gracefulShutdown({ exitCode: 1 });\n }\n\n var runnerOpts = {\n environment: flags.environment,\n // This is used in the worker to resolve\n // the path to the processor module\n scriptPath: args.script,\n // TODO: This should be an array of files, like inputFiles above\n absoluteScriptPath: path.resolve(process.cwd(), args.script),\n plugins: [],\n scenarioName: flags['scenario-name']\n };\n\n // Set \"name\" tag if not set explicitly\n if (tagResult.tags.filter((t) => t.name === 'name').length === 0) {\n tagResult.tags.push({\n name: 'name',\n value: path.basename(runnerOpts.scriptPath)\n });\n }\n // Override the \"name\" tag with the value of --name if set\n if (flags.name) {\n for (const t of tagResult.tags) {\n if (t.name === 'name') {\n t.value = flags.name;\n }\n }\n }\n\n if (flags.config) {\n runnerOpts.absoluteConfigPath = path.resolve(process.cwd(), flags.config);\n }\n\n if (process.env.WORKERS) {\n runnerOpts.count = parseInt(process.env.WORKERS, 10) || 1;\n }\n if (flags.solo) {\n runnerOpts.count = 1;\n }\n\n const platformConfig = {};\n if (flags['platform-opt']) {\n for (const opt of flags['platform-opt']) {\n const [k, v] = opt.split('=');\n platformConfig[k] = v;\n }\n }\n\n const launcherOpts = {\n platform: flags.platform,\n platformConfig,\n mode: flags.platform === 'local' ? 'distribute' : 'multiply',\n count: parseInt(flags.count || 1, 10),\n cliArgs: flags,\n testRunId\n };\n\n var launcher = await createLauncher(\n script,\n script.config.payload,\n runnerOpts,\n launcherOpts\n );\n\n if (!launcher) {\n console.log('Failed to create launcher');\n await gracefulShutdown({ exitCode: 1 });\n }\n\n const intermediates = [];\n\n const metricsToSuppress = getPluginMetricsToSuppress(script);\n // TODO: Wire up workerLog or something like that\n const consoleReporter = createConsoleReporter(launcher.events, {\n quiet: flags.quiet || false,\n metricsToSuppress\n });\n\n var reporters = [consoleReporter];\n if (process.env.CUSTOM_REPORTERS) {\n const customReporterNames = process.env.CUSTOM_REPORTERS.split(',');\n customReporterNames.forEach((name) => {\n const createReporter = require(name);\n const reporter = createReporter(launcher.events, flags);\n reporters.push(reporter);\n });\n }\n\n launcher.events.on('phaseStarted', (_phase) => {});\n\n launcher.events.on('stats', (stats) => {\n if (artillery.runtimeOptions.legacyReporting) {\n const report = SSMS.legacyReport(stats).report();\n intermediates.push(report);\n } else {\n intermediates.push(stats);\n }\n });\n\n launcher.events.on('done', async (stats) => {\n let report;\n if (artillery.runtimeOptions.legacyReporting) {\n report = SSMS.legacyReport(stats).report();\n report.phases = _.get(script, 'config.phases', []);\n } else {\n report = stats;\n }\n\n if (flags.output) {\n const logfile = getLogFilename(flags.output);\n if (!flags.quiet) {\n console.log('Log file: %s', logfile);\n }\n\n for (const ix of intermediates) {\n delete ix.histograms;\n ix.histograms = ix.summaries;\n }\n delete report.histograms;\n report.histograms = report.summaries;\n\n fs.writeFileSync(\n logfile,\n JSON.stringify(\n {\n aggregate: report,\n intermediate: intermediates\n },\n null,\n 2\n ),\n { flag: 'w' }\n );\n }\n\n // This is used in the beforeExit event handler in gracefulShutdown\n finalReport = report;\n await gracefulShutdown();\n });\n\n global.artillery.ext({\n ext: 'beforeExit',\n method: async (event) => {\n try {\n const duration = Math.round(\n (event.report?.lastMetricAt - event.report?.firstMetricAt) / 1000\n );\n await sendTelemetry(script, flags, { duration });\n } catch (_err) {}\n }\n });\n\n global.artillery.globalEvents.emit('test:init', {\n flags,\n testRunId,\n tags: tagResult.tags,\n metadata: {\n testId: testRunId,\n startedAt: Date.now(),\n count: runnerOpts.count || Number(flags.count),\n tags: tagResult.tags,\n launchType: flags.platform,\n artilleryVersion: {\n core: global.artillery.version\n },\n // Properties from the runnable script object:\n testConfig: {\n target: script.config.target,\n phases: script.config.phases,\n plugins: script.config.plugins,\n environment: script._environment,\n scriptPath: script._scriptPath,\n configPath: script._configPath\n }\n }\n });\n\n launcher.run();\n\n var finalReport = {};\n var shuttingDown = false;\n process.on('SIGINT', async () => {\n gracefulShutdown({ earlyStop: true, exitCode: 130 });\n });\n process.on('SIGTERM', async () => {\n gracefulShutdown({ earlyStop: true, exitCode: 143 });\n });\n\n async function gracefulShutdown(opts = { exitCode: 0 }) {\n debug('shutting down đŸĻ‘');\n if (shuttingDown) {\n return;\n }\n\n debug('Graceful shutdown initiated');\n\n shuttingDown = true;\n global.artillery.globalEvents.emit('shutdown:start', opts);\n\n // Run beforeExit first, and then onShutdown\n\n const ps = [];\n for (const e of global.artillery.extensionEvents) {\n const testInfo = { endTime: Date.now() };\n if (e.ext === 'beforeExit') {\n ps.push(\n e.method({\n ...opts,\n report: finalReport,\n flags,\n runnerOpts,\n testInfo\n })\n );\n }\n }\n await Promise.allSettled(ps);\n\n const ps2 = [];\n for (const e of global.artillery.extensionEvents) {\n if (e.ext === 'onShutdown') {\n ps2.push(e.method(opts));\n }\n }\n await Promise.allSettled(ps2);\n\n if (launcher) {\n await launcher.shutdown();\n }\n\n await (async () => {\n if (reporters) {\n for (const r of reporters) {\n if (r.cleanup) {\n try {\n await p(r.cleanup.bind(r))();\n } catch (cleanupErr) {\n debug(cleanupErr);\n }\n }\n }\n }\n\n if (\n global.artillery.hasTypescriptProcessor &&\n !process.env.ARTILLERY_TS_KEEP_BUNDLE\n ) {\n try {\n fs.unlinkSync(global.artillery.hasTypescriptProcessor);\n } catch (err) {\n console.log(\n `WARNING: Failed to remove typescript bundled file: ${global.artillery.hasTypescriptProcessor}`\n );\n console.log(err);\n }\n try {\n fs.rmdirSync(path.dirname(global.artillery.hasTypescriptProcessor));\n } catch (_err) {}\n }\n debug('Cleanup finished');\n process.exit(artillery.suggestedExitCode || opts.exitCode);\n })();\n }\n\n global.artillery.shutdown = gracefulShutdown;\n};\n\nasync function sendTelemetry(script, flags, extraProps) {\n if (process.env.WORKER_ID) {\n debug('Telemetry: Running in cloud worker, skipping test run event');\n return;\n }\n\n function hash(str) {\n return crypto.createHash('sha1').update(str).digest('base64');\n }\n\n const properties = {};\n\n if (script.config?.__createdByQuickCommand) {\n properties.quick = true;\n }\n if (cloud?.enabled && cloud.user) {\n properties.cloud = cloud.user;\n }\n\n properties.solo = flags.solo;\n try {\n // One-way hash of target endpoint:\n if (script.config?.target) {\n const targetHash = hash(script.config.target);\n properties.targetHash = targetHash;\n }\n\n if (flags.target) {\n const targetHash = hash(flags.target);\n properties.targetHash = targetHash;\n }\n\n properties.platform = flags.platform;\n\n properties.count = flags.count;\n\n if (properties.targetHash) {\n properties.distinctId = properties.targetHash;\n }\n\n let macaddr;\n const nonInternalIpv6Interfaces = [];\n for (const [_iface, descrs] of Object.entries(os.networkInterfaces())) {\n for (const o of descrs) {\n if (o.internal === true) {\n continue;\n }\n\n //prefer ipv4 interface when available\n if (o.family !== 'IPv4') {\n nonInternalIpv6Interfaces.push(o);\n continue;\n }\n\n macaddr = o.mac;\n break;\n }\n }\n\n //default to first ipv6 interface if no ipv4 interface is available\n if (!macaddr && nonInternalIpv6Interfaces.length > 0) {\n macaddr = nonInternalIpv6Interfaces[0].mac;\n }\n\n if (macaddr) {\n properties.macHash = hash(macaddr);\n }\n properties.hostnameHash = hash(os.hostname());\n properties.usernameHash = hash(os.userInfo().username);\n\n if (script.config?.engines) {\n properties.loadsEngines = true;\n }\n\n properties.enginesUsed = [];\n const OSS_ENGINES = [\n 'http',\n 'socketio',\n 'ws',\n\n 'playwright',\n 'kinesis',\n 'socketio-v3',\n 'rediscluster',\n 'kafka',\n 'tcp',\n 'grpc',\n 'meteor',\n 'graphql-ws',\n 'ldap',\n 'lambda'\n ];\n\n for (const scenario of script.scenarios || []) {\n if (OSS_ENGINES.indexOf(scenario.engine || 'http') > -1) {\n if (properties.enginesUsed.indexOf(scenario.engine || 'http') === -1) {\n properties.enginesUsed.push(scenario.engine || 'http');\n }\n }\n }\n\n // Official plugins:\n if (script.config.plugins) {\n properties.plugins = true;\n properties.officialPlugins = [];\n const OFFICIAL_PLUGINS = [\n 'apdex',\n 'expect',\n 'publish-metrics',\n 'metrics-by-endpoint',\n 'hls',\n 'fuzzer',\n 'ensure',\n 'memory-inspector',\n 'fake-data',\n 'slack'\n ];\n for (const p of OFFICIAL_PLUGINS) {\n if (script.config.plugins[p]) {\n properties.officialPlugins.push(p);\n }\n }\n }\n\n // publish-metrics reporters\n if (script.config.plugins['publish-metrics']) {\n const OFFICIAL_REPORTERS = [\n 'datadog',\n 'open-telemetry',\n 'newrelic',\n 'splunk',\n 'dynatrace',\n 'cloudwatch',\n 'honeycomb',\n 'mixpanel',\n 'prometheus'\n ];\n\n properties.officialMonitoringReporters = script.config.plugins[\n 'publish-metrics'\n ]\n .map((reporter) => {\n if (OFFICIAL_REPORTERS.includes(reporter.type)) {\n return reporter.type;\n }\n return undefined;\n })\n .filter((type) => type !== undefined);\n }\n\n // before/after hooks\n if (script.before) {\n properties.beforeHook = true;\n }\n\n if (script.after) {\n properties.afterHook = true;\n }\n\n Object.assign(properties, extraProps);\n } catch (err) {\n debug(err);\n } finally {\n telemetry.capture('test run', properties);\n }\n}\n\nfunction checkDirExists(output) {\n if (!output) {\n return;\n }\n // If destination is a file check only path to its directory\n const exists = path.extname(output)\n ? fs.existsSync(path.dirname(output))\n : fs.existsSync(output);\n\n return exists;\n}\n\nfunction getLogFilename(output, nameFormat) {\n let logfile;\n\n // is the destination a directory that exists?\n let isDir = false;\n if (output) {\n try {\n isDir = fs.statSync(output).isDirectory();\n } catch (_err) {\n // ENOENT do nothing, handled in checkDirExists before test run\n }\n }\n\n const defaultFormat = '[artillery_report_]YMMDD_HHmmSS[.json]';\n if (!isDir && output) {\n // -o is set with a filename (existing or not)\n logfile = output;\n } else if (!isDir && !output) {\n // no -o set\n } else {\n // -o is set with a directory\n logfile = path.join(output, moment().format(nameFormat || defaultFormat));\n }\n\n return logfile;\n}\n\nfunction getPluginMetricsToSuppress(script) {\n if (!script.config.plugins) {\n return [];\n }\n const metrics = [];\n for (const [plugin, options] of Object.entries(script.config.plugins)) {\n if (options.suppressOutput) {\n metrics.push(`plugins.${plugin}`);\n }\n }\n return metrics;\n}\n\nmodule.exports = RunCommand;\n" }, { "path": "packages/artillery/lib/console-capture.js", "content": "const debug = require('debug')('console-capture');\n\nfunction setupConsoleCapture() {\n let outputLines = [];\n let truncated = false;\n let currentSize = 0;\n let sendFromIndex = 0;\n\n const MAX_RETAINED_LOG_SIZE_MB = Number(\n process.env.MAX_RETAINED_LOG_SIZE_MB || '50'\n );\n const MAX_RETAINED_LOG_SIZE = MAX_RETAINED_LOG_SIZE_MB * 1024 * 1024;\n\n const interval = setInterval(() => {\n if (!truncated && outputLines.length - sendFromIndex > 0) {\n const newBatch = outputLines.slice(sendFromIndex, outputLines.length);\n sendFromIndex = outputLines.length;\n global.artillery.globalEvents.emit('logLines', newBatch, Date.now());\n }\n }, 10 * 1000).unref();\n\n global.artillery.ext({\n ext: 'onShutdown',\n method: async () => {\n debug('onBeforeExit', sendFromIndex, outputLines.length);\n clearInterval(interval);\n\n if (!truncated && sendFromIndex < outputLines.length) {\n const ts = Date.now();\n global.artillery.globalEvents.emit(\n 'logLines',\n outputLines.slice(sendFromIndex, outputLines.length),\n ts,\n true\n );\n sendFromIndex = outputLines.length;\n }\n }\n });\n\n console.log = (() => {\n const orig = console.log;\n return (...args) => {\n try {\n orig.apply(console, args);\n\n if (currentSize < MAX_RETAINED_LOG_SIZE) {\n outputLines = outputLines.concat([args]);\n for (const x of args) {\n currentSize += String(x).length;\n }\n } else {\n if (!truncated) {\n truncated = true;\n const msg = `[WARNING] Artillery: maximum retained log size exceeded, max size: ${MAX_RETAINED_LOG_SIZE_MB}MB. Further logs won't be retained.\\n\\n`;\n process.stdout.write(msg);\n outputLines = outputLines.concat([msg]);\n }\n }\n } catch (err) {\n debug(err);\n }\n };\n })();\n\n console.error = (() => {\n const orig = console.error;\n return (...args) => {\n try {\n orig.apply(console, args);\n\n if (currentSize < MAX_RETAINED_LOG_SIZE) {\n outputLines = outputLines.concat([args]);\n for (const x of args) {\n currentSize += String(x).length;\n }\n } else {\n if (!truncated) {\n truncated = true;\n const msg = `[WARNING] Artillery: maximum retained log size exceeded, max size: ${MAX_RETAINED_LOG_SIZE_MB}MB. Further logs won't be retained.\\n\\n`;\n process.stdout.write(msg);\n outputLines = outputLines.concat([msg]);\n }\n }\n } catch (err) {\n debug(err);\n }\n };\n })();\n}\n\nmodule.exports = setupConsoleCapture;\n" }, { "path": "packages/artillery/lib/console-reporter.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\n\n\nconst ora = require('ora');\nconst _ = require('lodash');\nconst moment = require('moment');\nconst chalk = require('chalk');\nconst Table = require('cli-table3');\nconst util = require('./util');\nconst SSMS = require('@artilleryio/int-core').ssms.SSMS;\n\nmodule.exports = createConsoleReporter;\n\nfunction createConsoleReporter(events, opts) {\n const reporter = new ConsoleReporter(opts);\n events.on('phaseStarted', reporter.phaseStarted.bind(reporter));\n events.on('phaseCompleted', reporter.phaseCompleted.bind(reporter)); // TODO: Not firing - event not propagating?\n events.on('stats', reporter.stats.bind(reporter));\n events.on('done', reporter.done.bind(reporter));\n reporter.start();\n return reporter;\n}\n\nfunction ConsoleReporter(opts) {\n this.opts = opts || {};\n this.outputFormat = opts.outputFormat || process.env.OUTPUT_FORMAT || 'new';\n\n this.quiet = opts.quiet;\n this.metricsToSuppress = opts.metricsToSuppress;\n this.spinner = ora({\n spinner: 'dots'\n });\n this.spinner.start();\n\n this.reportScenarioLatency = !!opts.reportScenarioLatency;\n this.startTime = null;\n\n global.artillery.globalEvents.on('log', (opts, ...args) => {\n let logger;\n if (typeof opts.level !== 'undefined' && opts.level !== 'info') {\n logger = console.error;\n } else {\n logger = console.log;\n }\n\n if (opts.showTimestamp) {\n args.push(chalk.gray(`[${moment().format('HH:mm:ss')}]`));\n }\n\n this.spinner.clear();\n logger.apply(console, [...args]);\n this.spinner.start();\n });\n\n return this;\n}\n\nConsoleReporter.prototype.cleanup = function (done) {\n this.spinner.clear();\n return done(null);\n};\n\nConsoleReporter.prototype.start = function start() {\n if (this.quiet) {\n return this;\n }\n // artillery.log(`Artillery running - ${moment(Date.now()).toISOString()}\\n`);\n return this;\n};\n\nConsoleReporter.prototype.phaseStarted = function phaseStarted(phase) {\n if (this.quiet) {\n return this;\n }\n\n const phaseDuration = phase.duration || phase.pause;\n //only append s when phaseDuration is a number or number-like string (like from env variables). otherwise it's a converted unit (e.g. 5min)\n const durationString = Number.isInteger(_.toNumber(phaseDuration)) ? `${phaseDuration}s` : `${phaseDuration}`;\n\n artillery.log(\n `Phase started: ${chalk.green(\n phase.name ? phase.name : 'unnamed'\n )} (index: ${phase.index}, duration: ${\n durationString\n }) ${formatTimestamp(new Date())}\\n`\n );\n};\n\nConsoleReporter.prototype.phaseCompleted = function phaseCompleted(phase) {\n if (this.quiet) {\n return this;\n }\n\n const phaseDuration = phase.duration || phase.pause;\n //only append s when phaseDuration is a number or number-like string (like from env variables). otherwise it's a converted unit (e.g. 5min)\n const durationString = Number.isInteger(_.toNumber(phaseDuration)) ? `${phaseDuration}s` : `${phaseDuration}`;\n\n artillery.log(\n `Phase completed: ${chalk.green(\n phase.name ? phase.name : 'unnamed'\n )} (index: ${phase.index}, duration: ${\n durationString\n }) ${formatTimestamp(new Date())}\\n`\n );\n\n return this;\n};\n\nConsoleReporter.prototype.stats = function stats(data) {\n if (this.quiet) {\n return this;\n }\n\n if (!this.startTime) {\n this.startTime = data.firstMetricAt || Date.now();\n }\n\n // NOTE: histograms property is available and contains raw\n // histogram objects\n data.summaries = data.summaries || {};\n data.counters = data.counters || {};\n // data.rates = data.rates || {};\n\n if (typeof data.report === 'function') {\n // Compatibility fix with Artillery Pro which uses 1.x\n // API for emitting reports to console-reporter.\n // TODO: Remove when support for 1x is dropped in Artillery Pro\n artillery.log(\n `Elapsed time: ${util.formatDuration(Date.now() - this.startTime)}`\n );\n this.printReport(data.report(), this.opts);\n } else {\n this.printReport(data, this.opts);\n }\n artillery.log();\n artillery.log();\n};\n\nConsoleReporter.prototype.done = function done(data) {\n if (this.quiet) {\n return this;\n }\n\n if (this.startTime !== null) {\n artillery.log(\n `All VUs finished. Total time: ${util.formatDuration(\n Date.now() - this.startTime\n )}\\n`\n );\n }\n\n const txt = `Summary report @ ${formatTimestamp(new Date())}`;\n artillery.log(`${underline(txt)}\\n${txt}\\n${underline(txt)}\\n`);\n\n // TODO: this is repeated in 'stats' handler\n data.summaries = data.summaries || {};\n data.counters = data.counters || {};\n\n if (typeof data.report === 'function') {\n // Compatibility fix with Artillery Pro which uses 1.x\n // API for emitting reports to console-reporter.\n // TODO: Remove when support for 1x is dropped in Artillery Pro\n this.printReport(\n data.report(),\n Object.assign({}, this.opts, {\n showScenarioCounts: true,\n printPeriod: false\n })\n );\n } else {\n this.printReport(\n data,\n Object.assign({}, this.opts, {\n showScenarioCounts: true,\n printPeriod: false\n })\n );\n }\n};\n\nConsoleReporter.prototype.printReport = function printReport(report, opts) {\n opts = opts || {};\n if (opts.printPeriod !== false) {\n const timeWindowEnd = moment(\n new Date(Number(report.period) + 10 * 1000)\n ).format('HH:mm:ss(ZZ)');\n if (typeof report.period !== 'undefined') {\n // FIXME: up to bound should be included in the report\n // Add underline\n const txt = `Metrics for period to: ${timeWindowEnd}`;\n artillery.log(\n underline(txt) +\n '\\n' +\n txt +\n ' ' +\n chalk.gray(\n '(width: ' +\n (report.lastMetricAt - report.firstMetricAt) / 1000 +\n 's)'\n ) +\n '\\n' +\n underline(txt) +\n '\\n'\n );\n\n // artillery.log(padded('time_window:', timeWindowEnd));\n } else {\n artillery.log('Report @ %s', formatTimestamp(report.timestamp));\n }\n }\n\n if (this.outputFormat === 'new') {\n report.rates = report.rates || {};\n report.counters = report.counters || {};\n report.summaries = report.summaries || {};\n\n const sortedByLen = _(\n Object.keys(report.summaries)\n .concat(Object.keys(report.counters))\n .concat(Object.keys(report.rates))\n )\n .sortBy([(x) => x.length])\n .value();\n\n if (sortedByLen.length === 0) {\n // No scenarios launched or completed, no requests made or completed etc. Nothing happened.\n artillery.log('No measurements recorded during this period');\n return;\n }\n\n const sortedAlphabetically = sortedByLen.sort();\n\n let result = [];\n for (const metricName of sortedAlphabetically) {\n\n if (shouldSuppressOutput(metricName, this.metricsToSuppress)) {\n continue;\n };\n if (typeof report.counters?.[metricName] !== 'undefined') {\n result = result.concat(printCounters([metricName], report));\n }\n if (typeof report.summaries?.[metricName] !== 'undefined') {\n result = result.concat(printSummaries([metricName], report));\n }\n if (typeof report.rates?.[metricName] !== 'undefined') {\n result = result.concat(printRates([metricName], report));\n }\n }\n\n artillery.log(result.join('\\n'));\n }\n};\n\nif (this.outputFormat === 'classic') {\n report = SSMS.legacyReport(report).report();\n\n // TODO: Read new fields instead of the old ones\n\n artillery.log('Scenarios launched: %s', report.scenariosCreated);\n artillery.log('Scenarios completed: %s', report.scenariosCompleted);\n artillery.log('Requests completed: %s', report.requestsCompleted);\n\n artillery.log('Mean responses/sec: %s', report.rps.mean);\n artillery.log('Response time (msec):');\n artillery.log(' min: %s', report.latency.min);\n artillery.log(' max: %s', report.latency.max);\n artillery.log(' median: %s', report.latency.median);\n artillery.log(' p95: %s', report.latency.p95);\n artillery.log(' p99: %s', report.latency.p99);\n\n if (this.reportScenarioLatency) {\n artillery.log('Scenario duration:');\n artillery.log(' min: %s', report.scenarioDuration.min);\n artillery.log(' max: %s', report.scenarioDuration.max);\n artillery.log(' median: %s', report.scenarioDuration.median);\n artillery.log(' p95: %s', report.scenarioDuration.p95);\n artillery.log(' p99: %s', report.scenarioDuration.p99);\n }\n\n // We only want to show this for the aggregate report:\n if (opts.showScenarioCounts && report.scenarioCounts) {\n artillery.log('Scenario counts:');\n _.each(report.scenarioCounts, (count, name) => {\n const percentage =\n Math.round((count / report.scenariosCreated) * 100 * 1000) / 1000;\n artillery.log(' %s: %s (%s%)', name, count, percentage);\n });\n }\n\n if (_.keys(report.codes).length !== 0) {\n artillery.log('Codes:');\n _.each(report.codes, (count, code) => {\n artillery.log(' %s: %s', code, count);\n });\n }\n if (_.keys(report.errors).length !== 0) {\n artillery.log('Errors:');\n _.each(report.errors, (count, code) => {\n artillery.log(' %s: %s', code, count);\n });\n }\n\n if (_.size(report.summaries) > 0 || _.size(report.counters) > 0) {\n _.each(report.summaries, (r, n) => {\n if (excludeFromReporting(n)) return;\n\n artillery.log('%s:', n);\n artillery.log(' min: %s', r.min);\n artillery.log(' max: %s', r.max);\n artillery.log(' median: %s', r.median);\n artillery.log(' p95: %s', r.p95);\n artillery.log(' p99: %s', r.p99);\n });\n }\n\n _.each(report.customStats, (r, n) => {\n artillery.log('%s:', n);\n artillery.log(' min: %s', r.min);\n artillery.log(' max: %s', r.max);\n artillery.log(' median: %s', r.median);\n artillery.log(' p95: %s', r.p95);\n artillery.log(' p99: %s', r.p99);\n });\n\n _.each(report.counters, (value, name) => {\n // Only show user/custom metrics in this mode, but none of the internally generated ones:\n if (excludeFromReporting(name)) return;\n artillery.log('%s: %s', name, value);\n });\n\n artillery.log();\n}\n\nfunction isCollectionMetric(n) {\n const collectionMetrics = ['artillery.codes', 'errors'];\n return (\n collectionMetrics.filter((m) => {\n return n.startsWith(m);\n }).length > 0\n );\n}\n\nif (this.outputFormat === 'table') {\n const t = new Table({ head: ['Metric', 'Value'] });\n\n if (_.size(report.summaries) > 0 || _.size(report.counters) > 0) {\n _.sortBy(Object.keys(report.summaries)).forEach((n) => {\n const r = report.summaries[n];\n const spaces = ' '.repeat(Math.min(8, n.length + 1));\n t.push([`${n}`]);\n t.push([`${spaces}min`, r.min]);\n t.push([`${spaces}max`, r.max]);\n t.push([`${spaces}median`, r.median]);\n t.push([`${spaces}p95`, r.p95]);\n t.push([`${spaces}p99`, r.p99]);\n });\n\n _.sortBy(\n Object.keys(report.counters).filter((name) => !isCollectionMetric(name))\n ).forEach((name) => {\n const value = report.counters[name];\n t.push([name, value]);\n });\n }\n artillery.log(t.toString());\n artillery.log();\n}\n\n// TODO: Make smarter if date changes, ie. test runs over midnight\nfunction formatTimestamp(timestamp) {\n return moment(new Date(timestamp)).format('HH:mm:ss(ZZ)');\n}\n\nfunction underline(text) {\n return '-'.repeat(text.length);\n}\n\nfunction excludeFromReporting(name) {\n return (\n ['engine', 'core', 'artillery', 'errors', 'scenarios'].indexOf(\n name.split('.')[0]\n ) > -1\n );\n}\n\nfunction padded(str1, str2) {\n const defaultWidth = 79;\n // We need at least 50\n const columnsAvailable = Math.max(\n process.stdout?.columns || defaultWidth,\n 50\n );\n // But no more than 79:\n const width = Math.min(columnsAvailable, defaultWidth);\n\n return util.padded(str1, str2, width);\n}\n\nfunction printRates(rates, report) {\n return rates.sort().map((name) => {\n return `${padded(`${name}:`, report.rates[name])}/sec`;\n });\n}\n\nfunction printCounters(counters, report) {\n return counters.sort().map((name) => {\n const value = report.counters[name];\n return padded(`${name}:`, value);\n });\n}\n\nfunction printSummaries(summaries, report) {\n const result = [];\n for (const n of summaries) {\n const r = report.summaries[n];\n result.push(`${n}:`);\n result.push(padded(' min:', r.min));\n result.push(padded(' max:', r.max));\n result.push(padded(' mean:', r.mean));\n result.push(padded(' median:', r.median));\n result.push(padded(' p95:', r.p95));\n result.push(padded(' p99:', r.p99));\n\n // TODO: Can work well if padded to look like a table:\n // result.push(padded(`${trimName(n)}:`, `min: ${r.min} | max: ${r.max} | p50: ${r.p50} | p95: ${r.p95} | p99: ${r.p99}`));\n }\n return result;\n}\n\nfunction shouldSuppressOutput(currMetricName, suppressMetricsList) {\n if (!suppressMetricsList) {\n return;\n };\n return suppressMetricsList.some((metric)=> currMetricName.includes(metric));\n}\n" }, { "path": "packages/artillery/lib/create-bom/built-in-plugins.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nmodule.exports = [\n 'metrics-by-endpoint',\n 'ensure',\n 'publish-metrics',\n 'expect',\n 'apdex',\n 'slack'\n];\n" }, { "path": "packages/artillery/lib/create-bom/create-bom.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\n// TODO: async-ify this\n\nconst path = require('node:path');\nconst fs = require('node:fs');\nconst A = require('async');\nconst debug = require('debug')('bom');\nconst _ = require('lodash');\nconst Table = require('cli-table3');\nconst { getCustomJsDependencies } = require('../platform/aws-ecs/legacy/bom');\n\nconst { readScript, parseScript } = require('../util');\n\nconst BUILTIN_PLUGINS = require('./built-in-plugins');\n\n// NOTE: Presumes ALL paths are absolute.\nasync function createBOM(absoluteScriptPath, extraFiles, opts, callback) {\n A.waterfall(\n [\n A.constant(absoluteScriptPath),\n readScript,\n parseScript,\n (scriptData, next) => {\n return next(null, {\n opts: {\n scriptData,\n absoluteScriptPath\n },\n localFilePaths: [absoluteScriptPath],\n npmModules: []\n });\n },\n getPlugins,\n getCustomEngines,\n getCustomJsDependencies,\n getVariableDataFiles,\n // getFileUploadPluginFiles,\n getExtraFiles\n // expandDirectories\n ],\n\n (err, context) => {\n if (err) {\n return callback(err, null);\n }\n\n context.localFilePaths = context.localFilePaths.concat(extraFiles);\n\n // TODO: Entries in localFilePaths may be directories\n\n // Handle case with only one entry, where the string itself\n // will be the common prefix, meaning that when we substring() on it later, we'll\n // get an empty string, ending up with a manifest like:\n // { files:\n // [ { orig: '/Users/h/tmp/artillery/hello.yaml', noPrefix: '' } ],\n // modules: [] }\n //\n let prefix = '';\n if (context.localFilePaths.length === 1) {\n prefix = context.localFilePaths[0].substring(\n 0,\n context.localFilePaths[0].length -\n path.basename(context.localFilePaths[0]).length\n );\n\n // This may still be an empty string if the script path is just 'hello.yml':\n prefix = prefix.length === 0 ? context.localFilePaths[0] : prefix;\n } else {\n prefix = commonPrefix(context.localFilePaths);\n }\n\n debug('prefix', prefix);\n\n //\n // include package.json / package-lock.json / yarn.lock\n //\n let packageDescriptionFiles = ['.npmrc'];\n if (opts.packageJsonPath) {\n packageDescriptionFiles.push(opts.packageJsonPath);\n } else {\n packageDescriptionFiles = packageDescriptionFiles.concat([\n 'package.json',\n 'package-lock.json',\n 'yarn.lock'\n ]);\n }\n const dependencyFiles = packageDescriptionFiles.map((s) =>\n path.join(prefix, s)\n );\n\n debug(dependencyFiles);\n\n dependencyFiles.forEach((p) => {\n try {\n if (fs.statSync(p)) {\n context.localFilePaths.push(p);\n }\n } catch (_ignoredErr) {}\n });\n\n const files = context.localFilePaths.map((p) => {\n return { orig: p, noPrefix: p.substring(prefix.length, p.length) };\n });\n\n const pkgPath = _.find(files, (f) => {\n return f.noPrefix === 'package.json';\n });\n\n if (pkgPath) {\n const pkg = JSON.parse(fs.readFileSync(pkgPath.orig, 'utf8'));\n const pkgDeps = [].concat(\n Object.keys(pkg.dependencies || {}),\n Object.keys(pkg.devDependencies || {})\n );\n context.pkgDeps = pkgDeps;\n context.npmModules = _.uniq(context.npmModules.concat(pkgDeps)).sort();\n } else {\n context.pkgDeps = [];\n }\n\n return callback(null, {\n files: _.uniqWith(files, _.isEqual),\n modules: _.uniq(context.npmModules).filter(\n (m) =>\n m !== 'artillery' &&\n m !== 'playwright' &&\n !m.startsWith('@playwright/')\n ),\n pkgDeps: context.pkgDeps\n });\n }\n );\n}\n\nfunction getPlugins(context, next) {\n const environmentPlugins = _.reduce(\n _.get(context, 'opts.scriptData.config.environments', {}),\n function getEnvironmentPlugins(acc, envSpec, _envName) {\n acc = acc.concat(Object.keys(envSpec.plugins || []));\n return acc;\n },\n []\n );\n const pluginNames = Object.keys(\n _.get(context, 'opts.scriptData.config.plugins', {})\n ).concat(environmentPlugins);\n\n const pluginPackages = _.uniq(\n pluginNames\n .filter((p) => BUILTIN_PLUGINS.indexOf(p) === -1)\n .map((p) => `artillery-plugin-${p}`)\n );\n\n debug(pluginPackages);\n context.npmModules = context.npmModules.concat(pluginPackages);\n\n return next(null, context);\n}\n\nfunction getCustomEngines(context, next) {\n // TODO: Environment-specific engines (see getPlugins())\n const engineNames = _.uniq(\n Object.keys(_.get(context, 'opts.scriptData.config.engines', {}))\n );\n const enginePackages = engineNames.map((x) => `artillery-engine-${x}`);\n context.npmModules = context.npmModules.concat(enginePackages);\n\n return next(null, context);\n}\n\nfunction getVariableDataFiles(context, next) {\n // NOTE: Presuming that the script has been run through the functions\n // that normalize the config.payload definition (presume it's an array).\n // Also assuming that context.opts.scriptData contains both the config and\n // the scenarios section.\n\n // Iterate over environments\n\n function resolvePayloadPaths(obj) {\n const result = [];\n if (obj.payload) {\n if (_.isArray(obj.payload)) {\n obj.payload.forEach((payloadSpec) => {\n result.push(\n path.resolve(\n path.dirname(context.opts.absoluteScriptPath),\n payloadSpec.path\n )\n );\n });\n } else if (_.isObject(obj.payload)) {\n // NOTE: isObject returns true for arrays, so this branch must\n // come second.\n result.push(\n path.resolve(\n path.dirname(context.opts.absoluteScriptPath),\n obj.payload.path\n )\n );\n }\n }\n return result;\n }\n\n context.localFilePaths = context.localFilePaths.concat(\n resolvePayloadPaths(context.opts.scriptData.config)\n );\n context.opts.scriptData.config.environments =\n context.opts.scriptData.config.environments || {};\n Object.keys(context.opts.scriptData.config.environments).forEach(\n (envName) => {\n const envSpec = context.opts.scriptData.config.environments[envName];\n context.localFilePaths = context.localFilePaths.concat(\n resolvePayloadPaths(envSpec)\n );\n }\n );\n return next(null, context);\n}\n\nfunction getExtraFiles(context, next) {\n if (\n context.opts.scriptData.config?.includeFiles\n ) {\n const absPaths = _.map(context.opts.scriptData.config.includeFiles, (p) => {\n const includePath = path.resolve(\n path.dirname(context.opts.absoluteScriptPath),\n p\n );\n debug('includeFile:', includePath);\n return includePath;\n });\n context.localFilePaths = context.localFilePaths.concat(absPaths);\n return next(null, context);\n } else {\n return next(null, context);\n }\n}\n\nfunction commonPrefix(paths, separator) {\n if (\n !paths ||\n paths.length === 0 ||\n paths.filter((s) => typeof s !== 'string').length > 0\n ) {\n return '';\n }\n\n if (paths.includes('/')) {\n return '/';\n }\n\n const sep = separator ? separator : path.sep;\n\n const splitPaths = paths.map((p) => p.split(sep));\n const shortestPath = splitPaths.reduce((a, b) => {\n return a.length < b.length ? a : b;\n }, splitPaths[0]);\n\n let furthestIndex = shortestPath.length;\n\n for (const p of splitPaths) {\n for (let i = 0; i < furthestIndex; i++) {\n if (p[i] !== shortestPath[i]) {\n furthestIndex = i;\n break;\n }\n }\n }\n\n const joined = shortestPath.slice(0, furthestIndex).join(sep);\n\n if (joined.length > 0) {\n // Check if joined path already ends with separator which\n // will happen when input is a root drive on Windows, e.g. \"C:\\\"\n return joined.endsWith(sep) ? joined : joined + sep;\n } else {\n return '';\n }\n}\n\nfunction prettyPrint(manifest) {\n const t = new Table({ head: ['Name', 'Type', 'Notes'] });\n for (const f of manifest.files) {\n t.push([f.noPrefix, 'file']);\n }\n for (const m of manifest.modules) {\n t.push([\n m,\n 'package',\n manifest.pkgDeps.indexOf(m) === -1 ? 'not in package.json' : ''\n ]);\n }\n artillery.log(t.toString());\n artillery.log();\n}\n\nmodule.exports = { createBOM, commonPrefix, prettyPrint };\n" }, { "path": "packages/artillery/lib/dispatcher.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\n\n\nconst core = require('@artilleryio/int-core');\n\nmodule.exports = core;\n" }, { "path": "packages/artillery/lib/dist.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\n\n\nconst assert = require('node:assert');\nconst L = require('lodash');\nconst isIdlePhase = require('@artilleryio/int-core').isIdlePhase;\n\nmodule.exports = divideWork;\n\n/**\n *\n * Create a number of scripts for workers from the script given to use by user.\n *\n * @param {Script} script\n * @param {number} numWorkers\n * @returns {Script[]} array of scripts distributed representing the work for each worker\n *\n * @todo: Distribute payload data to workers\n */\nfunction divideWork(script, numWorkers) {\n const workerScripts = createWorkerScriptBases(numWorkers, script);\n for (const phase of script.config.phases) {\n // switching on phase type to determine how to distribute work\n switch (true) {\n case !!phase.rampTo: {\n handleRampToPhase(phase, numWorkers, workerScripts);\n break;\n }\n case !!phase.arrivalRate: {\n handleArrivalRatePhase(phase, numWorkers, workerScripts);\n break;\n }\n case !!phase.arrivalCount: {\n // arrivalCount is executed in the first worker\n // and replaced with a `pause` phase in the others\n handleArrivalCountPhase(workerScripts, phase, numWorkers);\n break;\n }\n case !!phase.pause: {\n // nothing to adjust here, pause is executed in all workers\n for (let i = 0; i < numWorkers; i++) {\n workerScripts[i].config.phases.push(L.cloneDeep(phase));\n }\n break;\n }\n default: {\n console.log(\n 'Unknown phase spec definition, skipping.\\n%j\\n' +\n 'This should not happen',\n phase\n );\n }\n }\n }\n\n // Filter out scripts which have only idle phases\n const result = workerScripts.filter(\n (workerScript) => !workerScript.config.phases.every(isIdlePhase)\n );\n\n // Add worker and totalWorkers properties to phases\n const hasPayload = scriptHasPayload(script);\n for (let i = 0; i < result.length; i++) {\n for (const phase of result[i].config.phases) {\n phase.totalWorkers = result.length;\n phase.worker = i + 1;\n }\n\n // Distribute payload data to workers\n if (hasPayload) {\n for (\n let payloadIdx = 0;\n payloadIdx < script.config.payload.length;\n payloadIdx++\n ) {\n // If there are more workers than payload data, then we will repeat the payload data\n const scriptPayloadData = script.config.payload[payloadIdx].data;\n const idxToMatch = i % scriptPayloadData.length;\n result[i].config.payload[payloadIdx].data = scriptPayloadData.filter(\n (_, index) => index % result.length === idxToMatch\n );\n }\n }\n }\n\n return result;\n}\n\nfunction scriptHasPayload(script) {\n return script.config.payload && script.config.payload.length > 0;\n}\n\nfunction handleArrivalCountPhase(workerScripts, phase, numWorkers) {\n workerScripts[0].config.phases.push(L.cloneDeep(phase));\n\n for (let i = 1; i < numWorkers; i++) {\n workerScripts[i].config.phases.push({\n name: phase.name,\n pause: phase.duration\n });\n }\n}\n\nfunction handleArrivalRatePhase(phase, numWorkers, workerScripts) {\n const rates = distribute(phase.arrivalRate, numWorkers);\n const activeWorkers = rates.reduce(\n (acc, rate) => acc + (rate > 0 ? 1 : 0),\n 0\n );\n const maxVusers = phase.maxVusers\n ? distribute(phase.maxVusers, activeWorkers)\n : false;\n for (let i = 0; i < numWorkers; i++) {\n const newPhase = L.cloneDeep(phase);\n newPhase.arrivalRate = rates[i];\n if (maxVusers) {\n newPhase.maxVusers = maxVusers[i];\n }\n workerScripts[i].config.phases.push(newPhase);\n }\n}\n\nfunction handleRampToPhase(phase, numWorkers, workerScripts) {\n phase.arrivalRate = phase.arrivalRate || 0;\n\n const rate = phase.arrivalRate / numWorkers;\n const ramp = phase.rampTo / numWorkers;\n const activeWorkers = rate > 0 || ramp > 0 ? numWorkers : 0;\n const maxVusers = phase.maxVusers\n ? distribute(phase.maxVusers, activeWorkers)\n : false;\n\n for (let i = 0; i < numWorkers; i++) {\n const newPhase = L.cloneDeep(phase);\n newPhase.arrivalRate = rate;\n newPhase.rampTo = ramp;\n if (maxVusers) {\n newPhase.maxVusers = maxVusers[i];\n }\n workerScripts[i].config.phases.push(newPhase);\n }\n}\n\nfunction createWorkerScriptBases(numWorkers, script) {\n const bases = [];\n for (let i = 0; i < numWorkers; i++) {\n const newScript = L.cloneDeep({\n ...script,\n config: {\n ...script.config,\n phases: [],\n ...(scriptHasPayload(script) && {\n payload: script.config.payload.map((payload) => {\n return {\n ...payload,\n data: []\n };\n })\n })\n }\n });\n // 'before' and 'after' hooks are executed in the main thread\n delete newScript.before;\n delete newScript.after;\n\n bases.push(newScript);\n }\n return bases;\n}\n\nfunction distribute(m, n) {\n m = Number(m);\n n = Number(n);\n\n const result = [];\n\n if (m < n) {\n for (let i = 0; i < n; i++) {\n result.push(i < m ? 1 : 0);\n }\n } else {\n const baseCount = Math.floor(m / n);\n let extraItems = m % n;\n for (let i = 0; i < n; i++) {\n result.push(baseCount);\n if (extraItems > 0) {\n result[i]++;\n extraItems--;\n }\n }\n }\n assert(m === sum(result), `${m} === ${sum(result)}`);\n return result;\n}\n\nfunction sum(a) {\n let result = 0;\n for (let i = 0; i < a.length; i++) {\n result += a[i];\n }\n return result;\n}\n\nif (require.main === module) {\n console.log(distribute(1, 4));\n console.log(distribute(1, 10));\n console.log(distribute(4, 4));\n console.log(distribute(87, 4));\n console.log(distribute(50, 8));\n console.log(distribute(39, 20));\n console.log(distribute(20, 4));\n console.log(distribute(19, 4));\n console.log(distribute(20, 3));\n console.log(distribute(61, 4));\n console.log(distribute(121, 4));\n console.log(distribute(32, 3));\n console.log(distribute(700, 31));\n console.log(distribute(700, 29));\n}\n" }, { "path": "packages/artillery/lib/index.js", "content": "const { getStash } = require('./stash');\n\nmodule.exports = {\n getStash\n};\n" }, { "path": "packages/artillery/lib/launch-platform.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst { SSMS } = require('@artilleryio/int-core').ssms;\nconst { loadPlugins, loadPluginsConfig } = require('./load-plugins');\n\nconst EventEmitter = require('eventemitter3');\nconst debug = require('debug')('core');\n\nconst p = require('node:util').promisify;\nconst _ = require('lodash');\n\nconst PlatformLocal = require('./platform/local');\nconst PlatformLambda = require('./platform/aws-lambda');\nconst PlatformAzureACI = require('./platform/az/aci');\n\nasync function createLauncher(script, payload, opts, launcherOpts) {\n launcherOpts = launcherOpts || {\n platform: 'local',\n mode: 'distribute'\n };\n let l;\n try {\n l = new Launcher(script, payload, opts, launcherOpts);\n } catch (err) {\n console.log(err);\n return null;\n }\n\n return l;\n}\nclass Launcher {\n constructor(script, payload, opts, launcherOpts) {\n this.script = script;\n this.payload = payload;\n this.opts = opts;\n\n this.exitedWorkersCount = 0;\n this.workerMessageBuffer = [];\n\n this.metricsByPeriod = {}; // individual intermediates by worker\n this.finalReportsByWorker = {};\n\n this.events = new EventEmitter();\n\n this.pluginEvents = new EventEmitter();\n this.pluginEventsLegacy = new EventEmitter();\n\n this.launcherOpts = launcherOpts;\n\n this.periodsReportedFor = [];\n\n if (launcherOpts.platform === 'local') {\n this.platform = new PlatformLocal(script, payload, opts, launcherOpts);\n } else if (launcherOpts.platform === 'aws:lambda') {\n this.platform = new PlatformLambda(script, payload, opts, launcherOpts);\n } else if (launcherOpts.platform === 'az:aci') {\n this.platform = new PlatformAzureACI(script, payload, opts, launcherOpts);\n } else {\n throw new Error(`Unknown platform: ${launcherOpts.platform}`);\n }\n\n this.phaseStartedEventsSeen = {};\n this.phaseCompletedEventsSeen = {};\n\n this.eventsByWorker = {};\n }\n\n async initWorkerEvents(workerEvents) {\n workerEvents.on('workerError', (_workerId, message) => {\n const { id, error, level, aggregatable, logs } = message;\n\n if (level !== 'warn') {\n this.exitedWorkersCount++;\n }\n\n if (aggregatable) {\n this.workerMessageBuffer.push(message);\n } else {\n global.artillery.log(`[${id}]: ${error.message}`);\n if (logs) {\n global.artillery.log(logs);\n }\n }\n\n this.events.emit('workerError', message);\n });\n\n workerEvents.on('phaseStarted', (_workerId, message) => {\n // Note - we send only the first event for a phase, not all of them\n if (\n typeof this.phaseStartedEventsSeen[message.phase.index] === 'undefined'\n ) {\n this.phaseStartedEventsSeen[message.phase.index] = Date.now();\n const fullPhase = {\n //get back original phase without any splitting for workers\n ...this.script.config.phases[message.phase.index],\n index: message.phase.index,\n id: message.phase.id,\n startTime: this.phaseStartedEventsSeen[message.phase.index]\n };\n\n this.events.emit('phaseStarted', fullPhase);\n this.pluginEvents.emit('phaseStarted', fullPhase);\n this.pluginEventsLegacy.emit('phaseStarted', fullPhase);\n\n global.artillery.globalEvents.emit('phaseStarted', fullPhase);\n }\n });\n\n workerEvents.on('phaseCompleted', (_workerId, message) => {\n if (\n typeof this.phaseCompletedEventsSeen[message.phase.index] ===\n 'undefined'\n ) {\n this.phaseCompletedEventsSeen[message.phase.index] = Date.now();\n const fullPhase = {\n //get back original phase without any splitting for workers\n ...this.script.config.phases[message.phase.index],\n id: message.phase.id,\n index: message.phase.index,\n startTime: this.phaseStartedEventsSeen[message.phase.index],\n endTime: message.phase.endTime\n };\n\n this.events.emit('phaseCompleted', fullPhase);\n this.pluginEvents.emit('phaseCompleted', fullPhase);\n this.pluginEventsLegacy.emit('phaseCompleted', fullPhase);\n global.artillery.globalEvents.emit('phaseCompleted', fullPhase);\n }\n });\n\n // We are not going to receive stats events from workers\n // which have zero arrivals for a phase. (This can only happen\n // in \"distribute\" mode.)\n workerEvents.on('stats', (_workerId, message) => {\n const workerStats = SSMS.deserializeMetrics(message.stats);\n const period = workerStats.period;\n if (typeof this.metricsByPeriod[period] === 'undefined') {\n this.metricsByPeriod[period] = [];\n }\n // TODO: might want the full message here, with worker ID etc\n this.metricsByPeriod[period].push(workerStats);\n });\n\n workerEvents.on('done', async (workerId, message) => {\n this.exitedWorkersCount++;\n this.finalReportsByWorker[workerId] = SSMS.deserializeMetrics(\n message.report\n );\n });\n\n workerEvents.on('log', async (_workerId, message) => {\n artillery.globalEvents.emit('log', ...message.args);\n });\n\n workerEvents.on('setSuggestedExitCode', (_workerId, message) => {\n artillery.suggestedExitCode = message.code;\n });\n }\n\n async initPlugins() {\n const plugins = await loadPlugins(\n this.script.config.plugins,\n this.script,\n this.opts\n );\n\n //\n // init plugins\n //\n for (const [name, result] of Object.entries(plugins)) {\n if (result.isLoaded) {\n if (result.version === 3) {\n // TODO: load the plugin, subscribe to events\n // global.artillery.plugins[name] = result.plugin;\n } else {\n // global.artillery.log(`WARNING: Legacy plugin detected: ${name}\n // See https://artillery.io/docs/resources/core/v2.html for more details.`,\n // 'warn');\n\n // NOTE:\n // We are giving v1 and v2 plugins a throw-away script\n // object because we only care about the plugin setting\n // up event handlers here. The plugins will be loaded\n // properly in individual workers where they will have the\n // opportunity to attach custom code, modify the script\n // object etc.\n // If we let a plugin access to the actual script object,\n // and it happens to attach code to it (with a custom\n // processor function for example) - spawning a worker\n // will fail.\n const dummyScript = JSON.parse(JSON.stringify(this.script));\n dummyScript.config = {\n ...dummyScript.config,\n // Load additional plugins configuration from the environment\n plugins: loadPluginsConfig(this.script.config.plugins)\n };\n\n if (result.version === 1) {\n result.plugin = new result.PluginExport(\n dummyScript.config,\n this.pluginEventsLegacy\n );\n global.artillery.plugins.push(result);\n } else if (result.version === 2) {\n if (result.PluginExport.LEGACY_METRICS_FORMAT === false) {\n result.plugin = new result.PluginExport.Plugin(\n dummyScript,\n this.pluginEvents,\n this.opts\n );\n } else {\n result.plugin = new result.PluginExport.Plugin(\n dummyScript,\n this.pluginEventsLegacy,\n this.opts\n );\n }\n global.artillery.plugins.push(result);\n } else {\n // TODO: print warning\n }\n }\n } else {\n global.artillery.log(`WARNING: Could not load plugin: ${name}`, 'warn');\n global.artillery.log(result.msg, 'warn');\n // global.artillery.log(result.error, 'warn');\n }\n }\n }\n\n async handleAllWorkersFinished() {\n const allWorkersDone =\n this.exitedWorkersCount === this.platform.getDesiredWorkerCount();\n if (allWorkersDone) {\n clearInterval(this.i1);\n clearInterval(this.i2);\n\n // Flush messages from workers\n await this.flushWorkerMessages(0);\n await this.flushIntermediateMetrics(true);\n\n const pds = Object.keys(this.finalReportsByWorker).map(\n (k) => this.finalReportsByWorker[k]\n );\n\n const statsByPeriod = Object.values(SSMS.mergeBuckets(pds));\n const stats = SSMS.pack(statsByPeriod);\n\n stats.summaries = {};\n for (const [name, value] of Object.entries(stats.histograms || {})) {\n const summary = SSMS.summarizeHistogram(value);\n stats.summaries[name] = summary;\n }\n\n clearInterval(this.workerExitWatcher);\n\n // Relay event to workers\n this.pluginEvents.emit('done', stats);\n\n global.artillery.globalEvents.emit('done', stats);\n this.pluginEventsLegacy.emit('done', SSMS.legacyReport(stats));\n\n this.events.emit('done', stats);\n }\n }\n\n async flushWorkerMessages(maxAge = 9000) {\n // Collect messages older than maxAge msec and group by log message:\n const now = Date.now();\n const okToPrint = this.workerMessageBuffer.filter(\n (m) => now - m.ts > maxAge\n );\n this.workerMessageBuffer = this.workerMessageBuffer.filter(\n (m) => now - m.ts <= maxAge\n );\n\n const readyMessages = okToPrint.reduce((acc, message) => {\n const { error } = message;\n // TODO: Take event type and level into account\n if (typeof acc[error.message] === 'undefined') {\n acc[error.message] = [];\n }\n acc[error.message].push(message);\n return acc;\n }, {});\n\n for (const [_logMessage, messageObjects] of Object.entries(readyMessages)) {\n if (messageObjects[0].error) {\n global.artillery.log(\n `[${messageObjects[0].id}] ${messageObjects[0].error.message}`,\n messageObjects[0].level\n );\n } else {\n // Expect a msg property:\n global.artillery.log(\n `[${messageObjects[0].id}] ${messageObjects[0].msg}`,\n messageObjects[0].level\n );\n }\n }\n }\n\n async flushIntermediateMetrics(flushAll = false) {\n if (Object.keys(this.metricsByPeriod).length === 0) {\n debug('No metrics received yet');\n return;\n }\n\n // We always look at the earliest period available so that reports come in chronological order\n const unreportedPeriods = Object.keys(this.metricsByPeriod)\n .filter((x) => this.periodsReportedFor.indexOf(x) === -1)\n .sort();\n\n const earliestPeriodAvailable = unreportedPeriods[0];\n\n // TODO: better name. One above is earliestNotAlreadyReported\n const earliest = Object.keys(this.metricsByPeriod).sort()[0];\n if (this.periodsReportedFor.indexOf(earliest) > -1) {\n global.artillery.log(\n 'Warning: multiple batches of metrics for period',\n earliest,\n new Date(Number(earliest))\n );\n\n delete this.metricsByPeriod[earliest]; // FIXME: need to merge them in for the final report\n }\n\n // Dynamically adjust the duration we're willing to wait for. This matters on SQS where messages are received\n // in batches of 10 and more workers => need to wait longer.\n const MAX_WAIT_FOR_PERIOD_MS =\n (Math.ceil(this.platform.getDesiredWorkerCount() / 10) * 3 + 30) * 1000;\n\n debug({\n now: Date.now(),\n count: this.platform.getDesiredWorkerCount(),\n earliestPeriodAvailable,\n earliest,\n MAX_WAIT_FOR_PERIOD_MS,\n numReports: this.metricsByPeriod[earliestPeriodAvailable]?.length,\n periodsReportedFor: this.periodsReportedFor,\n metricsByPeriod: Object.keys(this.metricsByPeriod)\n });\n\n const allWorkersReportedForPeriod =\n this.metricsByPeriod[earliestPeriodAvailable]?.length ===\n this.platform.getDesiredWorkerCount();\n const waitedLongEnough =\n Date.now() - Number(earliestPeriodAvailable) > MAX_WAIT_FOR_PERIOD_MS;\n\n if (flushAll) {\n for (const period of unreportedPeriods) {\n this.emitIntermediatesForPeriod(period);\n }\n } else if (\n typeof earliestPeriodAvailable !== 'undefined' &&\n (allWorkersReportedForPeriod || waitedLongEnough)\n ) {\n this.emitIntermediatesForPeriod(earliestPeriodAvailable);\n // TODO: autoscaling. Handle workers that drop off or join, and update count\n } else {\n debug('Waiting for more workerStats before emitting stats event');\n }\n }\n\n emitIntermediatesForPeriod(period) {\n debug(\n 'Report @',\n new Date(Number(period)),\n 'made up of items:',\n this.metricsByPeriod[String(period)].length\n );\n\n // TODO: Track how many workers provided metrics in the metrics report\n // summarize histograms for console reporter:\n const merged = SSMS.mergeBuckets(this.metricsByPeriod[String(period)]);\n const stats = merged[String(period)];\n\n stats.summaries = {};\n for (const [name, value] of Object.entries(stats.histograms || {})) {\n const summary = SSMS.summarizeHistogram(value);\n stats.summaries[name] = summary;\n }\n\n delete this.metricsByPeriod[String(period)];\n\n this.periodsReportedFor.push(period);\n this.pluginEvents.emit('stats', stats);\n global.artillery.globalEvents.emit('stats', stats);\n this.pluginEventsLegacy.emit('stats', SSMS.legacyReport(stats));\n\n this.events.emit('stats', stats);\n }\n\n async run() {\n await this.initPlugins();\n\n this.i1 = setInterval(async () => {\n await this.flushWorkerMessages();\n }, 1 * 1000).unref();\n\n this.i2 = setInterval(async () => {\n this.flushIntermediateMetrics();\n }, 2 * 1000).unref();\n\n this.workerExitWatcher = setInterval(async () => {\n await this.handleAllWorkersFinished();\n }, 2 * 1000);\n\n await this.initWorkerEvents(this.platform.events);\n await this.platform.startJob();\n debug('workers running');\n }\n\n async shutdown() {\n await this.platform.shutdown();\n\n // TODO: flush worker messages, and intermediate stats\n\n // Unload plugins\n // TODO: v3 plugins\n if (global.artillery?.plugins) {\n for (const o of global.artillery.plugins) {\n if (o.plugin.cleanup) {\n try {\n await p(o.plugin.cleanup.bind(o.plugin))();\n debug('plugin unloaded:', o.name);\n } catch (cleanupErr) {\n global.artillery.log(cleanupErr, 'error');\n }\n }\n }\n }\n }\n}\n\nmodule.exports = createLauncher;\n" }, { "path": "packages/artillery/lib/load-plugins.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst debug = require('debug')('core');\nconst path = require('node:path');\n\n// Additional paths to load plugins can be set via ARTILLERY_PLUGIN_PATH\n// Additional plugin config mafy be set via ARTILLERY_PLUGINS (as JSON)\n// Version may be: v1, v2, v3 or any\nfunction loadPluginsConfig(pluginSpecs) {\n let additionalPlugins = {};\n\n if (process.env.ARTILLERY_PLUGINS) {\n try {\n additionalPlugins = JSON.parse(process.env.ARTILLERY_PLUGINS);\n } catch (ignoreErr) {\n debug(ignoreErr);\n }\n }\n\n return Object.assign({}, pluginSpecs, additionalPlugins);\n}\n\nasync function loadPlugins(pluginSpecs, testScript) {\n let requirePaths = [''];\n\n // requirePaths = requirePaths.concat(pro.getPluginPath());\n\n if (process.env.ARTILLERY_PLUGIN_PATH) {\n requirePaths = requirePaths.concat(\n process.env.ARTILLERY_PLUGIN_PATH.split(':')\n );\n }\n\n pluginSpecs = loadPluginsConfig(pluginSpecs);\n\n const results = {};\n for (const [name, config] of Object.entries(pluginSpecs)) {\n const result = await loadPlugin(name, config, requirePaths, testScript);\n results[name] = result;\n }\n\n return results;\n}\n\nasync function loadPlugin(name, config, requirePaths, testScript) {\n // TODO: Take scope in directly - don't need the full script\n const pluginConfigScope = config.scope || testScript.config.pluginsScope;\n const pluginPrefix = pluginConfigScope\n ? pluginConfigScope\n : 'artillery-plugin-';\n const requireString = pluginPrefix + name;\n let PluginExport, pluginErr, loadedFrom, version;\n\n for (const p of requirePaths) {\n debug('Looking for plugin in:', p);\n try {\n loadedFrom = path.join(p, requireString);\n PluginExport = require(loadedFrom);\n if (typeof PluginExport === 'function') {\n version = 1;\n } else if (\n typeof PluginExport === 'object' &&\n typeof PluginExport.Plugin === 'function'\n ) {\n version = 2;\n } // TODO: Add v3\n } catch (err) {\n debug(err);\n pluginErr = err;\n }\n\n if (typeof PluginExport !== 'undefined') {\n break;\n }\n }\n\n if (!PluginExport) {\n let msg;\n\n if (!pluginErr) {\n msg = `WARNING: Could not initialize plugin: ${name}`;\n } else {\n if (pluginErr.code === 'MODULE_NOT_FOUND') {\n msg = `WARNING: Plugin ${name} specified but module ${requireString} could not be found (${pluginErr.code})`;\n } else {\n msg = `WARNING: Could not initialize plugin: ${name} (${pluginErr.message})`;\n }\n }\n\n return {\n name,\n isLoaded: false,\n isInitialized: false,\n msg: msg,\n error: pluginErr\n };\n } else {\n debug('Plugin %s loaded from %s', name, requireString);\n return {\n name,\n isLoaded: true,\n isInitialized: false,\n\n PluginExport,\n loadedFrom,\n version\n };\n }\n}\n\nmodule.exports = { loadPlugins, loadPlugin, loadPluginsConfig };\n" }, { "path": "packages/artillery/lib/platform/aws/aws-cloudwatch.js", "content": "const {\n CloudWatchLogsClient,\n PutRetentionPolicyCommand\n} = require('@aws-sdk/client-cloudwatch-logs');\nconst debug = require('debug')('artillery:aws-cloudwatch');\n\nconst allowedRetentionDays = [\n 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827,\n 2192, 2557, 2922, 3288, 3653\n];\n\nasync function _putCloudwatchRetentionPolicy(\n logGroupName,\n retentionInDays,\n region\n) {\n const cloudwatchlogs = new CloudWatchLogsClient({\n apiVersion: '2014-11-06',\n region\n });\n const putRetentionPolicyParams = {\n logGroupName,\n retentionInDays\n };\n\n return cloudwatchlogs.send(\n new PutRetentionPolicyCommand(putRetentionPolicyParams)\n );\n}\n\nfunction setCloudwatchRetention(\n logGroupName,\n retentionInDays,\n region,\n options = { maxRetries: 5, waitPerRetry: 1000 }\n) {\n if (!allowedRetentionDays.includes(retentionInDays)) {\n console.log(\n `WARNING: Skipping setting CloudWatch retention, as invalid value specified: ${retentionInDays}. Allowed values are: ${allowedRetentionDays.join(\n ', '\n )}`\n );\n return;\n }\n\n const interval = setInterval(\n async (opts) => {\n debug(\n `Trying to set CloudWatch Log group ${logGroupName} retention policy to ${retentionInDays} days`\n );\n opts.incr = (opts.incr || 0) + 1;\n\n try {\n const _res = await _putCloudwatchRetentionPolicy(\n logGroupName,\n retentionInDays,\n region\n );\n debug(\n `Successfully set CloudWatch Logs retention policy to ${retentionInDays} days`\n );\n clearInterval(interval);\n } catch (error) {\n const resumeTestMessage =\n 'The test will continue without setting the retention policy.';\n if (error?.code === 'AccessDeniedException') {\n console.log(`\\n${error.message}`);\n console.log(\n '\\nWARNING: Missing logs:PutRetentionPolicy permission to set CloudWatch retention policy. Please ensure the IAM role has the necessary permissions:\\nhttps://docs.art/fargate#iam-permissions'\n );\n console.log(`${resumeTestMessage}\\n`);\n clearInterval(interval);\n return;\n }\n\n if (error?.code !== 'ResourceNotFoundException') {\n console.log(`\\n${error.message}`);\n console.log(\n '\\nWARNING: Unexpected error setting CloudWatch retention policy\\n'\n );\n console.log(`${resumeTestMessage}\\n`);\n clearInterval(interval);\n return;\n }\n\n if (opts.incr >= opts.maxRetries) {\n console.log(`\\n${error.message}`);\n console.log(\n `\\nWARNING: Cannot find log group ${logGroupName}\\nMax retries exceeded setting CloudWatch retention policy:`\n );\n console.log(`${resumeTestMessage}\\n`);\n clearInterval(interval);\n return;\n }\n }\n },\n options.waitPerRetry,\n options\n );\n\n return interval;\n}\n\nmodule.exports = {\n setCloudwatchRetention\n};\n" }, { "path": "packages/artillery/lib/platform/aws/aws-create-sqs-queue.js", "content": "const {\n SQSClient,\n CreateQueueCommand,\n ListQueuesCommand\n} = require('@aws-sdk/client-sqs');\nconst debug = require('debug')('artillery:aws-create-sqs-queue');\nconst sleep = require('../../util/sleep');\n\n// TODO: Add timestamp to SQS queue name for automatic GC\nasync function createSQSQueue(region, queueName) {\n const sqs = new SQSClient({\n region\n });\n\n const params = {\n QueueName: queueName,\n Attributes: {\n FifoQueue: 'true',\n ContentBasedDeduplication: 'false',\n MessageRetentionPeriod: '1800',\n VisibilityTimeout: '600'\n }\n };\n\n const result = await sqs.send(new CreateQueueCommand(params));\n const sqsQueueUrl = result.QueueUrl;\n\n // Wait for the queue to be available:\n let waited = 0;\n let ok = false;\n while (waited < 120 * 1000) {\n try {\n const results = await sqs.send(\n new ListQueuesCommand({ QueueNamePrefix: queueName })\n );\n if (results.QueueUrls && results.QueueUrls.length === 1) {\n debug('SQS queue created:', queueName);\n ok = true;\n break;\n } else {\n await sleep(10 * 1000);\n waited += 10 * 1000;\n }\n } catch (_err) {\n await sleep(10 * 1000);\n waited += 10 * 1000;\n }\n }\n\n if (!ok) {\n debug('Time out waiting for SQS queue:', queueName);\n throw new Error('SQS queue could not be created');\n }\n\n return sqsQueueUrl;\n}\n\nmodule.exports = createSQSQueue;\n" }, { "path": "packages/artillery/lib/platform/aws/aws-ensure-s3-bucket-exists.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst debug = require('debug')('util:aws:ensureS3BucketExists');\n\nconst {\n S3Client,\n PutBucketLifecycleConfigurationCommand,\n CreateBucketCommand,\n NoSuchBucket\n} = require('@aws-sdk/client-s3');\n\nconst getAWSAccountId = require('./aws-get-account-id');\nconst createS3Client = require('../aws-ecs/legacy/create-s3-client');\nconst { S3_BUCKET_NAME_PREFIX } = require('./constants');\nconst { getBucketRegion } = require('./aws-get-bucket-region');\n\nconst setBucketLifecyclePolicy = async (\n bucketName,\n lifecycleConfigurationRules,\n region\n) => {\n const s3 = createS3Client({ region });\n const params = {\n Bucket: bucketName,\n LifecycleConfiguration: {\n Rules: lifecycleConfigurationRules\n }\n };\n try {\n await s3.send(new PutBucketLifecycleConfigurationCommand(params));\n } catch (err) {\n debug('Error setting lifecycle policy');\n debug(err);\n }\n};\n\n// Create an S3 bucket in the given region if it doesn't already exist.\n// By default, the bucket will be created without specifying a specific region.\n// Sometimes we need to use region-specific buckets, e.g. when\n// creating Lambda functions from a zip file in S3 the region of the\n// Lambda and the region of the S3 bucket must match.\nmodule.exports = async function ensureS3BucketExists(\n region,\n lifecycleConfigurationRules = [],\n withRegionSpecificName = false\n) {\n const accountId = await getAWSAccountId();\n let bucketName = `${S3_BUCKET_NAME_PREFIX}-${accountId}`;\n if (withRegionSpecificName) {\n bucketName = `${S3_BUCKET_NAME_PREFIX}-${accountId}-${region}`;\n }\n\n const s3 = new S3Client({ region });\n\n let location;\n try {\n location = await getBucketRegion(bucketName);\n } catch (err) {\n if (err instanceof NoSuchBucket) {\n await s3.send(new CreateBucketCommand({ Bucket: bucketName }));\n } else {\n throw err;\n }\n }\n\n if (lifecycleConfigurationRules.length > 0) {\n await setBucketLifecyclePolicy(\n bucketName,\n lifecycleConfigurationRules,\n location\n );\n }\n\n debug(bucketName);\n return bucketName;\n};\n" }, { "path": "packages/artillery/lib/platform/aws/aws-get-account-id.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst debug = require('debug')('util:aws:getAccountId');\nconst { STSClient, GetCallerIdentityCommand } = require('@aws-sdk/client-sts');\n\nmodule.exports = async function getAccountId(stsOpts = {}) {\n if (!stsOpts.region) {\n stsOpts.region = global.artillery.awsRegion || 'us-east-1';\n }\n\n if (process.env.ARTILLERY_STS_OPTS) {\n stsOpts = Object.assign(\n stsOpts,\n JSON.parse(process.env.ARTILLERY_STS_OPTS)\n );\n }\n\n const sts = new STSClient(stsOpts);\n const result = await sts.send(new GetCallerIdentityCommand({}));\n const awsAccountId = result.Account;\n\n debug(awsAccountId);\n return awsAccountId;\n};\n" }, { "path": "packages/artillery/lib/platform/aws/aws-get-bucket-region.js", "content": "const { S3Client, GetBucketLocationCommand } = require('@aws-sdk/client-s3');\n\nasync function getBucketRegion(bucketName) {\n const c = new S3Client({ region: global.artillery.awsRegion || 'us-east-1' });\n const command = new GetBucketLocationCommand({\n Bucket: bucketName\n });\n\n const response = await c.send(command);\n\n // Buckets is us-east-1 have a LocationConstraint of null\n const location = response.LocationConstraint || 'us-east-1';\n return location;\n}\n\nmodule.exports = {\n getBucketRegion\n};\n" }, { "path": "packages/artillery/lib/platform/aws/aws-get-credentials.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst debug = require('debug')('util:aws:getSSOCredentials');\nconst { fromSSO } = require('@aws-sdk/credential-providers');\n\nmodule.exports = getSSOCredentials;\n\n// If SSO is in use and we can acquire fresh credentials, return [true, credentials object]\n// If SSO is in use, but the session is stale, we return [true, {}]\n// If SSO is not in use we return [false, null]\n\nasync function getSSOCredentials() {\n debug('Trying AWS SSO');\n try {\n const credentials = await fromSSO()();\n return [true, credentials];\n } catch (err) {\n debug(err);\n\n if (/SSO.+expired/.test(err.message)) {\n return [true, null];\n } else {\n return [false, null];\n }\n }\n}\n" }, { "path": "packages/artillery/lib/platform/aws/aws-get-default-region.js", "content": "const { loadConfig } = require('@smithy/node-config-provider');\nconst {\n NODE_REGION_CONFIG_FILE_OPTIONS,\n NODE_REGION_CONFIG_OPTIONS\n} = require('@smithy/config-resolver');\nconst debug = require('debug')('util:aws:get-default-region');\n\nlet defaultRegionAlreadyChecked = false;\nlet currentDefaultRegion = null;\n\nmodule.exports = async function getDefaultRegion() {\n if (!defaultRegionAlreadyChecked) {\n try {\n currentDefaultRegion = await loadConfig(\n NODE_REGION_CONFIG_OPTIONS,\n NODE_REGION_CONFIG_FILE_OPTIONS\n )();\n } catch (err) {\n debug('default region check:', err);\n } finally {\n defaultRegionAlreadyChecked = true;\n }\n }\n\n return currentDefaultRegion;\n};\n" }, { "path": "packages/artillery/lib/platform/aws/aws-whoami.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst { STSClient, GetCallerIdentityCommand } = require('@aws-sdk/client-sts');\n\nmodule.exports = async function whoami() {\n const sts = new STSClient();\n try {\n const response = await sts.send(new GetCallerIdentityCommand({}));\n return response;\n } catch (stsErr) {\n return stsErr;\n }\n};\n" }, { "path": "packages/artillery/lib/platform/aws/constants.js", "content": "module.exports = {\n SQS_QUEUES_NAME_PREFIX: 'artilleryio_test_metrics',\n S3_BUCKET_NAME_PREFIX: 'artilleryio-test-data',\n ECS_WORKER_ROLE_NAME: 'artilleryio-ecs-worker-role',\n\n ARTILLERY_CLUSTER_NAME: 'artilleryio-cluster'\n};\n" }, { "path": "packages/artillery/lib/platform/aws/iam-cf-templates/aws-iam-fargate-cf-template.yml", "content": "AWSTemplateFormatVersion: \"2010-09-09\"\nDescription: \"Template to create an IAM Role with an attached policy that provides all necessary permissions for Artillery.io to run distributed tests on AWS Fargate.\n By default the IAM role is configured to trust your AWS account, meaning it will allow any IAM User, Role or service from your account to assume it. You can restrict the role to allow only by a specific IAM user or role to assume it by filling out the appropriate parameter value below.\"\n\nMetadata:\n AWS::CloudFormation::Interface:\n ParameterGroups:\n - Label:\n default: \"Restrict to specific IAM User (optional)\"\n Parameters:\n - User\n - Label:\n default: \"Restrict to specific IAM Role (optional)\"\n Parameters:\n - Role\n ParameterLabels:\n User:\n default: \"IAM user name or ARN\"\n Role:\n default: \"IAM role name or ARN\"\n\nParameters:\n\n User:\n Type: String\n Default: \"\"\n Description: Use when you want to allow the created role to be assumed only by a specific IAM user (by default any user, role or service from your account will be allowed to assume it). Provide the user name or ARN.\n\n Role:\n Type: String\n Default: \"\"\n Description: Use when you want to allow the created role to be assumed only by a specific IAM role (by default any user, role or service from your account will be allowed to assume it). Provide the role name or ARN.\n\nConditions:\n ShouldTrustAccount:\n !And \n - !Equals [!Ref User, \"\"]\n - !Equals [!Ref Role, \"\"]\n ShouldTrustUser:\n !Not [!Equals [!Ref User, \"\"]]\n IsUserArn:\n !Equals [!Select [0, !Split [\":\", !Ref User]], \"arn\"]\n ShouldTrustRole:\n !Not [!Equals [!Ref Role, \"\"]]\n IsRoleArn:\n !Equals [!Select [0, !Split [\":\", !Ref Role]], \"arn\"]\n\n\nResources:\n ArtilleryDistributedTestingFargateRole:\n Type: \"AWS::IAM::Role\"\n Properties:\n RoleName: \"ArtilleryDistributedTestingFargateRole\"\n AssumeRolePolicyDocument:\n Version: \"2012-10-17\"\n Statement:\n - Effect: \"Allow\"\n Principal:\n AWS: [\n !If [ShouldTrustAccount, !Ref \"AWS::AccountId\", !Ref \"AWS::NoValue\"],\n !If [ShouldTrustUser, !If [IsUserArn, !Ref User, !Sub \"arn:aws:iam::${AWS::AccountId}:user/${User}\"], !Ref \"AWS::NoValue\"],\n !If [ShouldTrustRole, !If [IsRoleArn, !Ref Role, !Sub \"arn:aws:iam::${AWS::AccountId}:role/${Role}\"], !Ref \"AWS::NoValue\"]\n ]\n Action: [\n \"sts:AssumeRole\"\n ]\n \n Path: \"/\"\n Policies:\n - PolicyName: \"ArtilleryDistributedTestingFargatePolicy\"\n PolicyDocument:\n Version: \"2012-10-17\"\n Statement:\n - Sid: \"CreateOrGetECSRole\"\n Effect: \"Allow\"\n Action:\n - \"iam:CreateRole\"\n - \"iam:GetRole\"\n - \"iam:AttachRolePolicy\"\n - \"iam:PassRole\"\n Resource:\n Fn::Sub: \"arn:aws:iam::${AWS::AccountId}:role/artilleryio-ecs-worker-role\"\n - Sid: \"CreateECSPolicy\"\n Effect: \"Allow\"\n Action:\n - \"iam:CreatePolicy\"\n Resource:\n Fn::Sub: \"arn:aws:iam::${AWS::AccountId}:policy/artilleryio-ecs-worker-policy\"\n - Effect: \"Allow\"\n Action:\n - \"iam:CreateServiceLinkedRole\"\n Resource:\n - \"arn:aws:iam::*:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS*\"\n Condition:\n StringLike:\n iam:AWSServiceName: \"ecs.amazonaws.com\"\n - Effect: \"Allow\"\n Action:\n - \"iam:PassRole\"\n Resource:\n - Fn::Sub: \"arn:aws:iam::${AWS::AccountId}:role/artilleryio-ecs-worker-role\"\n - Sid: \"SQSPermissions\"\n Effect: \"Allow\"\n Action:\n - \"sqs:*\"\n Resource:\n Fn::Sub: \"arn:aws:sqs:*:${AWS::AccountId}:artilleryio*\"\n - Sid: \"SQSListQueues\"\n Effect: \"Allow\"\n Action:\n - \"sqs:ListQueues\"\n Resource: \"*\"\n - Sid: \"ECSPermissionsGeneral\"\n Effect: \"Allow\"\n Action:\n - \"ecs:ListClusters\"\n - \"ecs:CreateCluster\"\n - \"ecs:RegisterTaskDefinition\"\n - \"ecs:DeregisterTaskDefinition\"\n Resource: \"*\"\n - Sid: \"ECSPermissionsScopedToCluster\"\n Effect: \"Allow\"\n Action:\n - \"ecs:DescribeClusters\"\n - \"ecs:ListContainerInstances\"\n Resource:\n Fn::Sub: \"arn:aws:ecs:*:${AWS::AccountId}:cluster/*\"\n - Sid: \"ECSPermissionsScopedWithCondition\"\n Effect: \"Allow\"\n Action:\n - \"ecs:SubmitTaskStateChange\"\n - \"ecs:DescribeTasks\"\n - \"ecs:ListTasks\"\n - \"ecs:ListTaskDefinitions\"\n - \"ecs:DescribeTaskDefinition\"\n - \"ecs:StartTask\"\n - \"ecs:StopTask\"\n - \"ecs:RunTask\"\n Condition:\n ArnEquals:\n ecs:cluster:\n Fn::Sub: \"arn:aws:ecs:*:${AWS::AccountId}:cluster/*\"\n Resource: \"*\"\n - Sid: \"S3Permissions\"\n Effect: \"Allow\"\n Action:\n - \"s3:CreateBucket\"\n - \"s3:DeleteObject\"\n - \"s3:GetObject\"\n - \"s3:GetObjectAcl\"\n - \"s3:GetObjectTagging\"\n - \"s3:GetObjectVersion\"\n - \"s3:PutObject\"\n - \"s3:PutObjectAcl\"\n - \"s3:ListBucket\"\n - \"s3:GetBucketLocation\"\n - \"s3:GetBucketLogging\"\n - \"s3:GetBucketPolicy\"\n - \"s3:GetBucketTagging\"\n - \"s3:PutBucketPolicy\"\n - \"s3:PutBucketTagging\"\n - \"s3:PutMetricsConfiguration\"\n - \"s3:GetLifecycleConfiguration\"\n - \"s3:PutLifecycleConfiguration\"\n Resource:\n - \"arn:aws:s3:::artilleryio-test-data-*\"\n - \"arn:aws:s3:::artilleryio-test-data-*/*\"\n - Sid: \"LogsPermissions\"\n Effect: \"Allow\"\n Action:\n - \"logs:PutRetentionPolicy\"\n Resource:\n - Fn::Sub: \"arn:aws:logs:*:${AWS::AccountId}:log-group:artilleryio-log-group/*\"\n - Effect: \"Allow\"\n Action:\n - \"secretsmanager:GetSecretValue\"\n Resource:\n - Fn::Sub: \"arn:aws:secretsmanager:*:${AWS::AccountId}:secret:artilleryio/*\"\n - Effect: \"Allow\"\n Action:\n - \"ssm:PutParameter\"\n - \"ssm:GetParameter\"\n - \"ssm:GetParameters\"\n - \"ssm:DeleteParameter\"\n - \"ssm:DescribeParameters\"\n - \"ssm:GetParametersByPath\"\n Resource:\n - Fn::Sub: \"arn:aws:ssm:us-east-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:us-east-2:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:us-west-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:us-west-2:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:ca-central-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:eu-west-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:eu-west-2:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:eu-west-3:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:eu-central-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:eu-north-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:ap-south-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:ap-east-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:ap-northeast-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:ap-northeast-2:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:ap-southeast-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:ap-southeast-2:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:me-south-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:sa-east-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Effect: \"Allow\"\n Action:\n - \"ec2:DescribeRouteTables\"\n - \"ec2:DescribeVpcs\"\n - \"ec2:DescribeSubnets\"\n Resource: \"*\"\n\nOutputs:\n RoleArn:\n Description: \"ARN of the created IAM Role\"\n Value:\n Fn::GetAtt:\n - \"ArtilleryDistributedTestingFargateRole\"\n - \"Arn\"\n" }, { "path": "packages/artillery/lib/platform/aws/iam-cf-templates/aws-iam-lambda-cf-template.yml", "content": "AWSTemplateFormatVersion: \"2010-09-09\"\nDescription: Template to create an IAM Role with an attached policy that provides all necessary permissions for Artillery.io to run distributed tests on AWS Lambda. By default the IAM role is configured to trust your AWS account, meaning it will allow any AWS principal (e.g. IAM User, IAM Role) to assume it. You can restrict the role to allow only by a specific IAM user or role to assume it by filling out the appropriate parameter value below.\n\nMetadata:\n AWS::CloudFormation::Interface:\n ParameterGroups:\n - Label:\n default: \"Restrict to specific IAM User (optional)\"\n Parameters:\n - User\n - Label:\n default: \"Restrict to specific IAM Role (optional)\"\n Parameters:\n - Role\n ParameterLabels:\n User:\n default: \"IAM user name or ARN\"\n Role:\n default: \"IAM role name or ARN\"\n\nParameters:\n\n User:\n Type: String\n Default: \"\"\n Description: Use when you want to allow the created role to be assumed only by a specific IAM user (by default any user, role or service from your account will be allowed to assume it). Provide the user name or ARN.\n\n Role:\n Type: String\n Default: \"\"\n Description: Use when you want to allow the created role to be assumed only by a specific IAM role (by default any user, role or service from your account will be allowed to assume it). Provide the role name or ARN.\n\nConditions:\n ShouldTrustAccount:\n !And \n - !Equals [!Ref User, \"\"]\n - !Equals [!Ref Role, \"\"]\n ShouldTrustUser:\n !Not [!Equals [!Ref User, \"\"]]\n IsUserArn:\n !Equals [!Select [0, !Split [\":\", !Ref User]], \"arn\"]\n ShouldTrustRole:\n !Not [!Equals [!Ref Role, \"\"]]\n IsRoleArn:\n !Equals [!Select [0, !Split [\":\", !Ref Role]], \"arn\"]\n\n\n\nResources:\n ArtilleryDistributedTestingLambdaRole:\n Type: \"AWS::IAM::Role\"\n Properties:\n RoleName: \"ArtilleryDistributedTestingLambdaRole\"\n AssumeRolePolicyDocument:\n Version: \"2012-10-17\"\n Statement:\n - Effect: \"Allow\"\n Principal:\n AWS: [\n !If [ShouldTrustAccount, !Ref \"AWS::AccountId\", !Ref \"AWS::NoValue\"],\n !If [ShouldTrustUser, !If [IsUserArn, !Ref User, !Sub \"arn:aws:iam::${AWS::AccountId}:user/${User}\"], !Ref \"AWS::NoValue\"],\n !If [ShouldTrustRole, !If [IsRoleArn, !Ref Role, !Sub \"arn:aws:iam::${AWS::AccountId}:role/${Role}\"], !Ref \"AWS::NoValue\"]\n ]\n Action: [\"sts:AssumeRole\"]\n \n Path: \"/\"\n Policies:\n - PolicyName: ArtilleryDistributedTestingLambdaPolicy\n PolicyDocument:\n Version: \"2012-10-17\"\n Statement:\n - Sid: CreateOrGetLambdaRole\n Effect: Allow\n Action:\n - iam:CreateRole\n - iam:GetRole\n - iam:PassRole\n - iam:AttachRolePolicy\n Resource: !Sub \"arn:aws:iam::${AWS::AccountId}:role/artilleryio-default-lambda-role-*\"\n - Sid: CreateLambdaPolicy\n Effect: Allow\n Action:\n - iam:CreatePolicy\n Resource: !Sub \"arn:aws:iam::${AWS::AccountId}:policy/artilleryio-lambda-policy-*\"\n - Sid: SQSPermissions\n Effect: Allow\n Action:\n - sqs:*\n Resource: !Sub \"arn:aws:sqs:*:${AWS::AccountId}:artilleryio*\"\n - Sid: SQSListQueues\n Effect: Allow\n Action:\n - sqs:ListQueues\n Resource: \"*\"\n - Sid: LambdaPermissions\n Effect: Allow\n Action:\n - lambda:InvokeFunction\n - lambda:CreateFunction\n - lambda:DeleteFunction\n - lambda:GetFunctionConfiguration\n Resource: !Sub \"arn:aws:lambda:*:${AWS::AccountId}:function:artilleryio-*\"\n - Sid: EcrPullImagePermissions\n Effect: Allow\n Action:\n - ecr:GetDownloadUrlForLayer\n - ecr:BatchGetImage\n Resource: \"arn:aws:ecr:*:248481025674:repository/artillery-worker\"\n - Sid: S3Permissions\n Effect: Allow\n Action:\n - s3:CreateBucket\n - s3:DeleteObject\n - s3:GetObject\n - s3:PutObject\n - s3:ListBucket\n - s3:GetLifecycleConfiguration\n - s3:PutLifecycleConfiguration\n Resource:\n - !Sub \"arn:aws:s3:::artilleryio-test-data-*\"\n - !Sub \"arn:aws:s3:::artilleryio-test-data-*/*\"\nOutputs:\n RoleArn:\n Description: ARN of the IAM Role for Artillery.io Lambda functions\n Value: !GetAtt ArtilleryDistributedTestingLambdaRole.Arn\n" }, { "path": "packages/artillery/lib/platform/aws/iam-cf-templates/gh-oidc-fargate.yml", "content": "AWSTemplateFormatVersion: '2010-09-09'\nDescription: Creates an ArtilleryGitHubOIDCForFargateRole IAM role with permissions needed to run Artillery Fargate tests from a specified GitHub repository. An OIDC identity provider for Github will also be created if it is not already present in the account.\nMetadata:\n AWS::CloudFormation::Interface:\n ParameterGroups:\n - Label:\n default: \"GitHub\"\n Parameters:\n - GitHubRepository\n - GitHubBranch\n - Label:\n default: \"AWS IAM\"\n Parameters:\n - GitHubOIDCProviderExists\n\n ParameterLabels:\n GitHubRepository:\n default: \"GitHub repository\"\n GitHubBranch:\n default: \"GitHub branch\"\n GitHubOIDCProviderExists:\n default: \"GitHub OIDC identity provider already created for the account?\"\n\nParameters:\n GitHubRepository:\n Type: String\n Default: \"\"\n Description: The GitHub repository (orgname/reponame) to be allowed to assume the created IAM role using OIDC (e.g. \"artilleryio/artillery\").\n\n GitHubBranch:\n Type: String\n Default: \"*\"\n Description: (Optional) Use when you want to allow only a specific branch within the specified Github repository to assume this IAM role using OIDC (e.g. \"main\"). If not set, defaults to \"*\" (all branches). \n\n GitHubOIDCProviderExists:\n Type: String\n Default: 'No'\n AllowedValues:\n - 'Yes'\n - 'No'\n Description: This will let CloudFormation know whether it needs to create the provider. (If it exists, can be found at Services -> IAM -> Identity providers as 'token.actions.githubusercontent.com').\n\nConditions:\n IsGHRepoSet:\n !Not [!Equals [!Ref GitHubRepository, \"\"]]\n\n CreateOIDCProvider:\n !Equals [!Ref GitHubOIDCProviderExists, \"No\"]\n\nResources:\n GitHubOIDCProvider:\n Type: AWS::IAM::OIDCProvider\n Condition: CreateOIDCProvider\n Properties:\n Url: \"https://token.actions.githubusercontent.com\"\n ClientIdList:\n - \"sts.amazonaws.com\"\n ThumbprintList:\n - \"6938fd4d98bab03faadb97b34396831e3780ee11\"\n\n ArtilleryGitHubOIDCForFargateRole:\n Type: \"AWS::IAM::Role\"\n Properties:\n RoleName: \"ArtilleryGitHubOIDCForFargateRole\"\n AssumeRolePolicyDocument:\n Version: \"2012-10-17\"\n Statement:\n - Effect: \"Allow\"\n Principal:\n Federated: \n Fn::If:\n - CreateOIDCProvider\n - !Ref GitHubOIDCProvider\n - !Sub \"arn:aws:iam::${AWS::AccountId}:oidc-provider/token.actions.githubusercontent.com\"\n Action: \"sts:AssumeRoleWithWebIdentity\"\n Condition: {\n StringEquals:\n {\n \"token.actions.githubusercontent.com:aud\": \"sts.amazonaws.com\"\n },\n StringLike:\n {\n \"token.actions.githubusercontent.com:sub\": !Sub \"repo:${GitHubRepository}:${GitHubBranch}\"\n }\n }\n Path: \"/\"\n Policies:\n - PolicyName: \"ArtilleryGitHubOIDCForFargatePolicy\"\n PolicyDocument:\n Version: \"2012-10-17\"\n Statement:\n - Sid: \"CreateOrGetECSRole\"\n Effect: \"Allow\"\n Action:\n - \"iam:CreateRole\"\n - \"iam:GetRole\"\n - \"iam:AttachRolePolicy\"\n - \"iam:PassRole\"\n Resource:\n Fn::Sub: \"arn:aws:iam::${AWS::AccountId}:role/artilleryio-ecs-worker-role\"\n - Sid: \"CreateECSPolicy\"\n Effect: \"Allow\"\n Action:\n - \"iam:CreatePolicy\"\n Resource:\n Fn::Sub: \"arn:aws:iam::${AWS::AccountId}:policy/artilleryio-ecs-worker-policy\"\n - Effect: \"Allow\"\n Action:\n - \"iam:CreateServiceLinkedRole\"\n Resource:\n - \"arn:aws:iam::*:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS*\"\n Condition:\n StringLike:\n iam:AWSServiceName: \"ecs.amazonaws.com\"\n - Effect: \"Allow\"\n Action:\n - \"iam:PassRole\"\n Resource:\n - Fn::Sub: \"arn:aws:iam::${AWS::AccountId}:role/artilleryio-ecs-worker-role\"\n - Sid: \"SQSPermissions\"\n Effect: \"Allow\"\n Action:\n - \"sqs:*\"\n Resource:\n Fn::Sub: \"arn:aws:sqs:*:${AWS::AccountId}:artilleryio*\"\n - Sid: \"SQSListQueues\"\n Effect: \"Allow\"\n Action:\n - \"sqs:ListQueues\"\n Resource: \"*\"\n - Sid: \"ECSPermissionsGeneral\"\n Effect: \"Allow\"\n Action:\n - \"ecs:ListClusters\"\n - \"ecs:CreateCluster\"\n - \"ecs:RegisterTaskDefinition\"\n - \"ecs:DeregisterTaskDefinition\"\n Resource: \"*\"\n - Sid: \"ECSPermissionsScopedToCluster\"\n Effect: \"Allow\"\n Action:\n - \"ecs:DescribeClusters\"\n - \"ecs:ListContainerInstances\"\n Resource:\n Fn::Sub: \"arn:aws:ecs:*:${AWS::AccountId}:cluster/*\"\n - Sid: \"ECSPermissionsScopedWithCondition\"\n Effect: \"Allow\"\n Action:\n - \"ecs:SubmitTaskStateChange\"\n - \"ecs:DescribeTasks\"\n - \"ecs:ListTasks\"\n - \"ecs:ListTaskDefinitions\"\n - \"ecs:DescribeTaskDefinition\"\n - \"ecs:StartTask\"\n - \"ecs:StopTask\"\n - \"ecs:RunTask\"\n Condition:\n ArnEquals:\n ecs:cluster:\n Fn::Sub: \"arn:aws:ecs:*:${AWS::AccountId}:cluster/*\"\n Resource: \"*\"\n - Sid: \"S3Permissions\"\n Effect: \"Allow\"\n Action:\n - \"s3:CreateBucket\"\n - \"s3:DeleteObject\"\n - \"s3:GetObject\"\n - \"s3:GetObjectAcl\"\n - \"s3:GetObjectTagging\"\n - \"s3:GetObjectVersion\"\n - \"s3:PutObject\"\n - \"s3:PutObjectAcl\"\n - \"s3:ListBucket\"\n - \"s3:GetBucketLocation\"\n - \"s3:GetBucketLogging\"\n - \"s3:GetBucketPolicy\"\n - \"s3:GetBucketTagging\"\n - \"s3:PutBucketPolicy\"\n - \"s3:PutBucketTagging\"\n - \"s3:PutMetricsConfiguration\"\n - \"s3:GetLifecycleConfiguration\"\n - \"s3:PutLifecycleConfiguration\"\n Resource:\n - \"arn:aws:s3:::artilleryio-test-data-*\"\n - \"arn:aws:s3:::artilleryio-test-data-*/*\"\n - Sid: \"LogsPermissions\"\n Effect: \"Allow\"\n Action:\n - \"logs:PutRetentionPolicy\"\n Resource:\n - Fn::Sub: \"arn:aws:logs:*:${AWS::AccountId}:log-group:artilleryio-log-group/*\"\n - Effect: \"Allow\"\n Action:\n - \"secretsmanager:GetSecretValue\"\n Resource:\n - Fn::Sub: \"arn:aws:secretsmanager:*:${AWS::AccountId}:secret:artilleryio/*\"\n - Effect: \"Allow\"\n Action:\n - \"ssm:PutParameter\"\n - \"ssm:GetParameter\"\n - \"ssm:GetParameters\"\n - \"ssm:DeleteParameter\"\n - \"ssm:DescribeParameters\"\n - \"ssm:GetParametersByPath\"\n Resource:\n - Fn::Sub: \"arn:aws:ssm:us-east-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:us-east-2:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:us-west-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:us-west-2:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:ca-central-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:eu-west-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:eu-west-2:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:eu-west-3:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:eu-central-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:eu-north-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:ap-south-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:ap-east-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:ap-northeast-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:ap-northeast-2:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:ap-southeast-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:ap-southeast-2:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:me-south-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Fn::Sub: \"arn:aws:ssm:sa-east-1:${AWS::AccountId}:parameter/artilleryio/*\"\n - Effect: \"Allow\"\n Action:\n - \"ec2:DescribeRouteTables\"\n - \"ec2:DescribeVpcs\"\n - \"ec2:DescribeSubnets\"\n Resource: \"*\"\n\nOutputs:\n RoleArn:\n Description: \"ARN of the created IAM Role\"\n Value:\n Fn::GetAtt:\n - \"ArtilleryGitHubOIDCForFargateRole\"\n - \"Arn\"\n OIDCProviderArn:\n Condition: CreateOIDCProvider\n Description: \"ARN of the newly created OIDC provider\"\n Value: !Ref GitHubOIDCProvider" }, { "path": "packages/artillery/lib/platform/aws/iam-cf-templates/gh-oidc-lambda.yml", "content": "AWSTemplateFormatVersion: '2010-09-09'\nDescription: Creates an ArtilleryGitHubOIDCForLambdaRole IAM role with permissions needed to run Artillery Lambda tests from a specified GitHub repository. An OIDC identity provider for Github will also be created if it is not already present in the account.\n\n\nMetadata:\n AWS::CloudFormation::Interface:\n ParameterGroups:\n - Label:\n default: \"GitHub\"\n Parameters:\n - GitHubRepository\n - GitHubBranch\n - Label:\n default: \"AWS IAM\"\n Parameters:\n - GitHubOIDCProviderExists\n\n ParameterLabels:\n GitHubRepository:\n default: \"GitHub repository\"\n GitHubBranch:\n default: \"GitHub branch\"\n GitHubOIDCProviderExists:\n default: \"GitHub OIDC identity provider already created for the account?\"\n\nParameters:\n GitHubRepository:\n Type: String\n Default: \"\"\n Description: The GitHub repository (orgname/reponame) to be allowed to assume the created IAM role using OIDC (e.g. \"artilleryio/artillery\").\n\n GitHubBranch:\n Type: String\n Default: \"*\"\n Description: (Optional) Use when you want to allow only a specific branch within the specified Github repository to assume this IAM role using OIDC (e.g. \"main\"). If not set, defaults to \"*\" (all branches). \n\n GitHubOIDCProviderExists:\n Type: String\n Default: 'No'\n AllowedValues:\n - 'Yes'\n - 'No'\n Description: This will let CloudFormation know whether it needs to create the provider. (If it exists, can be found at Services -> IAM -> Identity providers as 'token.actions.githubusercontent.com').\n\nConditions:\n IsGHRepoSet:\n !Not [!Equals [!Ref GitHubRepository, \"\"]]\n\n CreateOIDCProvider:\n !Equals [!Ref GitHubOIDCProviderExists, \"No\"]\n\nResources:\n GitHubOIDCProvider:\n Type: AWS::IAM::OIDCProvider\n Condition: CreateOIDCProvider\n Properties:\n Url: \"https://token.actions.githubusercontent.com\"\n ClientIdList:\n - \"sts.amazonaws.com\"\n ThumbprintList:\n - \"6938fd4d98bab03faadb97b34396831e3780ee11\"\n\n\n ArtilleryGitHubOIDCForLambdaRole:\n Type: \"AWS::IAM::Role\"\n Properties:\n RoleName: \"ArtilleryGitHubOIDCForLambdaRole\"\n AssumeRolePolicyDocument:\n Version: \"2012-10-17\"\n Statement:\n - Effect: \"Allow\"\n Principal:\n Federated: \n Fn::If:\n - CreateOIDCProvider\n - !Ref GitHubOIDCProvider\n - !Ref GitHubOIDCProviderArn\n Action: \"sts:AssumeRoleWithWebIdentity\"\n Condition: {\n StringEquals:\n {\n \"token.actions.githubusercontent.com:aud\": \"sts.amazonaws.com\"\n },\n StringLike:\n {\n \"token.actions.githubusercontent.com:sub\": !Sub \"repo:${GitHubRepository}:${GitHubBranch}\"\n }\n }\n Path: \"/\"\n Policies:\n - PolicyName: ArtilleryDistributedTestingLambdaPolicy\n PolicyDocument:\n Version: \"2012-10-17\"\n Statement:\n - Sid: CreateOrGetLambdaRole\n Effect: Allow\n Action:\n - iam:CreateRole\n - iam:GetRole\n - iam:PassRole\n - iam:AttachRolePolicy\n Resource: !Sub \"arn:aws:iam::${AWS::AccountId}:role/artilleryio-default-lambda-role-*\"\n - Sid: CreateLambdaPolicy\n Effect: Allow\n Action:\n - iam:CreatePolicy\n Resource: !Sub \"arn:aws:iam::${AWS::AccountId}:policy/artilleryio-lambda-policy-*\"\n - Sid: SQSPermissions\n Effect: Allow\n Action:\n - sqs:*\n Resource: !Sub \"arn:aws:sqs:*:${AWS::AccountId}:artilleryio*\"\n - Sid: SQSListQueues\n Effect: Allow\n Action:\n - sqs:ListQueues\n Resource: \"*\"\n - Sid: LambdaPermissions\n Effect: Allow\n Action:\n - lambda:InvokeFunction\n - lambda:CreateFunction\n - lambda:DeleteFunction\n - lambda:GetFunctionConfiguration\n Resource: !Sub \"arn:aws:lambda:*:${AWS::AccountId}:function:artilleryio-*\"\n - Sid: EcrPullImagePermissions\n Effect: Allow\n Action:\n - ecr:GetDownloadUrlForLayer\n - ecr:BatchGetImage\n Resource: \"arn:aws:ecr:*:248481025674:repository/artillery-worker\"\n - Sid: S3Permissions\n Effect: Allow\n Action:\n - s3:CreateBucket\n - s3:DeleteObject\n - s3:GetObject\n - s3:PutObject\n - s3:ListBucket\n - s3:GetLifecycleConfiguration\n - s3:PutLifecycleConfiguration\n Resource:\n - !Sub \"arn:aws:s3:::artilleryio-test-data-*\"\n - !Sub \"arn:aws:s3:::artilleryio-test-data-*/*\"\n\nOutputs:\n RoleArn:\n Description: ARN of the IAM Role for Artillery.io Lambda functions\n Value: !GetAtt ArtilleryGitHubOIDCForLambdaRole.Arn\n OIDCProviderArn:\n Condition: CreateOIDCProvider\n Description: \"ARN of the newly created OIDC provider\"\n Value: !Ref GitHubOIDCProvider" }, { "path": "packages/artillery/lib/platform/aws-ecs/ecs.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst debug = require('debug')('platform:aws-ecs');\n\nconst ensureS3BucketExists = require('../aws/aws-ensure-s3-bucket-exists');\n\nconst {\n IAMClient,\n GetRoleCommand,\n CreateRoleCommand,\n CreatePolicyCommand,\n AttachRolePolicyCommand\n} = require('@aws-sdk/client-iam');\n\nconst { ensureParameterExists } = require('./legacy/aws-util');\n\nconst { S3_BUCKET_NAME_PREFIX } = require('../aws/constants');\n\nconst getAccountId = require('../aws/aws-get-account-id');\n\nconst sleep = require('../../util/sleep');\nconst { getBucketRegion } = require('../aws/aws-get-bucket-region');\nconst awsGetDefaultRegion = require('../aws/aws-get-default-region');\n\nclass PlatformECS {\n constructor(_script, _payload, opts, platformOpts) {\n this.opts = opts;\n this.platformOpts = platformOpts;\n\n this.arnPrefx = this.platformOpts.region.startsWith('cn-')\n ? 'arn:aws-cn'\n : 'arn:aws';\n\n this.testRunId = platformOpts.testRunId;\n if (!this.testRunId) {\n throw new Error('testRunId is required');\n }\n\n this.s3LifecycleConfigurationRules = [\n {\n Expiration: { Days: 2 },\n Filter: { Prefix: 'tests/' },\n ID: 'RemoveAdHocTestData',\n Status: 'Enabled'\n },\n {\n Expiration: { Days: 7 },\n Filter: { Prefix: 'test-runs/' },\n ID: 'RemoveTestRunMetadata',\n Status: 'Enabled'\n }\n ];\n }\n\n async init() {\n global.artillery.awsRegion =\n (await awsGetDefaultRegion()) || this.platformOpts.region;\n\n this.accountId = await getAccountId();\n\n await ensureSSMParametersExist(this.platformOpts.region);\n const bucketName = await ensureS3BucketExists(\n this.platformOpts.region,\n this.s3LifecycleConfigurationRules,\n false\n );\n\n global.artillery.s3BucketRegion = await getBucketRegion(bucketName);\n await this.createIAMResources(\n this.accountId,\n this.platformOpts.taskRoleName\n );\n }\n\n async createIAMResources(accountId, taskRoleName) {\n const workerRoleArn = await this.createWorkerRole(accountId, taskRoleName);\n\n return {\n workerRoleArn\n };\n }\n\n async createWorkerRole(accountId, taskRoleName) {\n const iam = new IAMClient({ region: global.artillery.awsRegion });\n\n try {\n const res = await iam.send(\n new GetRoleCommand({ RoleName: taskRoleName })\n );\n return res.Role.Arn;\n } catch (err) {\n debug(err);\n }\n\n const createRoleResp = await iam.send(\n new CreateRoleCommand({\n AssumeRolePolicyDocument: JSON.stringify({\n Version: '2012-10-17',\n Statement: [\n {\n Effect: 'Allow',\n Principal: {\n Service: ['ecs-tasks.amazonaws.com', 'ecs.amazonaws.com']\n },\n Action: 'sts:AssumeRole'\n }\n ]\n }),\n Path: '/',\n RoleName: taskRoleName\n })\n );\n\n const policyDocument = {\n Version: '2012-10-17',\n Statement: [\n {\n Effect: 'Allow',\n Action: ['ssm:DescribeParameters'],\n Resource: ['*']\n },\n {\n Effect: 'Allow',\n Action: [\n 'ssm:GetParameters',\n 'ssm:GetParameter',\n 'ssm:PutParameter',\n 'ssm:DeleteParameter',\n 'ssm:DescribeParameters',\n 'ssm:GetParametersByPath'\n ],\n Resource: [\n `${this.arnPrefx}:ssm:*:${accountId}:parameter/artilleryio/*`\n ]\n },\n {\n Effect: 'Allow',\n Action: ['ecr:GetAuthorizationToken'],\n Resource: ['*']\n },\n {\n Effect: 'Allow',\n Action: ['logs:*'],\n Resource: [\n `${this.arnPrefx}:logs:*:${accountId}:log-group:artilleryio-log-group*:*`\n ]\n },\n {\n Effect: 'Allow',\n Action: ['sqs:*'],\n Resource: [`${this.arnPrefx}:sqs:*:${accountId}:artilleryio*`]\n },\n {\n Effect: 'Allow',\n Action: ['s3:*'],\n Resource: [\n `${this.arnPrefx}:s3:::${S3_BUCKET_NAME_PREFIX}-${accountId}`,\n `${this.arnPrefx}:s3:::${S3_BUCKET_NAME_PREFIX}-${accountId}/*`\n ]\n },\n {\n Effect: 'Allow',\n Action: ['xray:PutTraceSegments', 'xray:PutTelemetryRecords'],\n Resource: ['*']\n }\n ]\n };\n\n const createPolicyResp = await iam.send(\n new CreatePolicyCommand({\n PolicyName: 'artilleryio-ecs-worker-policy',\n Path: '/',\n PolicyDocument: JSON.stringify(policyDocument)\n })\n );\n\n await iam.send(\n new AttachRolePolicyCommand({\n PolicyArn: createPolicyResp.Policy.Arn,\n RoleName: taskRoleName\n })\n );\n\n debug('Waiting for IAM role to be ready');\n await sleep(30 * 1000);\n return createRoleResp.Role.Arn;\n }\n\n async createWorker() {}\n\n async prepareWorker() {}\n\n async runWorker() {}\n\n async stopWorker() {}\n\n async shutdown() {}\n}\n\nasync function ensureSSMParametersExist(region) {\n await ensureParameterExists(\n '/artilleryio/NPM_TOKEN',\n 'null',\n 'SecureString',\n region\n );\n await ensureParameterExists(\n '/artilleryio/NPM_REGISTRY',\n 'null',\n 'String',\n region\n );\n await ensureParameterExists(\n '/artilleryio/NPM_SCOPE',\n 'null',\n 'String',\n region\n );\n await ensureParameterExists(\n '/artilleryio/ARTIFACTORY_AUTH',\n 'null',\n 'SecureString',\n region\n );\n await ensureParameterExists(\n '/artilleryio/ARTIFACTORY_EMAIL',\n 'null',\n 'String',\n region\n );\n await ensureParameterExists(\n '/artilleryio/NPMRC',\n 'null',\n 'SecureString',\n region\n );\n await ensureParameterExists(\n '/artilleryio/NPM_SCOPE_REGISTRY',\n 'null',\n 'String',\n region\n );\n}\n\nmodule.exports = PlatformECS;\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/aws-util.js", "content": "const { ECSClient, DescribeTasksCommand } = require('@aws-sdk/client-ecs');\nconst {\n SSMClient,\n GetParameterCommand,\n PutParameterCommand,\n DeleteParameterCommand\n} = require('@aws-sdk/client-ssm');\nconst debug = require('debug')('util');\n\nmodule.exports = {\n // ECS:\n ecsDescribeTasks,\n\n // AWS SSM:\n ensureParameterExists,\n parameterExists,\n putParameter,\n getParameter,\n deleteParameter\n};\n\n// Wraps ecs.describeTasks to support more than 100 task ARNs in params.tasks\nasync function ecsDescribeTasks(params, region) {\n const ecs = new ECSClient({ apiVersion: '2014-11-13', region });\n const taskArnChunks = splitIntoSublists(params.tasks, 100);\n const results = { tasks: [], failures: [] };\n for (let i = 0; i < taskArnChunks.length; i++) {\n const params2 = Object.assign({}, params, { tasks: taskArnChunks[i] });\n const ecsData = await ecs.send(new DescribeTasksCommand(params2));\n results.tasks = results.tasks.concat(ecsData.tasks);\n results.failures = results.failures.concat(ecsData.failures);\n }\n return results;\n}\n\n// Slice input list into several lists, where each list has no more than maxGroupSize elements\nfunction splitIntoSublists(list, maxGroupSize) {\n const result = [];\n const numGroups = Math.ceil(list.length / maxGroupSize);\n for (let i = 0; i < numGroups; i++) {\n result.push(list.slice(i * maxGroupSize, i * maxGroupSize + maxGroupSize));\n }\n return result;\n}\n\n// ********************\n// AWS SSM helpers\n// In future these will be parameter-store agnostic, and work with Kubernetes\n// ConfigMaps or Azure/GCP native equivalents.\n// ********************\n\n// If parameter exists, do nothing; otherwise set the value\nasync function ensureParameterExists(ssmPath, defaultValue, type, region) {\n const exists = await parameterExists(ssmPath, region);\n if (exists) {\n return;\n }\n return putParameter(ssmPath, defaultValue, type, region);\n}\n\nasync function parameterExists(path, region) {\n const ssm = new SSMClient({ apiVersion: '2014-11-06', region });\n const getParams = {\n Name: path,\n WithDecryption: true\n };\n\n try {\n await ssm.send(new GetParameterCommand(getParams));\n return true;\n } catch (ssmErr) {\n if (ssmErr.name === 'ParameterNotFound') {\n return false;\n } else {\n throw ssmErr;\n }\n }\n}\n\nasync function putParameter(path, value, type, region) {\n const ssm = new SSMClient({ apiVersion: '2014-11-06', region });\n\n const putParams = {\n Name: path,\n Type: type,\n Value: value,\n Overwrite: true\n };\n\n await ssm.send(new PutParameterCommand(putParams));\n}\n\nasync function getParameter(path, region) {\n const ssm = new SSMClient({ apiVersion: '2014-11-06', region });\n\n try {\n const ssmResponse = await ssm.send(\n new GetParameterCommand({\n Name: path,\n WithDecryption: true\n })\n );\n\n debug({ ssmResponse });\n return ssmResponse.Parameter?.Value;\n } catch (ssmErr) {\n if (ssmErr.name === 'ParameterNotFound') {\n return false;\n } else {\n throw ssmErr;\n }\n }\n}\n\nasync function deleteParameter(path, region) {\n const ssm = new SSMClient({ apiVersion: '2014-11-06', region });\n\n try {\n const ssmResponse = await ssm.send(\n new DeleteParameterCommand({\n Name: path\n })\n );\n\n debug({ ssmResponse });\n return ssmResponse;\n } catch (ssmErr) {\n if (ssmErr.name === 'ParameterNotFound') {\n return false;\n } else {\n throw ssmErr;\n }\n }\n}\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/bom.js", "content": "const path = require('node:path');\nconst fs = require('node:fs');\nconst A = require('async');\n\nconst { isBuiltin } = require('node:module');\nconst detective = require('detective-es6');\nconst depTree = require('dependency-tree');\n\nconst walkSync = require('walk-sync');\nconst debug = require('debug')('bom');\nconst _ = require('lodash');\nconst BUILTIN_PLUGINS = require('./plugins').getAllPluginNames();\nconst BUILTIN_ENGINES = require('./plugins').getOfficialEngines();\n\nconst Table = require('cli-table3');\n\nconst { resolveConfigTemplates } = require('../../../../util');\n\nconst prepareTestExecutionPlan = require('../../../../lib/util/prepare-test-execution-plan');\nconst { readScript, parseScript } = require('../../../../util');\n\n// NOTE: Code below presumes that all paths are absolute\n\n//Tests in Fargate run on ubuntu, which uses posix paths\n//This function converts a path to posix path, in case the original path was not posix (e.g. windows runs)\nfunction _convertToPosixPath(p) {\n return p.split(path.sep).join(path.posix.sep);\n}\n\n// NOTE: absoluteScriptPath here is actually the absolute path to the config file\nfunction createBOM(absoluteScriptPath, extraFiles, opts, callback) {\n A.waterfall(\n [\n A.constant(absoluteScriptPath),\n async (scriptPath) => {\n let scriptData;\n if (scriptPath.toLowerCase().endsWith('.ts')) {\n scriptData = await prepareTestExecutionPlan(\n [scriptPath],\n opts.flags,\n []\n );\n scriptData.config.processor = scriptPath;\n } else {\n const data = await readScript(scriptPath);\n scriptData = await parseScript(data);\n }\n\n return scriptData;\n },\n (scriptData, next) => {\n return next(null, {\n opts: {\n scriptData,\n absoluteScriptPath,\n flags: opts.flags,\n scenarioPath: opts.scenarioPath // Absolute path to the file that holds scenarios\n },\n localFilePaths: [absoluteScriptPath],\n npmModules: []\n });\n },\n applyScriptChanges,\n getPlugins,\n getCustomEngines,\n getCustomJsDependencies,\n getVariableDataFiles,\n getFileUploadPluginFiles,\n getExtraFiles,\n getDotEnv,\n expandDirectories\n ],\n\n (err, context) => {\n if (err) {\n return callback(err, null);\n }\n\n context.localFilePaths = context.localFilePaths.concat(extraFiles);\n\n // TODO: Entries in localFilePaths may be directories\n\n // How many entries do we have here? If we have only one entry, the string itself\n // will be the common prefix, meaning that when we substring() on it later, we'll\n // get an empty string, ending up with a manifest like:\n // { files:\n // [ { orig: '/Users/h/tmp/artillery/hello.yaml', noPrefix: '' } ],\n // modules: [] }\n //\n let prefix = '';\n if (context.localFilePaths.length === 1) {\n prefix = context.localFilePaths[0].substring(\n 0,\n context.localFilePaths[0].length -\n path.basename(context.localFilePaths[0]).length\n );\n // This may still be an empty string if the script path is just 'hello.yml':\n prefix = prefix.length === 0 ? context.localFilePaths[0] : prefix;\n } else {\n prefix = commonPrefix(context.localFilePaths);\n }\n\n prefix = _convertToPosixPath(prefix);\n debug('prefix', prefix);\n\n //\n // include package.json / package-lock.json / yarn.lock\n //\n let packageDescriptionFiles = ['.npmrc'];\n if (opts.packageJsonPath) {\n packageDescriptionFiles.push(opts.packageJsonPath);\n } else {\n packageDescriptionFiles = packageDescriptionFiles.concat([\n 'package.json',\n 'package-lock.json',\n 'yarn.lock'\n ]);\n }\n const dependencyFiles = packageDescriptionFiles.map((s) =>\n path.join(prefix, s)\n );\n\n debug(dependencyFiles);\n\n dependencyFiles.forEach((p) => {\n try {\n if (fs.statSync(p)) {\n context.localFilePaths.push(p);\n }\n } catch (_ignoredErr) {}\n });\n\n const files = context.localFilePaths.map((p) => {\n return {\n orig: p,\n noPrefix: p.substring(prefix.length, p.length),\n origPosix: _convertToPosixPath(p),\n noPrefixPosix: _convertToPosixPath(p).substring(\n prefix.length,\n p.length\n )\n };\n });\n\n const pkgPath = _.find(files, (f) => {\n return f.noPrefix === 'package.json';\n });\n\n if (pkgPath) {\n const pkg = JSON.parse(fs.readFileSync(pkgPath.orig, 'utf8'));\n const pkgDeps = [].concat(\n Object.keys(pkg.dependencies || {}),\n Object.keys(pkg.devDependencies || {})\n );\n context.pkgDeps = pkgDeps;\n context.npmModules = _.uniq(context.npmModules.concat(pkgDeps)).sort();\n } else {\n context.pkgDeps = [];\n }\n\n return callback(null, {\n files: _.uniqWith(files, _.isEqual),\n modules: _.uniq(context.npmModules).filter(\n (m) =>\n m !== 'artillery' &&\n m !== 'playwright' &&\n !m.startsWith('@playwright/')\n ),\n pkgDeps: context.pkgDeps,\n fullyResolvedConfig: context.opts.scriptData.config\n });\n }\n );\n}\n\nfunction isLocalModule(modName) {\n // NOTE: Absolute paths not supported\n return modName.startsWith('.');\n}\n\nfunction applyScriptChanges(context, next) {\n resolveConfigTemplates(\n context.opts.scriptData,\n context.opts.flags,\n context.opts.absoluteScriptPath,\n context.opts.scenarioPath\n ).then((resolvedConfig) => {\n context.opts.scriptData = resolvedConfig;\n return next(null, context);\n });\n}\n\nfunction getPlugins(context, next) {\n const environmentPlugins = _.reduce(\n _.get(context, 'opts.scriptData.config.environments', {}),\n function getEnvironmentPlugins(acc, envSpec, _envName) {\n acc = acc.concat(Object.keys(envSpec.plugins || []));\n return acc;\n },\n []\n );\n const pluginNames = Object.keys(\n _.get(context, 'opts.scriptData.config.plugins', {})\n ).concat(environmentPlugins);\n\n const pluginPackages = _.uniq(\n pluginNames\n .filter((p) => BUILTIN_PLUGINS.indexOf(p) === -1)\n .map((p) => `artillery-plugin-${p}`)\n );\n debug(pluginPackages);\n context.npmModules = context.npmModules.concat(pluginPackages);\n\n return next(null, context);\n}\n\nfunction getCustomEngines(context, next) {\n const environmentEngines = _.reduce(\n _.get(context, 'opts.scriptData.config.environments', {}),\n function getEnvironmentEngines(acc, envSpec, _envName) {\n acc = acc.concat(Object.keys(envSpec.engines || []));\n return acc;\n },\n []\n );\n\n const engineNames = Object.keys(\n _.get(context, 'opts.scriptData.config.engines', {})\n ).concat(environmentEngines);\n\n const enginePackages = _.uniq(\n engineNames\n .filter((p) => BUILTIN_ENGINES.indexOf(p) === -1)\n .map((p) => `artillery-engine-${p}`)\n );\n\n context.npmModules = context.npmModules.concat(enginePackages);\n\n return next(null, context);\n}\n\nfunction getCustomJsDependencies(context, next) {\n if (context.opts.scriptData.config?.processor) {\n //\n // Path to the main processor file:\n //\n\n const procPath = path.resolve(\n path.dirname(context.opts.absoluteScriptPath),\n context.opts.scriptData.config.processor\n );\n context.localFilePaths.push(procPath);\n\n // Get the tree of requires from the main processor file:\n const tree = depTree.toList({\n filename: procPath,\n directory: path.dirname(context.opts.absoluteScriptPath),\n filter: (path) => path.indexOf('node_modules') === -1 // optional\n });\n\n debug('tree');\n debug(tree);\n\n function getNpmDependencies(filename) {\n const src = fs.readFileSync(filename);\n const requires = detective(src);\n const npmPackages = requires\n .filter(\n (requireString) =>\n !isBuiltin(requireString) && !isLocalModule(requireString)\n )\n .map((requireString) => {\n return requireString.startsWith('@')\n ? `${requireString.split('/')[0]}/${requireString.split('/')[1]}`\n : requireString.split('/')[0];\n });\n return npmPackages;\n }\n\n const allNpmDeps = tree.map(getNpmDependencies);\n debug(allNpmDeps);\n const reduced = allNpmDeps.reduce((acc, deps) => {\n deps.forEach((d) => {\n if (acc.indexOf(d) === -1) {\n acc.push(d);\n }\n });\n return acc;\n }, []);\n debug(reduced);\n\n //\n // Any other local JS files and npm packages:\n //\n const procSrc = fs.readFileSync(procPath);\n const _processorRequires = detective(procSrc);\n // TODO: Look for and load dir/index.js and get its dependencies,\n // rather than just grabbing the entire directory.\n // NOTE: Some of these may be directories (with an index.js inside)\n // Could be JSON files too.\n context.localFilePaths = context.localFilePaths.concat(tree);\n context.npmModules = context.npmModules.concat(reduced);\n // Remove duplicate entries for the same file when invoked on a single .ts script\n // See line 44 - the config.processor property is always set on .ts files, which leads to\n // multiple entries in the localFilePaths array for the same file\n context.localFilePaths = _.uniq(context.localFilePaths);\n debug('got custom JS dependencies');\n return next(null, context);\n } else {\n debug('no custom JS dependencies');\n return next(null, context);\n }\n}\n\nfunction getVariableDataFiles(context, next) {\n // NOTE: assuming that context.opts.scriptData contains both the config and\n // the scenarios section here.\n\n // Iterate over environments\n\n function resolvePayloadPaths(obj) {\n const result = [];\n if (obj.payload) {\n // When using a separate config file, resolve paths relative to the scenario file\n // Otherwise, resolve relative to the config file\n const baseDir = context.opts.scenarioPath\n ? path.dirname(context.opts.scenarioPath)\n : path.dirname(context.opts.absoluteScriptPath);\n\n if (_.isArray(obj.payload)) {\n obj.payload.forEach((payloadSpec) => {\n result.push(path.resolve(baseDir, payloadSpec.path));\n });\n } else if (_.isObject(obj.payload)) {\n // isObject returns true for arrays, so this branch must come second\n result.push(path.resolve(baseDir, obj.payload.path));\n }\n }\n return result;\n }\n\n context.localFilePaths = context.localFilePaths.concat(\n resolvePayloadPaths(context.opts.scriptData.config)\n );\n context.opts.scriptData.config.environments =\n context.opts.scriptData.config.environments || {};\n Object.keys(context.opts.scriptData.config.environments).forEach(\n (envName) => {\n const envSpec = context.opts.scriptData.config.environments[envName];\n context.localFilePaths = context.localFilePaths.concat(\n resolvePayloadPaths(envSpec)\n );\n }\n );\n\n return next(null, context);\n}\n\nfunction getFileUploadPluginFiles(context, next) {\n if (context.opts.scriptData.config?.plugins?.['http-file-uploads']) {\n // Append filePaths array if it's there:\n\n if (context.opts.scriptData.config.plugins['http-file-uploads'].filePaths) {\n // When using a separate config file, resolve paths relative to the scenario file\n // Otherwise, resolve relative to the config file\n const baseDir = context.opts.scenarioPath\n ? path.dirname(context.opts.scenarioPath)\n : path.dirname(context.opts.absoluteScriptPath);\n\n const absPaths = context.opts.scriptData.config.plugins[\n 'http-file-uploads'\n ].filePaths.map((p) => {\n return path.resolve(baseDir, p);\n });\n context.localFilePaths = context.localFilePaths.concat(absPaths);\n }\n return next(null, context);\n } else {\n return next(null, context);\n }\n}\n\nfunction getExtraFiles(context, next) {\n if (context.opts.scriptData.config?.includeFiles) {\n // When using a separate config file, resolve paths relative to the scenario file\n // Otherwise, resolve relative to the config file\n const baseDir = context.opts.scenarioPath\n ? path.dirname(context.opts.scenarioPath)\n : path.dirname(context.opts.absoluteScriptPath);\n\n const absPaths = _.map(context.opts.scriptData.config.includeFiles, (p) => {\n const includePath = path.resolve(baseDir, p);\n debug('includeFile:', includePath);\n return includePath;\n });\n context.localFilePaths = context.localFilePaths.concat(absPaths);\n return next(null, context);\n } else {\n return next(null, context);\n }\n}\n\nfunction getDotEnv(context, next) {\n const flags = context.opts.flags;\n if (!flags.dotenv || flags.platform === 'aws:ecs') {\n return next(null, context);\n }\n\n const dotEnvPath = path.resolve(process.cwd(), flags.dotenv);\n try {\n if (fs.statSync(dotEnvPath)) {\n context.localFilePaths.push(dotEnvPath);\n }\n } catch (_ignoredErr) {\n console.log(`WARNING: could not find dotenv file: ${flags.dotenv}`);\n }\n\n return next(null, context);\n}\n\nfunction expandDirectories(context, next) {\n // This can potentially lead to VERY unexpected behaviour, when used\n // without due care with the file upload plugin (if filePaths is pointed at\n // a directory that contains files OTHER than those to be used with the\n // plugin)\n //\n // TODO: Warn if there are too many files in the directory\n // TODO: Only allow specific filenames or globs, not directories\n debug(context.localFilePaths);\n // FIXME: Don't need to scan twice:\n const dirs = context.localFilePaths.filter((p) => {\n let result = false;\n try {\n result = fs.statSync(p).isDirectory();\n } catch (_fsErr) {}\n return result;\n });\n // Remove directories from the list:\n context.localFilePaths = context.localFilePaths.filter((p) => {\n let result = true;\n try {\n result = !fs.statSync(p).isDirectory();\n } catch (_fsErr) {}\n return result;\n });\n\n debug('Dirs to expand');\n debug(dirs);\n dirs.forEach((d) => {\n const entries = walkSync.entries(d, { directories: false });\n debug(entries);\n context.localFilePaths = context.localFilePaths.concat(\n entries.map((e) => {\n return path.resolve(d, e.relativePath);\n })\n );\n });\n\n return next(null, context);\n}\n\nfunction commonPrefix(paths, separator) {\n if (\n !paths ||\n paths.length === 0 ||\n paths.filter((s) => typeof s !== 'string').length > 0\n ) {\n return '';\n }\n\n if (paths.includes('/')) {\n return '/';\n }\n\n const sep = separator ? separator : path.sep;\n\n const splitPaths = paths.map((p) => p.split(sep));\n const shortestPath = splitPaths.reduce((a, b) => {\n return a.length < b.length ? a : b;\n }, splitPaths[0]);\n\n let furthestIndex = shortestPath.length;\n\n for (const p of splitPaths) {\n for (let i = 0; i < furthestIndex; i++) {\n if (p[i] !== shortestPath[i]) {\n furthestIndex = i;\n break;\n }\n }\n }\n\n const joined = shortestPath.slice(0, furthestIndex).join(sep);\n\n if (joined.length > 0) {\n // Check if joined path already ends with separator which\n // will happen when input is a root drive on Windows, e.g. \"C:\\\"\n return joined.endsWith(sep) ? joined : joined + sep;\n } else {\n return '';\n }\n}\n\nfunction prettyPrint(manifest) {\n artillery.logger({ showTimestamp: true }).log('Test bundle prepared...');\n artillery.log('Test bundle contents:');\n const t = new Table({ head: ['Name', 'Type', 'Notes'] });\n for (const f of manifest.files) {\n t.push([f.noPrefix, 'file']);\n }\n for (const m of manifest.modules) {\n t.push([\n m,\n 'package',\n manifest.pkgDeps.indexOf(m) === -1 ? 'not in package.json' : ''\n ]);\n }\n artillery.log(t.toString());\n artillery.log();\n}\n\nmodule.exports = {\n createBOM,\n commonPrefix,\n prettyPrint,\n applyScriptChanges,\n getCustomJsDependencies\n};\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/constants.js", "content": "const pkgJson = require('../../../../package.json');\nconst DEFAULT_IMAGE_TAG = pkgJson.version;\n\n// Default wait timeout for cloud workers to start\nlet WAIT_TIMEOUT_SEC = 600;\n\n// Legacy override\nif (process.env.ECS_WAIT_TIMEOUT) {\n WAIT_TIMEOUT_SEC = parseInt(process.env.ECS_WAIT_TIMEOUT, 10);\n}\n\n// Override\nif (process.env.WORKER_WAIT_TIMEOUT_SEC) {\n WAIT_TIMEOUT_SEC = parseInt(process.env.WORKER_WAIT_TIMEOUT_SEC, 10);\n}\n\nmodule.exports = {\n ARTILLERY_CLUSTER_NAME: 'artilleryio-cluster',\n TASK_NAME: 'artilleryio-loadgen-worker',\n SQS_QUEUES_NAME_PREFIX: 'artilleryio_test_metrics',\n S3_BUCKET_NAME_PREFIX: 'artilleryio-test-data',\n LOGGROUP_NAME: 'artilleryio-log-group',\n LOGGROUP_RETENTION_DAYS: process.env.ARTILLERY_LOGGROUP_RETENTION_DAYS || 180,\n IMAGE_VERSION: process.env.ECR_IMAGE_VERSION || DEFAULT_IMAGE_TAG,\n WAIT_TIMEOUT: WAIT_TIMEOUT_SEC,\n TEST_RUNS_MAX_TAGS: parseInt(process.env.TEST_RUNS_MAX_TAGS, 10) || 8\n};\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/create-s3-client.js", "content": "const { S3Client } = require('@aws-sdk/client-s3');\n\nmodule.exports = createS3Client;\n\nfunction createS3Client(opts = {}) {\n const defaultOpts = {\n apiVersion: '2006-03-01'\n };\n\n let clientOpts = Object.assign(defaultOpts, opts);\n\n if (process.env.ARTILLERY_S3_OPTS) {\n clientOpts = Object.assign(\n defaultOpts,\n JSON.parse(process.env.ARTILLERY_S3_OPTS)\n );\n }\n\n if (!opts.region) {\n clientOpts.region = global.artillery.s3BucketRegion;\n }\n\n return new S3Client(clientOpts);\n}\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/create-test.js", "content": "\n\nconst A = require('async');\nconst debug = require('debug')('commands:create-test');\n\nconst { getBucketName } = require('./util');\nconst createS3Client = require('./create-s3-client');\n\nconst path = require('node:path');\n\nconst fs = require('node:fs');\n\nconst { createBOM, prettyPrint } = require('./bom');\n\nconst { PutObjectCommand } = require('@aws-sdk/client-s3');\n\nfunction tryCreateTest(scriptPath, options) {\n createTest(scriptPath, options);\n}\n\nasync function createTest(scriptPath, options, callback) {\n const absoluteScriptPath = path.resolve(process.cwd(), scriptPath);\n\n const contextPath = options.context\n ? path.resolve(options.context)\n : path.dirname(absoluteScriptPath);\n\n debug('script:', absoluteScriptPath);\n debug('root:', contextPath);\n\n const context = {\n contextDir: contextPath,\n scriptPath: absoluteScriptPath,\n originalScriptPath: scriptPath,\n name: options.name, // test name, eg simple-bom or aht_$UUID\n manifestPath: options.manifestPath,\n packageJsonPath: options.packageJsonPath,\n flags: options.flags\n };\n\n if (typeof options.config === 'string') {\n const absoluteConfigPath = path.resolve(process.cwd(), options.config);\n context.configPath = absoluteConfigPath;\n }\n\n if (options.customSyncClient) {\n context.customSyncClient = options.customSyncClient;\n }\n\n return new Promise((resolve, reject) => {\n A.waterfall(\n [\n A.constant(context),\n async (context) => {\n if (!context.customSyncClient) {\n context.s3Bucket = await getBucketName();\n return context;\n } else {\n context.s3Bucket = 'S3_BUCKET_ARGUMENT_NOT_USED_ON_AZURE';\n return context;\n }\n },\n prepareManifest,\n printManifest,\n syncS3,\n writeTestMetadata\n ],\n (err, context) => {\n if (err) {\n console.log(err);\n return;\n }\n\n if (callback) {\n callback(err, context);\n } else if (err) {\n reject(err);\n } else {\n resolve(context);\n }\n }\n );\n });\n}\n\nfunction prepareManifest(context, callback) {\n let fileToAnalyse = context.scriptPath;\n const extraFiles = [];\n if (context.configPath) {\n debug('context has been provided; extraFiles =', extraFiles);\n fileToAnalyse = context.configPath;\n extraFiles.push(context.scriptPath);\n }\n\n createBOM(\n fileToAnalyse,\n extraFiles,\n {\n packageJsonPath: context.packageJsonPath,\n flags: context.flags,\n scenarioPath: context.scriptPath\n },\n (err, bom) => {\n debug(err);\n debug(bom);\n context.manifest = bom;\n return callback(err, context);\n }\n );\n}\n\nfunction printManifest(context, callback) {\n prettyPrint(context.manifest);\n return callback(null, context);\n}\n\nasync function syncS3(context) {\n let s3;\n if (context.customSyncClient) {\n s3 = context.customSyncClient;\n } else {\n s3 = createS3Client();\n }\n\n const prefix = `tests/${context.name}`;\n\n context.s3Prefix = prefix;\n\n debug('Will try syncing to:', context.s3Bucket);\n\n debug('Manifest: ', context.manifest);\n\n // Iterate through manifest, for each element: has orig (local source) and noPrefix (S3\n // destination) properties\n return new Promise((resolve, reject) => {\n A.eachLimit(\n context.manifest.files,\n 3,\n async (item, eachDone) => {\n // If we can't read the file, it may have been specified with a\n // template in its name, e.g. a payload file like:\n // {{ $environment }}-users.csv\n // If so, ignore it, hope config.includeFiles was used, and let\n // \"artillery run\" in the worker deal with it.\n let body;\n try {\n body = fs.readFileSync(item.orig);\n } catch (fsErr) {\n debug(fsErr);\n }\n\n if (!body) {\n return eachDone(null, context);\n }\n\n // Filter bundled packages from package.json before upload\n if (item.noPrefix === 'package.json') {\n const pkg = JSON.parse(body.toString());\n const filterBundled = (deps) => {\n if (!deps) return deps;\n const filtered = {};\n for (const [name, version] of Object.entries(deps)) {\n if (\n name !== 'artillery' &&\n name !== 'playwright' &&\n !name.startsWith('@playwright/')\n ) {\n filtered[name] = version;\n }\n }\n return filtered;\n };\n pkg.dependencies = filterBundled(pkg.dependencies);\n pkg.devDependencies = filterBundled(pkg.devDependencies);\n body = Buffer.from(JSON.stringify(pkg, null, 2));\n }\n\n const key = `${context.s3Prefix}/${item.noPrefixPosix}`;\n await s3.send(\n new PutObjectCommand({\n Bucket: context.s3Bucket,\n Key: key,\n Body: body\n })\n );\n },\n (err) => {\n if (err) {\n reject(err);\n } else {\n resolve(context);\n }\n }\n );\n });\n}\n\n// create just overwrites an existing test for now\nasync function writeTestMetadata(context) {\n const metadata = {\n createdOn: Date.now(),\n name: context.name,\n modules: context.manifest.modules\n };\n\n // Here we need to provide config information (if given) -- so that the worker knows how to load it\n if (context.configPath) {\n const res = context.manifest.files.filter((o) => {\n return o.orig === context.configPath;\n });\n const newConfigPath = res[0].noPrefixPosix; // if we have been given a config, we must have an entry\n metadata.configPath = newConfigPath;\n }\n\n const newScriptPath = context.manifest.files.filter((o) => {\n return o.orig === context.scriptPath;\n })[0].noPrefixPosix;\n metadata.scriptPath = newScriptPath;\n\n debug('metadata', metadata);\n\n let s3 = null;\n if (context.customSyncClient) {\n s3 = context.customSyncClient;\n } else {\n s3 = createS3Client();\n }\n\n const key = `${context.s3Prefix}/metadata.json`; // TODO: Rename to something less likely to clash\n debug('metadata location:', `${context.s3Bucket}/${key}`);\n await s3.send(\n new PutObjectCommand({\n Body: JSON.stringify(metadata),\n Bucket: context.s3Bucket,\n Key: key\n })\n );\n\n return context;\n}\n\nmodule.exports = {\n tryCreateTest,\n createTest,\n syncS3,\n prepareManifest\n};\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/errors.js", "content": "class TestNotFoundError extends Error {\n constructor(message) {\n super(message);\n this.name = 'TestNotFoundError';\n }\n}\n\nclass NoAvailableQueueError extends Error {\n constructor(message) {\n super(message);\n this.name = 'NoAvailableQueueError';\n }\n}\n\nclass ClientServerVersionMismatchError extends Error {\n constructor(message) {\n super(message);\n this.name = 'ClientServerMismatchError';\n }\n}\n\nclass ConsoleOutputSerializeError extends Error {\n constructor(message) {\n super(message);\n this.name = 'OutputSerializeError';\n }\n}\n\nmodule.exports = {\n TestNotFoundError,\n NoAvailableQueueError,\n ClientServerVersionMismatchError,\n ConsoleOutputSerializeError\n};\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/find-public-subnets.js", "content": "const assert = require('node:assert').strict;\nconst {\n EC2Client,\n DescribeRouteTablesCommand,\n DescribeVpcsCommand,\n DescribeSubnetsCommand\n} = require('@aws-sdk/client-ec2');\n\nclass VPCSubnetFinder {\n constructor(opts) {\n this.ec2 = new EC2Client(opts);\n }\n\n async getRouteTables(vpcId) {\n const rts = await this.ec2.send(\n new DescribeRouteTablesCommand({\n Filters: [\n {\n Name: 'vpc-id',\n Values: [vpcId]\n }\n ]\n })\n );\n\n return rts.RouteTables;\n }\n\n async findDefaultVpc() {\n const vpcRes = await this.ec2.send(\n new DescribeVpcsCommand({\n Filters: [\n {\n Name: 'isDefault',\n Values: ['true']\n }\n ]\n })\n );\n\n assert.ok(vpcRes.Vpcs.length <= 1);\n\n if (vpcRes.Vpcs.length !== 1) {\n return null;\n } else {\n return vpcRes.Vpcs[0].VpcId;\n }\n }\n\n async getSubnets(vpcId) {\n const subRes = await this.ec2.send(\n new DescribeSubnetsCommand({\n Filters: [\n {\n Name: 'vpc-id',\n Values: [vpcId]\n }\n ]\n })\n );\n\n return subRes.Subnets;\n }\n\n isSubnetPublic(routeTables, subnetId) {\n //\n // Inspect associations of each route table (of a specific VPC). A route\n // table record has an Associations field, which is a list of association\n // objects. There are two types of those:\n //\n // 1. An implicit association, which is indicated by field Main set to\n // true and no explicit subnet id.\n // 2. An explicit association, which is indicated by field Main set to\n // false, and a SubnetId field containing a subnet id.\n //\n\n // Route table for the subnet - can there only be one?\n let subnetTable = routeTables.filter((rt) => {\n const explicitAssoc = rt.Associations.filter((assoc) => {\n return assoc.SubnetId && assoc.SubnetId === subnetId;\n });\n\n assert.ok(explicitAssoc.length <= 1);\n\n return explicitAssoc.length === 1;\n });\n\n if (subnetTable.length === 0) {\n // There is no explicit association for this subnet so it will be implicitly\n // associated with the VPC's main routing table.\n subnetTable = routeTables.filter((rt) => {\n const implicitAssoc = rt.Associations.filter((assoc) => {\n return assoc.Main === true;\n });\n\n assert.ok(implicitAssoc.length <= 1);\n\n return implicitAssoc.length === 1;\n });\n }\n\n if (subnetTable.length !== 1) {\n throw new Error(\n `Could not locate routing table for subnet: subnet id: ${subnetId}`\n );\n }\n\n const igwRoutes = subnetTable[0].Routes.filter((route) => {\n // NOTE: there may be no IGW attached to route\n return route.GatewayId?.startsWith('igw-');\n });\n\n return igwRoutes.length > 0;\n }\n\n // TODO: Distinguish between there being no default VPC,\n // or being given an invalid VPC ID, and no public subnets\n // existing in a VPC that definitely exists.\n async findPublicSubnets(vpcId) {\n if (!vpcId) {\n vpcId = await this.findDefaultVpc();\n }\n const rts = await this.getRouteTables(vpcId);\n const subnets = await this.getSubnets(vpcId);\n\n const publicSubnets = subnets.filter((subnet) => {\n return this.isSubnetPublic(rts, subnet.SubnetId);\n });\n\n return publicSubnets;\n }\n}\n\nasync function main() {\n const f = new VPCSubnetFinder({ region: process.env.REGION });\n\n try {\n const publicSubnets = await f.findPublicSubnets(process.env.VPC_ID);\n console.log(publicSubnets.map((s) => s.SubnetId).join('\\n'));\n } catch (err) {\n console.log(err);\n }\n}\n\nif (require.main === module) {\n main();\n}\n\nmodule.exports = { VPCSubnetFinder };\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/plugins/artillery-plugin-inspect-script/index.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\n\n\nmodule.exports.Plugin = ArtilleryInspectScriptPlugin;\n\nconst { btoa } = require('../../util');\n\nfunction ArtilleryInspectScriptPlugin(script, events) {\n this.script = script;\n this.events = events;\n\n const checksConfig = script.config?.ensure || script.config?.plugins?.ensure;\n\n if (checksConfig) {\n console.log(\n `inspect-script.config.ensure=${btoa(JSON.stringify(checksConfig))}`\n );\n }\n\n return this;\n}\nArtilleryInspectScriptPlugin.prototype.cleanup = (done) => {\n done(null);\n};\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/plugins/artillery-plugin-sqs-reporter/azure-aqs.js", "content": "// Copyright (c) Artillery Software Inc.\n// SPDX-License-Identifier: BUSL-1.1\n//\n// Non-evaluation use of Artillery on Azure requires a commercial license\n\nconst { QueueClient } = require('@azure/storage-queue');\nconst { BlobServiceClient } = require('@azure/storage-blob');\nconst { DefaultAzureCredential } = require('@azure/identity');\nconst { randomUUID } = require('node:crypto');\n\nfunction getAQS() {\n return new QueueClient(\n process.env.AZURE_STORAGE_QUEUE_URL,\n new DefaultAzureCredential()\n );\n}\n\n// Azure Queue Storage has a 64KB message limit\n// Use 60KB threshold to leave margin for encoding overhead\nconst AQS_SIZE_LIMIT = 60 * 1024;\n\nlet blobContainerClient = null;\n\nfunction getBlobClient() {\n if (!blobContainerClient) {\n const storageAccount = process.env.AZURE_STORAGE_ACCOUNT;\n const containerName = process.env.AZURE_STORAGE_BLOB_CONTAINER;\n if (!storageAccount || !containerName) {\n throw new Error(\n 'AZURE_STORAGE_ACCOUNT and AZURE_STORAGE_BLOB_CONTAINER must be set'\n );\n }\n const blobServiceClient = new BlobServiceClient(\n `https://${storageAccount}.blob.core.windows.net`,\n new DefaultAzureCredential()\n );\n blobContainerClient = blobServiceClient.getContainerClient(containerName);\n }\n return blobContainerClient;\n}\n\nasync function sendMessage(queue, body, tags) {\n const payload = JSON.stringify({\n payload: body,\n attributes: tags.reduce((acc, tag) => {\n acc[tag.key] = tag.value;\n return acc;\n }, {})\n });\n\n // Check if payload exceeds Azure Queue Storage limit\n if (Buffer.byteLength(payload, 'utf8') > AQS_SIZE_LIMIT) {\n // Upload to blob storage and send reference\n const testId = tags.find((t) => t.key === 'testId')?.value;\n const workerId = tags.find((t) => t.key === 'workerId')?.value;\n const messageId = randomUUID();\n const blobName = `tests/${testId}/overflow/${workerId}/${messageId}.json`;\n\n const blobClient = getBlobClient().getBlockBlobClient(blobName);\n await blobClient.upload(payload, Buffer.byteLength(payload, 'utf8'));\n\n // Send reference message\n const refPayload = JSON.stringify({\n payload: {\n _overflowRef: blobName,\n event: body.event\n },\n attributes: tags.reduce((acc, tag) => {\n acc[tag.key] = tag.value;\n return acc;\n }, {})\n });\n\n return queue.sendMessage(refPayload);\n }\n\n return queue.sendMessage(payload);\n}\n\nmodule.exports = { getAQS, sendMessage };\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/plugins/artillery-plugin-sqs-reporter/index.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst { SQSClient, SendMessageCommand } = require('@aws-sdk/client-sqs');\nconst { S3Client, PutObjectCommand } = require('@aws-sdk/client-s3');\nconst _debug = require('debug')('plugin:sqsReporter');\nconst uuid = require('node:crypto').randomUUID;\nconst { getAQS, sendMessage } = require('./azure-aqs');\n\n// SQS has 1MB message limit. Use 950KB threshold for safety margin.\nconst SQS_SIZE_LIMIT = 950 * 1024;\n\nmodule.exports = {\n Plugin: ArtillerySQSPlugin,\n LEGACY_METRICS_FORMAT: false\n};\n\nfunction ArtillerySQSPlugin(script, events) {\n this.script = script;\n this.events = events;\n\n this.unsent = 0;\n\n // List of objects: [{key: 'SomeKey', value: 'SomeValue'}, ...]\n this.tags = process.env.SQS_TAGS ? JSON.parse(process.env.SQS_TAGS) : [];\n this.testId = null;\n const messageAttributes = {};\n\n this.tags.forEach((tag) => {\n if (tag.key === 'testId') {\n this.testId = tag.value;\n }\n messageAttributes[tag.key] = {\n DataType: 'String',\n StringValue: tag.value\n };\n });\n\n this.messageAttributes = messageAttributes;\n\n this.sqs = null;\n this.aqs = null;\n\n if (process.env.SQS_QUEUE_URL) {\n this.sqs = new SQSClient({\n region:\n process.env.SQS_REGION || script.config.plugins['sqs-reporter'].region\n });\n\n this.queueUrl =\n process.env.SQS_QUEUE_URL ||\n script.config.plugins['sqs-reporter'].queueUrl;\n }\n\n this.s3 = null;\n this.s3Bucket = process.env.ARTILLERY_S3_BUCKET || null;\n if (this.sqs && this.s3Bucket) {\n this.s3 = new S3Client({\n region:\n process.env.SQS_REGION || script.config.plugins['sqs-reporter'].region\n });\n }\n\n if (process.env.AZURE_STORAGE_QUEUE_URL) {\n this.aqs = getAQS();\n }\n\n events.on('stats', (statsOriginal) => {\n const serialized = global.artillery.__SSMS.serializeMetrics(statsOriginal);\n const body = {\n event: 'workerStats',\n stats: serialized\n };\n\n this.sendMessage(body);\n });\n\n //TODO: reconcile some of this code with how lambda does sqs reporting\n events.on('phaseStarted', (phaseContext) => {\n const body = {\n event: 'phaseStarted',\n phase: phaseContext\n };\n\n this.sendMessage(body);\n });\n\n //TODO: reconcile some of this code with how lambda does sqs reporting\n events.on('phaseCompleted', (phaseContext) => {\n const body = {\n event: 'phaseCompleted',\n phase: phaseContext\n };\n this.sendMessage(body);\n });\n\n events.on('done', (_stats) => {\n const body = {\n event: 'done',\n stats: global.artillery.__SSMS.serializeMetrics(_stats)\n };\n this.sendMessage(body);\n });\n\n global.artillery.globalEvents.on('log', (opts, ...args) => {\n if (process.env.SHIP_LOGS) {\n const body = {\n event: 'artillery.log',\n log: {\n opts,\n args: [...args]\n }\n };\n\n this.sendMessage(body);\n }\n });\n\n return this;\n}\n\nArtillerySQSPlugin.prototype.cleanup = function (done) {\n const interval = setInterval(() => {\n if (this.unsent <= 0) {\n clearInterval(interval);\n done(null);\n }\n }, 200).unref();\n};\n\nArtillerySQSPlugin.prototype.sendMessage = function (body) {\n if (this.sqs) {\n this.sendSQS(body);\n } else {\n this.sendAQS(body);\n }\n};\n\nArtillerySQSPlugin.prototype.sendSQS = async function (body) {\n this.unsent++;\n\n const payload = JSON.stringify(body);\n const payloadSize = Buffer.byteLength(payload, 'utf8');\n\n try {\n let messageBody = payload;\n\n // Upload to S3 if payload exceeds SQS limit\n if (payloadSize > SQS_SIZE_LIMIT && this.s3 && this.s3Bucket) {\n const workerId = this.tags.find((t) => t.key === 'workerId')?.value;\n const messageId = uuid();\n const s3Key = `tests/${this.testId}/overflow/${workerId}/${messageId}.json`;\n\n await this.s3.send(\n new PutObjectCommand({\n Bucket: this.s3Bucket,\n Key: s3Key,\n Body: payload,\n ContentType: 'application/json'\n })\n );\n\n messageBody = JSON.stringify({\n event: body.event,\n _overflowRef: s3Key\n });\n\n _debug(\n 'Payload %d bytes exceeded limit, uploaded to S3: %s',\n payloadSize,\n s3Key\n );\n }\n\n const params = {\n MessageBody: messageBody,\n QueueUrl: this.queueUrl,\n MessageAttributes: this.messageAttributes,\n MessageDeduplicationId: uuid(),\n MessageGroupId: this.testId\n };\n\n await this.sqs.send(new SendMessageCommand(params));\n } catch (err) {\n console.error(err);\n } finally {\n this.unsent--;\n }\n};\n\nArtillerySQSPlugin.prototype.sendAQS = async function (body) {\n this.unsent++;\n sendMessage(this.aqs, body, this.tags)\n .then((_res) => {\n this.unsent--;\n })\n .catch((err) => {\n console.error(err);\n this.unsent--;\n });\n};\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/plugins.js", "content": "module.exports.getAllPluginNames = function () {\n return [...this.getOfficialPlugins(), ...this.getProPlugins()];\n};\n\nmodule.exports.getOfficialPlugins = () => [\n 'ensure',\n 'expect',\n 'metrics-by-endpoint',\n 'publish-metrics',\n 'apdex',\n 'slack'\n ];\n\nmodule.exports.getOfficialEngines = () => ['playwright'];\n\nmodule.exports.getProPlugins = () => ['http-ssl-auth', 'http-file-uploads', 'sqs-reporter'];\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/run-cluster.js", "content": "const {\n ECSClient,\n CreateClusterCommand,\n DescribeClustersCommand,\n RunTaskCommand,\n StopTaskCommand,\n DescribeTaskDefinitionCommand,\n RegisterTaskDefinitionCommand,\n DeregisterTaskDefinitionCommand,\n InvalidParameterException,\n ThrottlingException\n} = require('@aws-sdk/client-ecs');\nconst {\n SQSClient,\n CreateQueueCommand,\n DeleteQueueCommand,\n ListQueuesCommand,\n GetQueueAttributesCommand\n} = require('@aws-sdk/client-sqs');\nconst { GetObjectCommand, NoSuchKey } = require('@aws-sdk/client-s3');\nconst { IAMClient, GetRoleCommand } = require('@aws-sdk/client-iam');\n// Normal debugging for messages, summaries, and errors:\nconst debug = require('debug')('commands:run-test');\n// Verbose debugging for responses from AWS API calls, large objects etc:\nconst debugVerbose = require('debug')('commands:run-test:v');\nconst debugErr = require('debug')('commands:run-test:errors');\nconst _A = require('async');\nconst path = require('node:path');\nconst fs = require('node:fs');\nconst chalk = require('chalk');\nconst defaultOptions = require('rc')('artillery');\nconst moment = require('moment');\n\nconst EnsurePlugin = require('artillery-plugin-ensure');\nconst SlackPlugin = require('artillery-plugin-slack');\n\nconst {\n getADOTRelevantReporterConfigs,\n resolveADOTConfigSettings\n} = require('artillery-plugin-publish-metrics');\n\nconst EventEmitter = require('node:events');\n\nconst _ = require('lodash');\n\nconst pkg = require('../../../../package.json');\nconst { parseTags } = require('./tags');\nconst { Timeout, sleep, timeStringToMs } = require('./time');\nconst { SqsReporter } = require('./sqs-reporter');\n\nconst awaitOnEE = require('../../../../lib/util/await-on-ee');\n\nconst { VPCSubnetFinder } = require('./find-public-subnets');\nconst awsUtil = require('./aws-util');\nconst { createTest } = require('./create-test');\n\nconst createS3Client = require('./create-s3-client');\nconst { getBucketName } = require('./util');\nconst getAccountId = require('../../aws/aws-get-account-id');\nconst { setCloudwatchRetention } = require('../../aws/aws-cloudwatch');\n\nconst dotenv = require('dotenv');\n\nconst util = require('./util');\n\nmodule.exports = runCluster;\n\nlet consoleReporter = {\n toggleSpinner: () => {}\n};\n\nconst {\n TASK_NAME,\n SQS_QUEUES_NAME_PREFIX,\n LOGGROUP_NAME,\n LOGGROUP_RETENTION_DAYS,\n IMAGE_VERSION,\n WAIT_TIMEOUT,\n ARTILLERY_CLUSTER_NAME,\n TEST_RUNS_MAX_TAGS\n} = require('./constants');\n\nconst {\n TestNotFoundError,\n NoAvailableQueueError,\n ClientServerVersionMismatchError\n} = require('./errors');\n\nlet IS_FARGATE = false;\n\nconst TEST_RUN_STATUS = require('./test-run-status');\nconst prepareTestExecutionPlan = require('../../../util/prepare-test-execution-plan');\nconst { PutObjectCommand } = require('@aws-sdk/client-s3');\nconst awsGetDefaultRegion = require('../../aws/aws-get-default-region');\n\nfunction setupConsoleReporter(quiet) {\n const reporterOpts = {\n outputFormat: 'classic',\n printPeriod: false,\n quiet: quiet\n };\n\n if (\n global.artillery?.version?.startsWith('2')\n ) {\n delete reporterOpts.outputFormat;\n delete reporterOpts.printPeriod;\n }\n\n const reporterEvents = new EventEmitter();\n consoleReporter = global.artillery.__createReporter(\n reporterEvents,\n reporterOpts\n );\n\n // // Disable spinner on v1\n if (\n global.artillery?.version &&\n !global.artillery.version.startsWith('2')\n ) {\n consoleReporter.spinner.stop();\n consoleReporter.spinner.clear();\n consoleReporter.spinner = {\n start: () => {},\n stop: () => {},\n clear: () => {}\n };\n }\n\n return {\n reporterEvents\n };\n}\n\nfunction runCluster(scriptPath, options) {\n const artilleryReporter = setupConsoleReporter(options.quiet);\n\n // camelCase all flag names, e.g. `launch-config` becomes launchConfig\n const options2 = {};\n for (const [k, v] of Object.entries(options)) {\n options2[_.camelCase(k)] = v;\n }\n tryRunCluster(scriptPath, options2, artilleryReporter);\n}\n\nfunction logProgress(msg, opts = {}) {\n if (typeof opts.showTimestamp === 'undefined') {\n opts.showTimestamp = true;\n }\n if (global.artillery?.log) {\n artillery.logger(opts).log(msg);\n } else {\n consoleReporter.toggleSpinner();\n artillery.log(\n `${msg} ${chalk.gray(`[${moment().format('HH:mm:ss')}]`)}`\n );\n consoleReporter.toggleSpinner();\n }\n}\n\nasync function tryRunCluster(scriptPath, options, artilleryReporter) {\n global.artillery.awsRegion = (await awsGetDefaultRegion()) || options.region;\n\n let context = {};\n const inputFiles = [].concat(scriptPath, options.config || []);\n const runnableScript = await prepareTestExecutionPlan(inputFiles, options);\n\n context.runnableScript = runnableScript;\n\n let absoluteScriptPath;\n if (typeof scriptPath !== 'undefined') {\n absoluteScriptPath = path.resolve(process.cwd(), scriptPath);\n context.namedTest = false;\n\n try {\n fs.statSync(absoluteScriptPath);\n } catch (_statErr) {\n artillery.log('Could not read file:', scriptPath);\n process.exit(1);\n }\n }\n\n if (options.dotenv) {\n const dotEnvPath = path.resolve(process.cwd(), options.dotenv);\n const contents = fs.readFileSync(dotEnvPath);\n context.dotenv = dotenv.parse(contents);\n }\n\n const cloudKey = options.key || process.env.ARTILLERY_CLOUD_API_KEY;\n if (cloudKey) {\n const cloudEndpoint = process.env.ARTILLERY_CLOUD_ENDPOINT;\n // Explicitly make Artillery Cloud API key available to workers (if it's set)\n // Relying on the fact that contents of context.dotenv gets passed onto workers\n // for it\n context.dotenv = {\n ...context.dotenv,\n ARTILLERY_CLOUD_API_KEY: cloudKey\n };\n\n // Explicitly make Artillery Cloud endpoint available to workers (if it's set)\n if (cloudEndpoint) {\n context.dotenv = {\n ...context.dotenv,\n ARTILLERY_CLOUD_ENDPOINT: cloudEndpoint\n };\n }\n }\n\n if (options.bundle) {\n context.namedTest = true;\n }\n\n if (options.maxDuration) {\n const maxDurationMs = timeStringToMs(options.maxDuration);\n context.maxDurationMs = maxDurationMs;\n }\n\n context.tags = parseTags(options.tags);\n\n if (context.tags.length > TEST_RUNS_MAX_TAGS) {\n console.error(\n chalk.red(\n `A maximum of ${TEST_RUNS_MAX_TAGS} tags is allowed per test run`\n )\n );\n\n process.exit(1);\n }\n\n // Set name tag if not already set:\n if (context.tags.filter((t) => t.name === 'name').length === 0) {\n if (typeof scriptPath !== 'undefined') {\n context.tags.push({\n name: 'name',\n value: path.basename(scriptPath)\n });\n } else {\n context.tags.push({\n name: 'name',\n value: options.bundle\n });\n }\n }\n\n if (options.name) {\n for (const t of context.tags) {\n if (t.name === 'name') {\n t.value = options.name;\n }\n }\n }\n\n context.extraSecrets = options.secret || [];\n\n context.testId = global.artillery.testRunId;\n\n if (context.namedTest) {\n context.s3Prefix = options.bundle;\n debug(`Trying to run a named test: ${context.s3Prefix}`);\n }\n\n if (!context.namedTest) {\n const contextPath = options.context\n ? path.resolve(options.context)\n : path.dirname(absoluteScriptPath);\n\n debugVerbose('script:', absoluteScriptPath);\n debugVerbose('root:', contextPath);\n\n const containerScriptPath = path.join(\n path.relative(contextPath, path.dirname(absoluteScriptPath)),\n path.basename(absoluteScriptPath)\n );\n\n if (containerScriptPath.indexOf('..') !== -1) {\n artillery.log(\n chalk.red(\n 'Test script must reside inside the context dir. See Artillery docs for more details.'\n )\n );\n process.exit(1);\n }\n\n // FIXME: These need clearer names. dir vs path and local vs container.\n context.contextDir = contextPath;\n context.newScriptPath = containerScriptPath;\n\n debug('container script path:', containerScriptPath);\n }\n\n const count = Number(options.count) || 1;\n\n if (typeof options.taskRoleName !== 'undefined') {\n let customRoleName = options.taskRoleName;\n // Allow ARNs for convenience\n // https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html\n // We split by :role because role names may contain slash characters (subpaths)\n if (\n customRoleName.startsWith('arn:aws:iam') ||\n customRoleName.startsWith('arn:aws-cn:iam')\n ) {\n customRoleName = customRoleName.split(':role/')[1];\n }\n context.customTaskRoleName = customRoleName;\n }\n\n const clusterName = options.cluster || ARTILLERY_CLUSTER_NAME;\n if (options.launchConfig) {\n let launchConfig;\n try {\n launchConfig = JSON.parse(options.launchConfig);\n } catch (parseErr) {\n debug(parseErr);\n }\n\n if (!launchConfig) {\n artillery.log(\n chalk.red(\n \"Launch config could not be parsed. Please check that it's valid JSON.\"\n )\n );\n process.exit(1);\n }\n\n if (launchConfig.ulimits && !Array.isArray(launchConfig.ulimits)) {\n // TODO: Proper schema validation for the object\n artillery.log(chalk.red('ulimits must be an array of objects'));\n artillery.log(\n 'Please see AWS documentation for more information:\\nhttps://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html'\n );\n process.exit(1);\n }\n options.launchConfig = launchConfig;\n } else {\n options.launchConfig = {};\n }\n\n if (options.cpu) {\n const n = Number(options.cpu);\n if (Number.isNaN(n)) {\n artillery.log('The value of --cpu must be a number');\n process.exit(1);\n }\n\n // Allow specifying 16 vCPU as either \"16\" or \"16384\". The actual value is\n // validated later.\n const MAX_VCPUS = 16;\n if (n <= MAX_VCPUS) {\n options.launchConfig.cpu = n * 1024;\n } else {\n options.launchConfig.cpu = n;\n }\n }\n\n if (options.memory) {\n const n = Number(options.memory);\n if (Number.isNaN(n)) {\n artillery.log('The value of --memory must be a number');\n process.exit(1);\n }\n\n const MAX_MEMORY_IN_GB = 120;\n if (n <= MAX_MEMORY_IN_GB) {\n options.launchConfig.memory = String(parseInt(options.memory, 10) * 1024);\n } else {\n options.launchConfig.memory = options.memory;\n }\n }\n\n // check launch type is valid:\n if (typeof options.launchType !== 'undefined') {\n if (\n options.launchType !== 'ecs:fargate' &&\n options.launchType !== 'ecs:ec2'\n ) {\n artillery.log(\n 'Invalid launch type - the value of --launch-type needs to be ecs:fargate or ecs:ec2'\n );\n process.exit(1);\n }\n }\n\n if (typeof options.fargate !== 'undefined') {\n console.error(\n 'The --fargate flag is deprecated, use --launch-type ecs:fargate instead'\n );\n }\n\n if (options.fargate && options.launchType) {\n console.error(\n 'Either --fargate or --launch-type flag should be set, not both'\n );\n process.exit(1);\n }\n\n if (\n typeof options.fargate === 'undefined' &&\n typeof options.launchType === 'undefined'\n ) {\n options.launchType = 'ecs:fargate';\n }\n\n IS_FARGATE =\n typeof options.fargate !== 'undefined' || // --fargate set\n typeof options.publicSubnetIds !== 'undefined' || // --public-subnet-ids set\n (typeof options.launchType !== 'undefined' &&\n options.launchType === 'ecs:fargate') || // --launch-type ecs:fargate\n typeof options.launchType === 'undefined';\n\n global.artillery.globalEvents.emit('test:init', {\n flags: options,\n testRunId: context.testId,\n tags: context.tags,\n metadata: {\n testId: context.testId,\n startedAt: Date.now(),\n count,\n tags: context.tags,\n launchType: options.launchType\n }\n });\n\n let packageJsonPath;\n if (options.packages) {\n packageJsonPath = path.resolve(process.cwd(), options.packages);\n try {\n // TODO: Check that filename is package.json\n\n JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));\n } catch (err) {\n console.error('Could not load package dependency list');\n console.error('Trying to read from:', packageJsonPath);\n console.error(err);\n }\n }\n\n context = Object.assign(context, {\n scriptPath: absoluteScriptPath,\n originalScriptPath: scriptPath,\n count: count,\n region: options.region,\n arnPrefix: options.region.startsWith('cn-') ? 'arn:aws-cn' : 'arn:aws',\n taskName: `${TASK_NAME}_${\n IS_FARGATE ? 'fargate' : ''\n }_${clusterName}_${IMAGE_VERSION.replace(/\\./g, '-')}_${Math.floor(\n Math.random() * 1e6\n )}`,\n clusterName: clusterName,\n logGroupName: LOGGROUP_NAME,\n cliOptions: options,\n isFargate: IS_FARGATE,\n isCapacitySpot: typeof options.spot !== 'undefined',\n configTableName: '',\n status: TEST_RUN_STATUS.INITIALIZING,\n packageJsonPath,\n taskArns: []\n });\n\n let subnetIds = [];\n if (options.publicSubnetIds) {\n console.error(\n `${chalk.yellow(\n 'Warning'\n )}: --public-subnet-ids will be deprecated. Use --subnet-ids instead.`\n );\n\n subnetIds = options.publicSubnetIds.split(',');\n }\n if (options.subnetIds) {\n subnetIds = options.subnetIds.split(',');\n }\n\n if (IS_FARGATE) {\n context.fargatePublicSubnetIds = subnetIds;\n context.fargateSecurityGroupIds =\n typeof options.securityGroupIds !== 'undefined'\n ? options.securityGroupIds.split(',')\n : [];\n }\n\n if (global.artillery?.telemetry) {\n global.artillery.telemetry.capture('run-test', {\n version: global.artillery.version,\n proVersion: pkg.version,\n count: count,\n launchPlatform: IS_FARGATE ? 'ecs:fargate' : 'ecs:ec2',\n usesTags: context.tags.length > 0,\n region: context.region,\n crossRegion: context.region !== context.backendRegion\n });\n }\n\n async function newWaterfall(artilleryReporter) {\n let testRunCompletedSuccessfully = true;\n\n let shuttingDown = false;\n\n async function gracefulShutdown(opts = { earlyStop: false, exitCode: 0 }) {\n if (shuttingDown) {\n return;\n }\n\n shuttingDown = true;\n\n if (context.heartbeatIntervalId) {\n clearInterval(context.heartbeatIntervalId);\n context.heartbeatIntervalId = null;\n }\n\n if (opts.earlyStop) {\n if (context.status !== TEST_RUN_STATUS.ERROR) {\n // Retain ERROR status if already set elsewhere\n context.status = TEST_RUN_STATUS.EARLY_STOP;\n }\n }\n await cleanupResources(context);\n\n global.artillery.globalEvents.emit('shutdown:start', {\n exitCode: opts.exitCode,\n earlyStop: opts.earlyStop\n });\n\n const ps = [];\n for (const e of global.artillery.extensionEvents) {\n const testInfo = { endTime: Date.now() };\n if (e.ext === 'beforeExit') {\n ps.push(\n e.method({\n report: context.aggregateReport,\n flags: context.cliOptions,\n runnerOpts: {\n environment: context.cliOptions?.environment,\n scriptPath: '',\n absoluteScriptPath: ''\n },\n testInfo\n })\n );\n }\n }\n await Promise.allSettled(ps);\n\n const ps2 = [];\n const shutdownOpts = {\n earlyStop: opts.earlyStop,\n exitCode: opts.exitCode\n };\n for (const e of global.artillery.extensionEvents) {\n if (e.ext === 'onShutdown') {\n ps2.push(e.method(shutdownOpts));\n }\n }\n await Promise.allSettled(ps2);\n\n process.exit(global.artillery.suggestedExitCode || opts.exitCode);\n }\n\n global.artillery.shutdown = gracefulShutdown;\n\n process.on('SIGINT', async () => {\n if (shuttingDown) {\n return;\n }\n console.log('Stopping test run (SIGINT received)...');\n await gracefulShutdown({ exitCode: 1, earlyStop: true });\n });\n process.on('SIGTERM', async () => {\n if (shuttingDown) {\n return;\n }\n console.log('Stopping test run (SIGTERM received)...');\n await gracefulShutdown({ exitCode: 1, earlyStop: true });\n });\n\n // Messages from SQS reporter created later will be relayed via this EE\n context.reporterEvents = artilleryReporter.reporterEvents;\n\n try {\n logProgress('Checking AWS connectivity...');\n context.accountId = await getAccountId({ region: context.region });\n await Promise.all([\n (async (context) => {\n const bucketName = await getBucketName();\n context.s3Bucket = bucketName;\n return context;\n })(context)\n ]);\n\n logProgress('Checking cluster...');\n const clusterExists = await checkTargetCluster(context);\n\n if (!clusterExists) {\n if (typeof context.cliOptions.cluster === 'undefined') {\n // User did not specify a cluster with --cluster, and ARTILLERY_CLUSTER_NAME\n // does not exist, so create it\n await createArtilleryCluster(context);\n } else {\n // User specified a cluster, but it's not there\n throw new Error(\n `Could not find cluster ${context.clusterName} in ${context.region}`\n );\n }\n }\n\n if (context.tags.length > 0) {\n logProgress(\n `Tags: ${context.tags.map((t) => `${t.name}:${t.value}`).join(', ')}`\n );\n }\n logProgress(`Test run ID: ${context.testId}`);\n\n logProgress('Preparing launch platform...');\n\n await maybeGetSubnetIdsForFargate(context);\n\n logProgress(\n `Environment:\n Account: ${context.accountId}\n Region: ${context.region}\n Count: ${context.count}\n Cluster: ${context.clusterName}\n Launch type: ${context.cliOptions.launchType} ${\n context.isFargate && context.isCapacitySpot ? '(Spot)' : '(On-demand)'\n }\n`,\n { showTimestamp: false }\n );\n\n await createQueue(context);\n await checkCustomTaskRole(context);\n logProgress('Preparing test bundle...');\n await createTestBundle(context);\n await createADOTDefinitionIfNeeded(context);\n await ensureTaskExists(context);\n await getManifest(context);\n await generateTaskOverrides(context);\n\n logProgress('Launching workers...');\n await setupDefaultECSParams(context);\n\n if (\n context.status !== TEST_RUN_STATUS.EARLY_STOP &&\n context.status !== TEST_RUN_STATUS.TERMINATING\n ) {\n // Set up SQS listener:\n listen(context, artilleryReporter.reporterEvents);\n await launchLeadTask(context);\n }\n\n setCloudwatchRetention(\n `${LOGGROUP_NAME}/${context.clusterName}`,\n LOGGROUP_RETENTION_DAYS,\n context.region,\n {\n maxRetries: 10,\n waitPerRetry: 2 * 1000\n }\n );\n\n if (\n context.status !== TEST_RUN_STATUS.EARLY_STOP &&\n context.status !== TEST_RUN_STATUS.TERMINATING\n ) {\n logProgress(\n context.isFargate ? 'Waiting for Fargate...' : 'Waiting for ECS...'\n );\n await ecsRunTask(context);\n }\n\n if (\n context.status !== TEST_RUN_STATUS.EARLY_STOP &&\n context.status !== TEST_RUN_STATUS.TERMINATING\n ) {\n await waitForTasks2(context);\n }\n\n if (\n context.status !== TEST_RUN_STATUS.EARLY_STOP &&\n context.status !== TEST_RUN_STATUS.TERMINATING\n ) {\n // Start heartbeat before waitForWorkerSync so that workers that are\n // already up can see heartbeats while the rest of the pool provisions.\n // With 500+ Fargate tasks this window can be 10+ minutes.\n context.heartbeatIntervalId = startHeartbeat(context);\n logProgress('Waiting for workers to come online...');\n await waitForWorkerSync(context);\n await sendGoSignal(context);\n logProgress('Workers are running, waiting for reports...');\n\n if (context.maxDurationMs && context.maxDurationMs > 0) {\n logProgress(\n `Max duration for test run is set to: ${context.cliOptions.maxDuration}`\n );\n const testDurationTimeout = new Timeout(context.maxDurationMs);\n testDurationTimeout.start();\n testDurationTimeout.on('timeout', async () => {\n artillery.log(\n `Max duration of test run exceeded: ${context.cliOptions.maxDuration}\\n`\n );\n await gracefulShutdown({ earlyStop: true });\n });\n }\n\n context.status = TEST_RUN_STATUS.RECEIVING_REPORTS;\n }\n\n // Need to wait for all reports to be over here, not exit\n const workerState = await awaitOnEE(\n artilleryReporter.reporterEvents,\n 'workersDone'\n );\n debug(workerState);\n\n logProgress(`Test run completed: ${context.testId}`);\n\n context.status = TEST_RUN_STATUS.COMPLETED;\n\n let checks = [];\n global.artillery.globalEvents.once('checks', async (results) => {\n checks = results;\n });\n\n if (context.ensureSpec) {\n new EnsurePlugin.Plugin({ config: { ensure: context.ensureSpec } });\n }\n\n if (context.fullyResolvedConfig?.plugins?.slack) {\n new SlackPlugin.Plugin({\n config: context.fullyResolvedConfig\n });\n }\n\n if (context.cliOptions.output) {\n const logfile = getLogFilename(\n context.cliOptions.output,\n defaultOptions.logFilenameFormat\n );\n\n for (const ix of context.intermediateReports) {\n delete ix.histograms;\n ix.histograms = ix.summaries;\n }\n delete context.aggregateReport.histograms;\n context.aggregateReport.histograms = context.aggregateReport.summaries;\n\n const jsonReport = {\n intermediate: context.intermediateReports,\n aggregate: context.aggregateReport,\n testId: context.testId,\n metadata: {\n tags: context.tags,\n count: context.count,\n region: context.region,\n cluster: context.clusterName,\n artilleryVersion: {\n core: global.artillery.version,\n pro: pkg.version\n }\n },\n ensure: checks.map((c) => {\n return {\n condition: c.original,\n success: c.result === 1,\n strict: c.strict\n };\n })\n };\n\n fs.writeFileSync(logfile, JSON.stringify(jsonReport, null, 2), {\n flag: 'w'\n });\n }\n debug(context.testId, 'done');\n } catch (err) {\n debug(err);\n if (err instanceof InvalidParameterException) {\n if (\n err.message\n .toLowerCase()\n .indexOf('no container instances were found') !== -1\n ) {\n artillery.log(\n chalk.yellow('The ECS cluster has no active EC2 instances')\n );\n } else {\n artillery.log(err);\n }\n } else if (err instanceof TestNotFoundError) {\n artillery.log(`Test ${context.s3Prefix} not found`);\n } else if (\n err instanceof NoAvailableQueueError ||\n err instanceof ClientServerVersionMismatchError\n ) {\n artillery.log(chalk.red('Error:', err.message));\n } else {\n artillery.log(util.formatError(err));\n artillery.log(err);\n artillery.log(err.stack);\n }\n testRunCompletedSuccessfully = false;\n global.artillery.suggestedExitCode = 1;\n } finally {\n if (!testRunCompletedSuccessfully) {\n logProgress('Cleaning up...');\n context.status = TEST_RUN_STATUS.ERROR;\n await gracefulShutdown({ earlyStop: true, exitCode: 1 });\n } else {\n context.status = TEST_RUN_STATUS.COMPLETED;\n await gracefulShutdown({ earlyStop: false, exitCode: 0 });\n }\n }\n }\n\n await newWaterfall(artilleryReporter);\n}\n\nasync function cleanupResources(context) {\n try {\n if (context.sqsReporter) {\n context.sqsReporter.stop();\n }\n\n if (context.adot?.SSMParameterPath) {\n await awsUtil.deleteParameter(\n context.adot.SSMParameterPath,\n context.region\n );\n }\n\n if (context.taskArns && context.taskArns.length > 0) {\n for (const taskArn of context.taskArns) {\n try {\n const ecs = new ECSClient({\n apiVersion: '2014-11-13',\n region: context.region\n });\n await ecs.send(\n new StopTaskCommand({\n task: taskArn,\n cluster: context.clusterName,\n reason: 'Test cleanup'\n })\n );\n } catch (err) {\n // TODO: Retry if appropriate, give the user more information\n // to be able to fall back to manual intervention if possible.\n // TODO: Consumer has no idea if this succeeded or not\n debug(err);\n }\n }\n }\n\n // TODO: Should either retry, or not throw in any of these\n await Promise.all([\n deleteQueue(context),\n deregisterTaskDefinition(context),\n gcQueues(context)\n ]);\n } catch (err) {\n artillery.log(err);\n }\n}\n\nfunction checkFargateResourceConfig(cpu, memory) {\n function generateListOfOptionsMiB(minGB, maxGB, incrementGB) {\n const result = [];\n for (let i = 0; i <= (maxGB - minGB) / incrementGB; i++) {\n result.push((minGB + incrementGB * i) * 1024);\n }\n\n return result;\n }\n\n // Based on https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-cpu-memory-error.html\n const FARGATE_VALID_CONFIGS = {\n 256: [512, 1024, 2048],\n 512: [1024, 2048, 3072, 4096],\n 1024: [2048, 3072, 4096, 5120, 6144, 7168, 8192],\n 2048: generateListOfOptionsMiB(4, 16, 1),\n 4096: generateListOfOptionsMiB(8, 30, 1),\n 8192: generateListOfOptionsMiB(16, 60, 4),\n 16384: generateListOfOptionsMiB(32, 120, 8)\n };\n\n if (!FARGATE_VALID_CONFIGS[cpu]) {\n return new Error(\n `Unsupported cpu override for Fargate. Must be one of: ${Object.keys(\n FARGATE_VALID_CONFIGS\n ).join(', ')}`\n );\n }\n\n if (FARGATE_VALID_CONFIGS[cpu].indexOf(memory) < 0) {\n return new Error(\n `Fargate memory override for cpu = ${cpu} must be one of: ${FARGATE_VALID_CONFIGS[\n cpu\n ].join(', ')}`\n );\n }\n\n return null;\n}\n\nasync function createArtilleryCluster(context) {\n const ecs = new ECSClient({\n apiVersion: '2014-11-13',\n region: context.region\n });\n await ecs.send(\n new CreateClusterCommand({\n clusterName: ARTILLERY_CLUSTER_NAME,\n capacityProviders: ['FARGATE_SPOT']\n })\n );\n\n let retries = 0;\n while (retries < 12) {\n const clusterActive = await checkTargetCluster(context);\n if (clusterActive) {\n break;\n }\n retries++;\n await sleep(10 * 1000);\n }\n}\n\n//\n// Check that ECS cluster exists:\n//\nasync function checkTargetCluster(context) {\n const ecs = new ECSClient({\n apiVersion: '2014-11-13',\n region: context.region\n });\n try {\n const response = await ecs.send(\n new DescribeClustersCommand({ clusters: [context.clusterName] })\n );\n debug(response);\n if (response.clusters.length === 0 || response.failures.length > 0) {\n debugVerbose(response);\n return false;\n } else {\n const activeClusters = response.clusters.filter(\n (c) => c.status === 'ACTIVE'\n );\n return activeClusters.length > 0;\n }\n } catch (err) {\n debugVerbose(err);\n return false;\n }\n}\n\nasync function maybeGetSubnetIdsForFargate(context) {\n if (!context.isFargate) {\n return context;\n }\n\n // TODO: Sanity check that subnets actually exist before trying to use them in test definitions\n\n if (context.fargatePublicSubnetIds.length > 0) {\n return context;\n }\n\n debug('Subnet IDs not provided, looking up default VPC');\n\n const f = new VPCSubnetFinder({ region: context.region });\n const publicSubnets = await f.findPublicSubnets();\n\n if (publicSubnets.length === 0) {\n throw new Error('Could not find public subnets in default VPC');\n }\n\n context.fargatePublicSubnetIds = publicSubnets.map((s) => s.SubnetId);\n\n debug('Found public subnets:', context.fargatePublicSubnetIds.join(', '));\n\n return context;\n}\n\nasync function createTestBundle(context) {\n const result = await createTest(context.scriptPath, {\n name: context.testId,\n config: context.cliOptions.config,\n packageJsonPath: context.packageJsonPath,\n flags: context.cliOptions\n });\n\n context.fullyResolvedConfig = result.manifest.fullyResolvedConfig;\n\n return context;\n}\n\nasync function createADOTDefinitionIfNeeded(context) {\n const publishMetricsConfig =\n context.fullyResolvedConfig.plugins?.['publish-metrics'];\n if (!publishMetricsConfig) {\n debug('No publish-metrics plugin set, skipping ADOT configuration');\n return context;\n }\n\n const adotRelevantConfigs =\n getADOTRelevantReporterConfigs(publishMetricsConfig);\n if (adotRelevantConfigs.length === 0) {\n debug('No ADOT relevant reporter configs set, skipping ADOT configuration');\n return context;\n }\n\n try {\n const { adotEnvVars, adotConfig } = resolveADOTConfigSettings({\n configList: adotRelevantConfigs,\n dotenv: { ...context.dotenv }\n });\n\n context.dotenv = Object.assign(context.dotenv || {}, adotEnvVars);\n\n context.adot = {\n SSMParameterPath: `/artilleryio/OTEL_CONFIG_${context.testId}`\n };\n\n await awsUtil.putParameter(\n context.adot.SSMParameterPath,\n JSON.stringify(adotConfig),\n 'String',\n context.region\n );\n\n context.adot.taskDefinition = {\n name: 'adot-collector',\n image: 'amazon/aws-otel-collector:v0.39.0',\n command: [\n '--config=/etc/ecs/container-insights/otel-task-metrics-config.yaml'\n ],\n secrets: [\n {\n name: 'AOT_CONFIG_CONTENT',\n valueFrom: `${context.arnPrefix}:ssm:${context.region}:${context.accountId}:parameter${context.adot.SSMParameterPath}`\n }\n ],\n logConfiguration: {\n logDriver: 'awslogs',\n options: {\n 'awslogs-group': `${context.logGroupName}/${context.clusterName}`,\n 'awslogs-region': context.region,\n 'awslogs-stream-prefix': `artilleryio/${context.testId}`,\n 'awslogs-create-group': 'true'\n }\n }\n };\n } catch (err) {\n throw new Error(err);\n }\n return context;\n}\n\nasync function ensureTaskExists(context) {\n const ecs = new ECSClient({\n apiVersion: '2014-11-13',\n region: context.region\n });\n\n // Note: these are integers for container definitions, and strings for task definitions (on Fargate)\n // Defaults have to be Fargate-compatible\n // https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size\n let cpu = 4096;\n let memory = 8192;\n\n const defaultUlimits = {\n nofile: {\n softLimit: 8192,\n hardLimit: 8192\n }\n };\n let ulimits = [];\n\n if (context.cliOptions.launchConfig) {\n const lc = context.cliOptions.launchConfig;\n if (lc.cpu) {\n cpu = parseInt(lc.cpu, 10);\n }\n if (lc.memory) {\n memory = parseInt(lc.memory, 10);\n }\n\n if (lc.ulimits) {\n lc.ulimits.forEach((u) => {\n if (!defaultUlimits[u.name]) {\n defaultUlimits[u.name] = {};\n }\n defaultUlimits[u.name] = {\n softLimit: u.softLimit,\n hardLimit: typeof u.hardLimit === 'number' ? u.hardLimit : u.softLimit\n };\n });\n }\n\n // TODO: Check this earlier to return an error faster.\n if (context.isFargate) {\n const configErr = checkFargateResourceConfig(cpu, memory);\n if (configErr) {\n throw configErr;\n }\n }\n }\n\n ulimits = Object.keys(defaultUlimits).map((name) => {\n return {\n name: name,\n softLimit: defaultUlimits[name].softLimit,\n hardLimit: defaultUlimits[name].hardLimit\n };\n });\n\n const defaultArchitecture = 'x86_64';\n const imageUrl =\n process.env.WORKER_IMAGE_URL ||\n `public.ecr.aws/d8a4z9o5/artillery-worker:${IMAGE_VERSION}-${defaultArchitecture}`;\n\n const secrets = [\n 'NPM_TOKEN',\n 'NPM_REGISTRY',\n 'NPM_SCOPE',\n 'NPM_SCOPE_REGISTRY',\n 'NPMRC',\n 'ARTIFACTORY_AUTH',\n 'ARTIFACTORY_EMAIL'\n ]\n .concat(context.extraSecrets)\n .map((secretName) => {\n return {\n name: secretName,\n valueFrom: `${context.arnPrefix}:ssm:${context.region}:${context.accountId}:parameter/artilleryio/${secretName}`\n };\n });\n\n const artilleryContainerDefinition = {\n name: 'artillery',\n image: imageUrl,\n cpu: cpu,\n command: [],\n entryPoint: ['/artillery/loadgen-worker'],\n memory: memory,\n secrets: secrets,\n ulimits: ulimits,\n essential: true,\n logConfiguration: {\n logDriver: 'awslogs',\n options: {\n 'awslogs-group': `${context.logGroupName}/${context.clusterName}`,\n 'awslogs-region': context.region,\n 'awslogs-stream-prefix': `artilleryio/${context.testId}`,\n 'awslogs-create-group': 'true',\n mode: 'non-blocking'\n }\n }\n };\n\n if (context.cliOptions.containerDnsServers) {\n artilleryContainerDefinition.dnsServers =\n context.cliOptions.containerDnsServers.split(',');\n }\n\n const taskDefinition = {\n family: context.taskName,\n containerDefinitions: [artilleryContainerDefinition],\n executionRoleArn: context.taskRoleArn\n };\n\n if (typeof context.adot !== 'undefined') {\n taskDefinition.containerDefinitions.push(context.adot.taskDefinition);\n }\n\n context.taskDefinition = taskDefinition;\n\n if (!context.isFargate && taskDefinition.containerDefinitions.length > 1) {\n // Limits for sidecar have to be set explicitly on ECS EC2\n taskDefinition.containerDefinitions[1].memory = 1024;\n taskDefinition.containerDefinitions[1].cpu = 1024;\n }\n\n if (context.isFargate) {\n taskDefinition.networkMode = 'awsvpc';\n taskDefinition.requiresCompatibilities = ['FARGATE'];\n taskDefinition.cpu = String(cpu);\n taskDefinition.memory = String(memory);\n // NOTE: This role must exist.\n // This value cannot be an override, meaning it's hardcoded into the task definition.\n // That in turn means that if the role is updated then the task definition needs to be\n // recreated too\n taskDefinition.executionRoleArn = context.taskRoleArn; // TODO: A separate role for Fargate\n }\n\n const params = {\n taskDefinition: context.taskName\n };\n\n debug('Task definition\\n', JSON.stringify(taskDefinition, null, 4));\n\n try {\n await ecs.send(new DescribeTaskDefinitionCommand(params));\n debug('OK: ECS task exists');\n if (process.env.ECR_IMAGE_VERSION) {\n debug(\n 'ECR_IMAGE_VERSION is set, but the task definition was already in place.'\n );\n }\n return context;\n } catch (_err) {\n try {\n const response = await ecs.send(\n new RegisterTaskDefinitionCommand(taskDefinition)\n );\n debug('OK: ECS task registered');\n debugVerbose(JSON.stringify(response, null, 4));\n context.taskDefinitionArn = response.taskDefinition.taskDefinitionArn;\n debug(`Task definition ARN: ${context.taskDefinitionArn}`);\n return context;\n } catch (registerErr) {\n artillery.log(registerErr);\n artillery.log('Could not create ECS task, please try again');\n throw registerErr;\n }\n }\n}\n\nasync function checkCustomTaskRole(context) {\n if (!context.customTaskRoleName) {\n return;\n }\n\n const iam = new IAMClient({ region: global.artillery.awsRegion });\n const roleData = await iam.send(\n new GetRoleCommand({ RoleName: context.customTaskRoleName })\n );\n context.customRoleArn = roleData.Role.Arn;\n context.taskRoleArn = roleData.Role.Arn;\n debug(roleData);\n}\n\nasync function gcQueues(context) {\n const sqs = new SQSClient({\n region: context.region\n });\n\n let data;\n try {\n data = await sqs.send(\n new ListQueuesCommand({\n QueueNamePrefix: SQS_QUEUES_NAME_PREFIX,\n MaxResults: 1000\n })\n );\n } catch (err) {\n debug(err);\n }\n\n if (data?.QueueUrls && data.QueueUrls.length > 0) {\n for (const qu of data.QueueUrls) {\n try {\n const data = await sqs.send(\n new GetQueueAttributesCommand({\n QueueUrl: qu,\n AttributeNames: ['CreatedTimestamp']\n })\n );\n const ts = Number(data.Attributes.CreatedTimestamp) * 1000;\n // Delete after 96 hours\n if (Date.now() - ts > 96 * 60 * 60 * 1000) {\n await sqs.send(new DeleteQueueCommand({ QueueUrl: qu }));\n }\n } catch (err) {\n // TODO: Filter on errors which may be ignored, e.g.:\n // AWS.SimpleQueueService.NonExistentQueue: The specified queue does not exist\n // which can happen if another test ends between calls to listQueues and getQueueAttributes.\n // Sometimes SQS returns recently deleted queues to ListQueues too.\n debug(err);\n }\n }\n }\n}\n\nasync function deleteQueue(context) {\n if (!context.sqsQueueUrl) {\n return;\n }\n\n const sqs = new SQSClient({\n region: context.region\n });\n\n try {\n await sqs.send(new DeleteQueueCommand({ QueueUrl: context.sqsQueueUrl }));\n } catch (err) {\n console.error(`Unable to clean up SQS queue. URL: ${context.sqsQueueUrl}`);\n debug(err);\n }\n}\n\nasync function createQueue(context) {\n const sqs = new SQSClient({\n region: context.region\n });\n\n const queueName = `${SQS_QUEUES_NAME_PREFIX}_${context.testId.slice(\n 0,\n 30\n )}.fifo`;\n const params = {\n QueueName: queueName,\n Attributes: {\n FifoQueue: 'true',\n ContentBasedDeduplication: 'false',\n MessageRetentionPeriod: '1800',\n VisibilityTimeout: '600' // 10 minutes\n }\n };\n const result = await sqs.send(new CreateQueueCommand(params));\n context.sqsQueueUrl = result.QueueUrl;\n\n // Wait for the queue to be available:\n let waited = 0;\n let ok = false;\n while (waited < 120 * 1000) {\n try {\n const results = await sqs.send(\n new ListQueuesCommand({ QueueNamePrefix: queueName })\n );\n if (results.QueueUrls && results.QueueUrls.length === 1) {\n debug('SQS queue created:', queueName);\n ok = true;\n break;\n } else {\n await sleep(10 * 1000);\n waited += 10 * 1000;\n }\n } catch (_err) {\n await sleep(10 * 1000);\n waited += 10 * 1000;\n }\n }\n\n if (!ok) {\n debug('Time out waiting for SQS queue:', queueName);\n throw new Error('SQS queue could not be created');\n }\n}\n\nasync function getManifest(context) {\n try {\n const s3 = createS3Client({ region: global.artillery.s3BucketRegion });\n const params = {\n Bucket: context.s3Bucket,\n Key: `tests/${context.testId}/metadata.json`\n };\n\n const data = await s3.send(new GetObjectCommand(params));\n const metadata = JSON.parse(await data.Body.transformToString());\n context.newScriptPath = metadata.scriptPath;\n\n if (metadata.configPath) {\n context.configPath = metadata.configPath;\n }\n\n return context;\n } catch (err) {\n if (err instanceof NoSuchKey) {\n throw new TestNotFoundError();\n } else {\n throw err;\n }\n }\n}\n\nasync function generateTaskOverrides(context) {\n const cliArgs = ['run'].concat(\n context.cliOptions.environment\n ? ['--environment', context.cliOptions.environment]\n : [],\n context.cliOptions['scenarioName']\n ? ['--scenario-name', context.cliOptions['scenarioName']]\n : [],\n context.cliOptions.insecure ? ['-k'] : [],\n context.cliOptions.target ? ['-t', context.cliOptions.target] : [],\n context.cliOptions.overrides\n ? ['--overrides', context.cliOptions.overrides]\n : [],\n context.cliOptions.variables\n ? ['--variables', context.cliOptions.variables]\n : [],\n context.configPath ? ['--config', context.configPath] : []\n );\n // NOTE: This MUST come last:\n cliArgs.push(context.newScriptPath);\n\n debug('cliArgs', cliArgs, cliArgs.join(' '));\n\n const s3path = `s3://${context.s3Bucket}/tests/${\n context.namedTest ? context.s3Prefix : context.testId\n }`;\n const adotOverride = [\n {\n name: 'adot-collector',\n environment: []\n }\n ];\n\n const overrides = {\n containerOverrides: [\n {\n name: 'artillery',\n command: [\n '-p',\n s3path,\n '-a',\n util.btoa(JSON.stringify(cliArgs)),\n '-r',\n context.region,\n '-q',\n process.env.SQS_QUEUE_URL || context.sqsQueueUrl,\n '-i',\n context.testId,\n '-d',\n `s3://${context.s3Bucket}/test-runs`,\n '-t',\n String(WAIT_TIMEOUT)\n ],\n environment: [\n {\n name: 'AWS_SDK_JS_SUPPRESS_MAINTENANCE_MODE_MESSAGE',\n value: '1'\n },\n {\n name: 'ARTILLERY_TEST_RUN_ID',\n value: global.artillery.testRunId\n },\n {\n name: 'ARTILLERY_S3_BUCKET',\n value: context.s3Bucket\n }\n ]\n },\n ...(context.adot ? adotOverride : [])\n ],\n taskRoleArn: context.taskRoleArn\n };\n\n if (context.customRoleArn) {\n overrides.taskRoleArn = context.customRoleArn;\n }\n\n if (context.cliOptions.taskEphemeralStorage) {\n overrides.ephemeralStorage = {\n sizeInGiB: context.cliOptions.taskEphemeralStorage\n };\n }\n\n overrides.containerOverrides[0].environment.push({\n name: 'USE_V2',\n value: 'true'\n });\n\n if (context.dotenv) {\n const extraEnv = [];\n for (const [name, value] of Object.entries(context.dotenv)) {\n extraEnv.push({ name, value });\n }\n overrides.containerOverrides[0].environment =\n overrides.containerOverrides[0].environment.concat(extraEnv);\n if (overrides.containerOverrides[1]) {\n overrides.containerOverrides[1].environment =\n overrides.containerOverrides[1].environment.concat(extraEnv);\n }\n }\n\n if (context.cliOptions.launchConfig) {\n const lc = context.cliOptions.launchConfig;\n if (lc.environment) {\n overrides.containerOverrides[0].environment =\n overrides.containerOverrides[0].environment.concat(lc.environment);\n if (overrides.containerOverrides[1]) {\n overrides.containerOverrides[1].environment =\n overrides.containerOverrides[1].environment.concat(lc.environment);\n }\n }\n\n //\n // Not officially supported:\n //\n if (lc.taskRoleArn) {\n overrides.taskRoleArn = lc.taskRoleArn;\n }\n if (lc.command) {\n overrides.containerOverrides[0].command = lc.command;\n }\n }\n\n debug('OK: Overrides generated');\n debugVerbose(JSON.stringify(overrides, null, 4));\n\n context.taskOverrides = overrides;\n\n return context;\n}\n\nasync function setupDefaultECSParams(context) {\n const defaultParams = {\n taskDefinition: context.taskName,\n cluster: context.clusterName,\n overrides: context.taskOverrides,\n startedBy: context.testId\n };\n\n if (context.isFargate) {\n if (context.isCapacitySpot) {\n defaultParams.capacityProviderStrategy = [\n {\n capacityProvider: 'FARGATE_SPOT',\n weight: 1,\n base: 0\n }\n ];\n } else {\n // On-demand capacity\n defaultParams.launchType = 'FARGATE';\n }\n // Networking config: private subnets of the VPC that the ECS cluster\n // is in. Don't need public subnets.\n defaultParams.networkConfiguration = {\n awsvpcConfiguration: {\n // https://github.com/aws/amazon-ecs-agent/issues/1128\n assignPublicIp: context.cliOptions.noAssignPublicIp\n ? 'DISABLED'\n : 'ENABLED',\n securityGroups: context.fargateSecurityGroupIds,\n subnets: context.fargatePublicSubnetIds\n }\n };\n } else {\n defaultParams.launchType = 'EC2';\n }\n\n context.defaultECSParams = defaultParams;\n return context;\n}\n\nasync function launchLeadTask(context) {\n const metadata = {\n testId: context.testId,\n startedAt: Date.now(),\n cluster: context.clusterName,\n region: context.region,\n launchType: context.cliOptions.launchType,\n isFargateSpot: context.isCapacitySpot,\n count: context.count,\n sqsQueueUrl: context.sqsQueueUrl,\n tags: context.tags,\n secrets: JSON.stringify(\n Array.isArray(context.extraSecrets)\n ? context.extraSecrets\n : [context.extraSecrets]\n ),\n platformConfig: JSON.stringify({\n memory: context.taskDefinition.containerDefinitions[0].memory,\n cpu: context.taskDefinition.containerDefinitions[0].cpu\n }),\n artilleryVersion: JSON.stringify({\n core: global.artillery.version\n }),\n // Properties from the runnable script object:\n testConfig: {\n target: context.runnableScript.config.target,\n phases: context.runnableScript.config.phases,\n plugins: context.runnableScript.config.plugins,\n environment: context.runnableScript._environment,\n scriptPath: context.runnableScript._scriptPath,\n configPath: context.runnableScript._configPath\n }\n };\n\n artillery.globalEvents.emit('metadata', metadata);\n\n context.status = TEST_RUN_STATUS.LAUNCHING_WORKERS;\n\n const ecs = new ECSClient({\n apiVersion: '2014-11-13',\n region: context.region\n });\n\n const leaderParams = Object.assign(\n { count: 1 },\n JSON.parse(JSON.stringify(context.defaultECSParams))\n );\n leaderParams.overrides.containerOverrides[0].environment.push({\n name: 'IS_LEADER',\n value: 'true'\n });\n const runData = await ecs.send(new RunTaskCommand(leaderParams));\n if (runData.failures.length > 0) {\n if (runData.failures.length === context.count) {\n artillery.log('ERROR: Worker start failure');\n const uniqueReasons = [\n ...new Set(runData.failures.map((f) => f.reason))\n ];\n artillery.log('Reason:', uniqueReasons);\n throw new Error('Could not start workers');\n } else {\n artillery.log('WARNING: Some workers failed to start');\n artillery.log(chalk.red(JSON.stringify(runData.failures, null, 4)));\n throw new Error('Not enough capacity - terminating');\n }\n }\n\n context.taskArns = context.taskArns.concat(\n runData.tasks.map((task) => task.taskArn)\n );\n artillery.globalEvents.emit('metadata', {\n platformMetadata: { taskArns: context.taskArns }\n });\n\n return context;\n}\n\n// TODO: When launching >20 containers on Fargate, adjust WAIT_TIMEOUT dynamically to\n// add extra time spent in waiting between runTask calls: WAIT_TIMEOUT + worker_count.\nasync function ecsRunTask(context) {\n const ecs = new ECSClient({\n apiVersion: '2014-11-13',\n region: context.region\n });\n let tasksRemaining = context.count - 1;\n let retries = 0;\n\n while (\n tasksRemaining > 0 &&\n context.status !== TEST_RUN_STATUS.TERMINATING &&\n context.status !== TEST_RUN_STATUS.EARLY_STOP\n ) {\n if (retries >= 10) {\n artillery.log('Max retries for ECS (10) exceeded');\n throw new Error('Max retries exceeded');\n }\n\n const launchCount = tasksRemaining <= 10 ? tasksRemaining : 10;\n const params = Object.assign(\n { count: launchCount },\n JSON.parse(JSON.stringify(context.defaultECSParams))\n );\n\n params.overrides.containerOverrides[0].environment.push({\n name: 'IS_LEADER',\n value: 'false'\n });\n\n try {\n const runData = await ecs.send(new RunTaskCommand(params));\n\n const launchedTasksCount = runData.tasks?.length || 0;\n tasksRemaining -= launchedTasksCount;\n\n if (launchedTasksCount > 0) {\n const newTaskArns = runData.tasks.map((task) => task.taskArn);\n context.taskArns = context.taskArns.concat(newTaskArns);\n artillery.globalEvents.emit('metadata', {\n platformMetadata: { taskArns: newTaskArns }\n });\n debug(`Launched ${launchedTasksCount} tasks`);\n }\n\n if (runData.failures.length > 0) {\n artillery.log('Some workers failed to start');\n const uniqueReasons = [\n ...new Set(runData.failures.map((f) => f.reason))\n ];\n artillery.log(chalk.red(uniqueReasons));\n artillery.log('Retrying...');\n await sleep(10 * 1000);\n throw new Error('Not enough ECS capacity');\n }\n } catch (runErr) {\n if (runErr instanceof ThrottlingException) {\n artillery.log('ThrottlingException returned from ECS, retrying');\n await sleep(2000 * retries);\n debug('runTask throttled, retrying');\n debug(runErr);\n } else if (runErr.message.match(/Not enough ECS capacity/gi)) {\n // Do nothing\n } else {\n artillery.log(runErr);\n }\n\n retries++;\n if (retries >= 10) {\n artillery.log('Max retries for ECS (10) exceeded');\n throw runErr;\n }\n }\n }\n return context;\n}\n\nasync function waitForTasks2(context) {\n const params = {\n tasks: context.taskArns,\n cluster: context.clusterName\n };\n\n let failedTasks = [];\n let stoppedTasks = [];\n let maybeErr = null;\n\n const silentWaitTimeout = new Timeout(30 * 1000).start(); // wait this long before updating the user\n const waitTimeout = new Timeout(60 * 1000).start(); // wait for up to 1 minute\n while (context.status !== TEST_RUN_STATUS.TERMINATING) {\n let ecsData;\n try {\n ecsData = await awsUtil.ecsDescribeTasks(params, context.region);\n } catch (err) {\n // TODO: Inspect err for any conditions in which we may want to abort immediately.\n // Otherwise, let the timeout run to completion.\n debug(err);\n await sleep(5000);\n continue;\n }\n\n // All tasks are RUNNING, proceed:\n if (_.every(ecsData.tasks, (s) => s.lastStatus === 'RUNNING')) {\n logProgress('All workers started...');\n debug('All tasks in RUNNING state');\n break;\n }\n\n // If there are STOPPED tasks, we need to stop:\n stoppedTasks = ecsData.tasks.filter((t) => t.lastStatus === 'STOPPED');\n if (stoppedTasks.length > 0) {\n debug('Some tasks in STOPPED state');\n debugErr(stoppedTasks);\n // TODO: Stop RUNNING tasks and clean up (release queue lock, deregister task definition)\n // TODO: Provide more information here, e.g. task ARNs, or CloudWatch log group ID\n maybeErr = new Error('Worker init failure, aborting test');\n break;\n }\n\n // If some tasks failed to start altogether, abort:\n if (ecsData.failures.length > 0) {\n failedTasks = ecsData.failures;\n debug('Some tasks failed to start');\n debugErr(ecsData.failures);\n maybeErr = new Error('Worker start up failure, aborting test');\n break;\n }\n\n // If there are PENDING, update progress bar\n debug('Waiting on pending tasks');\n if (silentWaitTimeout.timedout()) {\n const statusCounts = _.countBy(ecsData.tasks, 'lastStatus');\n const statusSummary = _.map(statusCounts, (count, status) => {\n const displayStatus =\n status === 'RUNNING' ? 'ready' : status.toLowerCase();\n let displayStatusChalked = displayStatus;\n if (displayStatus === 'ready') {\n displayStatusChalked = chalk.green(displayStatus);\n } else if (displayStatus === 'pending') {\n displayStatusChalked = chalk.yellow(displayStatus);\n }\n\n return `${displayStatusChalked}: ${count}`;\n }).join(' / ');\n\n logProgress(`Waiting for workers to start: ${statusSummary}`);\n }\n\n if (waitTimeout.timedout()) {\n // TODO: Clean up RUNNING tasks etc\n break;\n }\n await sleep(10 * 1000);\n } // while\n waitTimeout.stop();\n\n if (maybeErr) {\n if (stoppedTasks.length > 0) {\n artillery.log(stoppedTasks);\n }\n if (failedTasks.length > 0) {\n artillery.log(failedTasks);\n }\n throw maybeErr;\n }\n\n return context;\n}\n\nasync function waitForWorkerSync(context) {\n const MAGIC_PREFIX = 'synced_';\n const prefix = `test-runs/${context.testId}/${MAGIC_PREFIX}`;\n\n const intervalSec = 10;\n const times = WAIT_TIMEOUT / intervalSec;\n let attempts = 0;\n let synced = false;\n\n while (attempts < times) {\n try {\n const objects = await util.listAllObjectsWithPrefix(\n context.s3Bucket,\n prefix\n );\n if (objects.length !== context.count) {\n attempts++;\n } else {\n synced = true;\n break;\n }\n } catch (_err) {\n attempts++;\n }\n await sleep(intervalSec * 1000);\n }\n\n if (synced) {\n return context;\n } else {\n throw new Error('Timed out waiting for worker sync');\n }\n}\n\nasync function sendGoSignal(context) {\n const s3 = createS3Client();\n const params = {\n Body: Buffer.from(context.testId),\n Bucket: context.s3Bucket,\n Key: `test-runs/${context.testId}/go.json`\n };\n await s3.send(new PutObjectCommand(params));\n return context;\n}\n\nasync function writeHeartbeat(context) {\n const s3 = createS3Client();\n const params = {\n Body: Buffer.from(String(Date.now())),\n Bucket: context.s3Bucket,\n Key: `test-runs/${context.testId}/heartbeat.json`\n };\n try {\n await s3.send(new PutObjectCommand(params));\n debug('Heartbeat written: %s', params.Body.toString());\n } catch (err) {\n debug('Heartbeat write failed: %s', err.message);\n // Non-fatal. Workers tolerate missed heartbeats via 180s threshold.\n }\n}\n\nfunction startHeartbeat(context) {\n writeHeartbeat(context).catch(debug);\n const intervalId = setInterval(() => {\n writeHeartbeat(context).catch(debug);\n }, 60 * 1000);\n return intervalId;\n}\n\nasync function listen(context, ee) {\n return new Promise((resolve, _reject) => {\n context.intermediateReports = [];\n context.aggregateReport = null;\n\n const r = new SqsReporter(context);\n context.sqsReporter = r;\n r.on('workersDone', (state) => {\n ee.emit('workersDone', state);\n return resolve(context);\n });\n r.on('done', (stats) => {\n if (stats.report) {\n context.aggregateReport = stats.report();\n } else {\n context.aggregateReport = stats;\n }\n\n global.artillery.globalEvents.emit('done', stats);\n ee.emit('done', stats);\n });\n r.on('error', (err) => {\n // Ignore SQS errors\n // ee.emit('error', err);\n // return reject(err);\n debug(err);\n });\n\n r.on('workerDone', (body, attrs) => {\n if (process.env.LOG_WORKER_MESSAGES) {\n artillery.log(\n chalk.green(\n `[${attrs.workerId.StringValue} ${JSON.stringify(body, null, 4)}]`\n )\n );\n }\n });\n r.on('workerError', (body, attrs) => {\n if (process.env.LOG_WORKER_MESSAGES) {\n artillery.log(\n chalk.red(\n `[${attrs.workerId.StringValue} ${JSON.stringify(body, null, 4)}]`\n )\n );\n }\n if (body.exitCode !== 21) {\n artillery.log(\n chalk.yellow(\n `Worker exited with an error, worker ID = ${attrs.workerId.StringValue}`\n )\n );\n }\n\n // TODO: Copy log over and print path to log file so that user may inspect it - in a temporary location\n global.artillery.suggestedExitCode = body.exitCode || 1;\n });\n\n r.on('workerMessage', (body, attrs) => {\n if (process.env.LOG_WORKER_MESSAGES) {\n artillery.log(\n chalk.yellow(\n `[${attrs.workerId.StringValue}] ${body.msg} ${body.type}`\n )\n );\n }\n\n if (body.type === 'stopped') {\n if (context.status !== TEST_RUN_STATUS.EARLY_STOP) {\n artillery.log('Test run has been requested to stop');\n }\n context.status = TEST_RUN_STATUS.EARLY_STOP;\n }\n\n if (body.type === 'ensure') {\n try {\n context.ensureSpec = JSON.parse(util.atob(body.msg));\n } catch (_parseErr) {\n console.error('Error processing ensure directive');\n }\n }\n\n if (body.type === 'leader' && body.msg === 'prepack_end') {\n ee.emit('prepack_end');\n }\n });\n\n r.on('stats', async (stats) => {\n let report;\n if (stats.report) {\n report = stats.report();\n context.intermediateReports.push(report);\n } else {\n context.intermediateReports.push(stats);\n report = stats;\n }\n\n global.artillery.globalEvents.emit('stats', stats);\n ee.emit('stats', stats);\n });\n\n r.on('phaseStarted', (phase) => {\n global.artillery.globalEvents.emit('phaseStarted', phase);\n });\n\n r.on('phaseCompleted', (phase) => {\n global.artillery.globalEvents.emit('phaseCompleted', phase);\n });\n\n r.start();\n });\n}\n\nasync function deregisterTaskDefinition(context) {\n if (!context.taskDefinitionArn) {\n return;\n }\n\n const ecs = new ECSClient({\n apiVersion: '2014-11-13',\n region: context.region\n });\n try {\n await ecs.send(\n new DeregisterTaskDefinitionCommand({\n taskDefinition: context.taskDefinitionArn\n })\n );\n debug(`Deregistered ${context.taskDefinitionArn}`);\n } catch (err) {\n artillery.log(err);\n debug(err);\n }\n\n return context;\n}\n\n// TODO: Remove - duplicated in run.js\nfunction getLogFilename(output, userDefaultFilenameFormat) {\n let logfile;\n\n // is the destination a directory that exists?\n let isDir = false;\n if (output) {\n try {\n isDir = fs.statSync(output).isDirectory();\n } catch (_err) {\n // ENOENT, don't need to do anything\n }\n }\n\n const defaultFormat = '[artillery_report_]YMMDD_HHmmSS[.json]';\n if (!isDir && output) {\n // -o is set with a filename (existing or not)\n logfile = output;\n } else if (!isDir && !output) {\n // no -o set\n } else {\n // -o is set with a directory\n logfile = path.join(\n output,\n moment().format(userDefaultFilenameFormat || defaultFormat)\n );\n }\n\n return logfile;\n}\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/sqs-reporter.js", "content": "const EventEmitter = require('node:events');\n\nconst { Consumer } = require('sqs-consumer');\nconst { S3Client, GetObjectCommand } = require('@aws-sdk/client-s3');\nconst driftless = require('driftless');\nconst debug = require('debug')('sqs-reporter');\nconst debugV = require('debug')('sqs-reporter:v');\n\nconst _ = require('lodash');\n\nclass SqsReporter extends EventEmitter {\n constructor(opts) {\n super();\n\n this.sqsQueueUrl = opts.sqsQueueUrl;\n this.region = opts.region;\n this.testId = opts.testId;\n this.count = opts.count;\n\n this.periodsReportedFor = [];\n\n this.ee = new EventEmitter();\n\n this.workerState = {};\n this.lastIntermediateReportAt = 0;\n this.taskWatcher = null;\n\n this.metricsByPeriod = {}; // individual intermediates by worker\n this.mergedPeriodMetrics = []; // merged intermediates for a period\n\n //TODO: this code is repeated from `launch-platform.js` - refactor later\n this.phaseStartedEventsSeen = {};\n this.phaseCompletedEventsSeen = {};\n\n // Debug info:\n this.messagesProcessed = {};\n this.metricsMessagesFromWorkers = {};\n\n this.poolSize =\n typeof process.env.SQS_CONSUMER_POOL_SIZE !== 'undefined'\n ? parseInt(process.env.SQS_CONSUMER_POOL_SIZE, 10)\n : Math.max(Math.ceil(this.count / 10), 75);\n\n this.s3 = null;\n this.s3Bucket = process.env.ARTILLERY_S3_BUCKET || null;\n if (this.s3Bucket) {\n this.s3 = new S3Client({ region: opts.region });\n }\n }\n\n _allWorkersDone() {\n return Object.keys(this.workerState).length === this.count;\n }\n\n async _fetchFromS3(s3Key) {\n const response = await this.s3.send(\n new GetObjectCommand({\n Bucket: this.s3Bucket,\n Key: s3Key\n })\n );\n return JSON.parse(await response.Body.transformToString());\n }\n\n stop() {\n debug('stopping');\n for (const sqsConsumer of this.sqsConsumers) {\n sqsConsumer.stop();\n }\n }\n\n start() {\n debug('starting');\n\n this.sqsDebugInterval = driftless.setDriftlessInterval(() => {\n debug(this.messagesProcessed);\n let total = 0;\n for (const [_k, v] of Object.entries(this.messagesProcessed)) {\n total += v;\n }\n debug('total:', total);\n }, 10 * 1000);\n\n this.intermediateReporterInterval = driftless.setDriftlessInterval(() => {\n if (Object.keys(this.metricsByPeriod).length === 0) {\n return; // nothing received yet\n }\n\n // We always look at the earliest period available so that reports come in chronological order\n const earliestPeriodAvailable = Object.keys(this.metricsByPeriod)\n .filter((x) => this.periodsReportedFor.indexOf(x) === -1)\n .sort()[0];\n\n // TODO: better name. One above is earliestNotAlreadyReported\n const earliest = Object.keys(this.metricsByPeriod).sort()[0];\n if (this.periodsReportedFor.indexOf(earliest) > -1) {\n global.artillery.log(\n 'Warning: multiple batches of metrics for period',\n earliest,\n new Date(Number(earliest))\n );\n delete this.metricsByPeriod[earliest]; // FIXME: need to merge them in for the final report\n }\n\n // We can process SQS messages in batches of 10 at a time, so\n // when there are more workers, we need to wait longer:\n const MAX_WAIT_FOR_PERIOD_MS =\n (Math.ceil(this.count / 10) * 2 + 20) * 1000;\n\n if (\n typeof earliestPeriodAvailable !== 'undefined' &&\n (this.metricsByPeriod[earliestPeriodAvailable].length === this.count ||\n Date.now() - Number(earliestPeriodAvailable) > MAX_WAIT_FOR_PERIOD_MS)\n ) {\n // TODO: autoscaling. Handle workers that drop off as the first case - self.count needs to be updated dynamically\n debug(\n 'have metrics from all workers for period or MAX_WAIT_FOR_PERIOD reached',\n earliestPeriodAvailable\n );\n\n debug(\n 'Report @',\n new Date(Number(earliestPeriodAvailable)),\n 'made up of items:',\n this.metricsByPeriod[String(earliestPeriodAvailable)].length\n );\n\n // TODO: Track how many workers provided metrics in the metrics report\n const stats = global.artillery.__SSMS.mergeBuckets(\n this.metricsByPeriod[String(earliestPeriodAvailable)]\n )[String(earliestPeriodAvailable)];\n this.mergedPeriodMetrics.push(stats);\n // summarize histograms for console reporter\n stats.summaries = {};\n for (const [name, value] of Object.entries(stats.histograms || {})) {\n const summary = global.artillery.__SSMS.summarizeHistogram(value);\n stats.summaries[name] = summary;\n delete this.metricsByPeriod[String(earliestPeriodAvailable)];\n }\n\n this.periodsReportedFor.push(earliestPeriodAvailable);\n\n debug('Emitting stats event');\n this.emit('stats', stats);\n } else {\n debug('Waiting for more workerStats before emitting stats event');\n }\n }, 5 * 1000);\n\n this.workersDoneWatcher = driftless.setDriftlessInterval(() => {\n if (!this._allWorkersDone()) {\n return;\n }\n\n // Have we received and processed all intermediate metrics?\n if (Object.keys(this.metricsByPeriod).length > 0) {\n debug(\n 'All workers done but still waiting on some intermediate reports'\n );\n return;\n }\n\n debug('ready to emit done event');\n debug('mergedPeriodMetrics');\n debug(this.mergedPeriodMetrics);\n\n // Merge by period, then compress and emit\n const stats = global.artillery.__SSMS.pack(this.mergedPeriodMetrics);\n stats.summaries = {};\n for (const [name, value] of Object.entries(stats.histograms || {})) {\n const summary = global.artillery.__SSMS.summarizeHistogram(value);\n stats.summaries[name] = summary;\n }\n\n if (process.env.DEBUG === 'sqs-reporter:v') {\n for (const [workerId, metrics] of Object.entries(\n this.metricsMessagesFromWorkers\n )) {\n debugV('worker', workerId, '->', metrics.length, 'items');\n }\n // fs.writeFileSync('worker-metrics-dump.json', JSON.stringify(self.metricsMessagesFromWorkers));\n }\n\n this.emit('done', stats);\n\n driftless.clearDriftless(this.intermediateReporterInterval);\n driftless.clearDriftless(this.workersDoneWatcher);\n driftless.clearDriftless(this.sqsDebugInterval);\n\n for (const sqsConsumer of this.sqsConsumers) {\n sqsConsumer.stop();\n }\n\n this.emit('workersDone', this.workerState);\n }, 5 * 1000);\n\n this.ee.on('message', (body, attrs) => {\n const workerId = attrs.workerId?.StringValue;\n\n if (!workerId) {\n debug('Got message with no workerId');\n debug(body);\n return;\n }\n if (body.event === 'workerDone' || body.event === 'workerError') {\n this.workerState[workerId] = body.event;\n this.emit(body.event, body, attrs);\n\n debug(workerId, body.event);\n return;\n }\n\n //TODO: this code is repeated from `launch-platform.js` - refactor later\n if (body.event === 'phaseStarted') {\n if (\n typeof this.phaseStartedEventsSeen[body.phase.index] === 'undefined'\n ) {\n this.phaseStartedEventsSeen[body.phase.index] = Date.now();\n this.emit(body.event, body.phase);\n }\n\n return;\n }\n\n //TODO: this code is repeated from `launch-platform.js` - refactor later\n if (body.event === 'phaseCompleted') {\n if (\n typeof this.phaseCompletedEventsSeen[body.phase.index] === 'undefined'\n ) {\n this.phaseCompletedEventsSeen[body.phase.index] = Date.now();\n this.emit(body.event, body.phase);\n }\n\n return;\n }\n\n // 'done' event is from SQS Plugin - unused for now\n if (body.event === 'done') {\n return;\n }\n\n if (body.msg) {\n this.emit('workerMessage', body, attrs);\n return;\n }\n\n if (body.event === 'workerStats') {\n // v2 SSMS stats\n const workerStats = global.artillery.__SSMS.deserializeMetrics(\n body.stats\n );\n const period = workerStats.period;\n\n debug(\n 'processing workerStats event, worker:',\n workerId,\n 'period',\n period\n );\n\n debugV(workerStats);\n if (typeof this.metricsByPeriod[period] === 'undefined') {\n this.metricsByPeriod[period] = [];\n }\n this.metricsByPeriod[period].push(workerStats);\n\n if (process.env.DEBUG === 'sqs-reporter:v') {\n if (\n typeof this.metricsMessagesFromWorkers[workerId] === 'undefined'\n ) {\n this.metricsMessagesFromWorkers[workerId] = [];\n }\n this.metricsMessagesFromWorkers[workerId].push(workerStats);\n }\n\n debugV('metricsByPeriod:');\n debugV(this.metricsByPeriod);\n debug('number of periods processed');\n debug(Object.keys(this.metricsByPeriod));\n debug('number of metrics collections for period:', period, ':');\n debug(this.metricsByPeriod[period].length, 'expecting:', this.count);\n }\n });\n\n this.ee.on('messageReceiveTimeout', () => {\n // TODO: 10 polls with no results, e.g. if all workers crashed\n });\n\n const createConsumer = (i) => Consumer.create({\n queueUrl: process.env.SQS_QUEUE_URL || this.sqsQueueUrl,\n region: this.region,\n waitTimeSeconds: 10,\n messageAttributeNames: ['testId', 'workerId'],\n visibilityTimeout: 60,\n batchSize: 10,\n handleMessage: async (message) => {\n let body = null;\n try {\n body = JSON.parse(message.Body);\n } catch (err) {\n console.error(err);\n console.log(message.Body);\n }\n\n //\n // Ignore any messages that are invalid or not tagged properly.\n //\n\n if (process.env.LOG_SQS_MESSAGES) {\n console.log(message);\n }\n\n if (!body) {\n throw new Error();\n }\n\n // Handle overflow messages stored in S3\n if (body._overflowRef && this.s3 && this.s3Bucket) {\n try {\n debug('Fetching overflow payload from S3: %s', body._overflowRef);\n body = await this._fetchFromS3(body._overflowRef);\n } catch (s3Err) {\n console.error('Failed to fetch overflow message from S3:', s3Err);\n throw new Error(\n `Failed to fetch overflow message: ${body._overflowRef}`\n );\n }\n }\n\n const attrs = message.MessageAttributes;\n if (!attrs || !attrs.testId) {\n throw new Error();\n }\n\n if (this.testId !== attrs.testId.StringValue) {\n throw new Error();\n }\n\n if (!this.messagesProcessed[i]) {\n this.messagesProcessed[i] = 0;\n }\n this.messagesProcessed[i] += 1;\n\n process.nextTick(() => {\n this.ee.emit('message', body, attrs);\n });\n }\n });\n\n this.sqsConsumers = [];\n for (let i = 0; i < this.poolSize; i++) {\n const sqsConsumer = createConsumer(i);\n\n sqsConsumer.on('error', (err) => {\n // TODO: Ignore \"SQSError: SQS delete message failed:\" errors\n if (err.message?.match(/ReceiptHandle.+expired/i)) {\n debug(err.name, err.message);\n } else {\n artillery.log(err);\n sqsConsumer.stop();\n this.emit('error', err);\n }\n });\n\n let empty = 0;\n sqsConsumer.on('empty', () => {\n empty++;\n if (empty > 10) {\n this.ee.emit('messageReceiveTimeout'); // TODO:\n }\n });\n sqsConsumer.start();\n\n this.sqsConsumers.push(sqsConsumer);\n }\n }\n\n // Given a (combined) stats object, what's the difference between the\n // time of earliest and latest requests made?\n calculateSpread(stats) {\n const period = _.reduce(\n stats._requestTimestamps,\n (acc, ts) => {\n acc.min = Math.min(acc.min, ts);\n acc.max = Math.max(acc.max, ts);\n return acc;\n },\n { min: Infinity, max: 0 }\n );\n\n const spread = round((period.max - period.min) / 1000, 1);\n return spread;\n }\n}\n\nfunction round(number, decimals) {\n const m = 10 ** decimals;\n return Math.round(number * m) / m;\n}\n\nmodule.exports = { SqsReporter };\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/tags.js", "content": "\n\nfunction parseTags(input) {\n const tags = [];\n if (input) {\n const tagList = input.split(',').map((x) => x.trim());\n for (const t of tagList) {\n const cs = t.split(':');\n if (cs.length !== 2) {\n console.error(`Invalid tag, skipping: ${t}`);\n } else {\n tags.push({ name: cs[0].trim(), value: cs[1].trim() });\n }\n }\n }\n\n return tags;\n}\n\nmodule.exports = {\n parseTags\n};\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/test-run-status.js", "content": "module.exports = {\n INITIALIZING: 1,\n LAUNCHING_WORKERS: 2,\n RECEIVING_REPORTS: 3,\n TERMINATING: 4,\n EARLY_STOP: 5,\n COMPLETED: 6,\n ERROR: 7\n};\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/time.js", "content": "\n\nconst EventEmitter = require('node:events');\nconst driftless = require('driftless');\n\nasync function sleep(ms) {\n return new Promise((resolve) => setTimeout(resolve, ms));\n}\n\nclass Timeout extends EventEmitter {\n constructor(duration) {\n super();\n this._startedAt = null;\n this._duration = duration;\n }\n\n start() {\n this._startedAt = Date.now();\n this._timeout = driftless.setDriftlessTimeout(() => {\n this.emit('timeout');\n }, this._duration);\n return this;\n }\n\n stop() {\n driftless.clearDriftless(this._timeout);\n return this;\n }\n\n timedout() {\n return Date.now() - this._startedAt > this._duration;\n }\n}\n\n// Turn a string like 2m into number of milliseconds\n// Supported units: ms, s, m, h\nfunction timeStringToMs(timeStr) {\n const rx = /^([0-9]+).+$/i;\n\n if (!rx.test(timeStr)) {\n throw new Error(`Invalid time string: ${timeStr}`);\n }\n\n let multiplier = 0;\n if (timeStr.endsWith('ms')) {\n multiplier = 1;\n } else if (timeStr.endsWith('s')) {\n multiplier = 1000;\n } else if (timeStr.endsWith('m')) {\n multiplier = 60 * 1000;\n } else if (timeStr.endsWith('h')) {\n multiplier = 60 * 60 * 1000;\n } else {\n throw new Error(\n `Unknown unit suffix in ${timeStr}. Supported units: ms, s, m, h`\n );\n }\n\n const n = parseInt(timeStr.match(rx)[0], 10);\n return n * multiplier;\n}\n\nmodule.exports = {\n Timeout,\n sleep,\n timeStringToMs\n};\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/legacy/util.js", "content": "\n\nconst _debug = require('debug')('artillery:util');\n\nconst chalk = require('chalk');\n\nconst _ = require('lodash');\n\nconst _A = require('async');\n\nconst createS3Client = require('./create-s3-client');\n\nconst supportedRegions = [\n 'us-east-1',\n 'us-east-2',\n 'us-west-1',\n 'us-west-2',\n 'us-gov-east-1',\n 'us-gov-west-1',\n 'ca-central-1',\n 'eu-west-1',\n 'eu-west-2',\n 'eu-west-3',\n 'eu-central-1',\n 'eu-north-1',\n 'ap-south-1',\n 'ap-east-1',\n 'ap-northeast-2',\n 'ap-southeast-1',\n 'ap-southeast-2',\n 'ap-northeast-1',\n 'me-south-1',\n 'il-central-1',\n 'sa-east-1',\n 'cn-north-1',\n 'cn-northwest-1'\n];\n\nconst getAccountId = require('../../aws/aws-get-account-id');\n\nconst { S3_BUCKET_NAME_PREFIX } = require('./constants');\nconst { paginateListObjectsV2 } = require('@aws-sdk/client-s3');\n\nfunction atob(data) {\n return Buffer.from(data, 'base64').toString('ascii');\n}\nfunction btoa(data) {\n return Buffer.from(data).toString('base64');\n}\n\nasync function getBucketName() {\n if (process.env.ARTILLERY_S3_BUCKET) {\n return process.env.ARTILLERY_S3_BUCKET;\n }\n\n const accountId = await getAccountId();\n const bucketName = `${S3_BUCKET_NAME_PREFIX}-${accountId}`;\n // const bucketArn = `arn:aws:s3:::${bucketName}`;\n return bucketName;\n}\n\nfunction formatError(err) {\n return (\n `${chalk.red('Error')}: ${err.message}${err.code ? ` (${err.code})` : ''}`\n );\n}\n\nasync function listAllObjectsWithPrefix(bucketName, prefix) {\n const s3Client = createS3Client();\n const allObjects = [];\n\n const paginator = paginateListObjectsV2(\n { client: s3Client },\n {\n Bucket: bucketName,\n Prefix: prefix,\n MaxKeys: 1000\n }\n );\n for await (const page of paginator) {\n if (page.Contents) {\n allObjects.push(...page.Contents);\n }\n }\n\n return allObjects;\n}\n\nmodule.exports = {\n supportedRegions,\n getAccountId,\n atob,\n btoa,\n formatError,\n listAllObjectsWithPrefix,\n getBucketName\n};\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/worker/Dockerfile", "content": "# ********************************\n# NOTE: Version we use here needs to be kept consistent with that in\n# artillery-engine-playwright.\n# ********************************\nFROM mcr.microsoft.com/playwright:v1.58.1\n\nARG TARGETARCH\n\nENV DEBIAN_FRONTEND=noninteractive\n\n# Install aws-lambda-ric build dependencies\nRUN apt-get update && apt-get install -y \\\n g++ \\\n make \\\n cmake \\\n unzip \\\n libcurl4-openssl-dev \\\n autoconf \\\n libtool \\\n python3-pip && pip3 install awscli --break-system-packages && pip3 install azure-cli==2.76.0 --break-system-packages\n\nRUN <> ~/.curlrc\nif [ \"$TARGETARCH\" = \"arm64\" ]; then\n# Temporal fix for SSL_ERROR_SYSCALL error on arm64\n# see: https://github.com/curl/curl/issues/14154\necho 'insecure' >> ~/.curlrc\nfi\nEOT\n\nARG WORKER_VERSION\nENV WORKER_VERSION=$WORKER_VERSION\n\n# Additional dependencies for Fargate\nRUN apt-get install -y bash jq pwgen curl git zip tree\n\n# Define custom function directory\nARG FUNCTION_DIR=\"/artillery\"\nRUN mkdir -p ${FUNCTION_DIR}\nWORKDIR ${FUNCTION_DIR}\n\nCOPY packages packages\nCOPY packages/artillery/lib/platform/aws-lambda/lambda-handler/ .\nCOPY package.json package.json\n\n## Copy Fargate worker files\nCOPY ./packages/artillery/lib/platform/aws-ecs/worker/loadgen-worker /artillery/loadgen-worker\nCOPY ./packages/artillery/lib/platform/aws-ecs/worker/helpers.sh /artillery/helpers.sh\n\n# Install dependencies\nRUN npm install -w artillery --ignore-scripts --omit=dev\nRUN npm install aws-lambda-ric\n\nRUN npm cache clean --force \\\n && rm ./package.json \\\n && rm -rf /root/.cache \\\n && ln -s /artillery/node_modules/.bin/artillery /usr/local/bin/artillery \\\n && rm -rf /ms-playwright/firefox* \\\n && rm -rf /ms-playwright/webkit* \\\n && echo \"ok\"\n\nRUN chmod +x /artillery/loadgen-worker\n\nENTRYPOINT [\"/artillery/packages/artillery/bin/run\"]\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/worker/helpers.sh", "content": "#!/usr/bin/env bash\n\nARTIFACTORY_AUTH=\"${ARTIFACTORY_AUTH:-\"null\"}\"\nARTIFACTORY_EMAIL=\"${ARTIFACTORY_EMAIL:-\"null\"}\"\nNPM_REGISTRY=\"${NPM_REGISTRY:-\"null\"}\"\nNPM_TOKEN=\"${NPM_TOKEN:-\"null\"}\"\nNPM_SCOPE=\"${NPM_SCOPE:-\"null\"}\"\nNPMRC=\"${NPMRC:-\"null\"}\"\n\ngenerate_npmrc () {\n if [[ \"$ARTIFACTORY_AUTH\" != \"null\" ]] && [[ \"$ARTIFACTORY_EMAIL\" != \"null\" ]] ; then\n echo \"_auth=$ARTIFACTORY_AUTH\"\n echo \"email=$ARTIFACTORY_EMAIL\"\n echo \"always-auth=true\"\n else\n # If only one is set - print a diagnostic message;\n # otherwise neither is set so do nothing.\n if [[ \"$ARTIFACTORY_AUTH\" != \"null\" ]] || [[ \"$ARTIFACTORY_EMAIL\" != \"null\" ]] ; then\n echo \"Both ARTIFACTORY_AUTH and ARTIFACTORY_EMAIL must be set for Artifactory auth to work\"\n fi\n fi\n\n # NOTE: Default value for NPM_SCOPE and NPM_TOKEN is \"null\"\n if [[ \"$NPM_REGISTRY\" == \"null\" ]] ; then\n NPM_REGISTRY=\"https://registry.npmjs.org/\"\n fi\n\n NPM_REGISTRY_BASE=\"${NPM_REGISTRY#http:}\"\n NPM_REGISTRY_BASE=\"${NPM_REGISTRY#https:}\"\n\n NPM_TOKEN=\"${NPM_TOKEN:-\"null\"}\"\n NPM_SCOPE=\"${NPM_SCOPE:-\"null\"}\"\n\n # Set registry URL:\n # npm config set registry \"$NPM_REGISTRY\"\n echo \"registry=${NPM_REGISTRY}\"\n\n if [[ ! \"$NPM_TOKEN\" = \"null\" ]] ; then\n echo \"${NPM_REGISTRY_BASE}:_authToken=${NPM_TOKEN}\"\n fi\n\n if [[ \"$NPM_SCOPE\" != \"null\" ]] ; then\n if [[ \"$NPM_SCOPE_REGISTRY\" != \"null\" ]] ; then\n echo \"${NPM_SCOPE}:registry=${NPM_SCOPE_REGISTRY}\"\n else\n # npm config set \"${NPM_SCOPE}:registry\" \"$NPM_REGISTRY\"\n echo \"${NPM_SCOPE}:registry=${NPM_REGISTRY}\"\n fi\n fi\n\n # Any extra bits from the user:\n if [[ \"$NPMRC\" != \"null\" ]] ; then\n echo \"$NPMRC\"\n fi\n}\n\nbase64d () {\n # Not expecting any tabs or newlines in the input so not read'ing in a loop.\n read encoded\n if [[ \"$(uname)\" == \"Darwin\" ]] ; then\n printf \"%s\" \"$encoded\" | base64 -D\n elif [[ \"$(uname)\" == \"Linux\" ]] ; then\n printf \"%s\" \"$encoded\" | base64 -d\n else\n printf \"Unknown platform: $(uname)\"\n # shellcheck disable=SC2034\n EXIT_CODE=$ERR_UNKNOWN_PLATFORM\n exit\n fi\n}\n\ndebug () {\n if [[ -n $DEBUG ]] ; then\n printf -- \"%s\\\\n\" \"$@\"\n fi\n}\n\nprogress () {\n printf \"******** [$worker_id] %s\\\\n\" \"$1\"\n}\n" }, { "path": "packages/artillery/lib/platform/aws-ecs/worker/loadgen-worker", "content": "#!/usr/bin/env bash\n\nset -euo pipefail\nIFS=$'\\n\\t'\n\nDEBUGX=${DEBUGX:-\"\"}\nDEBUG=${DEBUG:-\"\"}\n\nif [[ -n $DEBUGX ]] ; then\n set -x\nfi\n\ndeclare -r DIR=$(cd \"$(dirname \"$0\")\" && pwd)\n\nsource \"$DIR/helpers.sh\"\n\n# shellcheck disable=2155\n# declare -r DIR=$(cd \"$(dirname \"$0\")\" && pwd)\n\ndeclare -r ERR_ARGS=10\ndeclare -r ERR_TEST_DIR_EMPTY=3\ndeclare -r ERR_SIGNAL_SYNC=4\ndeclare -r ERR_GO_TIMEOUT=5\ndeclare -r ERR_CLI_ERROR=6\ndeclare -r ERR_INTERRUPTED=7\ndeclare -r ERR_UNKNOWN_PLATFORM=8\ndeclare -r ERR_DEP=9\ndeclare -r ERR_DEP_INSTALL=10 # npm install / yarn install failed\ndeclare -r ERR_NO_LICENSE=11\ndeclare -r ERR_CLI_ERROR_EXPECT=21\ndeclare -r ERR_HEARTBEAT_TIMEOUT=12\n\nERR_EXTRA_INFO=\"\"\n\n# shellcheck disable=2155\ndeclare -r TEST_DATA=\"$(pwd)/test_data\"\n\nWAIT_TIMEOUT=${WAIT_TIMEOUT:-600}\n\ndeclare -t EXIT_CODE=0\n\nCLI_RUNNING=\"no\"\nCLI_STATUS=\nCLI_PID=\n\nCLEANING_UP=\"no\"\n\n#mode=\"${MODE:-run}\" # \"run\" or \"bootstrap\"\nis_azure=\nazure_storage_container_name=\n\ns3_test_data_path=\ncli_args=()\ncli_args_encoded=\naws_region=\nsqs_queue_url=\ntest_run_id=\ns3_run_data_base_path=\ns3_run_data_path=\n\n# This is set once we know if we're on Azure or AWS\nworker_id=\nis_leader=${IS_LEADER:-false} # true or false\n\ndeclare -r DEPENDENCIES=(jq aws az pwgen node npm yarn tree)\n\nsend_message () {\n local body=\"$1\" # body of the message, a string\n local type=\"$2\" # type of the message: debug, leader, ensure\n\n if [[ \"$is_azure\" = \"yes\" ]] ; then\n send_message_aqs \"$body\" \"$type\"\n else\n send_message_sqs \"$body\" \"$type\"\n fi\n}\n\nsend_message_aqs () {\n set +e\n set +o pipefail\n\n local body=\"$1\"\n local type=\"$2\"\n\n local aqs_message_payload=\"{\\\"msg\\\":\\\"$body\\\",\\\"type\\\":\\\"$type\\\"}\"\n local aqs_message_attributes=\"{\\\"testId\\\": \\\"${test_run_id}\\\", \\\"workerId\\\": \\\"${worker_id}\\\"}\"\n\n >/dev/null az storage message put \\\n --content \"{ \\\"payload\\\": $aqs_message_payload, \\\"attributes\\\": $aqs_message_attributes }\" \\\n --queue-name \"$AQS_QUEUE_NAME\" \\\n --account-name \"$AZURE_STORAGE_ACCOUNT\" || true\n\n set -e\n set -o pipefail\n}\n\nsend_message_sqs () {\n set +e\n set +o pipefail\n\n local body=\"$1\"\n local type=\"$2\"\n\n local sqs_message_body=\"{\\\"msg\\\":\\\"$body\\\",\\\"type\\\":\\\"$type\\\"}\"\n local sqs_message_attributes=\"{\\\"testId\\\": {\\\"StringValue\\\": \\\"${test_run_id}\\\", \\\"DataType\\\": \\\"String\\\"}, \\\"workerId\\\": {\\\"StringValue\\\": \\\"${worker_id}\\\", \\\"DataType\\\": \\\"String\\\"}}\"\n\n >/dev/null aws sqs send-message \\\n --queue-url \"${sqs_queue_url}\" \\\n --message-body \"$sqs_message_body\" \\\n --message-attributes \"$sqs_message_attributes\" \\\n --message-group-id \"${test_run_id}\" \\\n --message-deduplication-id \"$(pwgen -A 32 1)\" \\\n --region \"$aws_region\" || true\n\n set -e\n set -o pipefail\n}\n\nsend_event () {\n set +e\n set +o pipefail\n \n local payload=\"$1\"\n\n if [[ \"$is_azure\" = \"yes\" ]] ; then\n send_event_aqs \"$payload\"\n else\n send_event_sqs \"$payload\"\n fi\n\n set -e\n set -o pipefail\n}\n\nsend_event_sqs () {\n local payload=\"$1\"\n\n local sqs_message_attributes=\"{\\\"testId\\\": {\\\"StringValue\\\": \\\"${test_run_id}\\\", \\\"DataType\\\": \\\"String\\\"}, \\\"workerId\\\": {\\\"StringValue\\\": \\\"${worker_id}\\\", \\\"DataType\\\": \\\"String\\\"}}\"\n\n >/dev/null aws sqs send-message \\\n --queue-url \"${sqs_queue_url}\" \\\n --message-body \"$payload\" \\\n --message-attributes \"$sqs_message_attributes\" \\\n --message-group-id \"${test_run_id}\" \\\n --message-deduplication-id \"$(pwgen -A 32 1)\" \\\n --region \"$aws_region\"\n}\n\nsend_event_aqs () {\n local payload=\"$1\"\n\n local aqs_message_attributes=\"{\\\"testId\\\": \\\"${test_run_id}\\\", \\\"workerId\\\": \\\"${worker_id}\\\"}\"\n\n >/dev/null az storage message put \\\n --content \"{ \\\"payload\\\": $payload, \\\"attributes\\\": $aqs_message_attributes }\" \\\n --queue-name \"$AQS_QUEUE_NAME\" \\\n --account-name \"$AZURE_STORAGE_ACCOUNT\"\n}\n\n\n\ninstall_npm_dependencies () {\n if [[ $(jq -r .modules \"$METADATA_FILE\") != \"null\" ]] ; then\n echo \"Installing required npm dependencies\"\n for dep in $(jq -r '.modules[]' \"$METADATA_FILE\") ; do\n echo \"installing $dep\"\n npm install --quiet \"$dep\"\n done\n else\n echo \"No extra npm modules to install\"\n fi\n\n if [[ -f \"$TEST_DATA/package.json\" ]] ; then\n echo \"Installing dependencies in package.json\"\n if [[ -f \"$TEST_DATA/yarn.lock\" ]] ; then\n # TODO: Test yarn's exit code\n yarn install\n else\n set +e\n npm install --loglevel=silent\n\n if [[ -f \"npm-debug.log\" ]] ; then\n cat npm-debug.log\n EXIT_CODE=\"$ERR_DEP_INSTALL\"\n exit\n else\n echo \"npm install completed\"\n fi\n set -e\n fi\n else\n npm init -y --quiet\n fi\n}\n\ncheck_dependencies () {\n for dep in \"${DEPENDENCIES[@]}\" ; do\n set +e\n if ! command -v \"$dep\" > /dev/null ; then\n echo \"Error: could not find $dep in \\$PATH. Please install $dep.\"\n exit $ERR_DEP\n fi\n set -e\n done\n}\n\nsync_test_data () {\n mkdir \"$TEST_DATA\" || true\n pushd \"$TEST_DATA\" >/dev/null\n\n echo \"is_azure: $is_azure\"\n\n if [[ \"$is_azure\" = \"yes\" ]] ; then\n sync_test_data_azure\n else\n sync_test_data_s3\n fi\n\n debug \"$(pwd)\"\n debug \"$(ls -a)\"\n}\n\nsync_test_data_azure () {\n # TODO: Exclude node_modules_stream.zip\n # This recreates the directory structure in the container, i.e. we'll have tests/$test_run_id here with all files under it\n # So we need to move them all up two levels to the current directory\n az storage blob download-batch -d . --account-name \"$AZURE_STORAGE_ACCOUNT\" -s \"$azure_storage_container_name\" --pattern \"tests/$test_run_id/*\"\n local tmpdir=\"$(mktemp -d)\"\n set +e\n mv tests/$test_run_id/{.,}* $tmpdir\n rm -rf tests/$test_run_id\n mv $tmpdir/{.,}* .\n set -e\n}\n\nsync_test_data_s3 () {\n aws s3 sync --exclude node_modules_stream.zip \"$s3_test_data_path\" . >/dev/null\n}\n\ncheck_test_data () {\n file_count=$(find . -maxdepth 1 -name \"*\" | grep -v '^.$' -c)\n if [[ ! $file_count -gt 0 ]]; then\n echo \"$TEST_DATA seems to be empty\"\n EXIT_CODE=$ERR_TEST_DIR_EMPTY\n exit\n fi\n}\n\ninstall_dependencies () {\n pushd \"$TEST_DATA\" >/dev/null\n\n local METADATA_FILE=\"metadata.json\"\n\n debug \"$(cat $METADATA_FILE || true)\"\n\n # Needed to install all packages to the dir of the test files.\n export NODE_PATH=\"$TEST_DATA:${NODE_PATH:-\"\"}\"\n\n generate_npmrc >> ~/.npmrc\n\n # Leader: pre-install modules for everyone else\n if [[ \"$is_leader\" = \"true\" ]] ; then\n send_message \"leader npm pack start `date +%s`\" \"debug\"\n install_npm_dependencies\n\n if [[ ! -d \"node_modules\" ]] ; then\n mkdir node_modules\n touch node_modules/.artillery\n fi\n\n zip -r -q node_modules.zip node_modules # | aws s3 cp - \"$s3_test_data_path/node_modules_stream.zip\"\n echo \"Modules pre-packaged\"\n \n # aws s3 mv \"$s3_test_data_path/node_modules_stream.zip\" \"$s3_test_data_path/node_modules.zip\"\n\n if [[ \"$is_azure\" = \"yes\" ]] ; then\n az storage blob upload --overwrite --account-name \"$AZURE_STORAGE_ACCOUNT\" --container-name \"$azure_storage_container_name\" --file node_modules.zip --name \"tests/$test_run_id/node_modules.zip\"\n else\n aws s3 cp node_modules.zip \"$s3_test_data_path/node_modules.zip\"\n fi\n\n send_message \"leader npm prepack end `date +%s`\" \"debug\"\n send_message \"prepack_end\" \"leader\"\n else\n # wait until node_modules.zip is available and unzip, or timeout\n # TODO: use aws s3api wait object-exists with a custom timeout\n send_message \"follower npm prepack wait start `date +%s`\" \"debug\"\n\n if [[ \"$is_azure\" = \"yes\" ]] ; then\n wait_for_go \"tests/$test_run_id/node_modules.zip\"\n else\n wait_for_go \"$s3_test_data_path/node_modules.zip\"\n fi\n unzip -o -q node_modules.zip\n send_message \"follower npm prepack wait end `date +%s`\" \"debug\"\n fi\n\n tree -I node_modules\n}\n\nsignal_ready () {\n local synced_filename=\"synced_${worker_id}.json\"\n echo \"{ \\\"worker_id\\\": \\\"${worker_id}\\\" }\" >> \"$synced_filename\"\n local synced_dest=\n local cp_status=\n\n if [[ \"$is_azure\" = \"yes\" ]] ; then\n\n send_event \"{\\\"event\\\": \\\"workerReady\\\"}\"\n\n synced_dest=\"${azure_storage_container_name}/$synced_filename\"\n az storage blob upload --overwrite --account-name \"$AZURE_STORAGE_ACCOUNT\" --container-name \"$azure_storage_container_name\" --file \"$synced_filename\" --name \"tests/$test_run_id/$synced_filename\"\n cp_status=$?\n else\n synced_dest=\"${s3_run_data_path}/${synced_filename}\"\n aws s3 cp \"$synced_filename\" \"$synced_dest\" 1>/dev/null 2>/dev/null\n cp_status=$?\n fi\n\n if [[ $cp_status -ne 0 ]]; then\n echo \"could not send synced signal (to: $synced_dest)\"\n EXIT_CODE=$ERR_SIGNAL_SYNC\n exit\n else\n echo \"Worker $worker_id synced up & ready\"\n fi\n}\n\nwait_for_go () {\n local SLEEP=2\n local slept=0\n local objpath=\n\n if [[ \"$is_azure\" = \"yes\" ]] ; then\n objpath=\"${1:-tests/$test_run_id/go.json}\"\n else\n objpath=\"${1:-$s3_run_data_path/go.json}\"\n fi\n\n echo \"Waiting... ($objpath)\"\n\n while true ; do\n set +e\n\n if [[ \"$is_azure\" = \"yes\" ]] ; then\n az storage blob download --account-name \"$AZURE_STORAGE_ACCOUNT\" --container-name \"$azure_storage_container_name\" --name \"$objpath\" --file \"$(basename $objpath)\" 1>/dev/null 2>/dev/null\n else\n aws s3 cp \"$objpath\" . 1>/dev/null 2>/dev/null\n fi\n\n\n local cp_exit_code=$?\n set -e\n\n if [[ $cp_exit_code -eq 0 ]]; then\n break\n else\n if [[ $slept -ge $WAIT_TIMEOUT ]]; then\n echo \"Timed out waiting for go signal\"\n EXIT_CODE=$ERR_GO_TIMEOUT\n exit\n else\n echo -n \".\"\n sleep $SLEEP\n (( slept = slept + SLEEP ))\n fi\n fi\n done\n}\n\nsend_no_license_message () {\n set +e\n\n az storage message put \\\n --content \"{\\\"payload\\\":{\\\"event\\\":\\\"workerError\\\",\\\"reason\\\":\\\"License not found - https://docs.art/az/license\\\", \\\"exitCode\\\":$ERR_NO_LICENSE},\\\"attributes\\\":{\\\"testId\\\": \\\"${test_run_id}\\\", \\\"workerId\\\": \\\"${worker_id}\\\"}}\" \\\n --queue-name \"$AQS_QUEUE_NAME\" \\\n --account-name \"$AZURE_STORAGE_ACCOUNT\" || true\n\n set -e\n}\n\ndecode_cli_args () {\n debug \"encoded args $cli_args_encoded\"\n local decoded_args=\n decoded_args=$(echo \"$cli_args_encoded\" | base64d)\n debug \"decoded: $decoded_args\"\n\n for an_arg in $(echo \"$cli_args_encoded\" | base64d | jq -r '.[] | @base64') ; do\n local decoded_arg=\n decoded_arg=\"$(printf -- \"%s\" \"$an_arg\" | base64d)\"\n debug \"decoded CLI arg: %s\" \"$decoded_arg\"\n cli_args+=(\"$decoded_arg\")\n done\n}\n\ncheck_heartbeat () {\n if [[ \"$is_azure\" = \"yes\" ]] ; then\n return # TODO: implement Azure blob storage equivalent\n fi\n\n local heartbeat_key=\"${s3_run_data_path}/heartbeat.json\"\n local threshold=180\n local check_interval=60\n local grace_period=180\n local started_at=$SECONDS\n\n debug \"Heartbeat monitor started (grace=${grace_period}s, threshold=${threshold}s)\"\n\n while true ; do\n sleep $check_interval\n\n local elapsed=$(( SECONDS - started_at ))\n if [[ $elapsed -lt $grace_period ]] ; then\n debug \"Heartbeat: grace period (${elapsed}s < ${grace_period}s)\"\n continue\n fi\n\n set +e\n aws s3 cp \"$heartbeat_key\" /tmp/heartbeat.json \\\n --region \"$aws_region\" 2>/dev/null\n local cp_exit=$?\n set -e\n\n if [[ $cp_exit -ne 0 ]] ; then\n printf \"WARNING: Heartbeat S3 fetch failed (exit=%d), retrying next cycle\\n\" \"$cp_exit\"\n continue\n fi\n\n local latest_ts\n latest_ts=$(cat /tmp/heartbeat.json 2>/dev/null)\n\n if [[ -z \"$latest_ts\" ]] ; then\n printf \"ERROR: No CLI heartbeat detected. Terminating worker.\\n\"\n echo \"$ERR_HEARTBEAT_TIMEOUT\" > /tmp/heartbeat_timeout\n if [[ \"$CLI_RUNNING\" = \"yes\" ]] && [[ -n \"$CLI_PID\" ]] ; then\n kill -TERM $CLI_PID 2>/dev/null || true\n sleep 15\n if kill -0 $CLI_PID 2>/dev/null ; then\n kill -KILL $CLI_PID 2>/dev/null || true\n fi\n fi\n exit $ERR_HEARTBEAT_TIMEOUT\n fi\n\n # %3N (nanoseconds truncated to ms) requires GNU coreutils date.\n # Available on Amazon Linux / Fargate; falls back to second precision elsewhere.\n local now_ms=$(date +%s%3N 2>/dev/null || echo $(( $(date +%s) * 1000 )))\n local age_ms=$(( now_ms - latest_ts ))\n local age_s=$(( age_ms / 1000 ))\n\n debug \"Heartbeat: latest=${latest_ts}, age=${age_s}s\"\n\n if [[ $age_s -gt $threshold ]] ; then\n printf \"ERROR: CLI heartbeat expired (%ds old). Terminating worker.\\n\" \"$age_s\"\n echo \"$ERR_HEARTBEAT_TIMEOUT\" > /tmp/heartbeat_timeout\n if [[ \"$CLI_RUNNING\" = \"yes\" ]] && [[ -n \"$CLI_PID\" ]] ; then\n kill -TERM $CLI_PID 2>/dev/null || true\n sleep 15\n if kill -0 $CLI_PID 2>/dev/null ; then\n kill -KILL $CLI_PID 2>/dev/null || true\n fi\n fi\n exit $ERR_HEARTBEAT_TIMEOUT\n fi\n done\n}\n\nrun_a9 () {\n # NOTE: node_modules is required for plugins to be loaded\n export NODE_PATH=\"$TEST_DATA/node_modules:${NODE_PATH:-\"\"}\"\n export DEBUG=${DEBUG:-\"debug:mode:off\"} # can set via --launch-config if needed\n\n export ARTILLERY_PLUGIN_PATH=${ARTILLERY_PLUGIN_PATH:-\"\"}:/artillery/packages/artillery/lib/platform/aws-ecs/legacy/plugins\n\n export ARTILLERY_PLUGINS=\"{\\\"sqs-reporter\\\":{\\\"region\\\": \\\"${aws_region}\\\"},\\\"inspect-script\\\":{}}\"\n export SQS_TAGS=\"[{\\\"key\\\": \\\"testId\\\", \\\"value\\\": \\\"${test_run_id}\\\"},{\\\"key\\\":\\\"workerId\\\", \\\"value\\\":\\\"${worker_id}\\\"}]\"\n \n if [[ \"$is_azure\" = \"yes\" ]] ; then\n export AZURE_STORAGE_QUEUE_URL=$sqs_queue_url\n else \n export SQS_QUEUE_URL=$sqs_queue_url\n export SQS_REGION=$aws_region\n fi\n\n export ARTILLERY_DISABLE_ENSURE=true\n\n debug \"CLI args:\"\n debug \"${cli_args[@]}\"\n\n # set max header size to 32KB -- solves the HPE_HEADER_OVERFLOW error\n # set max old space size to 12GB - max allocatable on Fargate\n MAX_OLD_SPACE_SIZE=${MAX_OLD_SPACE_SIZE:-12288}\n export NODE_OPTIONS=\"--max-http-header-size=32768 --max-old-space-size=$MAX_OLD_SPACE_SIZE ${NODE_OPTIONS:-\"\"}\"\n\n (set +eu ; ${ARTILLERY_BINARY:-\"artillery\"} \"${cli_args[@]}\" ; echo $? > exitCode ; set -eu) | tee output.txt &\n debug \"node processes:\"\n debug \"$(pgrep -lfa node)\"\n sleep 5\n CLI_PID=$(pgrep -lfa node | grep artillery | awk '{print $1}')\n CLI_RUNNING=\"yes\"\n\n check_heartbeat &\n HEARTBEAT_PID=$!\n\n debug \"CLI pid:\"\n debug \"$CLI_PID\"\n\n while kill -0 $CLI_PID 2> /dev/null ; do\n if [[ -f /tmp/heartbeat_timeout ]] ; then\n kill -KILL $CLI_PID 2>/dev/null || true\n break\n fi\n sleep 5 # signal handler will fire after we wake up\n done\n\n CLI_RUNNING=\"no\"\n kill $HEARTBEAT_PID 2>/dev/null || true\n wait $HEARTBEAT_PID 2>/dev/null || true\n CLI_STATUS=$(cat exitCode)\n\n printf \"Finished with code %s\\n\" \"$CLI_STATUS\"\n\n case `grep \"inspect-script.config.ensure\" \"output.txt\" >/dev/null; echo $?` in\n 0)\n # ensure spec found\n echo \"got ensure spec\"\n local ensure_spec=$(grep 'inspect-script.config.ensure' \"output.txt\" |awk -F 'ensure=' '{print $2}'|head -n 1)\n send_message \"$ensure_spec\" \"ensure\"\n ;;\n 1)\n # no ensure spec\n echo \"no ensure spec\" >&2\n ;;\n *)\n # error - ignore\n echo \"error while looking for ensure spec, ignoring\" >&2\n ;;\n esac\n\n # TODO: Upload to Storage Blob if on Azure\n if [[ \"$is_azure\" != \"yes\" ]] ; then\n aws s3 cp output.txt \"${s3_run_data_path}/worker-log-${worker_id}.txt\"\n echo \"log: ${s3_run_data_path}/worker-log-${worker_id}.txt\"\n fi\n\n if [[ -f /tmp/heartbeat_timeout ]] ; then\n EXIT_CODE=$(cat /tmp/heartbeat_timeout)\n rm -f /tmp/heartbeat_timeout\n elif [[ $CLI_STATUS -eq 0 ]] ; then\n EXIT_CODE=0\n elif [[ $CLI_STATUS -eq $ERR_CLI_ERROR_EXPECT ]] ; then\n EXIT_CODE=$ERR_CLI_ERROR_EXPECT\n else\n EXIT_CODE=$ERR_CLI_ERROR\n fi\n\n exit $EXIT_CODE\n}\n\nmain () {\n debug \"$@\"\n\n decode_cli_args\n\n s3_run_data_path=\"${s3_run_data_base_path}/${test_run_id}\"\n progress \"Test run ID = $test_run_id\"\n progress \"Syncing test data\"\n sync_test_data\n check_test_data\n\n progress \"Installing dependencies\"\n install_dependencies\n\n progress \"Ready to run\"\n signal_ready\n progress \"Waiting for green signal\"\n wait_for_go\n progress \"Off we go!\"\n run_a9\n}\n\nusage () {\n cat << EOF\nusage: $0 - run worker\nEOF\n}\n\nwhile getopts \"z:p:a:r:q:i:d:t:h?\" OPTION\ndo\n case $OPTION in\n h)\n usage\n exit 0\n ;;\n z)\n is_azure=\"$OPTARG\"\n ;;\n p)\n s3_test_data_path=\"$OPTARG\"\n ;;\n a)\n cli_args_encoded=\"$OPTARG\"\n ;;\n r)\n aws_region=\"$OPTARG\"\n ;;\n q)\n # Can also be AQS queue URL\n sqs_queue_url=\"$OPTARG\"\n ;;\n i)\n test_run_id=\"$OPTARG\"\n ;;\n d)\n s3_run_data_base_path=\"$OPTARG\"\n ;;\n t)\n WAIT_TIMEOUT=\"$OPTARG\"\n ;;\n \\?)\n usage\n exit $ERR_ARGS\n ;;\n :)\n echo \"Unknown option: -$OPTARG\" >&2; exit 1;;\n * ) echo \"Unimplemented option: -$OPTARG\" >&2; exit 1;;\n esac\ndone\n\n# shellcheck disable=2004\nshift $(($OPTIND - 1)) # remove all args processed by getopts\n\nif [[ ! $# -eq 0 ]] ; then\n usage\n EXIT_CODE=$ERR_ARGS\n exit\nfi\n\nif [[ -z $s3_test_data_path || -z $cli_args_encoded || -z $test_run_id ]] ; then\n echo \"Some required argument(s) not provided, aborting\" >&2\n EXIT_CODE=$ERR_ARGS\n exit\nfi\n\nif [[ \"$is_azure\" = \"yes\" ]] ; then\n # Remap for convenience\n azure_storage_container_name=\"$s3_test_data_path\"\n\n az login --service-principal -u $AZURE_CLIENT_ID -p $AZURE_CLIENT_SECRET --tenant $AZURE_TENANT_ID\nfi\n\nif [[ \"$is_azure\" != \"yes\" ]] ; then\n taskArn=$(curl -s \"$ECS_CONTAINER_METADATA_URI_V4/task\" \\\n | jq -r \".TaskARN\" \\\n | cut -d \"/\" -f 3)\nfi\n\nworker_id=${WORKER_ID_OVERRIDE:-$(pwgen -A 12 1)}\nworker_id=${taskArn:-$worker_id}\n# make available to Artillery custom scripts/environment\nexport WORKER_ID=\"$worker_id\"\n\nprogress \"============================\"\nprogress \"Worker starting up, ID = $worker_id, version = ${WORKER_VERSION:-unknown}, leader = $is_leader\"\nprogress \"============================\"\n\ncleanup () {\n local sig=\"$1\"\n\n debug \"cleanup called, signal:\"\n debug \"$sig\"\n\n if [[ $CLEANING_UP = \"no\" ]] ; then\n CLEANING_UP=\"yes\"\n\n if [[ \"$is_azure\" = \"yes\" ]] ; then\n if [[ \"$is_leader\" = \"true\" ]] ; then\n if [[ -z \"${AZURE_RETAIN_BLOBS:-\"\"}\" ]] ; then\n # This exits with 0 regardless of whether the pattern matches any\n # blobs or not so it's OK to run this multiple times\n az storage blob delete-batch \\\n --account-name \"$AZURE_STORAGE_ACCOUNT\" \\\n -s \"$azure_storage_container_name\" \\\n --pattern \"tests/$test_run_id/*\"\n fi\n fi\n fi\n\n # Abnormal exit:\n if [[ $CLI_RUNNING = \"yes\" ]] ; then\n printf \"Interrupted with %s, stopping\\n\" \"$sig\"\n EXIT_CODE=$ERR_INTERRUPTED\n kill -TERM $CLI_PID\n set +e\n timeout 20 tail --pid $CLI_PID -f /dev/null\n if [[ $? -eq 124 ]] ; then\n # timeout exits with 124 if the process it's waiting on is still running\n # i.e. if tail is still running it means the Artillery CLI did not exit:\n kill -KILL $CLI_PID\n CLI_STATUS=143 # SIGTERM (128 + 15)\n else\n # Preserve the exit code of the CLI\n CLI_STATUS=$(cat exitCode)\n fi\n set -e\n CLI_RUNNING=\"no\"\n fi\n\n local sqs_message_body=\n if [[ $EXIT_CODE -eq 0 ]] ; then\n sqs_message_body='{\"event\": \"workerDone\"}'\n else\n # If 137 then something SIGKILL'ed Artillery\n local extra_info=$(printf \"%s\" \"$$ERR_EXTRA_INFO\" | jq -sR)\n sqs_message_body=\"{\\\"event\\\": \\\"workerError\\\", \\\"exitCode\\\": \\\"$EXIT_CODE\\\" }\"\n fi\n\n send_event \"$sqs_message_body\"\n\n debug \"Message body: $sqs_message_body\"\n exit $EXIT_CODE\n else\n if [[ ! $sig = \"EXIT\" ]] ; then\n # EXIT will always fire after a TERM/INT, so if\n # that's the case we don't need to print this message.\n printf \"Received %s but cleaning up already\\n\" \"$sig\"\n fi\n fi\n}\n\nset_trap_with_arg () {\n func=\"$1\" ; shift\n for sig ; do\n # shellcheck disable=2064\n trap \"$func $sig\" \"$sig\"\n done\n}\n\nset_trap_with_arg cleanup INT TERM EXIT\n\nmain \"$@\"\n" }, { "path": "packages/artillery/lib/platform/aws-lambda/dependencies.js", "content": "const fs = require('fs-extra');\nconst { PutObjectCommand } = require('@aws-sdk/client-s3');\nconst debug = require('debug')('platform:aws-lambda');\nconst Table = require('cli-table3');\nconst { promisify } = require('node:util');\nconst { createBOM } = require('../aws-ecs/legacy/bom');\nconst createS3Client = require('../aws-ecs/legacy/create-s3-client');\n\nconst _createLambdaBom = async (\n absoluteScriptPath,\n absoluteConfigPath,\n flags\n) => {\n const createBomOpts = {};\n let entryPoint = absoluteScriptPath;\n const extraFiles = [];\n createBomOpts.scenarioPath = absoluteScriptPath;\n if (absoluteConfigPath) {\n entryPoint = absoluteConfigPath;\n extraFiles.push(absoluteScriptPath);\n createBomOpts.entryPointIsConfig = true;\n }\n // TODO: custom package.json path here\n if (flags) {\n createBomOpts.flags = flags;\n }\n\n const bom = await promisify(createBOM)(entryPoint, extraFiles, createBomOpts);\n\n return bom;\n};\n\nasync function _uploadFileToS3(item, testRunId, bucketName) {\n const s3 = createS3Client();\n const prefix = `tests/${testRunId}`;\n let body;\n try {\n body = fs.readFileSync(item.orig);\n } catch (fsErr) {\n console.log(fsErr);\n }\n\n if (!body) {\n return;\n }\n\n const key = `${prefix}/${item.noPrefixPosix}`;\n await s3.send(\n new PutObjectCommand({\n Bucket: bucketName,\n Key: key,\n // TODO: stream, not readFileSync\n Body: body\n })\n );\n\n debug(`Uploaded ${key}`);\n return;\n}\n\nasync function _syncS3(bomManifest, testRunId, bucketName) {\n const metadata = {\n createdOn: Date.now(),\n name: testRunId,\n modules: bomManifest.modules\n };\n\n //TODO: parallelise this\n let fileCount = 0;\n for (const file of bomManifest.files) {\n await _uploadFileToS3(file, testRunId, bucketName);\n fileCount++;\n }\n metadata.fileCount = fileCount;\n\n const plainS3 = createS3Client();\n const prefix = `tests/${testRunId}`;\n const key = `${prefix}/metadata.json`;\n await plainS3.send(\n new PutObjectCommand({\n Bucket: bucketName,\n Key: key,\n // TODO: stream, not readFileSync\n Body: JSON.stringify(metadata)\n })\n );\n\n debug(`Uploaded ${key}`);\n return `s3://${bucketName}/${key}`;\n}\n\nconst createAndUploadTestDependencies = async (\n bucketName,\n testRunId,\n absoluteScriptPath,\n absoluteConfigPath,\n flags\n) => {\n const bom = await _createLambdaBom(\n absoluteScriptPath,\n absoluteConfigPath,\n flags\n );\n artillery.log('Test bundle contents:');\n const t = new Table({ head: ['Name', 'Type', 'Notes'] });\n for (const f of bom.files) {\n t.push([f.noPrefix, 'file']);\n }\n for (const m of bom.modules) {\n t.push([\n m,\n 'package',\n bom.pkgDeps.indexOf(m) === -1 ? 'not in package.json' : ''\n ]);\n }\n //TODO: add dotenv file if specified\n artillery.log(t.toString());\n artillery.log();\n\n const s3Path = await _syncS3(bom, testRunId, bucketName);\n\n return {\n bom,\n s3Path\n };\n};\n\nmodule.exports = {\n createAndUploadTestDependencies\n};\n" }, { "path": "packages/artillery/lib/platform/aws-lambda/index.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst EventEmitter = require('node:events');\nconst debug = require('debug')('platform:aws-lambda');\n\nconst { randomUUID } = require('node:crypto');\n\nconst sleep = require('../../util/sleep');\nconst path = require('node:path');\nconst {\n LambdaClient,\n GetFunctionConfigurationCommand,\n InvokeCommand,\n CreateFunctionCommand,\n DeleteFunctionCommand,\n ResourceConflictException,\n ResourceNotFoundException\n} = require('@aws-sdk/client-lambda');\nconst { PutObjectCommand } = require('@aws-sdk/client-s3');\nconst { SQSClient, DeleteQueueCommand } = require('@aws-sdk/client-sqs');\nconst {\n IAMClient,\n GetRoleCommand,\n CreateRoleCommand,\n AttachRolePolicyCommand,\n CreatePolicyCommand\n} = require('@aws-sdk/client-iam');\n\nconst createS3Client = require('../aws-ecs/legacy/create-s3-client');\nconst { getBucketRegion } = require('../aws/aws-get-bucket-region');\n\nconst _https = require('node:https');\n\nconst { QueueConsumer } = require('../../queue-consumer');\n\nconst telemetry = require('../../telemetry');\nconst crypto = require('node:crypto');\n\nconst prices = require('./prices');\nconst _ = require('lodash');\n\nconst { SQS_QUEUES_NAME_PREFIX } = require('../aws/constants');\nconst ensureS3BucketExists = require('../aws/aws-ensure-s3-bucket-exists');\nconst getAccountId = require('../aws/aws-get-account-id');\n\nconst createSQSQueue = require('../aws/aws-create-sqs-queue');\nconst { createAndUploadTestDependencies } = require('./dependencies');\nconst awsGetDefaultRegion = require('../aws/aws-get-default-region');\nconst pkgVersion = require('../../../package.json').version;\n\n// https://stackoverflow.com/a/66523153\nfunction memoryToVCPU(memMB) {\n if (memMB < 832) {\n return 0.5;\n }\n\n if (memMB < 3009) {\n return 2;\n }\n\n if (memMB < 5308) {\n return 3;\n }\n\n if (memMB < 7077) {\n return 4;\n }\n\n if (memMB < 8846) {\n return 5;\n }\n\n return 6;\n}\n\nclass PlatformLambda {\n constructor(script, payload, opts, platformOpts) {\n this.workers = {};\n\n this.count = 0;\n this.waitingReadyCount = 0;\n\n this.script = script;\n this.payload = payload;\n this.opts = opts;\n\n this.events = new EventEmitter();\n\n const platformConfig = platformOpts.platformConfig;\n\n this.currentVersion = process.env.LAMBDA_IMAGE_VERSION || pkgVersion;\n this.ecrImageUrl = process.env.WORKER_IMAGE_URL;\n this.architecture = platformConfig.architecture || 'arm64';\n this.region = platformConfig.region || 'us-east-1';\n this.arnPrefix = this.region.startsWith('cn-') ? 'arn:aws-cn' : 'arn:aws';\n\n this.securityGroupIds =\n platformConfig['security-group-ids']?.split(',') || [];\n this.subnetIds = platformConfig['subnet-ids']?.split(',') || [];\n\n this.useVPC = this.securityGroupIds.length > 0 && this.subnetIds.length > 0;\n\n this.memorySize = platformConfig['memory-size'] || 4096;\n\n this.testRunId = platformOpts.testRunId;\n this.lambdaRoleArn =\n platformConfig['lambda-role-arn'] || platformConfig.lambdaRoleArn;\n\n this.platformOpts = platformOpts;\n\n this.cloudKey =\n this.platformOpts.cliArgs.key || process.env.ARTILLERY_CLOUD_API_KEY;\n\n this.s3LifecycleConfigurationRules = [\n {\n Expiration: { Days: 2 },\n Filter: { Prefix: '/lambda' },\n ID: 'RemoveAdHocTestData',\n Status: 'Enabled'\n },\n {\n Expiration: { Days: 7 },\n Filter: { Prefix: '/' },\n ID: 'RemoveTestRunMetadata',\n Status: 'Enabled'\n }\n ];\n\n this.artilleryArgs = [];\n }\n\n async init() {\n global.artillery.awsRegion = (await awsGetDefaultRegion()) || this.region;\n artillery.log('Îģ Preparing AWS Lambda function...');\n this.accountId = await getAccountId();\n\n const metadata = {\n region: this.region,\n platformConfig: {\n memory: this.memorySize,\n cpu: memoryToVCPU(this.memorySize)\n }\n };\n global.artillery.globalEvents.emit('metadata', metadata);\n\n //make sure the bucket exists to send the zip file or the dependencies to\n const bucketName = await ensureS3BucketExists(\n this.region,\n this.s3LifecycleConfigurationRules,\n true\n );\n this.bucketName = bucketName;\n\n global.artillery.s3BucketRegion = await getBucketRegion(bucketName);\n\n const { bom, s3Path } = await createAndUploadTestDependencies(\n this.bucketName,\n this.testRunId,\n this.opts.absoluteScriptPath,\n this.opts.absoluteConfigPath,\n this.platformOpts.cliArgs\n );\n\n this.artilleryArgs.push('run');\n\n if (this.platformOpts.cliArgs.environment) {\n this.artilleryArgs.push('-e');\n this.artilleryArgs.push(this.platformOpts.cliArgs.environment);\n }\n if (this.platformOpts.cliArgs.solo) {\n this.artilleryArgs.push('--solo');\n }\n\n if (this.platformOpts.cliArgs.target) {\n this.artilleryArgs.push('--target');\n this.artilleryArgs.push(this.platformOpts.cliArgs.target);\n }\n\n if (this.platformOpts.cliArgs.variables) {\n this.artilleryArgs.push('-v');\n this.artilleryArgs.push(this.platformOpts.cliArgs.variables);\n }\n\n if (this.platformOpts.cliArgs.overrides) {\n this.artilleryArgs.push('--overrides');\n this.artilleryArgs.push(this.platformOpts.cliArgs.overrides);\n }\n\n if (this.platformOpts.cliArgs.dotenv) {\n this.artilleryArgs.push('--dotenv');\n this.artilleryArgs.push(path.basename(this.platformOpts.cliArgs.dotenv));\n }\n\n if (this.platformOpts.cliArgs['scenario-name']) {\n this.artilleryArgs.push('--scenario-name');\n this.artilleryArgs.push(this.platformOpts.cliArgs['scenario-name']);\n }\n\n if (this.platformOpts.cliArgs.config) {\n this.artilleryArgs.push('--config');\n const p = bom.files.filter(\n (x) => x.orig === this.opts.absoluteConfigPath\n )[0];\n this.artilleryArgs.push(p.noPrefixPosix);\n }\n\n // This needs to be the last argument for now:\n const p = bom.files.filter(\n (x) => x.orig === this.opts.absoluteScriptPath\n )[0];\n this.artilleryArgs.push(p.noPrefixPosix);\n // 36 is length of a UUUI v4 string\n const queueName = `${SQS_QUEUES_NAME_PREFIX}_${this.testRunId.slice(\n 0,\n 36\n )}.fifo`;\n\n const sqsQueueUrl = await createSQSQueue(this.region, queueName);\n this.sqsQueueUrl = sqsQueueUrl;\n\n if (typeof this.lambdaRoleArn === 'undefined') {\n const lambdaRoleArn = await this.createLambdaRole();\n this.lambdaRoleArn = lambdaRoleArn;\n } else {\n artillery.log(` - Lambda role ARN: ${this.lambdaRoleArn}`);\n }\n\n this.functionName = this.createFunctionNameWithHash();\n\n await this.createOrUpdateLambdaFunctionIfNeeded();\n\n artillery.log(` - Lambda function: ${this.functionName}`);\n artillery.log(` - Region: ${this.region}`);\n artillery.log(` - AWS account: ${this.accountId}`);\n\n debug({ bucketName, s3Path, sqsQueueUrl });\n\n const consumer = new QueueConsumer();\n consumer.create(\n {\n poolSize: Math.min(this.platformOpts.count, 100)\n },\n {\n queueUrl: process.env.SQS_QUEUE_URL || this.sqsQueueUrl,\n region: this.region,\n waitTimeSeconds: 10,\n messageAttributeNames: ['testId', 'workerId'],\n visibilityTimeout: 60,\n batchSize: 10,\n handleMessage: async (message) => {\n let body = null;\n try {\n body = JSON.parse(message.Body);\n } catch (err) {\n console.error(err);\n console.log(message.Body);\n }\n\n //\n // Ignore any messages that are invalid or not tagged properly.\n //\n\n if (process.env.LOG_SQS_MESSAGES) {\n console.log(message);\n }\n\n if (!body) {\n throw new Error('SQS message with empty body');\n }\n\n const attrs = message.MessageAttributes;\n if (!attrs || !attrs.testId || !attrs.workerId) {\n throw new Error('SQS message with no testId or workerId');\n }\n\n if (this.testRunId !== attrs.testId.StringValue) {\n throw new Error('SQS message for an unknown testId');\n }\n\n const workerId = attrs.workerId.StringValue;\n\n if (body.event === 'workerStats') {\n this.events.emit('stats', workerId, body); // event consumer accesses body.stats\n } else if (body.event === 'artillery.log') {\n console.log(body.log);\n } else if (body.event === 'done') {\n // 'done' handler in Launcher exects the message argument to have an \"id\" and \"report\" fields\n body.id = workerId;\n body.report = body.stats; // Launcher expects \"report\", SQS reporter sends \"stats\"\n this.events.emit('done', workerId, body);\n } else if (\n body.event === 'phaseStarted' ||\n body.event === 'phaseCompleted'\n ) {\n body.id = workerId;\n this.events.emit(body.event, workerId, { phase: body.phase });\n } else if (body.event === 'workerError') {\n global.artillery.suggestedExitCode = body.exitCode || 1;\n\n if (body.exitCode !== 21) {\n this.events.emit(body.event, workerId, {\n id: workerId,\n error: new Error(\n `A Lambda function has exited with an error. Reason: ${body.reason}`\n ),\n level: 'error',\n aggregatable: false,\n logs: body.logs\n });\n }\n } else if (body.event === 'workerReady') {\n this.events.emit(body.event, workerId);\n this.waitingReadyCount++;\n\n // TODO: Do this only for batches of workers with \"wait\" option set\n if (this.waitingReadyCount === this.count) {\n // TODO: Retry\n const s3 = createS3Client();\n await s3.send(\n new PutObjectCommand({\n Body: Buffer.from(''),\n Bucket: this.bucketName,\n Key: `/${this.testRunId}/green`\n })\n );\n }\n } else {\n debug(body);\n }\n }\n }\n );\n\n let queueEmpty = 0;\n\n consumer.on('error', (err) => {\n artillery.log(err);\n });\n consumer.on('empty', (_err) => {\n debug('queueEmpty:', queueEmpty);\n queueEmpty++;\n });\n\n consumer.start();\n\n this.sqsConsumer = consumer;\n\n // TODO: Start the timer when the first worker is created\n const startedAt = Date.now();\n global.artillery.ext({\n ext: 'beforeExit',\n method: async (event) => {\n try {\n await telemetry.init().capture({\n event: 'ping',\n awsAccountId: crypto\n .createHash('sha1')\n .update(this.accountId)\n .digest('base64')\n });\n\n process.nextTick(() => {\n telemetry.shutdown();\n });\n } catch (_err) {}\n\n function round(number, decimals) {\n const m = 10 ** decimals;\n return Math.round(number * m) / m;\n }\n\n if (event.flags && event.flags.platform === 'aws:lambda') {\n let price = 0;\n if (!prices[this.region]) {\n price = prices.base[this.architecture];\n } else {\n price = prices[this.region][this.architecture];\n }\n\n const duration = Math.ceil((Date.now() - startedAt) / 1000);\n const total =\n ((price * this.memorySize) / 1024) *\n this.platformOpts.count *\n duration;\n const cost = round(total / 10e10, 4);\n console.log(`\\nEstimated AWS Lambda cost for this test: $${cost}\\n`);\n }\n }\n });\n }\n\n getDesiredWorkerCount() {\n return this.platformOpts.count;\n }\n\n async startJob() {\n await this.init();\n\n for (let i = 0; i < this.platformOpts.count; i++) {\n const { workerId } = await this.createWorker();\n this.workers[workerId] = { id: workerId };\n await this.runWorker(workerId);\n }\n }\n\n async createWorker() {\n const workerId = randomUUID();\n\n return { workerId };\n }\n\n async runWorker(workerId) {\n const lambda = new LambdaClient({\n apiVersion: '2015-03-31',\n region: this.region\n });\n const event = {\n SQS_QUEUE_URL: this.sqsQueueUrl,\n SQS_REGION: this.region,\n WORKER_ID: workerId,\n ARTILLERY_ARGS: this.artilleryArgs,\n TEST_RUN_ID: this.testRunId,\n BUCKET: this.bucketName,\n WAIT_FOR_GREEN: true,\n ARTILLERY_CLOUD_API_KEY: this.cloudKey\n };\n\n if (process.env.ARTILLERY_CLOUD_ENDPOINT) {\n event.ARTILLERY_CLOUD_ENDPOINT = process.env.ARTILLERY_CLOUD_ENDPOINT;\n }\n\n debug('Lambda event payload:');\n debug({ event });\n\n const payload = JSON.stringify(event);\n\n // Wait for the function to be invocable:\n const timeout = this.useVPC ? 240e3 : 120e3;\n let waited = 0;\n let ok = false;\n let state;\n while (waited < timeout) {\n try {\n state = (\n await lambda.send(\n new GetFunctionConfigurationCommand({\n FunctionName: this.functionName\n })\n )\n ).State;\n if (state === 'Active') {\n debug('Lambda function ready:', this.functionName);\n ok = true;\n break;\n } else {\n await sleep(10 * 1000);\n waited += 10 * 1000;\n }\n } catch (err) {\n debug('Error getting lambda state:', err);\n await sleep(10 * 1000);\n waited += 10 * 1000;\n }\n }\n\n if (!ok) {\n debug(\n 'Time out waiting for lamda function to be ready:',\n this.functionName\n );\n throw new Error(\n 'Timeout waiting for lambda function to be ready for invocation'\n );\n }\n\n await lambda.send(\n new InvokeCommand({\n FunctionName: this.functionName,\n Payload: payload,\n InvocationType: 'Event'\n })\n );\n\n this.count++;\n }\n\n async stopWorker(_workerId) {\n // TODO: Send message to that worker and have it exit early\n }\n\n async shutdown() {\n if (this.sqsConsumer) {\n this.sqsConsumer.stop();\n }\n\n const sqs = new SQSClient({ region: this.region });\n const lambda = new LambdaClient({\n apiVersion: '2015-03-31',\n region: this.region\n });\n\n try {\n await sqs.send(\n new DeleteQueueCommand({\n QueueUrl: this.sqsQueueUrl\n })\n );\n\n if (process.env.RETAIN_LAMBDA === 'false') {\n await lambda.send(\n new DeleteFunctionCommand({\n FunctionName: this.functionName\n })\n );\n }\n } catch (err) {\n console.error(err);\n }\n }\n\n async createLambdaRole() {\n const ROLE_NAME = 'artilleryio-default-lambda-role-20230116';\n const POLICY_NAME = 'artilleryio-lambda-policy-20230116';\n\n const iam = new IAMClient({ region: global.artillery.awsRegion });\n\n try {\n const res = await iam.send(new GetRoleCommand({ RoleName: ROLE_NAME }));\n return res.Role.Arn;\n } catch (err) {\n debug(err);\n }\n\n const principalService = this.region.startsWith('cn-')\n ? 'lambda.amazonaws.com.cn'\n : 'lambda.amazonaws.com';\n\n const res = await iam.send(\n new CreateRoleCommand({\n AssumeRolePolicyDocument: `{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"Service\": \"${principalService}\"\n },\n \"Action\": \"sts:AssumeRole\"\n }\n ]\n }`,\n Path: '/',\n RoleName: ROLE_NAME\n })\n );\n\n const lambdaRoleArn = res.Role.Arn;\n\n await iam.send(\n new AttachRolePolicyCommand({\n PolicyArn: `${this.arnPrefix}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole`,\n RoleName: ROLE_NAME\n })\n );\n\n await iam.send(\n new AttachRolePolicyCommand({\n PolicyArn: `${this.arnPrefix}:iam::aws:policy/service-role/AWSLambdaVPCAccessExecutionRole`,\n RoleName: ROLE_NAME\n })\n );\n\n const iamRes = await iam.send(\n new CreatePolicyCommand({\n PolicyDocument: `{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": [\"sqs:*\"],\n \"Resource\": \"${this.arnPrefix}:sqs:*:${this.accountId}:artilleryio*\"\n },\n {\n \"Effect\": \"Allow\",\n \"Action\": [\"s3:HeadObject\", \"s3:PutObject\", \"s3:ListBucket\", \"s3:GetObject\", \"s3:GetObjectAttributes\"],\n \"Resource\": [ \"${this.arnPrefix}:s3:::artilleryio-test-data*\", \"${this.arnPrefix}:s3:::artilleryio-test-data*/*\" ]\n }\n ]\n }\n `,\n PolicyName: POLICY_NAME,\n Path: '/'\n })\n );\n\n await iam.send(\n new AttachRolePolicyCommand({\n PolicyArn: iamRes.Policy.Arn,\n RoleName: ROLE_NAME\n })\n );\n\n // See https://stackoverflow.com/a/37438525 for why we need this\n await sleep(10 * 1000);\n\n return lambdaRoleArn;\n }\n\n async createOrUpdateLambdaFunctionIfNeeded() {\n const existingLambdaConfig = await this.getLambdaFunctionConfiguration();\n\n if (existingLambdaConfig) {\n debug(\n 'Lambda function with this configuration already exists. Using existing function.'\n );\n return;\n }\n\n try {\n await this.createLambda({\n bucketName: this.bucketName,\n functionName: this.functionName\n });\n return;\n } catch (err) {\n if (err instanceof ResourceConflictException) {\n debug(\n 'Lambda function with this configuration already exists. Using existing function.'\n );\n return;\n }\n\n throw new Error(`Failed to create Lambda Function: \\n${err}`);\n }\n }\n\n async getLambdaFunctionConfiguration() {\n const lambda = new LambdaClient({\n apiVersion: '2015-03-31',\n region: this.region\n });\n\n try {\n const res = await lambda.send(\n new GetFunctionConfigurationCommand({\n FunctionName: this.functionName\n })\n );\n\n return res;\n } catch (err) {\n if (err instanceof ResourceNotFoundException) {\n return null;\n }\n\n throw new Error(`Failed to get Lambda Function: \\n${err}`);\n }\n }\n\n createFunctionNameWithHash(_lambdaConfig) {\n const changeableConfig = {\n MemorySize: this.memorySize,\n VpcConfig: {\n SecurityGroupIds: this.securityGroupIds,\n SubnetIds: this.subnetIds\n }\n };\n\n const configHash = crypto\n .createHash('md5')\n .update(JSON.stringify(changeableConfig))\n .digest('hex');\n\n let name = `artilleryio-v${this.currentVersion.replace(/\\./g, '-')}-${\n this.architecture\n }-${configHash}`;\n\n if (name.length > 64) {\n name = name.slice(0, 64);\n }\n\n return name;\n }\n\n async createLambda(opts) {\n const { functionName } = opts;\n\n const lambda = new LambdaClient({\n apiVersion: '2015-03-31',\n region: this.region\n });\n\n const lambdaConfig = {\n PackageType: 'Image',\n Code: {\n ImageUri:\n this.ecrImageUrl ||\n `248481025674.dkr.ecr.${this.region}.amazonaws.com/artillery-worker:${this.currentVersion}-${this.architecture}`\n },\n ImageConfig: {\n Command: ['a9-handler-index.handler'],\n EntryPoint: ['/usr/bin/npx', 'aws-lambda-ric']\n },\n FunctionName: functionName,\n Description: 'Artillery.io test',\n MemorySize: parseInt(this.memorySize, 10),\n Timeout: 900,\n Role: this.lambdaRoleArn,\n //TODO: architecture influences the entrypoint. We should review which architecture to use in the end (may impact Playwright viability)\n Architectures: [this.architecture],\n Environment: {\n Variables: {\n S3_BUCKET_PATH: this.bucketName,\n NPM_CONFIG_CACHE: '/tmp/.npm', //TODO: move this to Dockerfile\n AWS_LAMBDA_LOG_FORMAT: 'JSON', //TODO: review this. we need to find a ways for logs to look better in Cloudwatch\n ARTILLERY_WORKER_PLATFORM: 'aws:lambda'\n }\n }\n };\n\n if (this.useVPC) {\n lambdaConfig.VpcConfig = {\n SecurityGroupIds: this.securityGroupIds,\n SubnetIds: this.subnetIds\n };\n }\n\n await lambda.send(new CreateFunctionCommand(lambdaConfig));\n }\n}\n\nmodule.exports = PlatformLambda;\n" }, { "path": "packages/artillery/lib/platform/aws-lambda/lambda-handler/a9-handler-dependencies.js", "content": "const fs = require('node:fs');\nconst path = require('node:path');\nconst { runProcess } = require('./a9-handler-helpers');\n\nconst syncTestData = async (bucketName, testRunId) => {\n console.log('Syncing test data');\n const LOCAL_TEST_DATA_PATH = `/tmp/test_data/${testRunId}`;\n const REMOTE_TEST_DATA_PATH = `s3://${bucketName}/tests/${testRunId}`;\n\n if (!fs.existsSync(LOCAL_TEST_DATA_PATH)) {\n fs.mkdirSync(LOCAL_TEST_DATA_PATH, { recursive: true });\n }\n\n const result = await runProcess(\n 'aws',\n ['s3', 'sync', REMOTE_TEST_DATA_PATH, LOCAL_TEST_DATA_PATH],\n { log: true }\n );\n\n if (result.code !== 0 || result.stderr) {\n throw new Error(`Failed to sync test data:\\n ${result.stderr}`);\n }\n console.log('Test data synced');\n};\n\nconst installNpmDependencies = async (testDataLocation) => {\n //TODO: handle npmrc (i.e. artifactory, etc)\n console.log(`Changing directory to ${testDataLocation}`);\n process.chdir(testDataLocation);\n\n const metadataJson = fs.readFileSync(\n path.join(testDataLocation, 'metadata.json')\n );\n\n //first, install custom dependencies\n for (const dep of JSON.parse(metadataJson).modules) {\n console.log(`Installing ${dep}`);\n await runProcess('npm', ['install', dep, '--prefix', testDataLocation], {\n log: true,\n env: {\n HOME: testDataLocation\n }\n });\n }\n\n if (!fs.existsSync(path.join(testDataLocation, 'package.json'))) {\n await runProcess('npm', ['init', '-y', '--quiet'], {\n log: true,\n env: {\n HOME: testDataLocation\n }\n });\n }\n\n const installResult = await runProcess(\n 'npm',\n ['install', '--prefix', testDataLocation],\n {\n log: true,\n env: {\n HOME: testDataLocation\n }\n }\n );\n\n console.log(installResult);\n console.log('Finished installing test data');\n};\n\nmodule.exports = {\n syncTestData,\n installNpmDependencies\n};\n" }, { "path": "packages/artillery/lib/platform/aws-lambda/lambda-handler/a9-handler-helpers.js", "content": "const { spawn } = require('node:child_process');\n\nconst sleep = async (n) => new Promise((resolve, _reject) => {\n setTimeout(() => {\n resolve();\n }, n);\n });\n\nasync function runProcess(name, args, { env, log }) {\n return new Promise((resolve, _reject) => {\n const proc = spawn(name, args, { env });\n let stdout = '';\n let stderr = '';\n\n proc.stdout.on('data', (data) => {\n if (log) {\n console.log(data.toString());\n }\n stdout += data.toString();\n });\n\n proc.stderr.on('data', (data) => {\n if (log) {\n console.error(data.toString());\n }\n\n stderr += data.toString();\n });\n\n proc.once('close', (code) => {\n resolve({ stdout, stderr, code });\n });\n\n proc.on('error', (err) => {\n resolve({ stdout, stderr, err });\n });\n });\n}\n\nmodule.exports = {\n runProcess,\n sleep\n};\n" }, { "path": "packages/artillery/lib/platform/aws-lambda/lambda-handler/a9-handler-index.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst { SQSClient, SendMessageCommand } = require('@aws-sdk/client-sqs');\nconst { S3Client, HeadObjectCommand } = require('@aws-sdk/client-s3');\nconst { randomUUID } = require('node:crypto');\nconst { runProcess, sleep } = require('./a9-handler-helpers');\nconst {\n syncTestData,\n installNpmDependencies\n} = require('./a9-handler-dependencies');\nconst path = require('node:path');\n\nconst TIMEOUT_THRESHOLD_MSEC = 20 * 1000;\n\nclass MQ {\n constructor({ region, queueUrl, attrs }) {\n this.sqs = new SQSClient({ region });\n this.queueUrl = queueUrl;\n this.attrs = attrs;\n }\n\n async send(body) {\n const messageAttributes = Object.keys(this.attrs).reduce((acc, key) => {\n acc[key] = {\n DataType: 'String',\n StringValue: this.attrs[key]\n };\n return acc;\n }, {});\n\n return this.sqs.send(\n new SendMessageCommand({\n QueueUrl: this.queueUrl,\n MessageBody: JSON.stringify(body),\n MessageAttributes: messageAttributes,\n MessageDeduplicationId: randomUUID(),\n MessageGroupId: this.attrs.testId\n })\n );\n }\n}\n\nasync function handler(event, context) {\n const {\n SQS_QUEUE_URL,\n SQS_REGION,\n TEST_RUN_ID,\n WORKER_ID,\n ARTILLERY_ARGS,\n BUCKET,\n ENV,\n WAIT_FOR_GREEN,\n ARTILLERY_CLOUD_API_KEY,\n ARTILLERY_CLOUD_ENDPOINT\n } = event;\n\n console.log('TEST_RUN_ID: ', TEST_RUN_ID);\n\n const mq = new MQ({\n region: SQS_REGION,\n queueUrl: SQS_QUEUE_URL,\n attrs: {\n testId: TEST_RUN_ID,\n workerId: WORKER_ID\n }\n });\n\n const TEST_DATA_LOCATION = `/tmp/test_data/${TEST_RUN_ID}`;\n\n try {\n await syncTestData(BUCKET, TEST_RUN_ID);\n } catch (err) {\n await mq.send({\n event: 'workerError',\n reason: 'TestDataSyncFailure',\n logs: {\n err: {\n message: err.message,\n stack: err.stack\n }\n }\n });\n }\n\n try {\n await installNpmDependencies(TEST_DATA_LOCATION);\n } catch (err) {\n await mq.send({\n event: 'workerError',\n reason: 'InstallDependenciesFailure',\n logs: {\n err: {\n message: err.message,\n stack: err.stack\n }\n }\n });\n }\n\n const interval = setInterval(async () => {\n const timeRemaining = context.getRemainingTimeInMillis();\n\n if (timeRemaining > TIMEOUT_THRESHOLD_MSEC) {\n return;\n }\n\n await mq.send({\n event: 'workerError',\n reason: 'AWSLambdaTimeout'\n });\n\n clearInterval(interval);\n }, 5000).unref();\n\n // TODO: Stop Artillery process - relying on Lambda runtime to shut everything down now\n\n const s3 = new S3Client();\n await mq.send({ event: 'workerReady' });\n\n let waitingFor = 0;\n const MAX_WAIT_MSEC = 3 * 60 * 1000;\n const SLEEP_MSEC = 2500;\n\n if (WAIT_FOR_GREEN) {\n while (waitingFor < MAX_WAIT_MSEC) {\n try {\n const params = {\n Bucket: BUCKET,\n Key: `/${TEST_RUN_ID}/green`\n };\n await s3.send(new HeadObjectCommand(params));\n break;\n } catch (_err) {\n await sleep(SLEEP_MSEC);\n waitingFor += SLEEP_MSEC;\n }\n }\n }\n\n try {\n const { err, code, stdout, stderr } = await execArtillery({\n SQS_QUEUE_URL,\n SQS_REGION,\n TEST_RUN_ID,\n WORKER_ID,\n ARTILLERY_ARGS,\n TEST_DATA_LOCATION,\n ENV,\n ARTILLERY_CLOUD_API_KEY,\n ARTILLERY_CLOUD_ENDPOINT\n });\n\n if (err || code !== 0) {\n console.log(err);\n await mq.send({\n event: 'workerError',\n reason: 'ArtilleryError',\n exitCode: code,\n logs: { stdout, stderr }\n });\n }\n } catch (err) {\n console.error(err);\n\n await mq.send({\n event: 'workerError',\n reason: 'StartupFailure',\n logs: {\n err: {\n message: err.message,\n stack: err.stack\n }\n }\n });\n }\n}\n\nasync function execArtillery(options) {\n const {\n SQS_QUEUE_URL,\n SQS_REGION,\n TEST_RUN_ID,\n WORKER_ID,\n ARTILLERY_ARGS,\n ENV,\n NODE_BINARY_PATH,\n ARTILLERY_BINARY_PATH,\n TEST_DATA_LOCATION,\n ARTILLERY_CLOUD_API_KEY,\n ARTILLERY_CLOUD_ENDPOINT\n } = options;\n\n const env = Object.assign(\n {},\n process.env,\n {\n ARTILLERY_PLUGINS: `{\"sqs-reporter\":{\"region\": \"${SQS_REGION}\"}}`,\n SQS_TAGS: `[{\"key\":\"testId\",\"value\":\"${TEST_RUN_ID}\"},{\"key\":\"workerId\",\"value\":\"${WORKER_ID}\"}]`,\n SQS_QUEUE_URL: SQS_QUEUE_URL,\n SQS_REGION: SQS_REGION,\n ARTILLERY_DISABLE_ENSURE: 'true',\n WORKER_ID: WORKER_ID,\n // Set test run ID for this Artillery process explicitly. This makes sure that $testId\n // template variable is set to the same value for all Lambda workers as the one user\n // sees on their terminal\n ARTILLERY_TEST_RUN_ID: TEST_RUN_ID\n // SHIP_LOGS: 'true',\n },\n ARTILLERY_CLOUD_API_KEY ? { ARTILLERY_CLOUD_API_KEY } : {},\n ARTILLERY_CLOUD_ENDPOINT ? { ARTILLERY_CLOUD_ENDPOINT } : {},\n ENV\n );\n\n const TEST_DATA_NODE_MODULES = `${TEST_DATA_LOCATION}/node_modules`;\n const ARTILLERY_NODE_MODULES = '/artillery/node_modules';\n const ARTILLERY_PATH =\n ARTILLERY_BINARY_PATH || `${ARTILLERY_NODE_MODULES}/artillery/bin/run`;\n\n // Set the plugin path to the legacy SQS plugin as well as to user's test data for third party plugins\n env.ARTILLERY_PLUGIN_PATH = `${TEST_DATA_NODE_MODULES}:${ARTILLERY_NODE_MODULES}/artillery/lib/platform/aws-ecs/legacy/plugins`;\n env.HOME = '/tmp';\n env.NODE_PATH = ['/artillery/node_modules', TEST_DATA_NODE_MODULES].join(\n path.delimiter\n );\n\n return runProcess(\n NODE_BINARY_PATH || 'node',\n [ARTILLERY_PATH].concat(ARTILLERY_ARGS),\n { env, log: true }\n );\n}\n\nmodule.exports = { handler, runProcess, execArtillery };\n" }, { "path": "packages/artillery/lib/platform/aws-lambda/lambda-handler/package.json", "content": "{\n \"name\": \"lambda-handler\",\n \"version\": \"1.0.0\",\n \"description\": \"\",\n \"main\": \"index.js\",\n \"scripts\": {\n \"test\": \"echo \\\"Error: no test specified\\\" && exit 1\"\n },\n \"keywords\": [],\n \"author\": \"\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"artillery-plugin-sqs-reporter\": \"^1.2.0\"\n }\n}\n" }, { "path": "packages/artillery/lib/platform/aws-lambda/prices.js", "content": "// Compute pricing for AWS Lambda\n// GB/second divided by 10e10\n// https://aws.amazon.com/lambda/pricing/\nmodule.exports = {\n base: {\n x86_64: 1666670,\n arm64: 1333340\n },\n 'af-south-1': {\n x86_64: 2210000,\n arm64: 1768000\n },\n 'ap-east-1': {\n x86_64: 2292000,\n arm64: 1830000\n },\n 'eu-south-1': {\n x86_64: 1951720,\n arm64: 1561380\n },\n 'me-south-1': {\n x86_64: 2066670,\n arm64: 1653340\n },\n 'me-central-1': {\n x86_64: 2066670,\n arm64: 1653340\n }\n};\n" }, { "path": "packages/artillery/lib/platform/az/aci.js", "content": "// Copyright (c) Artillery Software Inc.\n// SPDX-License-Identifier: BUSL-1.1\n//\n// Non-evaluation use of Artillery on Azure requires a commercial license\n\nconst { QueueConsumer } = require('./aqs-queue-consumer');\nconst { SQS_QUEUES_NAME_PREFIX } = require('../aws/constants');\nconst { DefaultAzureCredential } = require('@azure/identity');\nconst { QueueClient } = require('@azure/storage-queue');\nconst {\n ContainerInstanceManagementClient\n} = require('@azure/arm-containerinstance');\nconst { BlobServiceClient } = require('@azure/storage-blob');\nconst { createTest } = require('../aws-ecs/legacy/create-test');\nconst util = require('../aws-ecs/legacy/util');\nconst generateId = require('../../util/generate-id');\nconst EventEmitter = require('eventemitter3');\nconst debug = require('debug')('platform:azure-aci');\nconst { IMAGE_VERSION, WAIT_TIMEOUT } = require('../aws-ecs/legacy/constants');\nconst { regionNames } = require('./regions');\nconst path = require('node:path');\nconst { Timeout, sleep } = require('../aws-ecs/legacy/time');\nconst dotenv = require('dotenv');\nconst fs = require('node:fs');\n// got is loaded lazily via await import('got')\n\n// Helper to convert readable stream to string\nasync function streamToString(readableStream) {\n return new Promise((resolve, reject) => {\n const chunks = [];\n readableStream.on('data', (data) => {\n chunks.push(data.toString());\n });\n readableStream.on('end', () => {\n resolve(chunks.join(''));\n });\n readableStream.on('error', reject);\n });\n}\n\nclass PlatformAzureACI {\n constructor(script, variablePayload, opts, platformOpts) {\n this.script = script;\n this.variablePayload = variablePayload;\n this.opts = opts;\n this.platformOpts = platformOpts;\n\n this.cloudKey =\n this.platformOpts.cliArgs.key || process.env.ARTILLERY_CLOUD_API_KEY;\n\n this.events = new EventEmitter();\n\n this.testRunId = platformOpts.testRunId;\n\n this.workers = {};\n this.count = 0;\n this.waitingReadyCount = 0;\n this.artilleryArgs = [];\n\n this.azureTenantId =\n process.env.AZURE_TENANT_ID || platformOpts.platformConfig['tenant-id'];\n this.azureSubscriptionId =\n process.env.AZURE_SUBSCRIPTION_ID ||\n platformOpts.platformConfig['subscription-id'];\n this.azureClientId = process.env.AZURE_CLIENT_ID;\n this.azureClientSecret = process.env.AZURE_CLIENT_SECRET;\n\n this.storageAccount =\n process.env.AZURE_STORAGE_ACCOUNT ||\n platformOpts.platformConfig['storage-account'];\n this.blobContainerName =\n process.env.AZURE_STORAGE_BLOB_CONTAINER ||\n platformOpts.platformConfig['blob-container'];\n this.resourceGroupName =\n process.env.AZURE_RESOURCE_GROUP ||\n platformOpts.platformConfig['resource-group'];\n\n this.cpu = parseInt(platformOpts.platformConfig.cpu, 10) || 4;\n this.memory = parseInt(platformOpts.platformConfig.memory, 10) || 8;\n this.region = platformOpts.platformConfig.region || 'eastus';\n\n this.extraEnvVars = {};\n\n if (!regionNames.includes(this.region)) {\n const err = new Error(`Invalid region: ${this.region}`);\n err.code = 'INVALID_REGION';\n err.url = 'https://docs.art/az/regions';\n throw err;\n }\n\n if (\n !this.azureTenantId ||\n !this.azureSubscriptionId ||\n !this.azureClientId ||\n !this.azureClientSecret\n ) {\n const err = new Error('Azure credentials not found');\n err.code = 'AZURE_CREDENTIALS_NOT_FOUND';\n err.url = 'https://docs.art/az/credentials';\n throw err;\n }\n\n if (\n !this.storageAccount ||\n !this.blobContainerName ||\n !this.resourceGroupName\n ) {\n const err = new Error('Azure configuration not found');\n err.code = 'AZURE_CONFIG_NOT_FOUND';\n err.url = 'https://docs.art/az/configuration';\n throw err;\n }\n\n this.containerInstances = [];\n }\n\n async init() {\n const credential = new DefaultAzureCredential();\n\n artillery.log('Tenant ID:', this.azureTenantId);\n artillery.log('Subscription ID:', this.azureSubscriptionId);\n artillery.log('Storage account:', this.storageAccount);\n artillery.log('Blob container:', this.blobContainerName);\n artillery.log('Resource group:', this.resourceGroupName);\n\n if (this.platformOpts.count > 5) {\n const ok = await this.checkLicense();\n if (!ok) {\n console.log();\n console.log(`\n+--------------------------------------------------+\n| License for Azure integration not found |\n| |\n| Load tests on Azure are limited to a maximum of |\n| 5 workers without a valid license. |\n| See https://docs.art/az/license for more details |\n+--------------------------------------------------+\n`);\n throw new Error('ERR_LICENSE_REQUIRED');\n }\n }\n //\n // Upload test bundle\n //\n\n this.blobServiceClient = new BlobServiceClient(\n `https://${this.storageAccount}.blob.core.windows.net`,\n credential\n );\n this.blobContainerClient = this.blobServiceClient.getContainerClient(\n this.blobContainerName\n );\n\n const customSyncClient = {\n send: async (command) => {\n // command is always an instance of PutObjectCommand() from @aws-sdk/client-s3\n const { Key, Body } = command.input;\n const blockBlobClient =\n this.blobContainerClient.getBlockBlobClient(Key);\n await blockBlobClient.upload(Body, Body.length);\n }\n };\n\n const { manifest } = await createTest(this.opts.absoluteScriptPath, {\n name: this.testRunId,\n config: this.platformOpts.cliArgs.config,\n flags: this.platformOpts.cliArgs,\n customSyncClient\n });\n\n //\n // Create the queue\n //\n this.queueName = `${SQS_QUEUES_NAME_PREFIX}_${this.testRunId}.`\n .replaceAll('_', '-')\n .slice(0, 63);\n this.queueUrl =\n process.env.AZURE_STORAGE_QUEUE_URL ||\n `https://${this.storageAccount}.queue.core.windows.net/${this.queueName}`;\n const queueClient = new QueueClient(this.queueUrl, credential);\n await queueClient.create();\n this.aqsClient = queueClient;\n\n // Construct CLI args for the container\n\n this.artilleryArgs = [];\n this.artilleryArgs.push('run');\n\n if (this.platformOpts.cliArgs.environment) {\n this.artilleryArgs.push('-e');\n this.artilleryArgs.push(this.platformOpts.cliArgs.environment);\n }\n if (this.platformOpts.cliArgs.solo) {\n this.artilleryArgs.push('--solo');\n }\n\n if (this.platformOpts.cliArgs.target) {\n this.artilleryArgs.push('--target');\n this.artilleryArgs.push(this.platformOpts.cliArgs.target);\n }\n\n if (this.platformOpts.cliArgs.variables) {\n this.artilleryArgs.push('-v');\n this.artilleryArgs.push(this.platformOpts.cliArgs.variables);\n }\n\n if (this.platformOpts.cliArgs.overrides) {\n this.artilleryArgs.push('--overrides');\n this.artilleryArgs.push(this.platformOpts.cliArgs.overrides);\n }\n\n if (this.platformOpts.cliArgs.dotenv) {\n const dotEnvPath = path.resolve(\n process.cwd(),\n this.platformOpts.cliArgs.dotenv\n );\n const contents = fs.readFileSync(dotEnvPath);\n const envVars = dotenv.parse(contents);\n this.extraEnvVars = Object.assign({}, this.extraEnvVars, envVars);\n }\n\n if (this.platformOpts.cliArgs['scenario-name']) {\n this.artilleryArgs.push('--scenario-name');\n this.artilleryArgs.push(this.platformOpts.cliArgs['scenario-name']);\n }\n\n if (this.platformOpts.cliArgs.config) {\n this.artilleryArgs.push('--config');\n const p = manifest.files.filter(\n (x) => x.orig === this.opts.absoluteConfigPath\n )[0];\n this.artilleryArgs.push(p.noPrefixPosix);\n }\n\n if (this.platformOpts.cliArgs.quiet) {\n this.artilleryArgs.push('--quiet');\n }\n\n // This needs to be the last argument for now:\n const p = manifest.files.filter(\n (x) => x.orig === this.opts.absoluteScriptPath\n )[0];\n this.artilleryArgs.push(p.noPrefixPosix);\n\n const poolSize =\n typeof process.env.CONSUMER_POOL_SIZE !== 'undefined'\n ? parseInt(process.env.CONSUMER_POOL_SIZE, 10)\n : Math.max(Math.ceil(this.count / 25), 5);\n\n const consumer = new QueueConsumer(\n { poolSize },\n {\n queueUrl: process.env.AZURE_STORAGE_QUEUE_URL || this.queueUrl,\n handleMessage: async (message) => {\n let payload = null;\n let attributes = null;\n try {\n const result = JSON.parse(message.Body);\n payload = result.payload;\n attributes = result.attributes;\n } catch (parseErr) {\n console.error(parseErr);\n console.error(message.Body);\n }\n\n if (process.env.LOG_QUEUE_MESSAGES) {\n console.log(message);\n }\n\n if (!payload) {\n throw new Error('AQS message with an empty body');\n }\n\n // Handle overflow messages stored in blob storage\n if (payload._overflowRef) {\n try {\n const blobClient =\n this.blobContainerClient.getBlockBlobClient(\n payload._overflowRef\n );\n const downloadResponse = await blobClient.download(0);\n const downloaded = await streamToString(\n downloadResponse.readableStreamBody\n );\n const fullMessage = JSON.parse(downloaded);\n payload = fullMessage.payload;\n attributes = fullMessage.attributes;\n } catch (blobErr) {\n console.error('Failed to fetch worker message:', blobErr);\n throw new Error(\n `Failed to fetch worker message: ${payload._overflowRef}`\n );\n }\n }\n\n if (!attributes || !attributes.testId || !attributes.workerId) {\n throw new Error('AQS message with no testId or workerId');\n }\n\n if (this.testRunId !== attributes.testId) {\n throw new Error('AQS message for an unknown testId');\n }\n\n const workerId = attributes.workerId;\n if (payload.event === 'workerStats') {\n this.events.emit('stats', workerId, payload);\n } else if (payload.event === 'artillery.log') {\n console.log(payload.log);\n } else if (payload.event === 'done') {\n // 'done' handler in Launcher exects the message argument to have an \"id\" and \"report\" fields\n payload.id = workerId;\n payload.report = payload.stats;\n this.events.emit('done', workerId, payload);\n } else if (\n payload.event === 'phaseStarted' ||\n payload.event === 'phaseCompleted'\n ) {\n payload.id = workerId;\n this.events.emit(payload.event, workerId, { phase: payload.phase });\n } else if (payload.event === 'workerError') {\n global.artillery.suggestedExitCode = payload.exitCode || 1;\n\n if (payload.exitCode !== 21) {\n this.events.emit(payload.event, workerId, {\n id: workerId,\n error: new Error(\n `A worker has exited with an error. Reason: ${payload.reason}`\n ),\n level: 'error',\n aggregatable: false,\n logs: payload.logs\n });\n }\n } else if (payload.event === 'workerReady') {\n this.events.emit(payload.event, workerId);\n this.waitingReadyCount++;\n\n // TODO: Do this only for batches of workers with \"wait\" option set\n if (this.waitingReadyCount === this.count) {\n await this.sendGoSignal();\n }\n } else {\n debug(payload);\n }\n }\n }\n );\n\n consumer.on('error', (err) => {\n console.error(err);\n });\n\n this.queueConsumer = consumer;\n\n const metadata = {\n region: this.region,\n platformConfig: {\n memory: this.memory,\n cpu: this.cpu\n }\n };\n global.artillery.globalEvents.emit('metadata', metadata);\n }\n\n getDesiredWorkerCount() {\n return this.platformOpts.count;\n }\n\n async startJob() {\n await this.init();\n\n console.log('Creating container instances...');\n\n // Create & run the leader:\n const { workerId } = await this.createWorker();\n this.workers[workerId] = { workerId };\n await this.runWorker(workerId, { isLeader: true });\n\n // Run the rest of the containers we need:\n for (let i = 0; i < this.platformOpts.count - 1; i++) {\n const { workerId } = await this.createWorker();\n this.workers[workerId] = { workerId };\n await this.runWorker(workerId);\n\n if (i > 0 && i % 10 === 0) {\n const delayMs =\n Math.floor(\n Math.random() *\n parseInt(process.env.AZURE_LAUNCH_STAGGER_SEC || '5', 10)\n ) * 1000;\n await sleep(delayMs);\n }\n }\n\n let instancesCreated = false;\n console.log('Waiting for Azure ACI to create container instances...');\n\n const containerInstanceClient = new ContainerInstanceManagementClient(\n new DefaultAzureCredential(),\n this.azureSubscriptionId\n );\n\n const provisioningWaitTimeout = new Timeout(WAIT_TIMEOUT * 1000).start();\n\n let containerGroupsInTestRun = [];\n while (true) {\n const containerGroupListResult =\n containerInstanceClient.containerGroups.listByResourceGroup(\n this.resourceGroupName\n );\n\n containerGroupsInTestRun = [];\n for await (const containerGroup of containerGroupListResult) {\n if (containerGroup.name.indexOf(this.testRunId) > 0) {\n containerGroupsInTestRun.push(containerGroup);\n }\n }\n\n const byStatus = containerGroupsInTestRun.reduce((acc, cg) => {\n if (!acc[cg.provisioningState]) {\n acc[cg.provisioningState] = 0;\n }\n acc[cg.provisioningState]++;\n return acc;\n }, {});\n\n if (\n (byStatus.Succeeded || 0) + (byStatus.Running || 0) ===\n this.count\n ) {\n instancesCreated = true;\n break;\n }\n\n if (provisioningWaitTimeout.timedout()) {\n break;\n }\n\n await sleep(10000);\n }\n\n if (instancesCreated) {\n console.log(\n 'Container instances have been created. Waiting for workers to start...'\n );\n await this.queueConsumer.start();\n } else {\n console.log('Some containers instances failed to provision');\n console.log('Please see the Azure console for details');\n console.log(\n 'https://portal.azure.com/#view/HubsExtension/BrowseResource/resourceType/Microsoft.ContainerInstance%2FcontainerGroups'\n );\n await global.artillery.shutdown();\n }\n }\n\n async shutdown() {\n this.queueConsumer.stop();\n try {\n await this.aqsClient.delete();\n } catch (_err) {}\n\n const credential = new DefaultAzureCredential();\n\n if (process.env.RETAIN_CONTAINER_INSTANCES !== 'true') {\n const containerInstanceClient = new ContainerInstanceManagementClient(\n credential,\n this.azureSubscriptionId\n );\n\n const containerGroupListResult =\n containerInstanceClient.containerGroups.listByResourceGroup(\n this.resourceGroupName\n );\n\n for await (const containerGroup of containerGroupListResult) {\n if (containerGroup.name.indexOf(this.testRunId) > 0) {\n try {\n await containerInstanceClient.containerGroups.beginDeleteAndWait(\n this.resourceGroupName,\n containerGroup.name\n );\n } catch (err) {\n console.log(err);\n }\n }\n }\n }\n }\n\n async sendGoSignal() {\n const Key = `tests/${this.testRunId}/go.json`;\n const blockBlobClient = this.blobContainerClient.getBlockBlobClient(Key);\n const _res = await blockBlobClient.upload('', 0);\n }\n\n async createWorker() {\n const workerId = generateId('worker');\n return { workerId };\n }\n\n async runWorker(workerId, opts = { isLeader: false }) {\n const credential = new DefaultAzureCredential();\n\n const imageVersion =\n process.env.ARTILLERY_WORKER_IMAGE_VERSION || IMAGE_VERSION;\n const defaultArchitecture = 'x86_64';\n const containerImageURL =\n process.env.WORKER_IMAGE_URL ||\n `public.ecr.aws/d8a4z9o5/artillery-worker:${imageVersion}-${defaultArchitecture}`;\n\n const client = new ContainerInstanceManagementClient(\n credential,\n this.azureSubscriptionId\n );\n\n const environmentVariables = [\n {\n name: 'WORKER_ID_OVERRIDE',\n value: workerId\n },\n {\n name: 'ARTILLERY_TEST_RUN_ID',\n value: this.testRunId\n },\n // {\n // name: 'DEBUGX',\n // value: 'true',\n // },\n {\n name: 'DEBUG',\n value: 'cloud'\n },\n {\n name: 'IS_LEADER',\n value: String(opts.isLeader)\n },\n {\n name: 'AQS_QUEUE_NAME',\n value: this.queueName\n },\n {\n name: 'AZURE_STORAGE_ACCOUNT',\n value: this.storageAccount\n },\n {\n name: 'AZURE_STORAGE_BLOB_CONTAINER',\n value: this.blobContainerName\n },\n {\n name: 'AZURE_SUBSCRIPTION_ID',\n secureValue: this.azureSubscriptionId\n },\n {\n name: 'AZURE_TENANT_ID',\n secureValue: this.azureTenantId\n },\n {\n name: 'AZURE_CLIENT_ID',\n secureValue: this.azureClientId\n },\n {\n name: 'AZURE_CLIENT_SECRET',\n secureValue: this.azureClientSecret\n },\n {\n name: 'AZURE_STORAGE_AUTH_MODE',\n value: 'login'\n }\n ];\n\n if (this.cloudKey) {\n environmentVariables.push({\n name: 'ARTILLERY_CLOUD_API_KEY',\n secureValue: this.cloudKey\n });\n }\n\n const cloudEndpoint = process.env.ARTILLERY_CLOUD_ENDPOINT;\n if (cloudEndpoint) {\n environmentVariables.push({\n name: 'ARTILLERY_CLOUD_ENDPOINT',\n secureValue: cloudEndpoint\n });\n }\n\n for (const [name, value] of Object.entries(this.extraEnvVars)) {\n environmentVariables.push({ name, value });\n }\n\n const containerGroup = {\n location: this.region,\n containers: [\n {\n name: 'artillery-worker',\n image: containerImageURL,\n resources: {\n requests: {\n cpu: this.cpu,\n memoryInGB: this.memory\n }\n },\n command: [\n '/artillery/loadgen-worker',\n '-z',\n 'yes', // yes for Azure\n '-q',\n this.queueUrl,\n '-p',\n this.blobContainerName,\n '-a',\n util.btoa(JSON.stringify(this.artilleryArgs)),\n '-i',\n this.testRunId,\n '-t',\n String(WAIT_TIMEOUT),\n '-d',\n 'NOT_USED_ON_AZURE',\n '-r',\n 'NOT_USED_ON_AZURE'\n ],\n environmentVariables\n }\n ],\n osType: 'Linux',\n restartPolicy: 'Never'\n };\n\n if (!this.ts) {\n this.ts = Date.now();\n }\n\n const containerGroupName = `artillery-test-${this.ts}-${this.testRunId}-${this.count}`;\n try {\n const containerInstance =\n await client.containerGroups.beginCreateOrUpdate(\n this.resourceGroupName,\n containerGroupName,\n containerGroup\n );\n\n this.containerInstances.push(containerInstance);\n\n this.count++;\n } catch (err) {\n // TODO: Make this better\n console.log(err.code);\n console.log(err.details?.error?.message);\n throw err;\n }\n }\n\n async stopWorker(_workerId) {}\n\n async checkLicense() {\n const request = (await import('got')).default;\n const baseUrl =\n process.env.ARTILLERY_CLOUD_ENDPOINT || 'https://app.artillery.io';\n const res = await request.get(`${baseUrl}/api/user/whoami`, {\n headers: {\n 'x-auth-token': this.cloudKey\n },\n throwHttpErrors: false,\n retry: {\n limit: 3\n }\n });\n\n try {\n const body = JSON.parse(res.body);\n const activeOrg = body.activeOrg;\n if (!activeOrg) {\n return false;\n }\n if (!Array.isArray(body.memberships)) {\n return false;\n }\n\n const activeMembership = body.memberships.find(\n (membership) => membership.id === activeOrg\n );\n\n if (!activeMembership) {\n return false;\n }\n\n const plan = activeMembership.plan;\n return plan !== 'developer';\n } catch (_err) {\n return false;\n }\n }\n}\n\nmodule.exports = PlatformAzureACI;\n" }, { "path": "packages/artillery/lib/platform/az/aqs-queue-consumer.js", "content": "// Copyright (c) Artillery Software Inc.\n// SPDX-License-Identifier: BUSL-1.1\n//\n// Non-evaluation use of Artillery on Azure requires a commercial license\n//\n\nconst EventEmitter = require('eventemitter3');\n\nconst { QueueClient } = require('@azure/storage-queue');\nconst { DefaultAzureCredential } = require('@azure/identity');\n\nconst debug = require('debug')('platform:azure-aci');\n\nclass AzureQueueConsumer extends EventEmitter {\n constructor(\n opts = { poolSize: 30 },\n {\n queueUrl,\n pollIntervalMsec = 5000,\n visibilityTimeout = 60,\n batchSize = 32,\n handleMessage\n }\n ) {\n super();\n this.queueUrl = queueUrl;\n this.batchSize = batchSize;\n this.visibilityTimeout = visibilityTimeout;\n this.handleMessage = handleMessage;\n this.pollIntervalMsec = pollIntervalMsec;\n\n this.poolSize = opts.poolSize;\n\n this.consumers = [];\n }\n\n async start() {\n const credential = new DefaultAzureCredential();\n\n for (let i = 0; i < this.poolSize; i++) {\n debug('Creating consumer in pool', i);\n const queueClient = new QueueClient(this.queueUrl, credential);\n const pollInterval = setInterval(async () => {\n const messages = await queueClient.receiveMessages({\n numberOfMessages: this.batchSize,\n visibilityTimeout: this.visibilityTimeout\n });\n\n // TODO: Handle errors - no auth, no queue, network etc\n\n for (const messageItem of messages.receivedMessageItems) {\n const message = {\n Body: messageItem.messageText\n };\n\n let processed = false;\n try {\n await this.handleMessage(message);\n processed = true;\n } catch (err) {\n console.log(err);\n }\n\n if (processed) {\n try {\n await queueClient.deleteMessage(\n messageItem.messageId,\n messageItem.popReceipt\n );\n } catch (_err) {}\n }\n }\n }, this.pollIntervalMsec);\n\n this.consumers.push(pollInterval);\n }\n }\n\n async stop() {\n for (const interval of this.consumers) {\n clearInterval(interval);\n }\n }\n\n // TODO: events: error, empty\n}\n\nmodule.exports = { QueueConsumer: AzureQueueConsumer };\n" }, { "path": "packages/artillery/lib/platform/az/regions.js", "content": "const regionNames = [\n 'australiacentral',\n 'australiacentral2',\n 'australiaeast',\n 'australiasoutheast',\n 'brazilsouth',\n 'canadacentral',\n 'canadaeast',\n 'centralindia',\n 'centralus',\n 'eastasia',\n 'eastus',\n 'eastus2',\n 'francecentral',\n 'francesouth',\n 'germanynorth',\n 'germanywestcentral',\n 'israelcentral',\n 'italynorth',\n 'japaneast',\n 'japanwest',\n 'jioindiawest',\n 'koreacentral',\n 'koreasouth',\n 'mexicocentral',\n 'northcentralus',\n 'northeurope',\n 'norwayeast',\n 'norwaywest',\n 'polandcentral',\n 'qatarcentral',\n 'southafricanorth',\n 'southafricawest',\n 'southcentralus',\n 'southeastasia',\n 'southindia',\n 'spaincentral',\n 'swedencentral',\n 'switzerlandnorth',\n 'switzerlandwest',\n 'uaecentral',\n 'uaenorth',\n 'uksouth',\n 'ukwest',\n 'westcentralus',\n 'westeurope',\n 'westindia',\n 'westus',\n 'westus2'\n];\n\nmodule.exports = { regionNames };\n" }, { "path": "packages/artillery/lib/platform/cloud/api.js", "content": "const { getCloudHttpClient } = require('./http-client');\n\nclass Client {\n constructor({ apiKey, baseUrl }) {\n this.apiKey = apiKey || process.env.ARTILLERY_CLOUD_API_KEY;\n\n if (!apiKey) {\n const err = new Error();\n err.name = 'CloudAPIKeyMissing';\n throw err;\n }\n\n this.baseUrl =\n baseUrl ||\n process.env.ARTILLERY_CLOUD_ENDPOINT ||\n 'https://app.artillery.io';\n\n this.whoamiEndpoint = `${this.baseUrl}/api/user/whoami`;\n this.stashDetailsEndpoint = `${this.baseUrl}/api/stash`;\n\n this.defaultHeaders = {\n 'x-auth-token': this.apiKey\n };\n }\n\n async whoami() {\n const request = await getCloudHttpClient();\n const res = await request.get(this.whoamiEndpoint, {\n headers: this.defaultHeaders\n });\n\n const body = JSON.parse(res.body);\n this.orgId = body.activeOrg;\n return body;\n }\n\n async getStashDetails({ orgId }) {\n const request = await getCloudHttpClient();\n const currentOrgId = orgId || this.orgId;\n\n const res = await request.get(\n `${this.baseUrl}/api/org/${currentOrgId}/stash`,\n {\n headers: this.defaultHeaders\n }\n );\n\n if (res.statusCode === 200) {\n let body = {};\n try {\n body = JSON.parse(res.body);\n } catch (err) {\n console.error(err);\n return null;\n }\n\n if (body.url && body.token) {\n return { url: body.url, token: body.token };\n } else {\n return null;\n }\n } else {\n return null;\n }\n }\n}\n\nfunction createClient(opts) {\n return new Client(opts);\n}\n\nmodule.exports = {\n createClient\n};\n" }, { "path": "packages/artillery/lib/platform/cloud/cloud.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\n\n\nconst debug = require('debug')('cloud');\nconst { getCloudHttpClient } = require('./http-client');\nconst awaitOnEE = require('../../util/await-on-ee');\nconst sleep = require('../../util/sleep');\nconst util = require('node:util');\nconst chokidar = require('chokidar');\nconst fs = require('node:fs');\nconst path = require('node:path');\nconst { isCI, name: ciName, GITHUB_ACTIONS } = require('ci-info');\n\nclass ArtilleryCloudPlugin {\n constructor(_script, _events, { flags }) {\n this.enabled = false;\n\n const isInteractiveUse = typeof flags.record !== 'undefined';\n const enabledInCloudWorker =\n typeof process.env.WORKER_ID !== 'undefined' &&\n typeof process.env.ARTILLERY_CLOUD_API_KEY !== 'undefined';\n\n if (!isInteractiveUse && !enabledInCloudWorker) {\n return;\n }\n\n this.enabled = true;\n\n this.apiKey = flags.key || process.env.ARTILLERY_CLOUD_API_KEY;\n\n this.baseUrl =\n process.env.ARTILLERY_CLOUD_ENDPOINT || 'https://app.artillery.io';\n this.eventsEndpoint = `${this.baseUrl}/api/events`;\n this.whoamiEndpoint = `${this.baseUrl}/api/user/whoami`;\n this.getAssetUploadUrls = `${this.baseUrl}/api/asset-upload-urls`;\n this.pingEndpoint = `${this.baseUrl}/api/ping`;\n\n this.defaultHeaders = {\n 'x-auth-token': this.apiKey\n };\n this.unprocessedLogsCounter = 0;\n this.cancellationRequestedBy = '';\n\n let testEndInfo = {};\n\n // This value is available in cloud workers only. With interactive use, it'll be set\n // in the test:init event handler.\n this.testRunId = process.env.ARTILLERY_TEST_RUN_ID;\n\n if (isInteractiveUse) {\n global.artillery.globalEvents.on('test:init', async (testInfo) => {\n debug('test:init', testInfo);\n\n this.testRunId = testInfo.testRunId;\n\n const testRunUrl = `${this.baseUrl}/${this.orgId}/load-tests/${global.artillery.testRunId}`;\n testEndInfo.testRunUrl = testRunUrl;\n\n this.getLoadTestEndpoint = `${this.baseUrl}/api/load-tests/${this.testRunId}/status`;\n\n let ciURL = null;\n if (isCI && GITHUB_ACTIONS) {\n const { GITHUB_SERVER_URL, GITHUB_REPOSITORY, GITHUB_RUN_ID } =\n process.env;\n if (GITHUB_SERVER_URL && GITHUB_REPOSITORY && GITHUB_RUN_ID) {\n ciURL = `${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}`;\n }\n }\n\n const metadata = Object.assign({}, testInfo.metadata, {\n isCI,\n ciName,\n ciURL\n });\n\n await this._event('testrun:init', {\n metadata: metadata\n });\n this.setGetLoadTestInterval = this.setGetStatusInterval();\n\n if (typeof testInfo.flags.note !== 'undefined') {\n await this._event('testrun:addnote', { text: testInfo.flags.note });\n }\n\n this.uploading = 0;\n });\n\n global.artillery.globalEvents.on('phaseStarted', async (phase) => {\n await this._event('testrun:event', {\n eventName: 'phaseStarted',\n eventAttributes: phase\n });\n });\n\n global.artillery.globalEvents.on('phaseCompleted', async (phase) => {\n await this._event('testrun:event', {\n eventName: 'phaseCompleted',\n eventAttributes: phase\n });\n });\n\n global.artillery.globalEvents.on('stats', async (report) => {\n debug('stats', new Date());\n const ts = Number(report.period);\n await this._event('testrun:metrics', { report, ts });\n });\n\n global.artillery.globalEvents.on('done', async (report) => {\n debug('done');\n debug(\n 'testrun:aggregatereport: payload size:',\n JSON.stringify(report).length\n );\n await this._event('testrun:aggregatereport', { aggregate: report });\n });\n\n global.artillery.globalEvents.on('checks', async (checks) => {\n debug('checks');\n await this._event('testrun:checks', { checks });\n });\n\n global.artillery.globalEvents.on('logLines', async (lines, ts) => {\n debug('logLines event', ts);\n this.unprocessedLogsCounter += 1;\n\n let text = '';\n\n try {\n JSON.stringify(lines);\n } catch (stringifyErr) {\n console.log('Could not serialize console log');\n console.log(stringifyErr);\n }\n for (const args of lines) {\n text += util.format(...Object.keys(args).map((k) => args[k])) + '\\n';\n }\n\n try {\n await this._event('testrun:textlog', { lines: text, ts });\n } catch (err) {\n debug(err);\n } finally {\n this.unprocessedLogsCounter -= 1;\n }\n\n debug('last 100 characters:');\n debug(text.slice(text.length - 100, text.length));\n });\n\n global.artillery.globalEvents.on('metadata', async (metadata) => {\n await this._event('testrun:addmetadata', {\n metadata\n });\n });\n } // isInteractiveUse\n\n global.artillery.ext({\n ext: 'beforeExit',\n method: async ({ testInfo, report }) => {\n debug('beforeExit');\n testEndInfo = {\n ...testEndInfo,\n ...testInfo,\n report\n };\n }\n });\n\n // Send test end events just before the CLI shuts down. This ensures that all console\n // output has been captured and sent to the dashboard.\n global.artillery.ext({\n ext: 'onShutdown',\n method: async (opts) => {\n if (!this.enabled || this.off) {\n return;\n }\n\n if (isInteractiveUse) {\n clearInterval(this.setGetLoadTestInterval);\n\n // Wait for the last logLines events to be processed, as they can sometimes finish processing after shutdown has finished\n await awaitOnEE(\n global.artillery.globalEvents,\n 'logLines',\n 200,\n 1 * 1000 //wait at most 1 second for a final log lines event emitter to be fired\n );\n }\n\n await this.waitOnUnprocessedLogs(5 * 60 * 1000); //just waiting for ee is not enough, as the api call takes time\n\n if (isInteractiveUse) {\n await this._event('testrun:end', {\n ts: testEndInfo.endTime,\n exitCode: global.artillery.suggestedExitCode || opts.exitCode,\n isEarlyStop: !!opts.earlyStop,\n report: testEndInfo.report\n });\n\n console.log('\\n');\n if (this.cancellationRequestedBy) {\n console.log(`Test run stopped by ${this.cancellationRequestedBy}.`);\n }\n console.log(`Run URL: ${testEndInfo.testRunUrl}`);\n }\n }\n });\n }\n\n async init() {\n this.request = await getCloudHttpClient();\n\n if (!this.apiKey) {\n const err = new Error();\n err.name = 'CloudAPIKeyMissing';\n this.off = true;\n throw err;\n }\n\n let res;\n let body;\n try {\n res = await this.request.get(this.whoamiEndpoint, {\n headers: this.defaultHeaders,\n retry: { limit: 0 }\n });\n\n body = JSON.parse(res.body);\n debug(res.body);\n this.orgId = body.activeOrg;\n } catch (err) {\n this.off = true;\n throw err;\n }\n\n if (res.statusCode === 401) {\n const err = new Error();\n err.name = 'APIKeyUnauthorized';\n this.off = true;\n throw err;\n }\n\n let postSucceeded = false;\n try {\n res = await this.request.post(this.pingEndpoint, {\n headers: this.defaultHeaders\n });\n\n if (res.statusCode === 200) {\n postSucceeded = true;\n }\n } catch (_err) {\n this.off = true;\n }\n\n if (!postSucceeded) {\n const err = new Error();\n err.name = 'PingFailed';\n this.off = true;\n throw err;\n }\n\n console.log('Artillery Cloud reporting is configured for this test run');\n console.log(\n `Run URL: ${this.baseUrl}/${this.orgId}/load-tests/${global.artillery.testRunId}`\n );\n\n this.user = {\n id: body.id,\n email: body.email\n };\n\n const outputDir =\n process.env.PLAYWRIGHT_TRACING_OUTPUT_DIR ||\n `/tmp/${global.artillery.testRunId}/`;\n\n try {\n fs.mkdirSync(outputDir, { recursive: true });\n } catch (_err) {}\n\n const watcher = chokidar.watch(outputDir, {\n ignored: /(^|[/\\\\])\\../, // ignore dotfiles\n persistent: true,\n ignorePermissionErrors: true,\n ignoreInitial: true,\n awaitWriteFinish: {\n stabilityThreshold: 2000,\n pollInterval: 500\n }\n });\n\n watcher.on('add', (fp) => {\n if (path.basename(fp).startsWith('trace-') && fp.endsWith('.zip')) {\n this.uploading++;\n this._uploadAsset(fp);\n }\n });\n }\n\n async _uploadAsset(localFilename) {\n const payload = {\n testRunId: this.testRunId,\n filenames: [path.basename(localFilename)]\n };\n\n debug(payload);\n\n let url;\n try {\n // TODO: This could get rejected if a limit is exceeded so need to handle that case\n const res = await this.request.post(this.getAssetUploadUrls, {\n headers: this.defaultHeaders,\n json: payload\n });\n\n const body = JSON.parse(res.body);\n debug(body);\n\n url = body.urls[path.basename(localFilename)];\n } catch (err) {\n debug(err);\n }\n\n if (!url) {\n return;\n }\n\n const fileStream = fs.createReadStream(localFilename);\n try {\n const _response = await this.request.put(url, {\n body: fileStream\n });\n } catch (error) {\n console.error('Failed to upload Playwright trace recording:', error);\n console.log(error.code, error.name, error.message, error.stack);\n } finally {\n this.uploading--;\n artillery.globalEvents.emit('counter', 'browser.traces.uploaded', 1);\n try {\n fs.unlinkSync(localFilename);\n } catch (err) {\n debug(err);\n }\n }\n }\n\n async waitOnUnprocessedLogs(maxWaitTime) {\n let waitedTime = 0;\n while (\n (this.unprocessedLogsCounter > 0 || this.uploading > 0) &&\n waitedTime < maxWaitTime\n ) {\n debug('waiting on unprocessed logs');\n await sleep(500);\n waitedTime += 500;\n }\n\n return true;\n }\n\n setGetStatusInterval() {\n const interval = setInterval(async () => {\n if (this.cancellationRequestedBy) {\n return;\n }\n const res = await this._getLoadTestStatus();\n\n if (!res) {\n debug('No response from Artillery Cloud get status');\n return;\n }\n\n if (res.status !== 'CANCELLATION_REQUESTED') {\n return;\n }\n\n console.log(\n `WARNING: Artillery Cloud user ${res.cancelledBy} requested to stop the test. Stopping test run - this may take a few seconds.`\n );\n this.cancellationRequestedBy = res.cancelledBy;\n global.artillery.suggestedExitCode = 8;\n await global.artillery.shutdown({ earlyStop: true });\n }, 5000);\n\n return interval;\n }\n\n async _getLoadTestStatus() {\n debug('☁ī¸', 'Getting load test status');\n\n try {\n const res = await this.request.get(this.getLoadTestEndpoint, {\n headers: this.defaultHeaders\n });\n\n return JSON.parse(res.body);\n } catch (error) {\n debug(error);\n }\n }\n\n async _event(eventName, eventPayload) {\n debug('☁ī¸', eventName, eventPayload);\n\n try {\n const res = await this.request.post(this.eventsEndpoint, {\n headers: this.defaultHeaders,\n json: {\n eventType: eventName,\n eventData: Object.assign({}, eventPayload, {\n testRunId: this.testRunId\n })\n },\n retry: { limit: 2 }\n });\n\n if (res.statusCode !== 200) {\n if (res.statusCode === 401) {\n console.log(\n 'Error: API key is invalid. Could not send test data to Artillery Cloud.'\n );\n } else {\n console.log('Error: error sending test data to Artillery Cloud');\n console.log('Test report may be incomplete');\n }\n let body;\n try {\n body = JSON.parse(res.body);\n } catch (_err) {}\n\n if (body?.requestId) {\n console.log('Request ID:', body.requestId);\n }\n }\n debug('☁ī¸', eventName, 'sent');\n } catch (err) {\n debug(err);\n }\n }\n\n cleanup(done) {\n debug('cleaning up');\n done(null);\n }\n}\n\nmodule.exports.Plugin = ArtilleryCloudPlugin;\n" }, { "path": "packages/artillery/lib/platform/cloud/http-client.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst DEFAULT_TIMEOUT_MS = 20 * 10000;\nconst DEFAULT_RETRY_LIMIT = 3;\n\nlet _client;\nasync function getCloudHttpClient() {\n if (!_client) {\n const got = (await import('got')).default;\n _client = got.extend({\n timeout: { response: DEFAULT_TIMEOUT_MS },\n retry: {\n limit: DEFAULT_RETRY_LIMIT,\n methods: ['GET', 'POST', 'PUT']\n },\n throwHttpErrors: false\n });\n }\n return _client;\n}\n\nmodule.exports = { getCloudHttpClient };\n" }, { "path": "packages/artillery/lib/platform/local/artillery-worker-local.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\nconst EventEmitter = require('eventemitter3');\nconst { Worker } = require('node:worker_threads');\nconst path = require('node:path');\n\nconst STATES = require('../worker-states');\n\nconst awaitOnEE = require('../../util/await-on-ee');\n\nconst returnWorkerEnv = (needsSourcemap) => {\n const env = { ...process.env };\n\n if (needsSourcemap) {\n env.NODE_OPTIONS = process.env.NODE_OPTIONS\n ? `${process.env.NODE_OPTIONS} --enable-source-maps`\n : '--enable-source-maps';\n }\n\n return env;\n};\n\nclass ArtilleryWorker {\n constructor(opts) {\n this.opts = opts;\n this.events = new EventEmitter(); // events for consumers of this object\n this.workerEvents = new EventEmitter(); // turn events delivered via 'message' events into their own messages\n }\n\n async init(_opts) {\n this.state = STATES.initializing;\n\n const workerEnv = returnWorkerEnv(global.artillery.hasTypescriptProcessor);\n\n this.worker = new Worker(path.join(__dirname, 'worker.js'), {\n env: workerEnv\n });\n this.workerId = this.worker.threadId;\n this.worker.on('error', this.onError.bind(this));\n // TODO:\n this.worker.on('exit', (exitCode) => {\n this.events.emit('exit', exitCode);\n });\n\n this.worker.on('messageerror', (_err) => {});\n\n // TODO: Expose performance metrics via getHeapSnapshot() and performance object.\n\n await awaitOnEE(this.worker, 'online', 10);\n\n // Relay messages onto the real event emitter:\n this.worker.on('message', (message) => {\n switch (message.event) {\n case 'log':\n this.events.emit('log', message);\n this.workerEvents.emit('log', message);\n break;\n case 'workerError':\n this.events.emit('workerError', message);\n this.workerEvents.emit('workerError', message);\n break;\n case 'phaseStarted':\n this.events.emit('phaseStarted', message);\n this.workerEvents.emit('phaseStarted', message);\n break;\n case 'phaseCompleted':\n this.events.emit('phaseCompleted', message);\n this.workerEvents.emit('phaseCompleted', message);\n break;\n case 'stats':\n this.events.emit('stats', message);\n this.workerEvents.emit('stats', message);\n break;\n case 'done':\n this.events.emit('done', message);\n this.workerEvents.emit('done', message);\n break;\n case 'running':\n this.events.emit('running', message);\n this.workerEvents.emit('running', message);\n break;\n case 'readyWaiting':\n this.events.emit('readyWaiting', message);\n this.workerEvents.emit('readyWaiting', message);\n break;\n case 'setSuggestedExitCode':\n this.events.emit('setSuggestedExitCode', message);\n break;\n default:\n global.artillery.log(\n `Unknown message from worker ${message}`,\n 'error'\n );\n }\n });\n\n this.state = STATES.online;\n }\n\n async prepare(opts) {\n this.state = STATES.preparing;\n\n const { script, payload, options } = opts;\n let scriptForWorker = script;\n\n if (script.__transpiledTypeScriptPath && script.__originalScriptPath) {\n scriptForWorker = {\n __transpiledTypeScriptPath: script.__transpiledTypeScriptPath,\n __originalScriptPath: script.__originalScriptPath,\n __phases: script.config?.phases\n };\n }\n\n this.worker.postMessage({\n command: 'prepare',\n opts: {\n script: scriptForWorker,\n payload,\n options,\n testRunId: global.artillery.testRunId\n }\n });\n\n await awaitOnEE(this.workerEvents, 'readyWaiting', 50);\n this.state = STATES.readyWaiting;\n }\n\n async run(opts) {\n this.worker.postMessage({\n command: 'run',\n opts: JSON.parse(opts)\n });\n\n await awaitOnEE(this.workerEvents, 'running', 50);\n this.state = STATES.running;\n }\n\n async stop() {\n this.worker.postMessage({ command: 'stop' });\n }\n\n onError(err) {\n // TODO: set state, clean up\n this.events.emit('error', err);\n console.log('worker error, id:', this.workerId, err);\n }\n}\n\nmodule.exports = {\n ArtilleryWorker,\n STATES\n};\n" }, { "path": "packages/artillery/lib/platform/local/index.js", "content": "const { ArtilleryWorker } = require('./artillery-worker-local');\nconst core = require('../../dispatcher');\nconst { handleScriptHook, prepareScript, loadProcessor } =\n core.runner.runnerFuncs;\nconst debug = require('debug')('platform:local');\nconst EventEmitter = require('node:events');\nconst _ = require('lodash');\nconst divideWork = require('../../dist');\nconst STATES = require('../worker-states');\nconst os = require('node:os');\nclass PlatformLocal {\n constructor(script, payload, opts, platformOpts) {\n // We need these to run before/after hooks:\n this.script = script;\n this.payload = payload;\n this.opts = opts;\n this.events = new EventEmitter(); // send worker events such as workerError, etc\n this.platformOpts = platformOpts;\n this.workers = {};\n this.workerScripts = {};\n this.count = Infinity;\n }\n\n getDesiredWorkerCount() {\n return this.count;\n }\n\n async startJob() {\n await this.init();\n\n if (this.platformOpts.mode === 'distribute') {\n // Disable worker threads for Playwright-based load tests\n const count = this.script.config.engines?.playwright\n ? 1\n : Math.max(1, os.cpus().length - 1);\n this.workerScripts = divideWork(this.script, count);\n this.count = this.workerScripts.length;\n } else {\n // --count may only be used when mode is \"multiply\"\n this.count = this.platformOpts.count;\n this.workerScripts = new Array(this.count).fill().map((_) => this.script);\n }\n\n for (const script of this.workerScripts) {\n const w1 = await this.createWorker();\n\n this.workers[w1.workerId] = {\n id: w1.workerId,\n script,\n state: STATES.initializing,\n proc: w1\n };\n debug(`worker init ok: ${w1.workerId}`);\n }\n\n for (const [workerId, w] of Object.entries(this.workers)) {\n this.opts.cliArgs = this.platformOpts.cliArgs;\n await this.prepareWorker(workerId, {\n script: w.script,\n payload: this.payload,\n options: this.opts\n });\n this.workers[workerId].state = STATES.preparing;\n }\n debug('workers prepared');\n\n // the initial context is stringified and copied to the workers\n const contextVarsString = JSON.stringify(this.contextVars);\n\n for (const [workerId, _w] of Object.entries(this.workers)) {\n await this.runWorker(workerId, contextVarsString);\n this.workers[workerId].state = STATES.initializing;\n }\n }\n\n async init() {\n // 'before' hook is executed in the main thread,\n // its context is then passed to the workers\n const contextVars = await this.runHook('before');\n this.contextVars = contextVars; // TODO: Rename to something more descriptive\n }\n\n async createWorker() {\n const worker = new ArtilleryWorker();\n\n await worker.init();\n\n const workerId = worker.workerId;\n worker.events.on('workerError', (message) => {\n this.events.emit('workerError', workerId, message);\n });\n worker.events.on('log', (message) => {\n this.events.emit('log', workerId, message);\n });\n worker.events.on('phaseStarted', (message) => {\n this.events.emit('phaseStarted', workerId, message);\n });\n worker.events.on('phaseCompleted', (message) => {\n this.events.emit('phaseCompleted', workerId, message);\n });\n worker.events.on('stats', (message) => {\n this.events.emit('stats', workerId, message);\n });\n worker.events.on('done', (message) => {\n this.events.emit('done', workerId, message);\n });\n worker.events.on('readyWaiting', (message) => {\n this.events.emit('readyWaiting', workerId, message);\n });\n worker.events.on('setSuggestedExitCode', (message) => {\n this.events.emit('setSuggestedExitCode', workerId, message);\n });\n worker.events.on('exit', (message) => {\n this.events.emit('exit', workerId, message);\n });\n\n worker.events.on('error', (_err) => {\n // TODO: Only exit if ALL workers fail, otherwise log and carry on\n process.nextTick(() => process.exit(11));\n });\n\n return worker;\n }\n\n async prepareWorker(workerId, opts) {\n return this.workers[workerId].proc.prepare(opts);\n }\n\n async runWorker(workerId, contextVarsString) {\n // TODO: this will become opts\n debug('runWorker', workerId);\n return this.workers[workerId].proc.run(contextVarsString);\n }\n\n async stopWorker(workerId) {\n return this.workers[workerId].proc.stop();\n }\n\n async shutdown() {\n // 'after' hook is executed in the main thread, after all workers\n // are done\n await this.runHook('after', this.contextVars);\n\n for (const [workerId, _w] of Object.entries(this.workers)) {\n await this.stopWorker(workerId);\n }\n }\n\n // ********\n\n async runHook(hook, initialContextVars) {\n if (!this.script[hook]) {\n return {};\n }\n\n const runnableScript = await loadProcessor(\n prepareScript(this.script, _.cloneDeep(this.payload)),\n this.opts\n );\n\n const contextVars = await handleScriptHook(\n hook,\n runnableScript,\n this.events,\n initialContextVars\n );\n\n debug(`hook ${hook} context vars`, contextVars);\n\n return contextVars;\n }\n}\n\nmodule.exports = PlatformLocal;\n" }, { "path": "packages/artillery/lib/platform/local/worker.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\n//\n// Artillery Core worker process\n//\n\n\n\nconst {\n parentPort,\n threadId\n} = require('node:worker_threads');\n\nconst { getStash } = require('../../../lib/stash');\n\nconst { createGlobalObject } = require('../../artillery-global');\n\nconst core = require('@artilleryio/int-core');\nconst createRunner = core.runner.runner;\nconst debug = require('debug')('artillery:worker');\n\nconst _path = require('node:path');\n\nconst { SSMS } = require('@artilleryio/int-core').ssms;\nconst { loadPlugins, loadPluginsConfig } = require('../../load-plugins');\n\nconst EventEmitter = require('eventemitter3');\nconst p = require('node:util').promisify;\nconst { loadProcessor } = core.runner.runnerFuncs;\n\nconst prepareTestExecutionPlan = require('../../util/prepare-test-execution-plan');\n\nprocess.env.LOCAL_WORKER_ID = threadId;\n\nparentPort.on('message', onMessage);\n\nlet shuttingDown = false;\n\nlet runnerInstance = null;\n\nglobal.artillery._workerThreadSend = send;\n\n//\n// Supported messages: run, stop\n//\n\nasync function onMessage(message) {\n if (message.command === 'prepare') {\n await prepare(message.opts);\n return;\n }\n\n if (message.command === 'run') {\n run(message.opts);\n return;\n }\n\n if (message.command === 'stop') {\n await cleanup();\n\n // Unload plugins\n // TODO: v3 plugins\n for (const o of global.artillery.plugins) {\n if (o.plugin.cleanup) {\n try {\n await p(o.plugin.cleanup.bind(o.plugin))();\n debug('plugin unloaded:', o.name);\n } catch (cleanupErr) {\n send({\n event: 'workerError',\n error: cleanupErr,\n level: 'error',\n aggregatable: true\n });\n }\n }\n }\n\n process.exit(0);\n }\n}\n\nasync function cleanup() {\n return new Promise((resolve, _reject) => {\n if (shuttingDown) {\n resolve();\n }\n shuttingDown = true;\n\n if (runnerInstance && typeof runnerInstance.stop === 'function') {\n runnerInstance.stop().then(() => {\n resolve();\n });\n } else {\n resolve();\n }\n });\n}\n\nasync function createGlobalStashClient(cliArgs) {\n try {\n global.artillery.stash = await getStash({\n apiKey: cliArgs?.key || process.env.ARTILLERY_CLOUD_API_KEY\n });\n } catch (error) {\n if (error.name !== 'CloudAPIKeyMissing') {\n console.error(error);\n }\n global.artillery.stash = null;\n }\n}\n\nasync function prepare(opts) {\n await createGlobalObject();\n await createGlobalStashClient(opts.options.cliArgs);\n\n global.artillery.globalEvents.on('log', (...args) => {\n send({ event: 'log', args });\n });\n\n let _script;\n if (\n opts.script.__transpiledTypeScriptPath &&\n opts.script.__originalScriptPath\n ) {\n // Load and process pre-compiled TypeScript file\n _script = await prepareTestExecutionPlan(\n [opts.script.__originalScriptPath],\n opts.options.cliArgs,\n []\n );\n } else {\n _script = opts.script;\n }\n\n const { payload, options } = opts;\n const script = await loadProcessor(_script, options);\n\n if (opts.script.__phases) {\n script.config.phases = opts.script.__phases;\n }\n\n global.artillery.testRunId = opts.testRunId;\n\n //\n // load plugins\n //\n const plugins = await loadPlugins(script.config.plugins, script, options);\n\n // NOTE: We don't subscribe plugins to stats/done events from\n // individual runner instances here - those are handled in\n // launch-platform instead. (If we subscribe plugins to events here,\n // they will receive individual stats/done events from workers,\n // instead of objects that have been properly aggregated.)\n const stubEE = new EventEmitter();\n for (const [name, result] of Object.entries(plugins)) {\n if (result.isLoaded) {\n global.artillery.plugins[name] = result.plugin;\n if (result.version === 3) {\n // TODO: v3 plugins\n } else {\n // const msg = `WARNING: Legacy plugin detected: ${name}\n // See https://artillery.io/docs/resources/core/v2.html for more details.`;\n // send({\n // event: 'workerError',\n // error: new Error(msg),\n // level: 'warn',\n // aggregatable: true\n // });\n\n script.config = {\n ...script.config,\n // Load additional plugins configuration from the environment\n plugins: loadPluginsConfig(script.config.plugins)\n };\n\n if (result.version === 1) {\n result.plugin = new result.PluginExport(script.config, stubEE);\n global.artillery.plugins.push(result);\n } else if (result.version === 2) {\n result.plugin = new result.PluginExport.Plugin(\n script,\n stubEE,\n options\n );\n global.artillery.plugins.push(result);\n } else {\n // TODO:\n }\n }\n } else {\n const msg = `WARNING: Could not load plugin: ${name}`;\n send({\n event: 'workerError',\n error: new Error(msg),\n level: 'warn',\n aggregatable: true\n });\n }\n }\n\n // TODO: use await\n createRunner(script, payload, options)\n .then((runner) => {\n runnerInstance = runner;\n\n runner.on('phaseStarted', onPhaseStarted);\n runner.on('phaseCompleted', onPhaseCompleted);\n runner.on('stats', onStats);\n runner.on('done', onDone);\n\n // TODO: Enum for all event types\n send({ event: 'readyWaiting' });\n })\n .catch((err) => {\n // TODO: Clean up and exit (error state)\n // TODO: Handle workerError in launcher when readyWaiting\n // is not received and worker exits.\n send({\n event: 'workerError',\n error: err,\n level: 'error',\n aggregatable: true\n });\n });\n\n function onPhaseStarted(phase) {\n send({ event: 'phaseStarted', phase: phase });\n }\n\n function onPhaseCompleted(phase) {\n send({ event: 'phaseCompleted', phase: phase });\n }\n\n function onStats(stats) {\n send({ event: 'stats', stats: SSMS.serializeMetrics(stats) });\n }\n\n async function onDone(report) {\n await runnerInstance.stop();\n send({ event: 'done', report: SSMS.serializeMetrics(report) });\n }\n}\n\nasync function run(opts) {\n if (runnerInstance) {\n runnerInstance.run(opts);\n send({ event: 'running' });\n } else {\n // TODO: Emit error / set state\n }\n}\n\n// TODO: id -> workerId, ts -> _ts\nfunction send(data) {\n const payload = Object.assign({ id: threadId, ts: Date.now() }, data);\n debug(payload);\n parentPort.postMessage(payload);\n}\n" }, { "path": "packages/artillery/lib/platform/worker-states.js", "content": "module.exports = {\n initializing: 1,\n online: 2,\n preparing: 3,\n readyWaiting: 4,\n running: 5,\n unknown: 6,\n stoppedError: 7,\n completed: 8,\n stoppedEarly: 9,\n stoppedFailed: 10,\n timedout: 11\n};\n" }, { "path": "packages/artillery/lib/queue-consumer/index.js", "content": "const { EventEmitter } = require('eventemitter3');\nconst debug = require('debug')('queue-consumer');\nconst { Consumer } = require('sqs-consumer');\n\nclass QueueConsumer extends EventEmitter {\n create(opts = { poolSize: 30 }, queueConsumerOpts) {\n this.events = new EventEmitter();\n\n this.consumers = [];\n\n for (let i = 0; i < opts.poolSize; i++) {\n const sqsConsumer = Consumer.create(queueConsumerOpts);\n\n sqsConsumer.on('error', (err) => {\n // TODO: Ignore \"SQSError: SQS delete message failed:\" errors\n\n if (err.message?.match(/ReceiptHandle.+expired/i)) {\n debug(err.name, err.message);\n } else {\n sqsConsumer.stop();\n this.emit('error', err);\n }\n });\n\n let empty = 0;\n sqsConsumer.on('empty', () => {\n empty++;\n if (empty > 10) {\n this.emit('messageReceiveTimeout'); // TODO:\n }\n });\n\n this.consumers.push(sqsConsumer);\n }\n\n return this;\n }\n\n constructor(_opts) {\n super();\n }\n\n start() {\n for (const consumer of this.consumers) {\n consumer.start();\n }\n }\n\n stop() {\n for (const consumer of this.consumers) {\n consumer.stop();\n }\n }\n}\n\nmodule.exports = { QueueConsumer };\n" }, { "path": "packages/artillery/lib/stash.js", "content": "const { Redis } = require('@upstash/redis');\nconst { createClient } = require('./platform/cloud/api');\n\nasync function init(details) {\n if (details) {\n return new Redis({ url: details.url, token: details.token });\n } else {\n return null;\n }\n}\n\n/**\n * Get an Artillery Stash client instance\n *\n *\n * @param {Object} options - Configuration options\n * @param {string} options.apiKey - Artillery Cloud API key (optional, can use ARTILLERY_CLOUD_API_KEY env var)\n * @returns {Promise} - Redis client instance or null if not available\n */\nasync function getStash(options = {}) {\n const cloud = createClient({\n apiKey: options.apiKey || process.env.ARTILLERY_CLOUD_API_KEY\n });\n\n const whoami = await cloud.whoami();\n if (!whoami.activeOrg) {\n return null;\n }\n\n const stashDetails = await cloud.getStashDetails({\n orgId: whoami.activeOrg\n });\n\n if (!stashDetails) {\n return null;\n }\n\n return init(stashDetails);\n}\n\nmodule.exports = { initStash: init, getStash };\n" }, { "path": "packages/artillery/lib/telemetry.js", "content": "/* This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at http://mozilla.org/MPL/2.0/. */\n\n\n\nconst { version: artilleryVersion } = require('../package.json');\nconst { isCI, name: ciName } = require('ci-info');\nconst debug = require('debug')('telemetry');\n\nconst POSTHOG_TOKEN = '_uzX-_WJoVmE_tsLvu0OFD2tpd0HGz72D5sU1zM2hbs';\n\nconst notice = () => {\n console.log(\n 'Anonymized telemetry is on. Learn more: https://artillery.io/docs/resources/core/telemetry.html'\n );\n};\n\nconst isEnabled = () => {\n return typeof process.env.ARTILLERY_DISABLE_TELEMETRY === 'undefined';\n};\n\nasync function capture(eventName, data) {\n if (!isEnabled()) {\n return;\n }\n\n const debugEnabled =\n typeof process.env.ARTILLERY_TELEMETRY_DEBUG !== 'undefined';\n\n const url = 'https://us.i.posthog.com/i/v0/e/';\n const headers = {\n 'Content-Type': 'application/json'\n };\n\n let telemetryDefaults = {};\n try {\n telemetryDefaults = JSON.parse(process.env.ARTILLERY_TELEMETRY_DEFAULTS);\n } catch (_err) {\n /* empty */\n }\n\n const properties = Object.assign(\n {\n ...data,\n $process_person_profile: false,\n version: artilleryVersion,\n os: process.platform,\n isCi: isCI,\n ciName: isCI ? ciName : undefined,\n $ip: 'not-collected'\n },\n telemetryDefaults\n );\n\n const payload = {\n api_key: POSTHOG_TOKEN,\n event: eventName,\n distinct_id: data.distinctId || 'artillery-core',\n properties\n };\n\n if (debugEnabled) {\n console.log(`Telemetry data: ${JSON.stringify(payload.properties)}`);\n }\n\n try {\n await fetch(url, {\n method: 'POST',\n headers: headers,\n body: JSON.stringify(payload)\n });\n } catch (err) {\n debug(err);\n }\n}\n\nmodule.exports = { notice, capture, isEnabled };\n" }, { "path": "packages/artillery/lib/util/await-on-ee.js", "content": "const sleep = require('./sleep');\n\nasync function awaitOnEE(ee, message, pollMs = 1000, maxWaitMs = Infinity) {\n let messageFired = false;\n let args = null;\n let waitedMs = 0;\n\n ee.once(message, (...eventArgs) => {\n messageFired = true;\n args = eventArgs;\n });\n\n while (true && waitedMs < maxWaitMs) {\n if (messageFired) {\n break;\n }\n await sleep(pollMs);\n waitedMs += pollMs;\n }\n\n return args;\n}\n\nmodule.exports = awaitOnEE;\n" }, { "path": "packages/artillery/lib/util/generate-id.js", "content": "const { customAlphabet } = require('nanoid');\n\nfunction generateId(prefix = '') {\n const idf = customAlphabet('3456789abcdefghjkmnpqrtwxyz');\n const testRunId = `${prefix}${idf(4)}_${idf(29)}_${idf(4)}`;\n return testRunId;\n}\n\nmodule.exports = generateId;\n" }, { "path": "packages/artillery/lib/util/parse-tag-string.js", "content": "module.exports = function parseTagString(input) {\n const result = {\n tags: [],\n errors: []\n };\n\n if (!input) {\n return result;\n }\n\n const tagList = input.split(',').map((x) => x.trim());\n for (const t of tagList) {\n const cs = t.split(':');\n if (cs.length !== 2) {\n result.errors.push(t);\n } else {\n result.tags.push({ name: cs[0].trim(), value: cs[1].trim() });\n }\n }\n return result;\n};\n" }, { "path": "packages/artillery/lib/util/prepare-test-execution-plan.js", "content": "const csv = require('csv-parse');\nconst fs = require('node:fs');\nconst path = require('node:path');\nconst p = require('node:util').promisify;\nconst debug = require('debug')('artillery');\n\nconst {\n readScript,\n parseScript,\n addOverrides,\n addVariables,\n addDefaultPlugins,\n resolveConfigTemplates,\n checkConfig,\n resolveConfigPath\n} = require('../../util');\n\nconst validateScript = require('./validate-script');\n\nconst _ = require('lodash');\n\nasync function prepareTestExecutionPlan(inputFiles, flags, _args) {\n const scriptPath = inputFiles[0];\n let script1 = {};\n\n for (const fn of inputFiles) {\n const fn2 = fn.toLowerCase();\n const absoluteFn = path.resolve(process.cwd(), fn);\n if (\n fn2.endsWith('.yml') ||\n fn2.endsWith('.yaml') ||\n fn2.endsWith('.json')\n ) {\n const data = await readScript(absoluteFn);\n const parsedData = await parseScript(data);\n script1 = _.merge(script1, parsedData);\n } else {\n if (fn2.endsWith('.js')) {\n const parsedData = require(absoluteFn);\n script1 = _.merge(script1, parsedData);\n } else if (fn2.endsWith('.ts')) {\n const outputPath = path.join(\n path.dirname(absoluteFn),\n `dist/${path.basename(fn)}.js`\n );\n\n const entryPoint = path.resolve(process.cwd(), fn);\n // TODO: external packages will have to be specified externally to the script\n transpileTypeScript(entryPoint, outputPath, []);\n debug('transpiled TypeScript file into JS. Bundled file:', outputPath);\n const parsedData = require(outputPath);\n script1 = _.merge(script1, parsedData);\n // These magic properties are used by the worker to load the transpiled file\n script1.__transpiledTypeScriptPath = outputPath;\n script1.__originalScriptPath = entryPoint;\n } else {\n console.log('Unknown file type', fn);\n console.log(\n 'Only JSON (.json), YAML (.yml/.yaml) and TypeScript (.ts) files are supported'\n );\n console.log('https://docs.art/e/file-types');\n throw new Error('Unknown file type');\n }\n }\n }\n\n // We run the check here because subsequent steps can overwrite the target to undefined in\n // cases where the value of config.target is set to a value from the environment which\n // is not available at this point in time. Example: target is set to an environment variable\n // the value of which is only available at runtime in AWS Fargate\n const hasOriginalTarget =\n typeof script1.config.target !== 'undefined' ||\n typeof script1.config.environments?.[flags.environment]?.target !==\n 'undefined';\n\n script1 = await checkConfig(script1, scriptPath, flags);\n\n const script2 = await resolveConfigPath(script1, flags, scriptPath);\n\n const script3 = await addOverrides(script2, flags);\n const script4 = await addVariables(script3, flags);\n // The resolveConfigTemplates function expects the config and script path to be passed explicitly because it is used in Fargate as well where the two arguments will not be available on the script\n const script5 = await resolveConfigTemplates(\n script4,\n flags,\n script4._configPath,\n script4._scriptPath\n );\n\n if (!script5.config.target && !hasOriginalTarget) {\n throw new Error('No target specified and no environment chosen');\n }\n\n const validationError = validateScript(script5);\n\n if (validationError) {\n console.log(`Scenario validation error: ${validationError}`);\n\n process.exit(1);\n }\n\n const script6 = await readPayload(script5);\n\n if (typeof script6.config.phases === 'undefined' || flags.solo) {\n script6.config.phases = [\n {\n duration: 1,\n arrivalCount: 1\n }\n ];\n }\n\n script6.config.statsInterval = script6.config.statsInterval || 30;\n\n const script7 = addDefaultPlugins(script5);\n const script8 = replaceProcessorIfTypescript(script7, scriptPath);\n\n return script8;\n}\n\nasync function readPayload(script) {\n if (!script.config.payload) {\n return script;\n }\n\n for (const payloadSpec of script.config.payload) {\n const data = fs.readFileSync(payloadSpec.path, 'utf-8');\n\n const csvOpts = Object.assign(\n {\n skip_empty_lines:\n typeof payloadSpec.skipEmptyLines === 'undefined'\n ? true\n : payloadSpec.skipEmptyLines,\n cast: typeof payloadSpec.cast === 'undefined' ? true : payloadSpec.cast,\n from_line: payloadSpec.skipHeader === true ? 2 : 1,\n delimiter: payloadSpec.delimiter || ','\n },\n payloadSpec.options\n );\n const parsedData = await p(csv)(data, csvOpts);\n payloadSpec.data = parsedData;\n }\n\n return script;\n}\n\nfunction transpileTypeScript(entryPoint, outputPath, userExternalPackages) {\n const esbuild = require('esbuild-wasm');\n\n esbuild.buildSync({\n entryPoints: [entryPoint],\n outfile: outputPath,\n bundle: true,\n platform: 'node',\n format: 'cjs',\n sourcemap: 'inline',\n external: ['@playwright/test', ...userExternalPackages]\n });\n\n return outputPath;\n}\n\nfunction replaceProcessorIfTypescript(script, scriptPath) {\n const relativeProcessorPath = script.config.processor;\n const userExternalPackages = script.config.bundling?.external || [];\n\n if (!relativeProcessorPath) {\n return script;\n }\n const extensionType = path.extname(relativeProcessorPath);\n\n if (extensionType !== '.ts') {\n return script;\n }\n\n const actualProcessorPath = path.resolve(\n path.dirname(scriptPath),\n relativeProcessorPath\n );\n const processorFileName = path.basename(actualProcessorPath, extensionType);\n\n const processorDir = path.dirname(actualProcessorPath);\n const newProcessorPath = path.join(\n processorDir,\n `dist/${processorFileName}.js`\n );\n\n //TODO: move require to top of file when Lambda bundle size issue is solved\n //must be conditionally required for now as this package is removed in Lambda for now to avoid bigger package sizes\n const esbuild = require('esbuild-wasm');\n\n try {\n esbuild.buildSync({\n entryPoints: [actualProcessorPath],\n outfile: newProcessorPath,\n bundle: true,\n platform: 'node',\n format: 'cjs',\n sourcemap: 'inline',\n external: ['@playwright/test', ...userExternalPackages]\n });\n } catch (error) {\n throw new Error(`Failed to compile Typescript processor\\n${error.message}`);\n }\n\n global.artillery.hasTypescriptProcessor = newProcessorPath;\n console.log(\n `Bundled Typescript file into JS. New processor path: ${newProcessorPath}`\n );\n\n script.config.processor = newProcessorPath;\n return script;\n}\n\nmodule.exports = prepareTestExecutionPlan;\n" }, { "path": "packages/artillery/lib/util/sleep.js", "content": "async function sleep(ms) {\n return new Promise((resolve) => {\n setTimeout(resolve, ms);\n });\n}\n\nmodule.exports = sleep;\n" }, { "path": "packages/artillery/lib/util/validate-script.js", "content": "const Joi = require('joi').defaults((schema) =>\n schema.options({ allowUnknown: true, abortEarly: true })\n);\n\nconst config = Joi.object({\n target: Joi.string().when('environments', {\n not: Joi.exist(),\n then: Joi.required()\n }),\n http: Joi.object({\n extendedMetrics: Joi.boolean(),\n maxSockets: Joi.number(),\n timeout: Joi.alternatives(Joi.number(), Joi.string())\n }),\n environments: Joi.object(),\n processor: Joi.string(),\n phases: Joi.array(),\n engines: Joi.object()\n // payload: Joi.alternatives(Joi.object(), Joi.array())\n});\n\nconst capture = Joi.object({\n as: Joi.string().required()\n});\n\nconst httpMethodProps = {\n url: Joi.string().required(),\n headers: Joi.object(),\n cookie: Joi.object(),\n followRedirect: Joi.boolean(),\n qs: Joi.object(),\n gzip: Joi.boolean(),\n auth: Joi.object({\n user: Joi.string(),\n pass: Joi.string()\n }),\n beforeRequest: Joi.array().items(Joi.string()).single(),\n afterResponse: Joi.array().items(Joi.string()).single(),\n capture: Joi.array().items(capture).single()\n};\n\nconst httpItems = {\n get: Joi.object(httpMethodProps),\n post: Joi.object(httpMethodProps),\n put: Joi.object(httpMethodProps),\n patch: Joi.object(httpMethodProps),\n delete: Joi.object(httpMethodProps)\n};\n\nconst socketioItems = {\n emit: Joi.any().when(Joi.ref('....engine'), {\n is: 'socketio',\n then: Joi.alternatives(\n Joi.object({\n channel: Joi.string(),\n concat: Joi.boolean(),\n data: Joi.any()\n }),\n Joi.array().items(Joi.string())\n ),\n otherwise: Joi.any()\n })\n};\n\nconst wsItems = {\n connect: Joi.any().when(Joi.ref('....engine'), {\n is: 'ws',\n then: Joi.alternatives(Joi.object(), Joi.string()),\n otherwise: Joi.any()\n }),\n send: Joi.any()\n};\n\nconst flowItemSchema = Joi.object({\n function: Joi.string(),\n log: Joi.string(),\n think: Joi.alternatives(Joi.number(), Joi.string()),\n loop: Joi.array(),\n ...httpItems,\n ...wsItems,\n ...socketioItems\n}).when('.loop', {\n is: Joi.exist(),\n then: Joi.object({\n count: Joi.alternatives(Joi.number(), Joi.string()),\n over: Joi.alternatives(Joi.array(), Joi.string())\n }),\n otherwise: Joi.when('...engine', {\n is: Joi.exist().valid('socketio'),\n then: Joi.object().max(4),\n otherwise: Joi.object().length(1)\n })\n});\n\nconst scenarioItem = Joi.object({\n name: Joi.string(),\n engine: Joi.string(),\n beforeScenario: Joi.array().items(Joi.string()).single(),\n afterScenario: Joi.array().items(Joi.string()).single(),\n flow: Joi.any().when('engine', {\n is: Joi.valid('socketio', 'ws', 'http'),\n then: Joi.array().items(flowItemSchema).required(),\n otherwise: Joi.array().items(Joi.any())\n })\n});\n\nconst beforeAfterSchema = Joi.object({\n flow: Joi.when('engine', {\n is: Joi.exist(),\n then: Joi.when('engine', {\n is: Joi.valid('socketio', 'ws', 'http'),\n then: Joi.array().items(flowItemSchema).required(),\n otherwise: Joi.array().items(Joi.any())\n }),\n otherwise: Joi.array().items(flowItemSchema).required()\n })\n});\n\nconst schema = Joi.object({\n config: config,\n scenarios: Joi.array().items(scenarioItem).required(),\n before: beforeAfterSchema,\n after: beforeAfterSchema\n});\n\nmodule.exports = (script) => {\n const { error } = schema.validate(script);\n\n if (error?.details.length) {\n return error.details[0].message;\n }\n};\n" }, { "path": "packages/artillery/lib/util.js", "content": "\n\nconst fs = require('node:fs');\nconst path = require('node:path');\nconst YAML = require('js-yaml');\nconst debug = require('debug')('util');\nconst moment = require('moment');\nconst _ = require('lodash');\n\nconst chalk = require('chalk');\n\nconst engineUtil = require('@artilleryio/int-commons').engine_util;\nconst renderVariables = engineUtil._renderVariables;\nconst template = engineUtil.template;\nconst { contextFuncs } = require('@artilleryio/int-core').runner;\n\nconst p = require('node:util').promisify;\n\nmodule.exports = {\n readScript,\n parseScript,\n addOverrides,\n addVariables,\n addDefaultPlugins,\n resolveConfigPath,\n resolveConfigTemplates,\n checkConfig,\n renderVariables,\n template,\n formatDuration,\n padded,\n rainbow\n};\n\nasync function readScript(scriptPath) {\n const data = p(fs.readFile)(scriptPath, 'utf-8');\n return data;\n}\n\nasync function parseScript(data) {\n return YAML.safeLoad(data);\n}\n\nasync function addOverrides(script, flags) {\n if (!flags.overrides) {\n return script;\n }\n\n const o = JSON.parse(flags.overrides);\n const result = _.mergeWith(\n script,\n o,\n function customizer(_objVal, srcVal, _k, _obj, _src, _stack) {\n if (_.isArray(srcVal)) {\n return srcVal;\n } else {\n return undefined;\n }\n }\n );\n\n return result;\n}\n\nasync function addVariables(script, flags) {\n if (!flags.variables) {\n return script;\n }\n\n const variables = JSON.parse(flags.variables);\n script.config.variables = script.config.variables || {};\n for (const [k, v] of Object.entries(variables)) {\n script.config.variables[k] = v;\n }\n\n return script;\n}\n\nfunction addDefaultPlugins(script) {\n const finalScript = _.cloneDeep(script);\n\n if (!script.config.plugins) {\n finalScript.config.plugins = {};\n }\n\n const additionalPluginsAndOptions = {\n 'metrics-by-endpoint': { suppressOutput: true, stripQueryString: true }\n };\n\n for (const [pluginName, pluginOptions] of Object.entries(\n additionalPluginsAndOptions\n )) {\n if (!finalScript.config.plugins[pluginName]) {\n finalScript.config.plugins[pluginName] = pluginOptions;\n }\n }\n\n return finalScript;\n}\n\nasync function resolveConfigTemplates(script, flags, configPath, scriptPath) {\n const cliVariables = flags.variables ? JSON.parse(flags.variables) : {};\n\n script.config = engineUtil.template(script.config, {\n vars: {\n $scenarioFile: scriptPath,\n $dirname: path.dirname(configPath),\n $testId: global.artillery.testRunId,\n $processEnvironment: process.env,\n $env: process.env,\n $environment: flags.environment,\n ...cliVariables\n },\n funcs: contextFuncs\n });\n\n return script;\n}\n\nasync function checkConfig(script, scriptPath, flags) {\n script._environment = flags.environment;\n script.config = script.config || {};\n\n if (flags.environment) {\n debug('environment specified: %s', flags.environment);\n if (\n script.config.environments?.[flags.environment]\n ) {\n _.merge(script.config, script.config.environments[flags.environment]);\n } else {\n // TODO: Emit an event instead\n console.log(\n `WARNING: environment ${flags.environment} is set but is not defined in the script`\n );\n }\n }\n\n if (flags.target && script.config) {\n script.config.target = flags.target;\n }\n\n //\n // Override/set config.tls if needed:\n //\n if (flags.insecure) {\n if (script.config.tls) {\n if (script.config.tls.rejectUnauthorized) {\n console.log(\n 'WARNING: TLS certificate validation enabled in the ' +\n 'test script, but explicitly disabled with ' +\n '-k/--insecure.'\n );\n }\n script.config.tls.rejectUnauthorized = false;\n } else {\n script.config.tls = { rejectUnauthorized: false };\n }\n }\n\n //\n // Turn config.payload into an array:\n //\n if (_.get(script, 'config.payload')) {\n // Is it an object or an array?\n if (_.isArray(script.config.payload)) {\n // an array - nothing to do\n } else if (_.isObject(script.config.payload)) {\n if (flags.payload && !_.get(script.config.payload, 'path')) {\n script.config.payload.path = path.resolve(process.cwd(), flags.payload);\n } else if (!flags.payload && !_.get(script.config.payload, 'path')) {\n console.log(\n 'WARNING: config.payload.path not set and payload file not specified with -p'\n );\n } else if (flags.payload && _.get(script.config.payload, 'path')) {\n console.log(\n 'WARNING - both -p and config.payload.path are set, config.payload.path will be ignored.'\n );\n script.config.payload.path = flags.payload;\n } else {\n // no -p but config.payload.path is set - nothing to do\n }\n\n // Make it an array\n script.config.payload = [script.config.payload];\n } else {\n console.log('Ignoring config.payload, not an object or an array.');\n }\n }\n\n //\n // Resolve all payload paths to absolute paths now:\n //\n const absoluteScriptPath = path.resolve(process.cwd(), scriptPath);\n _.forEach(script.config.payload, (payloadSpec) => {\n const resolvedPathToPayload = path.resolve(\n path.dirname(absoluteScriptPath),\n payloadSpec.path\n );\n payloadSpec.path = resolvedPathToPayload;\n });\n script._scriptPath = absoluteScriptPath;\n return script;\n}\n\nasync function resolveConfigPath(script, flags, scriptPath) {\n if (!flags.config) {\n script._configPath = scriptPath;\n return script;\n }\n\n const absoluteConfigPath = path.resolve(process.cwd(), flags.config);\n script._configPath = absoluteConfigPath;\n\n if (!script.config.processor) {\n return script;\n }\n\n const processorPath = path.resolve(\n path.dirname(absoluteConfigPath),\n script.config.processor\n );\n\n const stats = fs.statSync(processorPath, { throwIfNoEntry: false });\n\n if (typeof stats === 'undefined') {\n // No file at that path - backwards compatibility mode:\n console.log(\n 'WARNING - config.processor is now resolved relative to the config file'\n );\n console.log('Expected to find file at:', processorPath);\n } else {\n script.config.processor = processorPath;\n }\n\n return script;\n}\n\nfunction formatDuration(durationInMs) {\n const duration = moment.duration(durationInMs);\n\n const days = duration.days();\n const hours = duration.hours();\n const minutes = duration.minutes();\n const seconds = duration.seconds();\n\n const timeComponents = [];\n if (days) {\n timeComponents.push(`${days} ${maybePluralize(days, 'day')}`);\n }\n\n if (hours || days) {\n timeComponents.push(`${hours} ${maybePluralize(hours, 'hour')}`);\n }\n\n if (minutes || hours || days) {\n timeComponents.push(`${minutes} ${maybePluralize(minutes, 'minute')}`);\n }\n\n timeComponents.push(`${seconds} ${maybePluralize(seconds, 'second')}`);\n\n return timeComponents.join(', ');\n}\n\nfunction maybePluralize(amount, singular, plural = `${singular}s`) {\n return amount === 1 ? singular : plural;\n}\n\nfunction padded(str1, str2, length = 79, formatPadding = chalk.gray) {\n const truncated = maybeTruncate(str1, length);\n return (\n truncated +\n ' ' +\n formatPadding('.'.repeat(length - truncated.length)) +\n ' ' +\n str2\n );\n}\n\nfunction maybeTruncate(str, length) {\n return str.length > length ? `${str.slice(0, length - 3)}...` : str;\n}\n\nfunction rainbow(str) {\n const letters = str.split('');\n const colors = ['red', 'yellow', 'green', 'cyan', 'blue', 'magenta'];\n const colorsCount = colors.length;\n\n return letters\n .map((l, i) => {\n const color = colors[i % colorsCount];\n return chalk[color](l);\n })\n .join('');\n}\n" }, { "path": "packages/artillery/lib/utils-config.js", "content": "const fs = require('node:fs');\nconst os = require('node:os');\n\nconst configFilePath = `${os.homedir()}/.artilleryrc`;\n\nfunction readArtilleryConfig() {\n try {\n const config = fs.readFileSync(configFilePath, 'utf-8');\n\n return JSON.parse(config);\n } catch (_err) {\n return {};\n }\n}\n\nfunction updateArtilleryConfig(data) {\n try {\n const updatedConf = {\n ...readArtilleryConfig(),\n ...data\n };\n\n fs.writeFileSync(configFilePath, JSON.stringify(updatedConf));\n\n return updatedConf;\n } catch (err) {\n console.error(err);\n }\n}\n\nmodule.exports = { readArtilleryConfig, updateArtilleryConfig };\n" }, { "path": "packages/artillery/man/artillery.1", "content": ".\\\" generated with Ronn/v0.7.3\n.\\\" http://github.com/rtomayko/ronn/tree/0.7.3\n.\n.TH \"ARTILLERY\" \"8\" \"December 2018\" \"\" \"\"\n.\n.SH \"NAME\"\n\\fBartillery\\fR \\- backend & API testing toolkit\n.\n.SH \"DESCRIPTION\"\nArtillery is a toolkit for load testing and functional testing of backend services & APIs\\. It supports HTTP, WebSocket, and Socket\\.io out of the box, and can be extended with plugins\\.\n.\n.SH \"SYNOPSIS\"\nThe artillery CLI has several commands\\. Run artillery \\-\\-help to see all of the available commands:\n.\n.IP \"\" 4\n.\n.nf\n\nartillery \\-\\-help\n\n\nUsage: artillery [options] [command]\n\n\nCommands:\n\nrun [options]