> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# autify/autify-web

CircleCI integration with Autify for Web. Run a test scenario or test plan with this Orb.


## Commands

### test-run

Run a test scenario or test plan.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `access-token` | env_var_name | AUTIFY_WEB_ACCESS_TOKEN | Environment variable storing the access token of Autify for Web. |
| `autify-cli-installer-url` | string | https://autify-cli-assets.s3.amazonaws.com/autify-cli/channels/stable/install-cicd.bash | Autify CLI installer URL |
| `autify-connect` | string |  | Name of the Autify Connect Access Point |
| `autify-connect-client` | boolean | false | When true, start Autify Connect Client |
| `autify-connect-client-extra-arguments` | string |  | Extra command line arguments you want to pass to Autify Connect Client e.g. "--experimental-tunnel-proxy http://proxy". |
| `autify-path` | string | autify | A path to `autify`. |
| `autify-test-url` | string |  | URL of a test scenario or test plan e.g. https://app.autify.com/projects/<ID>/(scenarios|test_plans)/<ID> |
| `browser` | string |  | Browser for running the test scenario (not supported by test plan executions) |
| `device` | string |  | Device for running the test scenario (not supported by test plan executions) |
| `device-type` | string |  | Device type for running the test scenario (not supported by test plan executions) |
| `max-retry-count` | integer | -1 | Maximum retry count while waiting. The command can take up to `timeout * (max-retry-count + 1)`. Only effective with `wait` |
| `os` | string |  | OS for running the test scenario (not supported by test plan executions) |
| `os-version` | string |  | OS version for running the test scenario (not supported by test plan executions) |
| `test-execution-name` | string |  | Name of the test execution (not supported by test plan executions) |
| `timeout` | integer | 300 | Timeout seconds when waiting. |
| `url-replacements` | string |  | URL replacements e.g. http://example.com=http://example.net,http://example.org=http://example.net |
| `verbose` | boolean | true |  |
| `wait` | boolean | false | When true, the action waits until the test finishes. |

## Jobs

### test-run

Run a test scenario or test plan.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `access-token` | env_var_name | AUTIFY_WEB_ACCESS_TOKEN | Environment variable storing the access token of Autify for Web. |
| `autify-cli-installer-url` | string | https://autify-cli-assets.s3.amazonaws.com/autify-cli/channels/stable/install-cicd.bash | Autify CLI installer URL |
| `autify-connect` | string |  | Name of the Autify Connect Access Point |
| `autify-connect-client` | boolean | false | When true, start Autify Connect Client |
| `autify-connect-client-extra-arguments` | string |  | Extra command line arguments you want to pass to Autify Connect Client e.g. "--experimental-tunnel-proxy http://proxy". |
| `autify-path` | string | autify | A path to `autify`. |
| `autify-test-url` | string |  | URL of a test scenario or test plan e.g. https://app.autify.com/projects/<ID>/(scenarios|test_plans)/<ID> |
| `browser` | string |  | Browser for running the test scenario (not supported by test plan executions) |
| `device` | string |  | Device for running the test scenario (not supported by test plan executions) |
| `device-type` | string |  | Device type for running the test scenario (not supported by test plan executions) |
| `executor` | executor | autify-cli/default | Executor name for this job. |
| `max-retry-count` | integer | -1 | Maximum retry count while waiting. The command can take up to `timeout * (max-retry-count + 1)`. Only effective with `wait` |
| `os` | string |  | OS for running the test scenario (not supported by test plan executions) |
| `os-version` | string |  | OS version for running the test scenario (not supported by test plan executions) |
| `test-execution-name` | string |  | Name of the test execution (not supported by test plan executions) |
| `timeout` | integer | 300 | Timeout seconds when waiting. |
| `url-replacements` | string |  | URL replacements e.g. http://example.com=http://example.net,http://example.org=http://example.net |
| `verbose` | boolean | true |  |
| `wait` | boolean | false | When true, the action waits until the test finishes. |

## Executors

### default

A base Docker image should work.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `size` | string | small | Docker executer's resource_class |
| `tag` | string | current | Pick a specific cimg/base image variant: https://hub.docker.com/r/cimg/base/tags
 |

## Examples

### test-run

Run a test scenario or test plan.


```yaml
version: '2.1'
orbs:
  autify-web: autify/autify-web@3
jobs:
  test-run-by-command:
    executor: autify-web/default
    steps:
      - autify-web/test-run:
          autify-test-url: https://app.autify.com/projects/<ID>/(scenarios|test_plans)/<ID>
workflows:
  test-run:
    jobs:
      - test-run-by-command
      - autify-web/test-run:
          autify-test-url: https://app.autify.com/projects/<ID>/(scenarios|test_plans)/<ID>
```