loadmill/runner repository overview

⁠Loadmill Package Runner

Users of Loadmill⁠ can use this image to execute Loadmill's Test Plan. This is basically a wrapper of Our npm package⁠

⁠Running

docker run -it --rm -e TOKEN=INSERT_TOKEN_HERE -e TP_ID=TEST_PLAN_ID_HERE loadmill/runner

The start command accepts the following options:

• TOKEN - (REQUIRED). can be retrieved through Loadmill's UI⁠.
• TP_ID - (REQUIRED). The test plan id you wish to execute.
• ADDITIONAL_DESCRIPTION - will be added at the end of the test plan description. Mostly for build number etc..
• LABELS - indicates Loadmill to run flows that are assigned to a specific label. Multiple labels can be provided separated by "," (e.g. 'label1,label2')
• LABELS_EXPRESSION - Run a test plan's suites with flows that match the labels expression. An expression may contain the characters ( ) & | ! - e.g. '(label1 | label2) & !label3'
• PARAMETERS - you may override Loadmill parameter values via command line arguments by passing 'name=value' pairs separated by "," (e.g. 'host=test.myapp.com,port=443')
• POOL - execute tests from a dedicated agent's pool (when using private agent).
• LOCAL - execute tests from a local dedicated agent. May used with a POOL option or without.
• VERBOSE - print out extra information for debugging.
• REPORT - print out Test Suite Flow Runs report when the run has ended.
• JUNIT_REPORT - create Test Suite (junit style) report when the suite has ended.
• JUNIT_REPORT_PATH - save junit styled report to a path (defaults to current location) when JUNIT_REPORT flag is on.
• MOCHAWESOME_REPORT - create Test Suite (mochawesome style) report when the suite has ended.
• MOCHAWESOME_REPORT_PATH - save JSON mochawesome styled report to a path (defaults to current location) when MOCHAWESOME_REPORT flag is on.
• COLORS - print test results in colors.

⁠Extended Examples

docker run -it --rm -e TOKEN="MY_TOKEN" -e TP_ID="4972abf0-53b0-44d7-9034-bfd81eb94ecb" -e ADDITIONAL_DESCRIPTION="${BUILD_NUMBER}" -e REPORT=true loadmill/runner

docker run -it --rm -e TOKEN="MY_TOKEN" -e TP_ID="4972abf0-53b0-44d7-9034-bfd81eb94ecb" -e LABELS="sanity,regression" -e VERBOSE=true loadmill/runner

docker run -it --rm -e TOKEN="MY_TOKEN" -e TP_ID="4972abf0-53b0-44d7-9034-bfd81eb94ecb" -e PARAMETERS="host=test.myapp.com,port=443" -e COLORS=true loadmill/runner

docker run -it --rm -e TOKEN="MY_TOKEN" -e TP_ID="4972abf0-53b0-44d7-9034-bfd81eb94ecb" -e POOL="myPoolId" loadmill/runner

docker run -it --rm -e TOKEN="MY_TOKEN" -e TP_ID="4972abf0-53b0-44d7-9034-bfd81eb94ecb" -e LOCAL=true loadmill/runner

⁠Note

When using LOCAL option you might run into connectivity issues. In such case please try:

• Check whether a local anti-virus, firewall or some security measures blocks the traffic
• Try run the docker command using --net=host.

If that didn't help - please contact us at [email protected]⁠

⁠Learn More

• About Loadmill⁠