Configure the Tosca CI Client for Remote test execution for non-Windows operating systems

If you will launch your tests from operating systems other than Windows, configure the behavior of your Tosca Continuous Integration Client (Tosca CI Client) in the config.properties file.

This file is located at %COMMANDER_HOME%/ToscaCI/Client. Ensure that it is located in the same directory as the ToscaCIJavaClient.jar file.

The config.properties file follows the format below:

address=
username=
password=
considerexecutionresult=
resulttype=
reportintermediateresults=
pathtoresultfile=
pollinginterval=
ciclienttimeout=

To customize the behavior of your Tosca CI Client, enter new values after the = (see the example below).

Ignore the properties dexpollinginterval and ciclienttimeout. These properties only apply if you execute your tests with Tosca Distributed Execution from non-Windows operating systems.

For test execution via Remote Service, you can define the following settings:

Setting

Description

Optional

address

Defines the endpoint of the Remote Service.

Enter the same endpoint address that you have specified in the system.serviceModel section of the ToscaCIRemoteExecutionService.exe.config file.

Replace the host name with the IP address of the machine that hosts the Remote Execution Service.

 

username

Authorizes the Tosca CI Client for the execution of tests. If you have configured the Remote Execution Service for client authentication, this setting is mandatory.

Enter the same value that you have specified in the ToscaCIRemoteExecutionService.exe.config file.

 

password

Password for the AuthenticationUsername. If you have configured the Remote Execution Service for client authentication, this setting is mandatory.

Enter the same value that you have specified in the ToscaCIRemoteExecutionService.exe.config file.

 

reportintermediateresults

Specifies that you want to receive results after the execution of each ExecutionEntry in addition to the summary results at the end of the test run.

By default, this setting is turned off, i.e. set to False.

If you turn it off, the Tosca CI Client only delivers summary results at the end of the test run.

 

pollinginterval

This setting only applies if ReportIntermediateResults is set to True.

The interval in milliseconds in which the Tosca CI Client requests a result from the Tosca Distribution Server.

 

ciclienttimeout

This setting only applies if ReportIntermediateResults is set to True.

Time in milliseconds the Tosca CI Client waits for a response from the Tosca Distribution Server.

If the Tosca CI Client does not receive a response from the Tosca Distribution Server within this time frame, it aborts the execution and removes the request from the queue.

The time interval defined in the CiClientTimeout must not be lower than that of the PollingInterval. If it is, the system automatically uses the time interval defined in the PollingInterval.

The default value is 36000000.

 

considerexecutionresult

If your build server requires exit codes that indicate whether tests were successful or not, set the value of this setting to True. The exit code informs the build server whether the tests have passed or failed, or whether there are no results for one or more ExecutionEntries:

  • Passed: exit code 0

  • Failed: exit code -1

  • No result for ExecutionEntries: exit code -2. This code applies if ReportIntermediateResults is set to True.

X

resulttype

Defines the structure of test results.

If ReportIntermediateResults is True, only result type Junit is possible.

X

pathtoresultfile

Defines the path to the result.xml file on the Tosca CI Client. The build server imports this file to display the test results.

You can overwrite this setting with the call parameter -r if you do not want to use the specified path for the execution of a particular test.

X

Example

In the example below, you have configured the following behavior:

  • The Remote Service endpoint is http://100.100.100.100:8732/TOSCARemoteExecutionService.

  • The Remote Execution Service is authorized to run the Tosca CI Client SampleAuthenticationUsername with the password SamplePassword12345.

  • The build server expects an exit code from the Tosca CI Client.

  • The structure of the test results is Junit.

  • The Tosca CI Client delivers intermediate results.

  • The Tosca CI Client saves the result file to the path SampleDirectory\\Result.xml.

  • The Tosca CI Client requests a result from the Tosca Distribution Server within 350.000 milliseconds.

  • The Tosca CI Client waits 36.000.000 milliseconds from a response from the Tosca Distribution Server. After that, it aborts the execution.

address=http://100.100.100.100:8732/TOSCARemoteExecutionService
username=SampleAuthenticationUsername
password=SamplePassword12345
considerexecutionresult=true
resulttype=Junit
reportintermediateresults=true
pathtoresultfile=SampleDirectory\\Result.xml
pollinginterval=350000
ciclienttimeout=36000000