README.md

Run test on Autify for Web

Run a test scenario or test plan on Autify for Web.

See our official documentation to get started: https://help.autify.com/docs/github-actions-integration

Usage

Run a test scenario or test plan

- uses: autifyhq/actions-web-test-run@v2
  with:
    access-token: ${{ secrets.AUTIFY_WEB_ACCESS_TOKEN }}
    autify-test-url: https://app.autify.com/projects/<ID>/(scenarios|test_plans)/<ID>

This will succeed immediately once the test is started but won't wait the finish of the test.

Run and wait a test scenario or test plan

- uses: autifyhq/actions-web-test-run@v2
  with:
    access-token: ${{ secrets.AUTIFY_WEB_ACCESS_TOKEN }}
    autify-test-url: https://app.autify.com/projects/<ID>/(scenarios|test_plans)/<ID>
    wait: true
    timeout: 300

This will keep running the action until the test finishes or times out.

Note: This will consume your GitHub Actions hosted runner's minutes. Be careful when extending the timeout value.

Options

access-token:
  required: true
  description: "Access token of Autify for Web."
autify-test-url:
  required: true
  description: "URL of a test scenario or test plan e.g. https://app.autify.com/projects/<ID>/(scenarios|test_plans)/<ID>"
wait:
  required: false
  default: "false"
  description: "When true, the action waits until the test finishes."
timeout:
  required: false
  description: "Timeout seconds when waiting."
interval:
  required: false
  description: "Interval seconds to poll the test result when waiting."
url-replacements:
  required: false
  description: "URL replacements e.g. http://example.com=http://example.net,http://example.org=http://example.net"
max-retry-count:
  required: false
  description: "Maximum retry count while waiting. The command can take up to `timeout * (max-retry-count + 1)`. Only effective with `wait`"
test-execution-name:
  required: false
  description: "Name of the test execution (not supported by test plan executions)"
browser:
  required: false
  description: "Browser for running the test scenario (not supported by test plan executions)"
device:
  required: false
  description: "Device for running the test scenario (not supported by test plan executions)"
device-type:
  required: false
  description: "Device type for running the test scenario (not supported by test plan executions)"
os:
  required: false
  description: "OS for running the test scenario (not supported by test plan executions)"
os-version:
  required: false
  description: "OS version for running the test scenario (not supported by test plan executions)"
autify-connect:
  required: false
  description: "Name of the Autify Connect Access Point"
autify-connect-client:
  required: false
  description: "When true, start Autify Connect Client"
  default: "false"
autify-connect-client-extra-arguments:
  required: false
  description: 'Extra command line arguments you want to pass to Autify Connect Client e.g. "--experimental-tunnel-proxy http://proxy".'
autify-path:
  required: false
  default: "autify"
  description: "A path to `autify` which will be used to invoke Autify CLI internally. Default is searching from PATH."
autify-cli-installer-url:
  required: false
  default: "https://autify-cli-assets.s3.amazonaws.com/autify-cli/channels/stable/install-cicd.bash"
  description: "Autify CLI installer URL"

Outputs

exit-code:
  description: "Exit code of autify-cli. 0 means succeeded."
log:
  description: "Log of stdout and stderr."
result-url:
  description: "Test result URL on Autify for Web"

Migrations

v2 from v1

Most of the case, v2 is compatible with v1 inputs. Please try to migrate to v2 because v1 is no more maintained.