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:
runner: testimio/runner@1.3.0
Use runner
elements in your existing workflows and jobs.
Opt-in to use of uncertified orbs on your organization’s Security settings page.
Run tests on Testim.io
1
2
3
4
5
6
7
8
9
10
11
orbs:
testimio: testimio/runner@x.y
version: 2.1
workflows:
build-and-test:
jobs:
- testimio/run_tests:
grid_name: 'grid name (optional, default: Public)'
options: '--<option_name> <parameter> (optional)'
project_id: project id (required)
token: 'token environment variable name. default: TESTIMIO_TOKEN'
Run tests on Testim.io
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
grid_name | - | No | Public | string |
options | - | No | '' | string |
project_id | - | Yes | - | string |
report_file | - | No | report.xml | string |
report_store_path | - | No | /tmp/circleci-test-results | string |
token | - | No | TESTIMIO_TOKEN | env_var_name |
Run tests on Testim.io
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
grid_name | - | No | Public | string |
options | - | No | '' | string |
project_id | - | Yes | - | string |
report_file | - | No | reports.xml | string |
report_store_path | - | No | /tmp/circleci-test-results | string |
token | - | No | TESTIMIO_TOKEN | env_var_name |
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# This code is licensed from CircleCI to the user under the MIT license.
# See here for details: https://circleci.com/developer/orbs/licensing
commands:
run_tests:
description: Run tests on Testim.io
parameters:
grid_name:
default: Public
type: string
options:
default: ""
type: string
project_id:
type: string
report_file:
default: reports.xml
type: string
report_store_path:
default: /tmp/circleci-test-results
type: string
token:
default: TESTIMIO_TOKEN
type: env_var_name
steps:
- run:
command: |
mkdir -p << parameters.report_store_path >>
OPTIONS='<< parameters.options >>'
if [[ -z ${OPTIONS} ]]; then
testim --project "<< parameters.project_id >>" \
--grid "<< parameters.grid_name >>" \
--token "${<< parameters.token >>}" \
--report-file << parameters.report_store_path >>/<< parameters.report_file >>
else
testim --project "<< parameters.project_id >>" \
--grid "<< parameters.grid_name >>" \
--token "${<< parameters.token >>}" \
--report-file << parameters.report_store_path >>/<< parameters.report_file >> \
<< parameters.options >>
fi
name: run tests
- store_artifacts:
path: << parameters.report_store_path >>
- store_test_results:
path: << parameters.report_store_path >>
description: |
Easily run your tests and suits from Testim.io
display:
home_url: https://www.testim.io
source_url: https://github.com/testimio/circleci-orb
examples:
test-cli-with-workflow:
description: Run tests on Testim.io
usage:
orbs:
testimio: testimio/runner@x.y
version: 2.1
workflows:
build-and-test:
jobs:
- testimio/run_tests:
grid_name: 'grid name (optional, default: Public)'
options: --<option_name> <parameter> (optional)
project_id: project id (required)
token: 'token environment variable name. default: TESTIMIO_TOKEN'
executors:
default:
description: The default executor for jobs in this orb.
docker:
- image: testim/docker-cli
jobs:
run_tests:
description: Run tests on Testim.io
executor: default
parameters:
grid_name:
default: Public
type: string
options:
default: ""
type: string
project_id:
type: string
report_file:
default: report.xml
type: string
report_store_path:
default: /tmp/circleci-test-results
type: string
token:
default: TESTIMIO_TOKEN
type: env_var_name
steps:
- run_tests:
grid_name: << parameters.grid_name >>
options: << parameters.options >>
project_id: << parameters.project_id >>
report_file: << parameters.report_file >>
report_store_path: << parameters.report_store_path >>
token: << parameters.token >>
version: 2.1