You can check the usage of any CLI command using the inbuilt
e.g. Get help on the options for the
Init a test script, a default configuration file and a minimal environment to get you started with Flood Element.
[dir](string) the directory to initialize with an Element test script. Defaults to the current directory.
--skip-install(boolean) Skip yarn/npm install. Defaults to
file(string) the test script name to generate. Specify a file name with a
.tsextension (TypeScript), for example,
You should make sure that
package.json file in the project root folder has the attribute
name before running this command.
file(string) the test script (or path to the test script) to output the plan from. Specify a test script written in TypeScript with a
--json(boolean) Output the test plan as JSON format. Defaults to
file(string) the test script (or path to the test script) to run. Specify a test script written in TypeScript with a
--browserSpecify the browser type used to run the test, using either
--executable-pathpath to the installation folder of a custom Chromium-based browser, used to run the test. If set, Element will ignore the browser settings, and use this custom browser instead.
--chromeSpecify which version of Google Chrome to use.
DEPRECATEDsince version 2.0). You can use
--no-headlessRun in non-headless mode so that you can see what the browser is doing as it runs the test.
--devtoolsRun in non-headless mode and also open devtools
--no-sandboxDisable the chrome sandbox - advanced option, mostly necessary on linux.
Running the test script:
<file>and rerun the test when it changes.
--ffRun the script in fast-forward: override the actionDelay and stepDelay settings to 1 second in the test script. Specify a number to set a different delay.
--slow-moRun the script in slow-motion: Increase the actionDelay and stepDelay settings in the test script to 10 seconds. Specify a number to set a different delay.
--verboseVerbose mode - display details of all commands/actions to the terminal.
--step-delayOverride stepDelay test script setting
--action-delayOverride actionDelay test script setting
--loop-countOverride the loopCount setting in the test script
--strictCompile the script in strict mode. This can be helpful in diagnosing problems.
--fail-status-codeSpecify an exit code when the test fails. Defaults to 1.
--config-fileSpecify the path to a config file to run the test with. If a path is not specified, defaults to
element.config.js. This flag only works when running a test with a config file
--work-rootSpecify a custom work root to save the test results. (Default: a directory named after your test script, under /tmp/element-results of your project folder)
--test-data-rootSpecify a custom path to find test data files. (Default: the same directory as the test script)
--exportGenerate an HTML report and a JSON data file for the test results. The report(s) will be located in a directory named after your test script under [your project folder]/reports.
--muRun test scripts with multiple users and simulate stages of ramping up or down. If not specified, run as a single user. This flag only works if one or more
stagesare configured in Test Settings. Learn more
--show-screenshotDisplay the screenshots right in the terminal output (for iTerm2 on MacOS only). If not specified, only the paths to screenshots are displayed.
PRIORITY OF SETTING VALUES
- CLI flags used in the command 'element run'
- Test settings specified in the test script itself
- Config file (default: 'element.config.js')
- Default settings of Element
For example, let's say you set actionDelay: '3s' and 'stepDelay: '5s' in the test script. Then if you'd like to just quickly verify the script, you can run 'element run --ff' to override the actionDelay and stepDelay settings to 1 second for this particular execution. This would save you from the chore of updating the test script's settings back and forth.
Flood Element supports using a config file across tests within a project. The default config file name (if not specified) is
element.config.js, with the content as below.
Note that there is already a default config file created when you initiate an Element project.
Element will find all the test scripts within the current project that match the
testPathMatch pattern specified in the default config file, then sort the scripts alphabetically (by path-to-script) and execute those scripts sequentially, with the options as specified in the config file.
This would be useful in case you want to reuse a config file across different projects.
Since Element 1.3.0, you can launch a flood directly from Element CLI. To do so, you need to be authenticated with Flood first.
Visit https://app.flood.io/account/api to get your API Token, then paste it into the above command to get authenticated. Unless you want to change the API Token, this step should be done only once.
Every flood needs to belong to a project. Therefore, you need to select a project to use before you can launch a flood.
This command would be useful in case you forgot the Flood project that is being used.
--hosted: indicates you're going to run a flood on hosted grid
--vu: number of virtual users to simulate. Default to
500if not specified
--duration: length of the test, measured in minutes. Default to
15minutes if not specified.
--rampup: the amount of time it will take to reach the defined number of
vu, measured in minutes. Default to
0if not specified.
The meaning and default values for
--rampup are the same as launching a flood on hosted grid, which are 500 (users), 15 (minutes) and 0 (minutes) respectively, if they are not specified in the command line.
HOW TO NAVIGATE AND SELECT
After running the command
element run flood, you will be asked to select regions (to run on-demand test), or grids (to run a test on a hosted grid). To navigate among the options, use the Up/Down arrow key. To select an option, press the Space bar. You can select multiple options if you want.