Tosca CI Client の設定

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

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

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

Windows 以外のオペレーティング システムから起動する場合は、 see chapter " Windows以外のOSで Tosca CI Client を構成する" 。

基本的なワークフロー

Tosca CI Client を設定するには、以下の手順に従います。

  1. HTTPSバインディングを使用してTosca Serverを利用する場合は、 Tosca CI Client の構成の準備を行ってください。

    これを行うには、 TricentisTricentisTosca ユーザー管理でClientの APIアクセストークンを作成します。トークンのClientID とクライアントシークレットが必要です。

  2. 必須設定を行います。

    • ToscaDistribution Server のエンドポイントを定義します。

    • HTTPSバインディングでTosca Serverを使用する場合、HTTPS経由で通信用、およびアクセス用に ToscaCI Client を設定します。

    • Distributed Execution with AOS を使用する場合は、必要な AOS 構成を行ってください。

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

Tosca CI Client の必須設定

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

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

  • HTTPSバインディングでTosca Serverを使用する場合のHTTPS設定とアクセス。

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

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

  1. ファイルを開きます。ToscaCIClient.dll.configデフォルトインストール後、このファイルは %COMMANDER_HOME%\ToscaCI\Client にあります。

  1. HTTPSバインディングを使用してTosca Serverを利用する場合、 Tosca CI Client へのアクセスを許可する必要があります。

    • TOSCAContinuousIntegrationにアクセスします。TOSCACIClientプロパティ設定セクション

    • DiscoveryServiceEndpoint 設定で、認証エンドポイントを入力します。

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

    • ClientId 設定で、 TricentisTricentisTosca ユーザー管理 APIアクセストークンのClientID を入力します。

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

<setting name="DiscoveryServiceEndpoint" serializeAs="String">
    <value>https://111.111.111.0:443</value>
</setting>
<setting name="ClientId" serializeAs="String">
    <value>MyClientId12345</value>
</setting>
<setting name="ClientSecret" serializeAs="String">
    <value>1a2B3c4D5e_6F</value>
</setting>

  1. Distributed Execution with AOS を使用する場合は、 AOS 用に Tosca CI Client 設定します。

    • TOSCAContinuousIntegrationに留まります。TOSCACIClientプロパティ設定セクション

    • WorkspaceRootName の設定で、 AOS 用に構成したワークスペースの名前を入力してください。

<setting name="WorkspaceRootName" serializeAs="String">
    <value>DEX_Work</value>
</setting>

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

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

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

ToscaCI Client のオプション設定

ToscaCI Client の動作を定義する追加設定を実行できます。例として、タイムアウトの設定や、ポーリング間隔を変更します。

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

  1. ファイルを開きます。ToscaCIClient.dll.configデフォルトインストール後、このファイルは %COMMANDER_HOME%\ToscaCI\Client にあります。

  2. 以下の設定を変更します。

設定名

説明

TimestampFormat

実行結果のタイムスタンプのフォーマットを定義します。

この設定のデフォルト値は yyMMdd HHmm です。

この設定はカスタム 文字列で変更できます。 可能な構文についての詳細は、 https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings を参照してください。

PathToResultFile

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

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

ConsiderExecutionResult

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

  • 合格：終了コード 0

  • 失敗：終了コード -1

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

デフォルト値 WorkspaceRootNameは False です。

ResultType

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

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

デフォルト値は junit です。

CiClientTimeout

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

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

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

デフォルト値は 36000000 です。

中間結果を報告する

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

デフォルト値は False です。

ポーリング間隔

Tosca CI Client が Tosca Distribution Server から結果を要求する際のミリ秒単位の間隔です。

デフォルト値は 60000 です。

AOServiceRequestTimeout

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

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

デフォルト値は 300000 です。

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

例： CiClientTimeout と PollingInterval に新しい値を設定します。

以下の例では、 CiClientTimeout と PollingInterval の値を増やしています。

<userSettings>
    [...]
    <TOSCAContinuousIntegration.TOSCACIClient.Properties.Settings>
        [...]
        <setting name="CiClientTimeout" serializeAs="String">
            <value>40000000</value>
        </setting>
        [...]
        <setting name="PollingInterval" serializeAs="String">
            <value>350000</value>
        </setting>
    </TOSCAContinuousIntegration.TOSCACIClient.Properties.Settings>
</userSettings>