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:
katalon-studio: katalon/katalon-studio@23.0.11
Use katalon-studio
elements in your existing workflows and jobs.
Opt-in to use of uncertified orbs on your organization’s Security settings page.
Executing a test suite with the latest version of Katalon Studio
1
2
3
4
5
6
7
8
9
10
11
version: 2.1
orbs:
katalon-studio: katalon/katalon-studio@23.0.12
workflows:
build:
jobs:
- katalon-studio/run:
version: latest
command_arguments: >-
-browserType='Chrome' -retry=0 -statusDelay=15 -testSuitePath='Test
Suites/TS_RegressionTest'
Executing your Katalon tests in the Katalon Studio's Docker Image with the provided command arguments
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
version | Specifying the Katalon Studio version your tests will be executed with (Only version 7+ supported). By default, it's the latest version. | No | latest | string |
KATALON_API_KEY | The API KEY used for authentication with the Katalon Server. Learn how to get the API KEY via https://docs.katalon.com/katalon-analytics/docs/ka-api-key.html. | No | KATALON_API_KEY | env_var_name |
command_arguments | The command arguments used for executing the tests. See the supported Command Syntax via https://docs.katalon.com/katalon-studio/docs/console-mode-execution.html. | No | '' | string |
Defining command arguments to execute your Katalon tests with API Key required
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
command_arguments | The defined command arguments used for executing your Katalon tests | No | '' | string |
KATALON_API_KEY | The name of the environment variable containing the API key used for authentication with Katalon Server | Yes | - | env_var_name |
Ubuntu based Docker Image for Katalon Studio
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
version | Specifying the Katalon Studio version your tests will be executed with (Only version 7+ supported) | No | latest | 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
76
77
78
79
80
81
82
83
# 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: >
Executing Katalon tests with your CircleCI CI/CD pipeline easily with the Katalon orb
display:
home_url: https://docs.katalon.com/katalon-studio/docs/integration-circleci.html
source_url: https://github.com/katalon-studio/katalon-circleci-orb
orbs:
examples:
execute_sample_test:
description: Executing a test suite with the latest version of Katalon Studio
usage:
version: 2.1
orbs:
katalon-studio: katalon/katalon-studio@23.0.12 #replace 23.0.12 with the latest version of Katalon Orb
workflows:
build:
jobs:
- katalon-studio/run:
version: "latest"
command_arguments: "-browserType='Chrome' -retry=0 -statusDelay=15 -testSuitePath='Test Suites/TS_RegressionTest'"
executors:
default:
description: Ubuntu based Docker Image for Katalon Studio
parameters:
version:
description : "Specifying the Katalon Studio version your tests will be executed with (Only version 7+ supported)"
type: string
default: "latest"
docker:
- image: katalonstudio/katalon:<<parameters.version>>
commands:
execute:
description: Defining command arguments to execute your Katalon tests with API Key required
parameters:
command_arguments:
description: The defined command arguments used for executing your Katalon tests
type: string
default: ""
KATALON_API_KEY:
description: The name of the environment variable containing the API key used for authentication with Katalon Server
type: env_var_name
steps:
- run:
name: Katalon Execute
command: katalon-execute.sh -apiKey=$<<parameters.KATALON_API_KEY>> <<parameters.command_arguments>>
jobs:
run:
description: Executing your Katalon tests in the Katalon Studio's Docker Image with the provided command arguments
executor: default
parameters:
version:
description: "Specifying the Katalon Studio version your tests will be executed with (Only version 7+ supported). By default, it's the latest version."
default: "latest"
type: string
KATALON_API_KEY:
description: The API KEY used for authentication with the Katalon Server. Learn how to get the API KEY via https://docs.katalon.com/katalon-analytics/docs/ka-api-key.html.
default: KATALON_API_KEY
type: env_var_name
command_arguments:
description: The command arguments used for executing the tests. See the supported Command Syntax via https://docs.katalon.com/katalon-studio/docs/console-mode-execution.html.
default: ""
type: string
steps:
- checkout
- execute:
KATALON_API_KEY: <<parameters.KATALON_API_KEY>>
command_arguments: <<parameters.command_arguments>>
- store_artifacts:
path: report
- store_test_results:
path: report
workflows:
build:
jobs:
- katalon-studio/run:
executor: katalon-studio/default
steps:
- checkkout
- katalon-studio/execute:
version: "latest"
command_arguments: '-browserType="Chrome" -retry=0 -statusDelay=15 -testSuitePath="Test Suites/TS_RegressionTest"'