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

# cloudbeat/oxygen

Use the Oxygen open source framework to run automated tests. See this orb's source: https://github.com/oxygenhq/oxygen-orb


## Commands

### install-oxygen-cli

Install Oxygen CLI.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `executor` | executor | default | executor to use for this job |

### install-selenium

Install Selenium Standalone Server


| Parameter | Type | Default | Description |
|---|---|---|---|
| `executor` | executor | default | executor to use for this job |
| `selenium-minor-version` | string | 3.5 | the minor version of Selenium Standalone Server to use |
| `selenium-patch-version` | string | 3.5.3 | the patch version of Selenium Standalone Server to use |

### start-selenium

Start Selenium Standalone Server


| Parameter | Type | Default | Description |
|---|---|---|---|
| `executor` | executor | default | executor to use for this job |
| `selenium-minor-version` | string | 3.5 | the minor version of Selenium Standalone Server to use |
| `selenium-patch-version` | string | 3.5.3 | the patch version of Selenium Standalone Server to use |

### run-tests

Run a test case or test suite with Oxygen CLI.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `executor` | executor | default | executor to use for this job |
| `file` | string |  | Test case or test suite file to execute.
 |
| `results` | string | oxygen-test-results | Folder in which test results will be stored. Default is oxygen-test-results.
 |
| `iter` | integer | 1 | Number of times (iterations) to run the test. Default is 1.
 |
| `param` | string |  | Parameters file (optional). If not specified an attempt will be made to load parameters from a file named same as the test script, located in the same directory, and having extension - xlsx, xls, csv, or txt.
 |
| `pm` | enum | seq | Order in which to read the parameters - sequential, random, all. Default is seq. In seq and random modes test will run exact number of times specified with the iter parameter. In all mode, all available parameters will be read sequentially. This option is mutually exclusive with iter parameter.
 |
| `browser` | enum | chrome | Browser name (chrome or ie). Default is chrome.
 |
| `selenium-url` | string |  | Selenium hub URL (optional). If not specified an attempt will be made to use  http://localhost:4444/wd/hub.
 |

## Jobs

### install-start-run-tests

Install Oxygen, Selenium, and Mono (optional), then start server and run a test case or test suite with Oxygen CLI

| Parameter | Type | Default | Description |
|---|---|---|---|
| `executor` | executor | default | executor to use for this job |
| `selenium-minor-version` | string | 3.5 | the minor version of Selenium Standalone Server to use |
| `selenium-patch-version` | string | 3.5.3 | the patch version of Selenium Standalone Server to use |
| `checkout` | boolean | true | Boolean for whether or not to checkout as a first step. Default is true.
 |
| `file` | string |  | Test case or test suite file to execute.
 |
| `results` | string | oxygen-test-results | Folder in which test results will be stored. Default is oxygen-test-results.
 |
| `iter` | integer | 1 | Number of times (iterations) to run the test. Default is 1.
 |
| `param` | string |  | Parameters file (optional). If not specified an attempt will be made to load parameters from a file named same as the test script, located in the same directory, and having extension - xlsx, xls, csv, or txt.
 |
| `pm` | enum | seq | Order in which to read the parameters - sequential, random, all. Default is seq. In seq and random modes test will run exact number of times specified with the iter parameter. In all mode, all available parameters will be read sequentially. This option is mutually exclusive with iter parameter.
 |
| `browser` | enum | chrome | Browser name (chrome or ie). Default is chrome.
 |

## Executors

### default

## Examples

### build

Install the Oxygen CLI, its dependencies, Selenium Standalone Server, start the Selenium Standalone Server and run a test suite with Oxygen CLI.


```yaml
version: 2.1
orbs:
  oxygen: cloudbeat/oxygen@1.0.0
workflows:
  oxygen_install-start-run-tests:
    jobs:
      - oxygen/install-start-run-tests:
          selenium-minor-version: '3.5'
          selenium-patch-version: 3.5.3
          file: tests/suite.json
```