katalon

katalon/katalon@v1

Process 'katalon' function.

katalon function has mandatory project and test-suite-collection-path inputs to execute a test suite collection in a project.

katalon function has mandatory project, test-suite-path and browser-type inputs to execute a test suite in a project.

CAUTION: The system environment variables KATALON_API_KEY and KATALON_ORG_ID must be defined on the execution environment.

KATALON_API_KEY = Katalon API license key, for example: "123a4567-123a-1ab2-1234-1234567890ab".
KATALON_ORG_ID = Organisation ID at Katalon, for example: "123456".

Additionally, in the case of processing a test suite without specifying the "browser-type" input in the PEaC file, the system environment variable KATALON_BROWSER_TYPE must also be defined.

KATALON_BROWSER_TYPE = Default browser type, for example: Web Service.

If the function is used more than once in a job, it is up to the caller to ensure no previous test execution results remain before executing a new test.

It is also up to the caller to attach the relevant reports so that publishers can do their job too, by using the actions/get-files@v1 function or some other means.

Examples

Execute a test suite collection in a project with the mandatory inputs:

- uses: katalon/katalon@v1
  with:
    project: path/to/project.prj  (Project location (include .prj file), from the root folder of the workspace)
    test-suite-collection-path: path/to/test_suite_collection_file  (Test suite collection file (without extension .tsc))

Execute a test suite collection in a project with the other available inputs:

- uses: katalon/katalon@v1
  with:
    project: path/to/project.prj  (Project location (include .prj file), from the root folder of the workspace)
    test-suite-collection-path: path/to/test_suite_collection_file  (Test suite collection file (without extension .tsc))

    browser-type: value1  (Web Service|Firefox|Chrome|Remote|IE|Edge|Edge (Chromium)|Safari|Android|iOS)
    execution-profile: value2  (Execution profile that a test suite or a test suite collection executes with)
    retry: value3  (number of retry times; 0 for no retry)
    status-delay: value4  (number in seconds)
    send-mail: value5  (e-mail address for receiving report files)
    report-folder: path/to/report_folder  (Destination folder for saving report files)
    report-file-name: value6  (Name for report files (.html, .csv, .log))

    extra-options: additional_options (all other options)

Execute a test suite in a project with the mandatory inputs:

- uses: katalon/katalon@v1
  with:
    project: path/to/project.prj  (Project location (include .prj file), from the root folder of the workspace)
    test-suite-path: path/to/test_suite_file  (Test suite file (without extension .ts))
    browser-type: value1  (Web Service|Firefox|Chrome|Remote|IE|Edge|Edge (Chromium)|Safari|Android|iOS)

Execute a test suite in a project with the other available inputs:

- uses: katalon/katalon@v1
  with:
    project: path/to/project.prj  (Project location (include .prj file), from the root folder of the workspace)
    test-suite-path: path/to/test_suite_file  (Test suite file (without extension .ts))
    browser-type: value1  (Web Service|Firefox|Chrome|Remote|IE|Edge|Edge (Chromium)|Safari|Android|iOS)

    execution-profile: value2  (Execution profile that a test suite or a test suite collection executes with)
    retry: value3  (number of retry times; 0 for no retry)
    status-delay: value4  (number in seconds)
    send-mail: value5  (e-mail address for receiving report files)
    report-folder: path/to/report_folder  (Destination folder for saving report files)
    report-file-name: value6  (Name for report files (.html, .csv, .log))

    extra-options: additional_options (all other options)

Inputs

The function has the following inputs:

project (required)

Specify the project location (include .prj file). The path from the root folder of the workspace must be used in this case. (-projectPath=<path>)
test-suite-collection-path (optional)

Specify the test suite collection file (without extension .tsc). The relative path must be used in this case (root being project folder). (-testSuiteCollectionPath=<path>)
test-suite-path (optional)

Specify the test suite file (without extension .ts). The relative path must be used in this case (root being project folder). (-testSuitePath=<path>)
browser-type (optional)

Specify the browser type used for test suite execution. (-browserType=<browser>)
- Available values for <browser> in Linux OS: (Web Service|Firefox|Chrome|Remote).
- Available values for <browser> in other OS: (Web Service|Firefox|Chrome|IE|Edge|Edge (Chromium)|Safari|Remote|Android|iOS).
- (Web Service) is used for Web Service test execution.
You can use this option in Test Suite Collection execution. The specified browser is used for all test suites in that collection.
execution-profile (optional)

Specify the execution profile that a test suite executes with. (-executionProfile=<profile_name>)
You can use this option in Test Suite Collection execution. The specified execution profile is applied to all test suites in that collection.
retry (optional)

Specify the number of times running test cases in the test suite, until the test suite passes successfully. (-retry=<number of retry times>)
<number of retry times>=0 for no retry.
By default, the retry input is set to 0.
status-delay (optional)

System updates execution status of the test suite after the delay period (in seconds) specified. (-statusDelay=<seconds>)
send-mail (optional)

Specify the e-mail address for receiving report files. If the e-mail address was not specified, the report files are not to be sent. (-sendMail=<e-mail address>)
report-folder (optional)

Specify the destination folder for saving report files. You can use an absolute path or relative path (root being project folder). (-reportFolder=<path>)
By default, the report-folder input is set to Katalon_reports.
report-file-name (optional)

Specify the name for report files (.html, .csv, .log). (-reportFileName=<name>)
If not provided, the system uses the name report (report.html, report.csv, report.log).
extra-options (optional)

All other additional options.

Reports

The function generates the following reports:
(* is a wildcard matching any character string.)

*Junit_Report.xml

Surefire (XML).

Generated when test-suite-collection-path or test-suite-path is specified.
*Katalon_reports.tar or *<report_folder>.tar

TAR archive.

*Katalon_reports.tar by default or *<report_folder>.tar if report-folder is specified.

Contains all files present in the reports folder.

Generated when test-suite-collection-path or test-suite-path is specified.
*report.html or *<report_file_name>.html

Report formatted in HTML.

*report.html by default or *<report_file_name>.html if report-file-name is specified.

Generated when test-suite-path is specified.
*report.csv or *<report_file_name>.csv

Report formatted in CSV.

*report.csv by default or *<report_file_name>.csv if report-file-name is specified.

Generated when test-suite-path is specified.

katalon/execute@v1

An 'execute' function for use by generators.

execute function has a mandatory test input.

The first argument (separated by #) in the test input is mandatory, the other are optional, but you must have 3 # separators in the test input.

So you must specify either the test suite collection after the first # separator or the test suite after the second # separator, but not both.

path/to/project.prj specifies the project location. The path from the root folder of the workspace must be used in this case.

CAUTION: The system environment variables KATALON_API_KEY and KATALON_ORG_ID must be defined on the execution environment.

KATALON_API_KEY = Katalon API license key, for example: "123a4567-123a-1ab2-1234-1234567890ab".
KATALON_ORG_ID = Organisation ID at Katalon, for example: "123456".

Additionally, in the case of processing a test suite, the system environment variable KATALON_BROWSER_TYPE must also be defined.

KATALON_BROWSER_TYPE = Default browser type, for example: Web Service.

Examples

Execute a test suite collection in the project.prj project:

- uses: katalon/execute@v1
  with:
    test: path/to/project.prj#relative_path/to/testSuiteCollection##relative_path/to/testCase

Execute a test suite in the project.prj project:

- uses: katalon/execute@v1
  with:
    test: path/to/project.prj##relative_path/to/testSuite#relative_path/to/testCase

Inputs

The function has the following inputs:

test (required)

The datasource to use.

Reports

The function generates the following reports:
(* is a wildcard matching any character string.)

*Junit_Report.xml

Surefire (XML).

Generated when a test suite collection or test suite is executed.
*Katalon_reports.tar

TAR archive.

Contains all files present in the reports folder.

Generated when a test suite collection or test suite is executed.
*report.html

Report formatted in HTML.

Generated when a test suite is executed.
*report.csv

Report formatted in CSV.

Generated when a test suite is executed.

katalon/params@v1

A 'params' function for use by generators.

params function has mandatory data and format inputs.

Example

- uses: katalon/params@v1
  with:
    data:
      global:
        key1: value1
        key2: value2
      test:
        key1: value3
        key3: value4
    format: format

format must so far be SQUASHTM_FORMAT (tm.squashtest.org/params@v1).

data can have two keys:

global for defining global parameters.
test for defining test parameters.

Inputs

The function has the following inputs:

data (required)

The data to use for the automated test.
format (required)

The format to use for the automated test data.

actions/prepare-inception@v1

Preload the inception environment with data.

prepare-inception function has a mandatory input per file it prepares.

In the case of Katalon:

Example

- uses: actions/prepare-inception@v1
  with:
    Junit_Report.xml: ${{ resources.files.xml }}
    Katalon_reports.tar: ${{ resources.files.tar }}
    report.html: ${{ resources.files.html }}
    report.csv: ${{ resources.files.csv }}

Inputs

The function has the following inputs:

Junit_Report.xml (required)

Surefire (XML), this report is the one used to determinate the test status (success/failure).
Katalon_reports.tar (optional)

TAR archive.
report.html (optional)

Report formatted in HTML.
report.csv (optional)

Report formatted in CSV.