Windows以外のOSで Tosca CI Client を構成する

このトピックは、Tricentisが近い将来に廃止する予定の従来の機能について説明します。廃止計画およびタイムラインに関する詳細情報については、この Tricentisナレッジベースの記事をご覧ください。

代替案については、トピックをチェックしてください。

この章では、Windows以外のオペレーティングシステムから Tosca Distributed Execution を起動する場合に Tosca Continuous Integration Client（Tosca CI Client）の動作を構成する方法を説明します。

Windowsオペレーティングシステムから起動する場合は、 see chapter "Tosca CI Client の設定" 。

基本的なワークフロー

Tosca CI Client を設定するには、の手順に従ってください。

  1. HTTPSバインディングを使用してTosca Serverを使用する場合は、 Tosca CI Client 構成の準備をします。

    • HTTPS経由で通信できるように Tosca CI Client を設定します。そのためには、証明書をJava TrustStoreに追加します。デフォルトのシステム全体のJava TrustStoreは、 %JAVA_HOME%/ lib/security/cacerts にあります。

    • TricentisのTricentis Tosca User Administration でClientのAPIアクセストークンを作成します。トークンのClient IDとクライアントシークレットが必要です。

  2. 必須の構成を行ってください。

    • Tosca Distribution ServerTosca のエンドポイントを定義します。

    • HTTPSバインディングでTosca Serverを使用する場合は、 Tosca CI Client を認証します。

    • Distributed Execution with AOS を使用する場合は、必要な AOS 構成を行います。

  3. Tosca CI Client の動作を定義するオプション構成を実行します。例えば、タイムアウト設定やポーリング間隔を変更します。

Tosca CI Client の必須構成

Tosca CI Client でテストを実行するには、いくつかの必須設定が必要です。

  • Tosca Distribution Server（DEX Server）のエンドポイント。

  • HTTPS バインディングで Tosca Server を使用する場合は、HTTPS アクセス。

  • Distributed Execution with AOS を使用する場合は、 AOS ワークスペース上の情報。

これらの構成を行うには、以下の手順に従ってください。

  1. ファイル config.properties を開きます。デフォルトインストールを行うと、このファイルは %COMMANDER_HOME%\ToscaCI\Client に格納されます。

    カスタムインストールを行った場合は、このファイルが ToscaCIJavaClient.jar ファイルと同じディレクトリにあることを確認します。

  2. DEXサーバーのアドレスを定義します。これを行うには、アドレス設定にエンドポイントを入力してください。

    http(s)://<Tosca Server <span class="Product_Name">Gateway</span> IP address or host name>:<Gateway port>/DistributionServerService/ManagerService.svc 

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

  1. HTTPSバインディングでTosca Serverを使用する場合は、 Tosca CI Client にアクセス許可を与えてください。

    • tokenEndpoint 設定で、認証エンドポイントを入力してください。

      http(s)://<Tosca Server <span class="Product_Name">Gateway</span> IP address or host name>:<Gateway port>/connect/token

    • clientId 設定で、 TricentisのTricentis ToscaUser Administration APIアクセストークンのClientIDを入力します。

    • clientSecret 設定で、APIアクセストークンのクライアントシークレットを入力します。

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

  1. Distributed Execution with AOS を使用する場合は、 AOS 用に Tosca CI Client を設定してください。

    • aoserviceaddress 設定については、まず、 ToscaCIJavaClient.Jarがどこに存在するかを検討します。

      ToscaCIJavaClient.Jar がTosca Serverにある場合は、 http://localhost:5006 をサービスアドレスとして使用します。ToscaCIJavaClient.Jar が別の場所にある場合は、/automationobjectservice のAPIエンドポイントをTosca ServerのURLに追加して、サービスアドレスを作成します。例： https://my-tosca-server.com/automationobjectservice

    • aoservicerequesttimeout 設定では、デフォルト値の30,000ミリ秒（5分）を編集することも、そのままにしておくこともできます。

    • workspacerootname 設定では、ワークスペース作成時に見つけたプロジェクトルート名を入力します。

aoserviceaddress=http://localhost:5006
aoservicerequesttimeout=300000
workspacerootname=DEX_AOS_workspace

  1. 以下のオプションのいずれかを選択してください。

    • 追加のオプション設定を行います。

    • ファイルを保存して閉じます。

Tosca CI Client 用のオプション構成

Tosca CI Client の動作を定義する追加構成を行うことができます。例として、タイムアウトの設定か、ポーリング間隔を変更します。

オプション構成を設定するには、以下の手順に従ってください。

  1. ファイル config.properties を開きます。デフォルトインストールを行うと、このファイルは %COMMANDER_HOME%\ToscaCI\Client に格納されます。

    カスタムインストールを行った場合は、このファイルが ToscaCIJavaClient.jar ファイルと同じディレクトリにあることを確認します。

  2. 以下の設定を修正します。

設定

説明

considerexecutionresult

ビルドサーバでテストが成功したかどうかを示す終了コードが必要な場合は、この設定の値を TRUE に設定します。終了コードは、テストが合格か不合格か、または 1 つ以上の ExecutionEntries に対して結果がないかどうかをビルドサーバに通知します。

  • 合格：終了コード 0

  • 失敗：終了コード -1

  • ExecutionEntriesに結果なし：終了コード -2 。このコードは、 ReportIntermediateResults が TRUE に設定されている場合に適用されます。

デフォルト値は false です。

resulttype

テスト結果の構造を定義します。

ReportIntermediateResults が TRUE の場合は、結果タイプ junit のみが可能です。

デフォルト値は junit です。

pathtoresultfile

Tosca CI Client 上の result.xml ファイルへのパスを定義します。ビルドサーバはこのファイルをインポートしてテスト結果を表示します。

特定のテストの実行に指定されたパスを使用しない場合は、呼び出しパラメータ -r を使用してこの設定を上書きできます。

pollinginterval

Tosca CI Client が Tosca Distribution Server に結果を要求する間隔（ミリ秒単位）。

デフォルト値は 60000 です。

ciclienttimeout

Tosca CI Client が Tosca Distribution Server からの応答を待つ時間（ミリ秒単位）。

Tosca CI Client がこのタイムフレーム内に Tosca Distribution Server から応答を受信しない場合、ユーザーが Tosca Distributed Execution Monitor でキャンセルするまで、TestEventはキューに残ります。

CiClientTimeout で定義された時間間隔は、 PollingInterval よりも長くなければなりません。そうでない場合、システムは PollingInterval で定義された時間間隔を自動的に使用します。

デフォルト値は 36000000 です。

reportintermediateresults

テストランの終了時の概要結果に加えて、各ExecutionEntryの実行後に結果を受け取る場合は、この設定の値を TRUE に設定します。

デフォルト値は false です。

aoservicerequesttimeout

Tosca CI Client が AOS からの応答を待つ時間（ミリ秒単位）。この構成はオプションで、 Distributed Execution with AOS を使用する場合にのみ適用されます。

Tosca CI Client は、TestEventのリストを AOS に送ることで、実行を開始しようとします。このタイムフレーム内に AOS からの応答がない場合、実行結果を取得するために Tosca Distribution Server のポーリングを開始します。Tosca Distribution Serverがこの実行に関する情報を AOS から受け取っていない場合、ポーリングは失敗し、 Tosca CI Client は終了します。このエラーが発生した場合は、タイムアウト時間を長くしてみてください。

デフォルト値は 300000 です。

プロパティのユーザー名とパスワードは無視してください。これらは、Windows以外のオペレーティングシステムからリモートサービスを通じてテストを実行する場合にのみ、適用されます。

例

下記の例では、以下の動作が構成されました：

  • Tosca Distribution Server のエンドポイントは https://111.111.111.0:443/DistributionServerService/ManagerService.svc です。

  • ビルドサーバは Tosca CI Client からの終了コードを期待します。

  • テスト結果の構造は junit です。

  • Tosca CI Client は、結果ファイルをパス SampleDirectory\\Result.xml に保存します。

  • Tosca CI Client は、350,000ミリ秒以内に Tosca Distribution Server に結果を要求します。

  • Tosca CI Client は Tosca Distribution Serve からの応答を36,000,000ミリ秒待ちます。その後、実行を中止します。

  • Tosca CI Client は中間結果を提供します。

  • Tosca CI Client は、クライアントIDMyClientId12345 とクライアントシークレット 1a2B3c4D5e_6F を使用して、 https://111.111.111.0:443/connect/token に対して認証を行います。

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