Tosca CI Client für Nicht-Windows-Betriebssysteme konfigurieren

Dieses Kapitel beschreibt ein Legacy-Feature, das Tricentis in naher Zukunft einstellen will. Nähere Informationen zum Einstellungsplan und Zeitablauf finden Sie in diesem Artikel der Tricentis Knowledge Base.

Um mehr über Alternativen zu erfahren, lesen Sie dieses Kapitel.

In diesem Kapitel erfahren Sie, wie Sie das Verhalten des Tosca Continuous Integration Client (Tosca CI Client) konfigurieren, wenn Sie die Tosca Distributed Execution von einem Nicht-Windows-Betriebssystem starten möchten.

Wenn Sie von einem Windows-Betriebssystem aus starten möchten, siehe Kapitel "Tosca CI Client konfigurieren".

Workflow

Um den Tosca CI Client zu konfigurieren, führen Sie diese Schritte aus:

Wenn Sie den Tosca Server mit einer HTTPS-Bindung verwenden, bereiten Sie die Konfiguration des Tosca CI Client vor:
- Richten Sie den Tosca CI Client für die Kommunikation über HTTPS ein. Fügen Sie dazu das Zertifikat zum Java TrustStore hinzu. Der systemweite Java TrustStore befindet sich standardmäßig unter %JAVA_HOME%/lib/security/cacerts.
- Erstellen Sie ein API-Zugriffstoken in der Tricentis User Administration. Sie benötigen die Client ID und den geheimen Clientschlüssel des Tokens, um den Tosca CI Client zu authentifizieren.
Nehmen Sie die obligatorischen Konfigurationen vor:
- Definieren Sie den Endpunkt des Tosca Distribution Server.
- Wenn Sie den Tosca Server mit einer HTTPS-Bindung verwenden, authentifizieren Sie den Tosca CI Client.
- Wenn Sie die Distributed Execution with AOS verwenden, nehmen Sie die erforderlichen AOS-Konfigurationen vor.
Nehmen Sie optionale Konfigurationen vor, die das Verhalten des Tosca CI Client definieren. Ändern Sie zum Beispiel die Timeout-Einstellungen oder das Abfrageintervall.

Obligatorische Konfigurationen für den Tosca CI Client

Um Ihre Tests auszuführen, benötigt der Tosca CI Client einige obligatorische Konfigurationen:

Der Endpunkt des Tosca Distribution Server (DEX Server).
Authentifizierung, wenn Sie den Tosca Server mit einer HTTPS-Bindung verwenden.
Informationen zum AOS-Arbeitsbereich, wenn Sie die Distributed Execution with AOS verwenden.

Um diese Konfigurationen durchzuführen, führen Sie diese Schritte aus:

Öffnen Sie die Datei config.properties. Bei einer Standardinstallation befindet sich diese Datei unter %COMMANDER_HOME%\ToscaCI\Client.

Wenn Sie eine benutzerdefinierte Installation durchgeführt haben, stellen Sie sicher, dass sich die Datei im gleichen Verzeichnis wie die Datei ToscaCIJavaClient.jar befindet.
Definieren Sie die Adresse des DEX Server. Geben Sie dazu den Endpunkt in die Einstellung address ein:

http(s)://<IP-Adresse oder Hostname des Tosca Server Gateway>:<Gateway-Port>/DistributionServerService/ManagerService.svc

address=https://111.111.111.0:443/DistributionServerService/ManagerService.svc

Wenn Sie den Tosca Server mit einer HTTPS-Bindung verwenden, authentifizieren Sie den Tosca CI Client:
- Geben Sie in der Einstellung tokenEndpoint den Authentifizierungsendpunkt ein:
  
  http(s)://<IP-Adresse oder Hostname des Tosca Server-Gateway>:<Gateway-Port>/connect/token
- Geben Sie in der Einstellung clientId die Client ID Ihres API-Zugriffstokens der Tricentis User Administration ein.
- Geben Sie in der Einstellung clientSecret den geheimen Clientschlüssel des API-Zugriffstokens ein.

tokenEndpoint=https://111.111.111.0:443/connect/token
clientId=MyClientId12345
clientSecret=1a2B3c4D5e_6F
                                                    

Wenn Sie die Distributed Execution with AOS verwenden, richten Sie den Tosca CI Client für AOS ein. Geben Sie dazu den Namen des für AOS konfigurierten Arbeitsbereichs in die Einstellung workspacerootname ein.

workspacerootname=DEX_AOS_workspace

Wählen Sie eine der folgenden Optionen:
- Nehmen Sie zusätzliche, optionale Konfigurationen vor.
- Speichern und schließen Sie die Datei.

Optionale Konfigurationen für Tosca CI Client

Sie können zusätzliche Konfigurationen vornehmen, die das Verhalten des Tosca CI Client definieren. Ändern Sie zum Beispiel die Timeout-Einstellungen oder das Abfrageintervall.

Um optionale Konfigurationen festzulegen, führen Sie diese Schritte aus:

Öffnen Sie die Datei config.properties. Bei einer Standardinstallation befindet sich diese Datei unter %COMMANDER_HOME%\ToscaCI\Client.

Wenn Sie eine benutzerdefinierte Installation durchgeführt haben, stellen Sie sicher, dass sich die Datei im gleichen Verzeichnis wie die Datei ToscaCIJavaClient.jar befindet.
Ändern Sie die folgenden Einstellungen:

Einstellung	Beschreibung
considerexecutionresult	Wenn Ihr Build-Server ExitCodes benötigt, die angeben, ob Tests erfolgreich waren oder nicht, setzen Sie den Wert dieser Einstellung auf true. Der ExitCode informiert den Build-Server darüber, ob die Tests erfolgreich waren oder nicht, bzw. ob es keine Ergebnisse für einen oder mehrere Ausführungseinträge gibt: Erfolgreich: ExitCode 0 Fehlgeschlagen: ExitCode -1 Kein Ergebnis für Ausführungseinträge: ExitCode -2. Dieser Code gilt, wenn ReportIntermediateResults auf true gesetzt ist. Der Standardwert ist false.
resulttype	Definiert die Struktur der Testergebnisse. Wenn ReportIntermediateResults true ist, ist nur der Ergebnistyp junit möglich. Der Standardwert ist junit.
pathtoresultfile	Definiert den Pfad zur Datei result.xml auf dem Tosca CI Client. Der Build-Server importiert diese Datei, um die Testergebnisse anzuzeigen. Sie können diese Einstellung mit dem Aufrufparameter -r überschreiben, wenn Sie den angegebenen Pfad für die Ausführung eines bestimmten Tests nicht verwenden möchten.
pollinginterval	Das Intervall in Millisekunden, in dem der Tosca CI Client ein Ergebnis vom Tosca Distribution Server verlangt. Der Standardwert ist 60000.
ciclienttimeout	Zeit in Millisekunden, die der Tosca CI Client auf eine Response des Tosca Distribution Server wartet. Wenn der Tosca CI Client innerhalb dieses Zeitraums keine Antwort vom Tosca Distribution Server erhält, belässt er das Testereignis in der Warteschlange, bis Sie es im Tosca Distributed Execution Monitor abbrechen. Das im CiClientTimeout definierte Zeitintervall muss höher sein als das des PollingInterval. Ist dies nicht der Fall, verwendet das System automatisch das im PollingInterval definierte Zeitintervall. Der Standardwert ist 36000000.
reportintermediateresults	Wenn Sie nach der Ausführung jedes Ausführungseintrags zusätzlich zu den zusammenfassenden Ergebnissen am Ende des Testdurchlaufs Ergebnisse erhalten möchten, setzen Sie den Wert dieser Einstellung auf true. Der Standardwert ist false.
aoservicerequesttimeout	Zeit in Millisekunden, die der Tosca CI Client auf eine Response des AOS wartet. Diese Konfiguration ist optional und nur anwendbar, wenn Sie die Distributed Execution with AOS verwenden. Der Tosca CI Client versucht, die Ausführung zu starten, indem er die Liste der Testereignisse an AOS sendet. Wenn er innerhalb dieses Zeitfensters keine Antwort vom AOS erhält, beginnt er, den Tosca Distribution Server nach Ausführungsergebnissen abzufragen. Wenn der Tosca Distribution Server vom AOS keine Informationen über diese Ausführung erhalten hat, schlägt die Abfrage fehl und der Tosca CI Client wird beendet. Wenn dieser Fehler auftritt, können Sie versuchen, den Timeout-Zeitraum zu erhöhen. Der Standardwert ist 300000.

Ignorieren Sie die Eigenschaften username und password. Diese betreffen Sie nur, wenn Sie Ihre Tests über den Remote Service von einem Nicht-Windows-Betriebssystem ausführen.

Beispiel

Im folgenden Beispiel haben Sie das Verhalten folgendermaßen konfiguriert:

Der Endpunkt des Tosca Distribution Server ist https://111.111.111.0:443/DistributionServerService/ManagerService.svc.
Der Build-Server erwartet einen ExitCode vom Tosca CI Client.
Die Struktur des Testergebnisses ist junit.
Der Tosca CI Client speichert die Ergebnisdatei in den Pfad SampleDirectory\\Result.xml.
Der Tosca CI Client fordert innerhalb von 350.000 Millisekunden ein Ergebnis vom Tosca Distribution Server.
Der Tosca CI Client wartet 36 000 000 Millisekunden auf eine Response vom Tosca Distribution Server Danach bricht er die Ausführung ab.
Der Tosca CI Client liefert Zwischenergebnisse.
Der Tosca CI Client authentifiziert sich anhand von https://111.111.111.0:443/connect/token mit der Client ID MyClientId12345 und dem geheimen Clientschlüssel 1a2B3c4D5e_6F.

address=https://111.111.111.0:443/DistributionServerService/ManagerService.svc
username=
password=
considerexecutionresult=true
resulttype=junit
pathtoresultfile=SampleDirectory\\Result.xml
pollinginterval=350000
ciclienttimeout=36000000
reportintermediateresults=true
tokenEndpoint=https://111.111.111.0:443/connect/token
clientId=MyClientId12345
clientSecret=1a2B3c4D5e_6F
                                                    