Page tree

Skip to end of metadata
Go to start of metadata

This topic describes the command line options you can use to run SOAtest on the command line. In this section:

Basic Usage

See CLI Usage for full details about using the SOAtest command line interface.

Use double quotation marks to specify SOAtest command line options. Single quotation marks are not supported.

soatestcli -<option> "<value>"

Example:

soatestcli -config "team://Our Configuration"

After execution, designated group managers and architects will automatically be emailed a report that lists all team/project tasks. The report also identifies which team member is responsible for each task. The report will be emailed–even if there are no tasks–unless the local setting file contains the
report.mail.on.error.only=true option.

If the appropriate prerequisites are met, SOAtest will automatically email team members a report containing only the tasks assigned to him or her. If no tasks are assigned to a particular team member, he or she will not be emailed a report.

Refer to the Eclipse documentation for details about options that are inherited from Eclipse.

Options References

The following options are available.

-appconsole stdout 

Print verbose output to stdout. 

The same type of output that would be shown in the console (if running from the GUI) is printed.

-browserTestsVisible

For browser tests, opens the browser UI and plays back tests in the browser. This gives you the option to view and capture the browser contents shown after each test step if, for example, compliance documentation is required.

-config

Specifies the test configuration you want to use to execute the tests. This parameter is required.

The value specified is interpreted as a URL, the name of a test configuration, or the path to a local file.

By filename example: 

-config "mylocalconfig.properties"

By URL example: 

-config "http://intranet.acme.com/SOAtest/team_config.properties"

Built-in configurations examples:

-config "builtin://Demo Configuration"
-config "Demo Configuration"

User-defined configurations example:

-config "user://My First Configuration"

Team configurations examples:

-config "team://Team Configuration"
-config "team://teamconfig.properties"

-data

Specifies the location of the Eclipse workspace directory to use for executing the tests. The default value is the current user’s dependent directory. If the option is not used, then the default workspace found under <SOATEST_WORKSPACE>\parasoft\workspace will be used, e.g., C:\Users\<USER>\parasoft\workspace.

-dataGroupConfig

Specifies the active data source within a data group. This argument must be followed by the location of an XML file that specifies the active data source for each data group within each .tst file contained in the test run. The XML file must use the following format:

<tests>
	<test> <!--1 or more-->
		<workspacePath></workspacePath>
		<dataGroups>
			<dataGroup> <!--1 or more-->
				<dataGroupName></dataGroupName>
				<activeDataSourceName></activeDataSourceName>
			</dataGroup>
		</dataGroups>
	</test>
</tests>

The <workspacePath> element for datagroupConfig and environmentConfig should contain the path to the resource (e.g., .tst) in the workspace—not the path on the file system. You can right-click the .tst file in the SOAtest UI and choose Properties to get the correct path to the resource. For example, the path in the following example is /SOAtest Tutorial/Calculator.tst.

-dataSourceName 

Specifies the name of the data source associated with the test(s) you want to run. See -dataSourceRow for additional information.

-dataSourceRow 

Runs all tests with the specified data source rows(s). You can specify a list of row numbers or row ranges. The following values are examples of valid values:

  • 5 
  • 1,2,5 
  • 3-9 
  • 2-5,7,20-30

You can also specify all as the value to force all data source rows to be used—even if the data sources were saved to use only specific rows.

You can use the -dataSourceName option to specify which data source contains the row associated with the tests you want to execute. The -dataSourceName argument is optional, but it must come after -dataSourceRow if it is used.

-encodepass

Generates an encoded version the specified value. The encoded string will print to the console and the command line application will terminate. We strongly recommend using this option to generate safe strings that you can use to connect to DTP or License Server. Example:

soatestcli -encodepass mypassword -config "builtin://Example Configuration"

Must be used with -config

-environment 

Specifies the name of the SOAtest environment to use for executing the tests. An environment in SOAtest is a set of variables that define endpoints and other test-specific inputs. SOAtest environments should not be confused with environment entities as described in Virtualize and Continuous Testing Platform. 

When running functional tests from the command line, you can override the active environment specified in a project with one specified from the command line. Note that if the specified environment is not found in the project, the default active environment will be used instead.

-environmentConfig

Specifies the active environment variables. This argument must be followed by the location of an XML file that specifies the environment variable values to use for each .tst file contained in the test run. The XML file must use the following format:

<tests>
	<test> <!--1 or more-->
		<workspacePath></workspacePath>
		<Environment>
			<Variable> <!--1 or more-->
				<Name></Name>
				<Value></Value>
			</Variable>
		</Environment>
	</test>
</tests>

The <workspacePath> element for datagroupConfig and environmentConfig should contain the path to the resource (e.g., .tst) in the workspace—not the path on the file system. You can right-click the .tst file in the SOAtest UI and choose Properties to get the correct path to the resource. For example, the path in the following example is /SOAtest Tutorial/Calculator.tst.

-exclude

Specifies a filename, path to a file, or pattern that matches filenames to be excluded during testing. The pattern matching syntax is similar to that of Ant file sets. The following wildcards are supported:

  • * (single asterisk): matches any character
  • ? (question mark): matches 0 or 1 of the preceding character 
  • ** (double asterisk): matches any directory.  

Examples:

  • -exclude **/internal/** (test everything except classes that have path with folder "internal")
  • -exclude **/*Test.xml (test everything, but files that end with Test.xml)

-fail

Fails the build by returning a non-zero exit code if any violations are reported. The return code will be 2 for static analysis violations, 4 for functional test violations, 8 for code review violations, and 1 for any other problem.

Also see CLI Exit Codes.

-help

Displays a list of valid command line options.

-ignoreMissingResources 

Enables the test execution to ignore missing resources and proceed with the resources present at runtime. If this option is not used, then all resources specified with the -resource option must be present for the test run to execute.  

-import

Imports the specified Eclipse project(s) into the Eclipse workspace. Specifying a .project file imports the selected project. Specifying a directory to import all Eclipse projects found in the selected directory and subdirectories.

Examples:

-import \".project\"

-import \"c:\\DevelRootDir\"

You can use multiple-import flags with soatestcli to specify each project or set of projects you want to import. After importing all necessary projects, you can run soatestcli without the -import option to execute tests.

-include

Specifies a filename, path to a file, or pattern that matches filenames to be included during testing. The pattern matching syntax is similar to that of Ant file sets. The following wildcards are supported:

  • * (single asterisk): matches any character
  • ? (question mark): matches 0 or 1 of the preceding character 
  • ** (double asterisk): matches any directory.  

Examples:

  • -include **/Bank.xml (test Bank.xml files)
  • -include **/ATM/Bank/*.xml (test all .xml files in folder ATM/Bank)
  • -include c:/ATM/Bank/Bank.xml (test only the c:/ATM/Bank/Bank.xml file)

You can also specify a list of patterns by adding them to a .lst file using the -include option to specify the .lst file. For example, you could save the following patterns to a file called "include.lst" and specify  -include c:/include.lst and SOAtest will treat each line in the file as a single pattern: 

**/Bank.xml
**/ATM/Bank/*.xml
c:/ATM/Bank/Bank.xml

The effects that specifying the  include.lst file achieves the same as the following command:

-include **/Bank.xml -include **/ATM/Bank/*.xml -include c:/ATM/Bank/Bank.xml"

-installcertificate 

Installs the Parasoft Root Certificate Authority, which enables SOAtest to record HTTPS traffic. The certificate is usually installed during the normal installation process (see Installation), but can be reinstalled with this option if necessary. Example usage:

soatestcli.exe -installcertificate

-J 

Specifies additional JVM options, which are passed to the Eclipse executable via the -vmargs option.

The Eclipse -vmargs option is used to customize the operation of the Java VM to use to run Eclipse. If specified, this option must come at the end of the command line. Even if not specified on the executable command line, the executable will automatically add the relevant arguments (including the class being launched) to the command line passed into Java using the -vmargs argument. Java Main then stores this value in eclipse.vmargs.

Usage is -vmargs [vmargs*] (Executable, Main)

-localsettings

Specifies the local setting file used to configure execution preferences. The settings in the local settings file specify details, such as Report Center settings, email settings, and Team Server settings.

The local setting file is a properties file. These files can control reporting preferences, who should reports be sent to, how should those reports be labelled, what mail server and domain should be used, etc.

For details on creating local setting files, see Local Settings Files - Options.

-machineid

Prints the machine ID. The machine ID is used for licensing purposes.

-prefs 

Specifies an Eclipse workspace preferences file to import. The specified value is interpreted as a URL or the path to a local Eclipse workspace preferences file. The best way to create a workspace preferences file is to use the Export wizard. To do this:

  1. Choose File> Export.
  2. In the Export Wizard, select Preferences, then click Next.
  3. Do one of the following:
    • To add all of the preferences to the file, select Export all.
    • To add only specified preferences to the file, select Choose specific preferences to export, then check the preferences you want to import.
  4. Click Browse... then indicate where you want the preferences file saved.
  5. Click Finish.

We recommend deleting properties that are not applicable to SOAtest and keeping only critical properties, such as the classpath property. We also recommend that you replace machine/user-specific locations with variables by using the $(VAR) notation. These variables will be replaced with the corresponding Java properties, which that can be set at runtime by running soatestcli with  -J-D options (for example soatestcli -J-DHOME=/home/user).

Examples:

-prefs "http://intranet.acme.com/SOAtest/workspace.properties"

-prefs "workspace.properties"

-publish 

Enables or disables publishing reports to DTP Report Center. DTP 5.3.x or later is required. Acceptable values are true to publish to DTP and false to disable publishing. Default is false.

The connection to DTP is configured in the local settings file.

-publishteamserver 

Enables or disables publishing reports to Parasoft Team Server.  Default is falseThe Team Server location can be specified in the GUI or in the local setting file described in -localsettings.

-qualityCenter

Report test results to HP Quality Center. Allows you to send results back to HP Quality Center. For details, see Using HP ALM and HP Quality Center with SOAtest.

-qualityCenterReportAllTraffic

Report test results to HP Quality Center. Allows you to send results back to HP Quality Center. For details, see Using HP ALM and HP Quality Center with SOAtest.

-resource

Specifies the path to the test suite(s) to run. To run a single test suite, specify the path to the .tst relative to the workspace. To run all test suites within a directory, specify the directory path relative to the workspace. Use the option multiple times in the command to specify multiple resources. Use quotation marks when the resource path contains spaces or other non-alphanumeric characters. All paths, including absolute paths, are relative to the workspace specified by the -data parameter.

You can specify the following types of resources:

.tst fileSpecify the path to a .tst file to execute all tests contained in the file.
directorySpecify the path to a directory in the workspace to execute all test suites in the directory.
.properties fileSpecify the path to a .properties file and the value configured for the com.parasoft.xtest.checkers.resources property in the file will be interpreted as a colon-separated list of resources. Only one .properties file can be specified in this way.
.lst file

Specify the path to a .lst file and each line in the file will be treated as a resource. If no resources are specified on the command line, the complete workspace will be tested.

Team Project Set File (PSF)PSFs are supported for SVN and other source systems, depending on the Eclipse plug-in capabilities installed.

Examples:

-resource "Acme Project"
-resource "/MyProject/tests/acme"
-resource testedprojects.properties

If you are specifying multiple tests from different projects, tests will be grouped project-by-project, in the order specified in the multiple -resource parameters or in the .lst file.

All tests in the same project as the first resource will be run before any tests in a different project. If you specify resources in the order the following order, for example:

/ProjectA/A.tst, /ProjectB/B.tst, /ProjectA/C.tst 

they will executed in the following order:

  1. /ProjectA/A.tst
  2. /ProjectA/C.tst
  3. /ProjectB/B.tst.

-report

Generates a report and saves it with the name and path specified. The report includes an XML file containing the report data, as well as HTML file for presenting the data. You can also configure SOAtest to generate a report in PDF or custom formats by specifying them in thereport.format option. The option is specified in the local settings file (see -localsettings). If a path is not included as part the specified value, the report will be generated in the execution directory.

All of the following commands will produce an HTML report filename.html and an XML report filename.xml.

  • -report filename.xml
  • -report filename.htm
  • -report filename.html

If the specified path ends with an ".html"/".htm"/ ".xml" extension, it will be treated as a path to the  report file to generate. Otherwise, it will be treated as a path to a directory where reports should be generated.

If the file name is explicitly specified in the command and a file with this name already exists in the specified location, the previous report will be overwritten. If your command doesn’t explicitly specify a file name, the existing report file will not be overwritten—the new file will be named repXXXX.html, where XXXX is a random number.

If the -report option is not specified, reports will be generated with the default names  "report.xml/html" in the current directory.

-router 

Specifies an argument to search for in the test suite and a value to replace it with.

In the following example, the URI specified with searchURI is replaced by the value specified with replaceURI:

-router searchURI:host1.adobe.com replaceURI:host2.adobe.com  

In the following example, searchURI matches all URIs and replaces them with the value specified with replaceURI:
-router searchURI:* replaceURI:http://host2.adobe.com/service

This option only applies for SOAP clients.

This feature is deprecated. Use Environments instead.

-showdetails

Prints detailed test progress information to the console.

-testName 

Specifies a string that matches the name or part of the name of a test to run. SOAtest searches for tests in the resource that contain the string specified, but programmatic pattern matching, such as wildcards or regex, is not performed. Use quotation marks if the test contains spaces.

In the following example, a test or test suite named WSDL Tests will run:

soatestcli.exe -data "C:\workspace" -resource "MyService.tst" -config "user://Example Configuration" -testName "WSDL Tests"

Use the match: qualifier to search for tests containing a specific string. In the following example, any tests that contain the string MyTest will run: 

soatestcli.exe -data "C:\workspace" -resource "MyService.tst" -config "user://Example Configuration" -testName match: MyTest

You can use more than on -testName flag to specify multiple tests:

soatestcli.exe -data "C:\workspace" -resource "MyService.tst" -config "user://Example Configuration" -testName "name1" -testName "name2"

If the test uses data from a data source, you can use the dataSourceRow: and dataSourceName: parameters immediately following a match: parameter to limit the range of data rows used to execute the test. The dataSourceName: argument is optional, but it must come after dataSourceRow: parameter if it is used, e.g.:  

soatestcli.exe -data "C:\workspace" -resource "MyService.tst" -config "user://Example Configuration" -testName match: "MyTest" dataSourceRow: 1 dataSourceName: "MyData" 

The value for the dataSourceRow: parameter can be specifies as a single row or a range of rows. The following values are examples of valid values:

  • 5 
  • 1,2,5 
  • 3-9 
  • 2-5,7,20-30

 The dataSourceRow: and dataSourceName: parameters are also available as standalone options. See -dataSourceRow and -dataSourceName.

-visualStudio

Report test results to Microsoft Visual Studio Team System. Allows you to send results back to Microsoft VIsual Studio Team System. For details, see Using Microsoft with SOAtest.

-version

Displays the SOAtest version number.

-workItems

Specifies a comma-delimited list of work item IDs. The test scope will be limited to the resources that are associated with those work items. See Working with the Requirements View for additional information.

  • No labels