Logo
2023.9.19

Command Line Tasks

Starting tasks

To perform various GeekLoad's tasks from the command line, you need to specify the product name and the necessary parameters in any order.

Each parameter is preceded by a hyphen.
If the parameter requires a value, then it is specified after the equal sign.
If the value contains spaces, then it should be framed with quotation marks.
Parameter names are case-insensitive.

InfoMultiple tasks can be combined in a single command line in any order. Tasks will be completed sequentially according to their priority.

Tasks

The tasks below are described according to their priority.

InfoThe ellipsis symbol in the examples below indicates a possible place to insert other command line parameters.

Strict errors handling

Enables strict error handling in reports.
In this case, operations that were performed with errors are not taken into account when calculating statistics (max, min, and so on).

Loading...

Warnings as success

Interprets the final status of the test execution as "Successful" if this status was equal to "Warning".

Loading...

Help

Display command line help.

Loading...

Import

Import a project from various formats.

Parameters
import
importFormat
generatedProject
:
:
:
URL
Enum
File path
- Url of external data.
- Format of external data.
- The path to the project to be generated.
Loading...

Run

Launching a project.

Loading...
Parameters
run
main
desc
users
:
:
:
:
File path
String
String
Number
- The path to the file of exported data or jdbc connection string
- Optional name of main function ("main" by default).
- Optional description of test (current time by default).
- Optional main number of test users.

Export

Exporting simulation log data to one of the supported formats.

Parameters
export
exportFormat
testID
:
:
:
File path
Enum
Number
- The path to the file of exported data or jdbc connection string
- Target format.
- ID of the exported test (ID of last test by default).
Loading...

List of tests

Displaying a list of saved project execution results. Each report has an identifier that can be used in other command-line tasks.

Loading...

Display report

Displaying test results with the ID XXX, if the ID is not specified, the report for the last test will be displayed.

Loading...

Wait for user

Waiting for the user to press any key after completing all the tasks to continue.

Loading...

Report set

Adjusts the amount of information in summary displayed after the test is completed.

Loading...
Parameters
short
medium
full
:
:
:
enum
enum
enum
- Minimal set of metrics (default value)
- Medium set of metrics
- Full set of metrics

Parametrization

Projects can be parameterized in various ways.
For example, using the parameters specified in the command line:

Loading...

Command line parameters are available as usual variables:

Loading...
InfoEnvironment variables are also interpreted as custom command line parameters.
If the parameter names match, a parameter with a higher priority is selected.

Priority

FeatureCommand line parameters.FeatureEnvironment variables.FeatureParameters from the project configuration file.FeatureParameters from the GeekLoad's configuration file. Also for agents.

Configuration files

Configuration files can also be used to parameterize projects.
By default, GeekLoad tries to upload a configuration file with the name of the main project file and the extension .ofl.
To use another configuration file, specify its path in the configurations parameter.

Example of a configuration file:

Loading...

Agents

All parameters passed to the project on the master are also passed to the agents before the test starts.

InfoThe parameters set in the agent's configuration file have priority over those passed from the master.

Exit codes

After completing any set of tasks, the GeekLoad returns the code with the overall result of the execution. This code is also displayed in the console.

Feature0 - Successful completion of all tasks.Feature1 - The command line parameters are set incorrectly.Feature2 - Reserved.Feature3 - Tasks are completed with warnings.Feature4 - Tasks are completed with errors.Feature5 - An fatal error has occurred in the GeekLoad operation.

© House of Geeks 2024
Telegram