Configure the Tosca CI Client for non-Windows operating systems

This chapter explains how to configure the behavior of the Tosca Continuous Integration Client (Tosca CI Client) if you want to launch Tosca Distributed Execution from non-Windows operating systems.

If you want to launch from Windows operating systems, see chapter "Configure the Tosca CI Client".

If you want to launch from non-Windows operating systems on HTTPS, chapter "Configure the Tosca CI Client for non-Windows operating systems for HTTPS".

To configure the Tosca CI Client, follow the steps below:

  1. Define the address of the Tosca Distribution Server. This step is mandatory.

  2. If you set up Distributed Execution with AOS (Automation Object Service), configure the Tosca CI Client for Distributed Execution with AOS.

  3. Optionally, customize the behavior of the Tosca CI Client.

Define the address of the Tosca Distribution Server

To define the address of the Tosca Distribution Server, follow the steps below:

  1. Open the file config.properties. This file is located at %COMMANDER_HOME%/ToscaCI/Client.

    Make sure that it is located in the same directory as the ToscaCIJavaClient.jar file.

  2. In the address setting, specify the address of the Tosca Distribution Server:

    address=http://<server IP address>:<port>/DistributionServerService/ManagerService.svc

    Replace <server address> and <port> with the IP address and the port of the Tosca Distribution Server.

Configure Tosca CI Client for Distributed Execution with AOS

If you set up Distributed Execution with AOS, you need to configure the Tosca CI Client to work with it.

To do so, follow the steps below:

  1. Open the file config.properties. This file is located at %COMMANDER_HOME%/ToscaCI/Client.

    Make sure that it is located in the same directory as the ToscaCIJavaClient.jar file.

  2. Change the value of the workspacelessexecution setting to true.

  3. Check that the address of the Automation Object Service is defined correctly in the aoserviceaddress setting.

  4. In the workspacerootname setting, specify the name of the workspace that you configured for the AOS.

Example: Configure Tosca CI Client for Distributed Execution with AOS

workspacelessexecution=true
aoserviceaddress=http://localhost:5006/
workspacerootname=DEX_Work

Optional configurations for Tosca CI Client

To set optional configurations for the Tosca CI Client, follow the steps below:

  1. Open the file config.properties. This file is located at %COMMANDER_HOME%/ToscaCI/Client.

    Make sure that it is located in the same directory as the ToscaCIJavaClient.jar file.

  2. Modify the following settings:

Setting

Description

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.

The default value is false.

resulttype

Defines the structure of test results.

If ReportIntermediateResults is true, only result type junit is possible.

The default value is junit.

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.

pollinginterval

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

The default value is 60000.

ciclienttimeout

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.

reportintermediateresults

If you want to receive results after the execution of each ExecutionEntry in addition to the summary results at the end of the test run, set the value of this setting to true.

The default value is false.

aoservicerequesttimeout

Time in milliseconds that the Tosca CI Client waits for a response from the AOS. This configuration is optional and only applicable if you use Distributed Execution with AOS.

The Tosca CI Client tries to start the execution by sending the list of TestEvents to the AOS. If it does not receive a response from the AOS within this time frame, it starts polling the Tosca Distribution Server for execution results. If the Tosca Distribution Server has not received information from the AOS about this execution, the poll fails and the Tosca CI Client exits. If this error occurs, you can try increasing the timeout period.

The default value is 300000.

Ignore the properties username and password. They only apply if you execute your tests via Remote Service from non-Windows operating systems.

Example

In the example below, you configured the following behavior:

  • The Tosca Distribution Server endpoint is http://192.168.0.1:85/DistributionServerService/ManagerService.svc.

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

  • The structure of the test results is junit.

  • 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.

  • The Tosca CI Client delivers intermediate results.

address=http://192.168.0.1:85/DistributionServerService/ManagerService.svc
username=
password=
considerexecutionresult=true
resulttype=junit
pathtoresultfile=SampleDirectory\\Result.xml
pollinginterval=350000
ciclienttimeout=36000000
reportintermediateresults=true