Testery - Create Test Run

To use this template in Octopus Deploy, copy the JSON below and paste it into the Library → Step templates → Import dialog.

{
  "Id": "9aa25d78-a90a-425e-a25d-b1e9f1bf08be",
  "Name": "Testery - Create Test Run",
  "Description": "Create and start a test run in your Testery account. For more information, visit https://testery.io/.",
  "Version": 26,
  "ExportedAt": "2026-02-13T21:10:21.323Z",
  "ActionType": "Octopus.Script",
  "Author": "wgunn-testery",
  "Packages": [],
  "Parameters": [
    {
      "Id": "96919d91-f313-48b5-bc31-a00245548909",
      "Name": "TesteryToken",
      "Label": "Token",
      "HelpText": "API token for your account. Found under Settings > Integrations",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "Sensitive"
      }
    },
    {
      "Id": "ad6b34cf-5bca-466e-a8eb-3a42b0da05b2",
      "Name": "TesteryProjectKey",
      "Label": "Project Key",
      "HelpText": "The project key",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "45766978-4187-4c85-8946-11b6b7e6b07c",
      "Name": "TesteryEnvironmentKey",
      "Label": "Environment Key",
      "HelpText": "The environment in the Testery account to run the tests against",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "55a412b7-8dcc-4940-893a-1eae13594862",
      "Name": "TesteryOutput",
      "Label": "Output",
      "HelpText": "The format for outputting results",
      "DefaultValue": "pretty",
      "DisplaySettings": {
        "Octopus.ControlType": "Select",
        "Octopus.SelectOptions": "json|Json\npretty|Pretty\nteamcity|TeamCity"
      }
    },
    {
      "Id": "6f960189-b17e-459b-aa3d-3b910d81a3f3",
      "Name": "TesteryGitRef?",
      "Label": "Git Ref?",
      "HelpText": "The git commit has of the version of tests being built",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "4507052e-ce4b-4f58-bfee-11aae4f75a6e",
      "Name": "TesteryGitBranch?",
      "Label": "Git Branch?",
      "HelpText": "The git branch whose code will be used for the run ",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "b77834af-3940-440d-b1d3-7ab5c55878e3",
      "Name": "TesteryTestSuite?",
      "Label": "Test Suite?",
      "HelpText": "Name of the test suite under the project to use for the run",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "d91a9249-4cf5-46b9-94d9-e99fa5ab354d",
      "Name": "TesteryWaitForResults?",
      "Label": "Wait for results?",
      "HelpText": "If set, the step will poll until the test run is complete",
      "DefaultValue": "False",
      "DisplaySettings": {
        "Octopus.ControlType": "Checkbox"
      }
    },
    {
      "Id": "cbe2bcb9-a6c7-4022-92c8-b10f1d08d0a3",
      "Name": "TesteryFailOnFailure?",
      "Label": "FailOnFailure?",
      "HelpText": "When set, the Testery command will return exit code 1 if there are test failures",
      "DefaultValue": "False",
      "DisplaySettings": {
        "Octopus.ControlType": "Checkbox"
      }
    },
    {
      "Id": "a98c1790-6c41-43b5-9f40-bf49591404ca",
      "Name": "TesteryLatestDeploy?",
      "Label": "Latest Deploy?",
      "HelpText": "When set, Testery will run the latest version of the tests deployed to the specified environment",
      "DefaultValue": "False",
      "DisplaySettings": {
        "Octopus.ControlType": "Checkbox"
      }
    },
    {
      "Id": "8fdb6676-2f00-45eb-af90-21d9a17bba10",
      "Name": "TesteryIncludedTags?",
      "Label": "Included Tags?",
      "HelpText": "List of tags that should be used in the run filter. Use one tag per line.\nExample:\n\n```txt\nSmoke\nProd\n```\n",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "MultiLineText"
      }
    },
    {
      "Id": "f8e8e729-8d7b-488c-9175-024887c60be0",
      "Name": "TesteryExcludedTags?",
      "Label": "Excluded Tags?",
      "HelpText": "List of tags that should be excluded from the test run. Use one tag per line.\nExample:\n\n```txt\nBug\nFlaky\n```",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "MultiLineText"
      }
    },
    {
      "Id": "8eabb4da-eda9-449e-934a-8b6019ac7ae5",
      "Name": "TesteryTestFilterRegex?",
      "Label": "Test Filter Regex?",
      "HelpText": "A regular expression to be used for filtering tests",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "45cd34de-8971-4d80-817d-5b4121845b68",
      "Name": "TesteryCopies?",
      "Label": "Copies?",
      "HelpText": "The number of copies of the tests to submit",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "ad3062f0-bbd8-433d-ad98-e6d59823732f",
      "Name": "TesteryBuildId?",
      "Label": "Build Id?",
      "HelpText": "A unique identifier for a build in your system",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "0f5a064d-2b8c-40f6-a823-8cb4fb086dd0",
      "Name": "TesteryParallelizationType?",
      "Label": "ParallelizationType?",
      "HelpText": "Parallelization method to use to run the tests. File/feature or test/scenario. If not set, will use the project or suite setting.",
      "DefaultValue": "default",
      "DisplaySettings": {
        "Octopus.ControlType": "Select",
        "Octopus.SelectOptions": "default|Default\n--parallelize-by-file|By File or Feature\n--parallelize-by-test|Test or Scenario"
      }
    },
    {
      "Id": "7d009132-31b6-4cd3-b1a9-856468ce27a7",
      "Name": "TesteryRunTimeout?",
      "Label": "Test Run Timeout?",
      "HelpText": "The maximum number of minutes this test run can take before it is killed automatically. Falls back to project or suite setting if not set.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "9d608b96-d759-4278-aead-15af3d3c3cb2",
      "Name": "TesteryTestTimeout?",
      "Label": "TestTimeout?",
      "HelpText": "The maximum number of seconds a test can take before it is stopped automatically. Falls back to project or suite setting if not set.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "162e2831-b657-494e-9168-c97c4bb24b35",
      "Name": "TesteryRunnerCount?",
      "Label": "Runner Count?",
      "HelpText": "Specify number of parallel runners to use in for this test run",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "35004742-451e-4244-965a-a7acfeaa5b11",
      "Name": "TesteryVariables?",
      "Label": "Variables?",
      "HelpText": "Add variable to the test run. Specified as \"KEY=VALUE\". To encrypt value, pass in \"secure:KEY=VALUE\", Multiple variables can be provided. Put each variable on a separate line.\n\nExample:\n```\nFOO=BAR\nsecure:HELLO=WORLD\n```",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "MultiLineText"
      }
    },
    {
      "Id": "0a9019a4-9831-409c-a3f1-f7007100550a",
      "Name": "TesteryTestName?",
      "Label": "Test Name?",
      "HelpText": "The name you want to use on the Git status for checks",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "d0d5d56a-1445-4b44-b6c8-2435ef49494d",
      "Name": "TesteryStatusName?",
      "Label": "Status Name?",
      "HelpText": "The custom name you want to use on the Git status, as plain text. This will overwrite the --test-name flag. The environment name will not be appended to this value.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "91165572-a950-4066-b4ae-525d26cbe71e",
      "Name": "TesterySkipVCSUpdates?",
      "Label": "Skip VCS Updates?",
      "HelpText": "Pass this flag if you do not want to submit status updates to Version Control",
      "DefaultValue": "False",
      "DisplaySettings": {
        "Octopus.ControlType": "Checkbox"
      }
    },
    {
      "Id": "ab2a6a27-13d0-4a8b-8691-558b24ef41cf",
      "Name": "TesteryPlaywrightProject?",
      "Label": "Playwright Project?",
      "HelpText": "The Playwright project to run. If not specified, all projects in your Playwright config will be run. If the --test-suite parameter is used, the project to run will be selected by the Test Suite and this value will not be used.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "27b08f43-f904-43d2-98e0-50928a6594c7",
      "Name": "TesteryDeployId?",
      "Label": "Deploy Id?",
      "HelpText": "The ID of the deploy to tie to this test run",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "93cdcb1f-dccc-4601-9eba-157d030cf866",
      "Name": "TesteryIncludeAllTags?",
      "Label": "IncludeAllTags?",
      "HelpText": "When set, overrides the testery.yml config and runs all available tags",
      "DefaultValue": "False",
      "DisplaySettings": {
        "Octopus.ControlType": "Checkbox"
      }
    },
    {
      "Id": "8aba3885-9522-438e-91f9-e77525521f88",
      "Name": "TesteryApplyTestSelectionRules?",
      "Label": "Apply Test Selection Rules?",
      "HelpText": "Use testery.yml file to select which tests to run",
      "DefaultValue": "False",
      "DisplaySettings": {
        "Octopus.ControlType": "Checkbox"
      }
    }
  ],
  "Properties": {
    "Octopus.Action.Script.ScriptSource": "Inline",
    "Octopus.Action.Script.Syntax": "Bash",
    "Octopus.Action.Script.ScriptBody": "set -e\n\nTOKEN=$(get_octopusvariable \"TesteryToken\")\nPROJECT_KEY=$(get_octopusvariable \"TesteryProjectKey\")\nENVIRONMENT_KEY=$(get_octopusvariable \"TesteryEnvironmentKey\")\nGIT_REF=$(get_octopusvariable \"TesteryGitRef?\")\nGIT_BRANCH=$(get_octopusvariable \"TesteryGitBranch?\")\nTEST_NAME=$(get_octopusvariable \"TesteryTestName?\")\nWAIT_FOR_RESULTS=$(get_octopusvariable \"TesteryWaitForResults?\")\nTEST_SUITE=$(get_octopusvariable \"TesteryTestSuite?\")\nLATEST_DEPLOY=$(get_octopusvariable \"TesteryLatestDeploy?\")\nINCLUDED_TAGS=$(get_octopusvariable \"TesteryIncludedTags?\")\nEXCLUDED_TAGS=$(get_octopusvariable \"TesteryExcludedTags?\")\nCOPIES=$(get_octopusvariable \"TesteryCopies?\")\nBUILD_ID=$(get_octopusvariable \"TesteryBuildId?\")\nOUTPUT=$(get_octopusvariable \"TesteryOutput\")\nVARIABLES=$(get_octopusvariable \"TesteryVariables?\")\nINCLUDE_ALL_TAGS=$(get_octopusvariable \"TesteryIncludeAllTags?\")\nPARALLELIZATION=$(get_octopusvariable \"TesteryParallelizationType?\")\nFAIL_ON_FAILURE=$(get_octopusvariable \"TesteryFailOnFailure?\")\nRUN_TIMEOUT=$(get_octopusvariable \"TesteryRunTimeout?\")\nTEST_TIMEOUT=$(get_octopusvariable \"TesteryTestTimeout?\")\nRUNNER_COUNT=$(get_octopusvariable \"TesteryRunnerCount?\")\nTEST_FILTER=$(get_octopusvariable \"TesteryTestFilterRegex?\")\nSTATUS_NAME=$(get_octopusvariable \"TesteryStatusName?\")\nPLAYWRIGHT_PROJECT=$(get_octopusvariable \"TesteryPlaywrightProject?\")\nSKIP_VSC_UPDATE=$(get_octopusvariable \"TesterySkipVCSUpdates?\")\nDEPLOY_ID=$(get_octopusvariable \"TesteryDeployId?\")\nAPPLY_TEST_SELECT=$(get_octopusvariable \"TesteryApplyTestSelectionRules?\")\n\nif [ \"$WAIT_FOR_RESULTS\" = \"False\" ] ; then\n    WAIT_FOR_RESULTS=\nfi\n\nif [ \"$PARALLELIZATION\" = \"default\" ] ; then\n    PARALLELIZATION=\nfi\n\nif [ \"$FAIL_ON_FAILURE\" = \"False\" ] ; then\n    FAIL_ON_FAILURE=\nfi\n\nif [ \"$APPLY_TEST_SELECT\" = \"False\" ] ; then\n    APPLY_TEST_SELECT=\nfi\n\nif [ \"$SKIP_VSC_UPDATE\" = \"False\" ] ; then\n    SKIP_VSC_UPDATE=\nfi\n\nif [ \"$INCLUDE_ALL_TAGS\" = \"False\" ] ; then\n    INCLUDE_ALL_TAGS=\nfi\n\nif [ \"$LATEST_DEPLOY\" = \"False\" ] ; then\n    LATEST_DEPLOY=\nfi\n\nif [[ -n \"$INCLUDED_TAGS\" ]]; then\n  INCLUDED_TAGS=$(echo \"$INCLUDED_TAGS\" | tr '\\n' ',' | sed 's/,$//')\nfi\n\nif [[ -n \"$EXCLUDED_TAGS\" ]]; then\n  EXCLUDED_TAGS=$(echo \"$EXCLUDED_TAGS\" | tr '\\n' ',' | sed 's/,$//')\nfi\n\nVAR_ARGS=()\nif [[ -n \"$VARIABLES\" ]]; then\n  mapfile -t VAR_LINES <<< \"$VARIABLES\"\n  for line in \"${VAR_LINES[@]}\"; do\n    [[ -z \"$line\" ]] && continue\n    VAR_ARGS+=(\"--variable\" \"$line\")\n  done\nfi\n\nexport PATH=\"$HOME/.local/bin:$PATH\"\npip install --user testery --upgrade\n\n\ntestery create-test-run --token $TOKEN \\\n  --project-key $PROJECT_KEY \\\n  --environment-key $ENVIRONMENT_KEY \\\n  --output $OUTPUT \\\n  ${GIT_REF:+ --git-ref \"$GIT_REF\"} \\\n  ${GIT_BRANCH:+ --git-branch \"$GIT_BRANCH\"} \\\n  ${TEST_NAME:+ --test-name \"$TEST_NAME\"} \\\n  ${WAIT_FOR_RESULTS:+ --wait-for-results} \\\n  ${TEST_SUITE:+ --test-suite \"$TEST_SUITE\"} \\\n  ${LATEST_DEPLOY:+ --latest-deploy } \\\n  ${COPIES:+ --copies \"$COPIES\"} \\\n  ${BUILD_ID:+ --build-id \"$BUILD_ID\"} \\\n  ${FAIL_ON_FAILURE:+ --fail-on-failure} \\\n  ${INCLUDE_ALL_TAGS:+ --include-all-tags} \\\n  ${PARALLELIZATION:+ \"${PARALLELIZATION}\"} \\\n  ${RUN_TIMEOUT:+ --timeout-minutes \"$RUN_TIMEOUT\"} \\\n  ${TEST_TIMEOUT:+ --test-timeout-seconds \"$TEST_TIMEOUT\"} \\\n  ${RUNNER_COUNT:+ --runner-count \"$RUNNER_COUNT\"} \\\n  ${VAR_ARGS:+ \"${VAR_ARGS[@]}\"} \\\n  ${TEST_FILTER:+ --test-filter-regex \"$TEST_FILTER\"} \\\n  ${STATUS_NAME:+ --status-name \"$STATUS_NAME\"} \\\n  ${PLAYWRIGHT_PROJECT:+ --playwright-project \"$PLAYWRIGHT_PROJECT\"} \\\n  ${SKIP_VSC_UPDATE:+ --skip-vcs-updates} \\\n  ${DEPLOY_ID:+ --deploy-id \"$DEPLOY_ID\"} \\\n  ${APPLY_TEST_SELECT:+ --apply-test-selection-rules} \\\n  ${INCLUDED_TAGS:+ --include-tags \"$INCLUDED_TAGS\"} \\\n  ${EXCLUDED_TAGS:+ --exclude-tags \"$EXCLUDED_TAGS\"}\n"
  },
  "Category": "Testery",
  "HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates//opt/buildagent/work/a381802920158308/step-templates/testery-create-test-run.json",
  "Website": "/step-templates/9aa25d78-a90a-425e-a25d-b1e9f1bf08be",
  "Logo": "iVBORw0KGgoAAAANSUhEUgAAALcAAACqCAYAAADvJt7aAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAbYSURBVHhe7Z3BkSNFEEV3sQATwAM8AM5c1gRM4MAdrpwAD8ADjtyAG0fwYPFgsQDqh6ZjZxTZ6q6u6urMrPcifoxiY9QhzT691WpmWq9gat6UfXm7CJCLt2X/PX1EckiDZJbYz4fkkIKl2taQHMJiVdsakkM4HlXbGpJDCPZW2xqSg2tqq20NycEdLdW2huTghh7VtqbjflYGcAm9q23t9zIkh+GcVW1rSA7DGFFta0gOp/Jh2chqW0NyOIVvyyzhrhiSQzdU7XdllmhXDsmhGU/VtobkcAiv1baG5FCF92pbQ3LYJFK1rSE5rBKx2taQHF4QvdrWDkn++uljFD4p018erPNF2de3i+n4o0z/Kkn2dOhOWY9s9n4tP4KqOlrH9LZdJf/g6SPk4J+yn24XU/Np2W9lDyVH7lzon+yZeCg5cudhlmpbSHLkTsxs1X7Ov2U/3C6+B7lzMHO1hcTWy58vQO4cUG0D5I4P1TaqLZA7PlR7BeSODdVeqbZA7thQ7Qcgd1yo9oNqC+SOC9XeALljQrU3qi2QOyZUewfIHQ+qvaPaArnjQbV3gtyxoNo7qy2QOxZUuwLkjgPVrqi2QO44UO1KkDsGVLuy2gK5YzBztfXArq62QG7/zF5tPbCrqy2Q2z+zV/vwAxu5fUO1G4h2OjWdn0K/xj8L35X9ers4BJ2u7vvbxcvRA/uj20U4i6tO4Xb1mzRdveZ3JuZpiV94rt0IcvuE59odQG6fUO0OILc/qHYnkNsfVLsTyO0LvXMA1YZhjHwp8P40vNbnZJ1e+uwK5faDqq0H0qykrfZXZZvvcXIRo8pt3X/r8zKue7W9oG+xLndSInmTfITca8W2Pjfjmr8b6RX9B+r+znqSfITca/fV+txsm6La1jxIfrbca9UW1udn21TVtnal5GfL/eh+WZ+fadNW29oVkp8p96NqC+s6mTZ9ta2NlPxMubfug3WdLKPaGxsh+Vlyb1VbWNfLMqq9c2dKfpbce26vdb0Mo9oHdobkZ8i9p9rCum6GUe2G9ZT8DLn33jbrutFHtTuth+S95d5bbWFdP/qodue1SN5b7prbYV0/8qj2iTsieU+5a6otrGNEHtUesBrJe8pd+8CyjhF1VHvw9kjeS+7aagvrOFFHtS/aI8l7yV1bbWEdJ+KotoNJZN3e5/SQ+0i1hXWsiKPajqbbvEjeQ+4j1RbWsaKNajudJP/z7s9qd7TawjpetFFtx9N9aKn30WoL63iRRrWdb/mtbElaK3lLtYV1zEhLW+0ez1U97P6UAzWSt1RbWMeMsrTV1l+qdYcjbu18GluSt1ZbWMeNMqodYFsni1mTvLXa4v6YUUa1g2zvmZCeS96j2uL+tkQZ1Q6yvXIvSHK9t0wPrNvjfW6q3ftcgfqLnekNmSz04P7rdnFKamNwGr3ldnPH4BL+LtP3BVzQU26qDTqhqRt6yk2158bdKZh7yU21wV3ceslNtefG5Ynze8hNtcFl3HrITbXnxu3bnbTKTbXBbdxa5abac+P6Tapa5Kba4DpuLXJT7blx/9aCR+Wm2uA+bkflptpz477a4ojcVBtCxO2I3FR7bkJUW9TKTbUhTNxq5abacxOm2qJGbqoNoeJWIzfVnptQ1RZ75abaEC5ue+Wm2nMTrtpij9xUG0LGbY/cVHtuQlZbbMlNtSFs3Lbk1sllfrxdhAkJW22xJfe7Mp2L4uOyn/UHMBWhn5Luec4tdP43ndwQyechdLXFXrkXkHwewr+QUCv3ApLnJny1xVG5F5A8Jyle/m2VewHJ85Ci2qKX3AtIHp8037TrLfcCksckTbXFWXIvIHks0lRbnC33ApL7J1W1xSi5F5DcL6mqLUbLvYDkvkhXbU/ofeL1RkHWW79dvSuLZt2eM6af/oST8Sh5drkp9mA8SZ5dbqp9ER4kzyw31XbAlZJnlptqO+IKybPKTbWdMlLyrHLra5iaq17nboXXydvQ10xfQwiAKvRLmVWo1mUsd/pqi6jlvkcVelP2eZm+2wbrUO3g6FUA/YfJqlbtspV7imqLLOW+R2JLcEr+EqqdkJaSZyr3NNUWr58+zoIkl6w1p4i78ifmvnn62ANVW68wQXJ6PiePsqmqDfNIrm94waRkl5xqQ0rJqTa8IJPkVBtMoktOtWGTqJJTbdhNJMmpNhwiguRUG5rwKjnVhm54k5xqQ3c8SE614VSulJxqwxBGS061YTijJKfacBmSXO/KbInZOqoNLtAvDejXvSxJj45qgyt6SU61wS2tklNtcM8Ryak2hKJGcqoNIdmSnGpDeNYkp9qQhueSU21IiSSn2gAAAAAAAAAAAACvXv0P3aW8VNTlYhYAAAAASUVORK5CYII=",
  "$Meta": {
    "Type": "ActionTemplate"
  }
}

History