Run options can be added to the run options entry field in the test script editor. They affect how the script gets executed and add a lot of power and flexibility. This article lists all run options that are available to users.
Configuring run options
To set the run options for a test script, open the script editor and look for the Run
Options entry field:
In that field, place all your run options one after the other with spaces between them.
List of available run options
| Run option | Description |
|---|---|
| #add-host:host:ip,… | Add host mapping to the probe machines. For example: #add-host:fake-host1.com:127.0.0.5,fake-host2.com:127.0.0.6 |
| #best-effort-threshold:X | Threshold to place on best effort execution mode. Default is 5%. See best effort mechanism for stress testing. For example: #best-effort-threshold:10 |
| #chrome-cli:X | At times, you may want to indicate a specific command line switch for your use case. To that end, you can use this run option in testRTC. Learn more about controlling Chrome command line switches in testRTC. |
| #disable-browser-logs | testRTC automatically collects all console logs. Sometimes, these can cause failures or too much “noise”. If you wish to suppress these issues and have testRTC not look and collect browser console logs at all then use this run option. |
| #dynamic-probe:true | Force dynamic allocation of probes when running a test. This slows down allocation and execution of a test for tests with a small number of probes. |
| #get-chrome-log | Instruct testRTC to collect Chrome browser debug logs as part of the test. This is not advisable for use in regular testing – only when such logs are needed to debug certain browser behaviors. |
| #getstats | Tells testRTC to collect its metrics using the WebRTC getstats API and not only using webrtc-internals. See collection methods and collection failures for more information. |
| #getstats-frequency:X | Determine the collection interval of getstats in running tests. The interval value denotes the number of seconds to wait between each call to getstats. By default, the following frequency values apply:Test #timout of up to 19 minutes uses 1 second frequency. Test #timeout of 20-59 minutes uses 5 seconds frequency. Test #timeout of over 60 minutes uses 30 seconds frequency. |
| #har-file | Collect HAR file, which holds all HTTP network traffic of the browser. This is not advisable to do in regular tests – only use when needed. To view this file, use netlog-viewer. This option will be ignored for tests with more than 4 probes or longer than 10 minutes. |
| #ignore-browser-errors | testRTC automatically collects all console logs. If these contain browser errors, they will account as errors of the test and cause it to fail. If you wish to suppress these issues and have testRTC ignore them then use this run option. |
| #ignore-browser-warnings | testRTC automatically collects all console logs. If these contain browser warnings, they will account as warnings of the test and cause it to succeed with warnings. If you wish to suppress these issues and have testRTC ignore them then use this run option. |
| #ignore-nightwatch-warnings | testRTC uses NightWatch for its scripting language. If there are warnings on NightWatch they will account for warnings in your test results. If you wish to suppress these issues and have testRTC ignore them then use this run option. |
| #no-getstats | If all else fails and you simply don’t want testRTC to collect statistics using getstats, you can use this run option. |
| #no-internals |
Note: This has been deprecated. Use
#webrtc-internals run option instead.
|
| #pcap-file:X | Collects a low level packet capture file. This option will be ignored for tests with more than 4 probes or longer than 10 minutes. Packets collected will be truncated to their first 100 bytes by default. You can change that by giving a number of bytes to this run option. |
| #perf:X | Collect machine performance data on the probes during the test. Default is true. You can use #perf:false to disable machine performance data collection. |
| #probe-failure-mode | See best effort mechanism for stress testing. |
| #probe-log-level:ALL | Configure the browser to collect all console logs available. See also here. |
| #probe-screen-height:X | Define the screen height. Useful for screen sharing testing. For example: #probe-screen-width:720 |
| #probe-screen-width:X | Define the screen width. Useful for screen sharing testing. For example: #probe-screen-width:1280 |
| #random-profile | At times, you may want to run the same test script, but with different machine profiles. To that end, you can use this run option and instead of the usual round robin selection of profiles for probes, it will pick the profiles at random from the list available on the test script. |
| #timeout:X | The scripts’ default maximum duration is 5 minutes. In order to keep the system’s resources from endless scripts, the tests manager will stop running scripts if reaching the script’s defined timeout. If you wish to run a longer script, please use the timeout run option #timeout:X. Try setting the timeout to a reasonable value that isn’t too high – if tests fail and get “stuck”, the time used will be counted towards your account’s balance. You can read more about timeout For long running tests (=15 minutes or more), please follow our long running WebRTC tests checklist. |
| #vnc | You can open a VNC connection to the tested instance and track the test’s progress. For further information about how to use VNC, please refer to Using VNC. |
| #webhook-filter | When using webhooks on test runs or monitor runs, you can use this run option to instruct the webhook to only be fired on certain test result status. For example: #webhook-filter:error,warning This will only invoke the webhook if the test ended with a status of error or warning. |
| #webrtc-internals | By default, this run option is set to false. If set to true, then webrtc-internals will be collected. If set to false, then webrtc-internals will not be collected. |
| #ignore-insights-errors | testRTC automatically collects all console logs. If these have insights errors, they will account as errors of the test and cause it to fail. If you wish to suppress these errors and have testRTC ignore them then use this run option. |
| #ignore-insights-warnings | testRTC automatically collects all console logs. If these have insights warnings, they will account as warnings of the test and cause it to succeed with warnings. If you wish to suppress these warnings and not have them presented, then use this run option. |