Use CircleCI version 2.1 at the top of your .circleci/config.yml file.
1
version: 2.1
Add the orbs
stanza below your version, invoking the orb:
1
2
orbs:
suite-runner: cloudqa/suite-runner@2.0.3
Use suite-runner
elements in your existing workflows and jobs.
Opt-in to use of uncertified orbs on your organization’s Security settings page.
Execute CloudQA test suites automatically be adding the `execute` job to your workflow.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
version: '2.1'
orbs:
suite-runner: cloudqa/suite-runner@2.0.3
workflows:
test-my-app:
jobs:
- suite-runner/execute:
browser: Chrome
build-tag: Circle CI demo
environment-name: QA
image: cimg/base:stable
is-sequential-execution: false
suite-id: <your-cloudqa-suite-id>
variables: cicd1=1,cicd2=2,cicd3=6
Trigger your CloudQA test suite from CircleCI build by passing parameters "Suite Id", "Browser (optional)","Tag (optional)","Variables (optional)", "Sequential Execution (optional)" and "Environment Name (optional)". Note: CLOUDQA_API_KEY will be pulled from the CiricleCI build environment variables. Your build status depends on the test suite status.
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
browser | (optional) Modify the browser to execute your suite against, defaults to `Chrome`. | No | Chrome | string |
build-tag | (optional) Modify the build tag to set build id of your suite, defaults to ``. | No | '' | string |
environment-name | (optional) Modify the environment name to execute your suite against, defaults to ``. | No | '' | string |
image | The Docker image for this job environment. CircleCI's `cimg/base:stable` will be used by default. Find other comptable images and tags here: https://hub.docker.com/u/cimg
| No | cimg/base:stable | string |
is-sequential-execution | (optional) Modify the is sequential execution to execution type(sequential, parallel) of your suite, defaults to `true`. | No | true | boolean |
suite-id | ID of the CloudQA suite to execute. | Yes | - | string |
variables | (optional) Modify the variables to set variables of your suite, defaults to ``. | No | '' | string |
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# This code is licensed from CircleCI to the user under the MIT license.
# See here for details: https://circleci.com/developer/orbs/licensing
version: 2.1
description: |
Automate Web Testing with CloudQA codeless selenium tests on CircleCI.
display:
home_url: https://cloudqa.io/
source_url: https://github.com/cloudqa-io/circle-ci-orb
jobs:
execute:
description: |
Trigger your CloudQA test suite from CircleCI build by passing parameters "Suite Id", "Browser (optional)","Tag (optional)","Variables (optional)", "Sequential Execution (optional)" and "Environment Name (optional)". Note: CLOUDQA_API_KEY will be pulled from the CiricleCI build environment variables. Your build status depends on the test suite status.
docker:
- image: <<parameters.image>>
environment:
CLOUDQA_BROWSER: << parameters.browser >>
CLOUDQA_BUILD_TAG: << parameters.build-tag >>
CLOUDQA_ENVIRONMENT_NAME: << parameters.environment-name >>
CLOUDQA_SEQUENTIAL_EXECUTION: << parameters.is-sequential-execution >>
CLOUDQA_SUITE_ID: << parameters.suite-id >>
CLOUDQA_VARIABLES: << parameters.variables >>
parameters:
browser:
default: Chrome
description: (optional) Modify the browser to execute your suite against, defaults to `Chrome`.
type: string
build-tag:
default: ""
description: (optional) Modify the build tag to set build id of your suite, defaults to ``.
type: string
environment-name:
default: ""
description: (optional) Modify the environment name to execute your suite against, defaults to ``.
type: string
image:
default: cimg/base:stable
description: |
The Docker image for this job environment. CircleCI's `cimg/base:stable` will be used by default. Find other comptable images and tags here: https://hub.docker.com/u/cimg
type: string
is-sequential-execution:
default: true
description: (optional) Modify the is sequential execution to execution type(sequential, parallel) of your suite, defaults to `true`.
type: boolean
suite-id:
description: ID of the CloudQA suite to execute.
type: string
variables:
default: ""
description: (optional) Modify the variables to set variables of your suite, defaults to ``.
type: string
steps:
- run: |
sudo apt-get update && sudo apt-get install -y jq
curl -O https://cquserfiles.s3.amazonaws.com/6394/28cb57ae611041d2a44ae2bcb3bbad66/cloudqa-app-circleci.sh
bash cloudqa-app-circleci.sh
examples:
execute_cloudqa_tests:
description: |
Execute CloudQA test suites automatically be adding the `execute` job to your workflow.
usage:
version: "2.1"
orbs:
suite-runner: cloudqa/suite-runner@2.0.3
workflows:
test-my-app:
jobs:
- suite-runner/execute:
browser: Chrome
build-tag: Circle CI demo
environment-name: QA
image: cimg/base:stable
is-sequential-execution: false
suite-id: <your-cloudqa-suite-id>
variables: cicd1=1,cicd2=2,cicd3=6