Running scenarios using the CLI tool
This topic describes how to use the command line interface (CLI) tool for scenario run automation.
The CLI tool enables you to run load test scenarios from the command prompt using a LoadRunner scenario (.lrs) file or an XML input file.
You construct the XML input prior to running scenarios, allowing for fully DevOps-oriented flows including:
- Pulling scripts from any source control
- Dynamically allocating Dockerized load generators
- Running scenarios from any CI tool
Invoking the CLI tool
- Prerequisite: The user name and password that were used to log in to the Controller machine will be used to run Controller. If you want to use different user credentials, define them in <LoadRunner root>\bin\CLIControllerApp.exe.config in the <appSettings> tag.
- Run CLIControllerApp.exe, located in the <LoadRunner root>\bin, appending the arguments as described in Command line format below.
Command line format
Use the following format for the command line arguments:
–{Run Type} –{File Path} –{Post Run Command} –{Result Name} –{Result Path}
| Arguments | Description |
|---|---|
|
Run Type (Mandatory) |
|
|
File Path (Mandatory) |
A valid Windows path leading to a file.
|
|
Post Run Command (Mandatory) |
Determines what happens when the run finishes.
|
|
Result Name (optional) |
Use this to define a folder under which the results will be stored. It must be followed by Result Path. Format: -ResultName<ResultPath> |
|
Result Path (optional) |
This argument represents the folder under which the results will be collated. It must always be preceded by -ResultName and it must be a valid folder path. Format: -ResultName<ResultPath> |
Examples
-
Running a test using an XML input file:
<LoadRunner root>\bin\CLIControllerApp.exe -InputFile C:\CLI.xml -CollateAndAnalyze -ResultName C:\ControllerResultPath\Res_01
-
Running a test using an existing *.lrs file:
<LoadRunner root>\bin\CLIControllerApp.exe -TestPath C:\testName.lrs -CollateAndAnalyze -ResultName C:\ControllerResultPath\Res
XML input file
The XML input file contains a CLIRun element which has the following structure:
<?xml version="1.0"?> -<CLIRun> -<Groups> -<Group> <Name>{Group Name}</Name> <Vusers>{Number of Vusers}</Vusers> -<Script> <Name>{The name of the script}</Name> <Path>{Full path leading to the script}</Path> <JMeterPath>{Path to the JMeter of the script}</JMeterPath> <JMeterAdditionalPropertiesFilePath>{Path to the file containing additional properties for JMeter}</JMeterAdditionalPropertiesFilePath> <!--Used only in the case of JMeter Protocol Type scripts--> </Script> -<AssignedHosts> <!-- NOTE: Make sure that the host defined here is also defined in the Hosts section below--> <HostName>{Name of the host that will be used by the group.}</HostName> <HostName>...</HostName> </AssignedHosts> </Group> </Groups> -<Hosts> -<Host> <Name>{Host Name}</Name> <Installation>{Acceptable values for this element are: 'Unix' or 'Windows'.}</Installation> <IsOverFirewall>{Acceptable values for this element are: 'true' or 'false'.}</IsOverFirewall> </Host> </Hosts> -<Scheduler> <Name>{Scheduler Name}</Name> -<Data> <Duration>{The time the test should run for.(in seconds)}</Duration> </Data> </Scheduler> </CLIRun>
The CLIRun element contains 3 sections:
- Groups. A list of all the groups that will be used in the test
- Hosts. A list of all the hosts that will be available for the Groups
- Scheduler. The scheduler details.
| Element | Description |
|---|---|
| Group |
A group in the list of groups.
|
|
A script used by a group.
|
|
| Host |
A host in the lists of hosts, and used by a group.
|
| Scheduler |
Determines the duration of the scenario run.
|
XML input file samples
<CliRun> <Groups> <Group> <Name>JMeter1</Name> <Vusers>1</Vusers> <Script> <Name>simple_test</Name> <Path>C:\Protocols\JmeterSimple_test\</Path> <JMeterPath>C:\Protocols\JmeterSimple_test\</JMeterPath> <JMeterAdditionalPropertiesFilePath>C:\Protocols\JmeterSimple_test\simple_test.properties</JMeterAdditionalPropertiesFilePath> </Script> <AssignedHosts> <HostName>localhost</HostName> </AssignedHosts> </Group> </Groups> <Hosts> <Host> <Name>WIN-2AKM2PQEN8J</Name> <Installation>Windows</Installation> <IsOverFirewall>false</IsOverFirewall> </Host> <Host> <Name>localhost</Name> <Installation>Windows</Installation> <IsOverFirewall>false</IsOverFirewall> </Host> </Hosts> <Scheduler> <Name>Scheduler 1</Name> <Data> <Duration>120</Duration> </Data> </Scheduler> </CliRun>
<CliRun> <Groups> <Group> <Name>a1</Name> <Vusers>2</Vusers> <Script> <Name>kali</Name> <Path>C:\Users\Administrator\Documents\VuGen\Scripts\kali</Path> </Script> <AssignedHosts> <HostName>localhost</HostName> </AssignedHosts> </Group> </Groups> <Hosts> <Host> <Name>WIN-2AKM2PQEN8J</Name> <Installation>Windows</Installation> <IsOverFirewall>false</IsOverFirewall> </Host> <Host> <Name>localhost</Name> <Installation>Windows</Installation> <IsOverFirewall>false</IsOverFirewall> </Host> </Hosts> <Scheduler> <Name>Scheduler 1</Name> <Data> <Duration>120</Duration> </Data> </Scheduler> </CliRun>
Notes about running tests using the CLI tool
When you invoke Controller from the command line, the following applies:
-
Only one instance of Controller can run at a time.
-
The arguments are case sensitive.
-
Controller will always overwrite results.
-
Controller launched through the command line behaves normally except when using the -Run option. When using the -Run option, dialogs and message boxes that open and require the user to close them in a usual launch, do not open in a command line launch.
-
Controller's settings are loaded from wlrun7.ini, located in the <LR installation>\config folder.
-
The following property settings are required for the user account used to run the CLI tool:
- Password never expires must be selected.
- User must change password at next logon must not be selected.
- If the application is terminated and an error code is displayed, check the Microsoft documentation for the error code meaning.
See also:
