サーバーのほとんどの構成設定は、<SOAVIRT_HOME>/WEB-INF ディレクトリにある config.properties ファイルで指定されます。このセクションの設定は最も一般的に指定されるオプションですが、より詳細な設定やテスト コンフィギュレーションの設定を指定できます。詳細については下記を参照してください。

円マークではなく、スラッシュを使用します。

config.properties で Windows のファイル パスを編集する場合、円マークではなくスラッシュを使用してください。

正しい例: c:/my/workspace

誤った例: c:\my\workspace

このセクションの内容:

基本設定オプション


parasoft.eula.accepted

このオプションは、Parasoft エンドユーザー使用許諾契約 (EULA) に同意するようにプロパティを設定します。  デフォルトは false です。製品を使用するには、EULA に同意する必要があります。https://www.parasoft.com/license で EULA をお読みください。

使用例

parasoft.eula.accepted=true

working.dir

SOAVIRT 作業ディレクトリへの相対パスです。指定されていない場合、デフォルトの作業ディレクトリは、<SOAVIRT_HOME> フォルダーの下の ‘workspace’ となります。デフォルトの値を変更し、<SOAVIRT_HOME> フォルダーの外部にワークスペースを置くよう推奨します。そうしないと、サーバーをより新しいバージョンにアップデートしたとき、ワークスペースが削除される可能性があります。

logging.config.file

ビルトイン設定または log4j2 設定を使用してロギング レベルを変更します。指定されていない場合、デフォルト値は /WEB-INF/default.logging.xml です。 

絶対パスまたは相対パスを使用して構成を指定できます。相対パスのルートは、<SOAVIRT_HOME> ディレクトリの場所です。サーバーには、2 つのビルトイン コンフィギュレーションが付属しています。

  • default.logging.xml: INFO、WARN、および ERROR メッセージをログに記録する標準的な log4j2 コンフィギュレーションです。
  • debug.logging.xml: 詳細な追加情報を記録する標準的な log4j2 コンフィギュレーションです。

必要に応じて、これらのビルトイン コンフィギュレーションを変更できます。詳細については log4j2 のマニュアル を参照してください。

使用例

logging.config.file=/WEB-INF/default.logging.xml

c:/wars/soavirt に WAR ファイルを展開した場合に、サーバーは logging.config.file に指定された相対的なパスを、絶対パス c:/wars/soavirt/WEB-INF/default.logging.xml に解決します。

logging.config.file=d:/MyConfigurations/default.logging.xml

scripting.timeout.minutes

Virtualize が応答のないスクリプトを中止し、エラー メッセージを記録するまでの時間を分単位で指定します。デフォルトは 10 分です。

使用例

scripting.timeout.minutes=5

server.hostname

このオプションは、CTP がサーバーへの接続に使用するホスト名を指定します。ほとんどの場合、このオプションは構成を必要としません。ただし、サーバー コンテナまたはネットワーク インフラストラクチャによって接続の確立が妨げられている場合には、リモート ホストがサーバーに接続するための有効な方法を決定できない場合、このオプションが必要になることがあります。これは、コンテナ化された環境で作業する場合に当てはまる可能性があります。 

server.port.http

Parasoft Virtualize Server が HTTP 通信を待機するポートを指定します。server.port.http または server.port.https のどちらかを指定する必要があります。この値は、Parasoft Virtualize Server がデプロイされた HTTP ポートと一致していなければなりません。

server.port.https

Parasoft Virtualize Server が HTTPS 通信を待機するポートを指定します。server.port.https または server.port.http のどちらかを指定する必要があります。この値は、Parasoft Virtualize Server がデプロイされた HTTPS ポートと一致していなければなりません。

env.manager.server

CTP サーバーの場所を指定します。必ずポートおよびプロトコル (http/https) を指定してください。コロンは円マーク \ でエスケープする必要があることに注意してください。

使用例

env.manager.server=http\://em.parasoft.com\:8080/

env.manager.server=https\://em.parasoft.com\:9443/

REST API によるプロパティ設定

このプロパティは、サーバーが起動した後に REST API を使って設定することもできます。.properties ファイルでは CTP に関連する設定名が "env.manager" である点に注意してください。これは CTP の以前の名称である Environment Manager を表しています。しかし、API の CTP オブジェクトには "ctp" というラベルが付いています。これらの設定は同じコンポートを表します。

  1. サーバーを起動し、.properties ファイルへの書き込み用のエンドポイントに移動します。

    http://<host>:<port>/soavirt/api/v5#!/preferences/preferencesPUT_config
     
  2. [Try it out!] をクリックし、入力フィールドに JSON オブジェクトとして Continuous Testing Platform (CTP) サーバー設定を入力します。
  3. [Execute] をクリックしてサーバーの構成を更新します。

次の JSON の例をコピーして入力フィールドに貼り付け、実際のインストール状況に合わせて値を変更できます。

{
  "ctp": {
    "server": "<your-ctp-server>:<port>",
    "name": "<your-ctp-server-name>",
    "username": "<your-username>",
    "password": "<your-password>",
    "notify": false,
  }
}

env.manager.server. name

CTP でこのサーバーを表示する際の名前を指定します。このサーバーを識別するのに役立つ任意の値を使用できます。 

使用例

env.manager.server.name=MyVirtServerLabel

REST API によるプロパティ設定

このプロパティは、サーバーが起動した後に REST API を使って設定することもできます。詳細については「env.manager.server」を参照してください。

env.manager.username

CTP にログインするためのユーザー名を指定します。

使用例

env.manager.username=me 

REST API によるプロパティ設定

このプロパティは、サーバーが起動した後に REST API を使って設定することもできます。詳細については「env.manager.server」を参照してください。

env.manager.password

CTP にログインするためのパスワード (プレーン テキストまたは暗号化されたパスワード) を指定します。 

認証を成功させ、安全な接続を確保するために、SOAtestまたはVirtualizeのコマンドラインインスタンスを -encodepass フラグを指定して実行することを強く推奨します。例:

soatestcli.exe -encodepass <your_password> 

virtualizecli.exe -encodepass <your_password> 

コマンドライン ツールはエンコードされた文字列を生成します。これは、SOAtest および Virtualize Server 構成ファイルの password プロパティの代わりに使用できます。 詳細については「CLI オプション」を参照してください。  

使用例

env.manager.password=12345

REST API によるプロパティ設定

このプロパティは、サーバーが起動した後に REST API を使って設定することもできます。詳細については「env.manager.server」を参照してください。

env.manager.notify

仮想アセットがデプロイされたとき、Parasoft Virtualize Server から Parasoft CTP に通知するかどうかを指定します。

使用例

次の例は、通知を有効にします。

env.manager.notify=true

REST API によるプロパティ設定

このプロパティは、サーバーが起動した後に REST API を使って設定することもできます。詳細については「env.manager.server」を参照してください。

env.manager.registry.id

CTP が使用する読み取り専用のオプションです。 

soatest.license.enabled

このオプションは、SOAtest の機能に関連するオプションを有効化/無効化します。デフォルト値は true です。このオプションが .properties 設定ファイルにない場合、デフォルトが使用されます。このオプションを false に設定した場合、ライセンス関連の設定は無理されます。

使用例

soatest.license.enabled=true

virtualize.license.enabled

このオプションは、Virtualize の機能に関連するオプションを有効化/無効化します。デフォルトは true です。このオプションが .properties 設定ファイルにない場合、デフォルトが使用されます。このオプションを false に設定した場合、ライセンス関連の設定は無理されます。

使用例

virtualize.license.enabled=true

soatest.license.use_network

ネットワーク ライセンスを使用するかどうかを指定します。ネットワーク ライセンスを使用する場合、License Server または Parasoft DTP への接続も設定する必要があります。 

License Server に接続する場合、次のオプションを設定します:

DTP に接続する場合、次のオプションを設定します:

使用例

次の例は、ネットワーク経由のライセンス取得を有効にします。

soatest.license.use_network=true

soatest.license.network.edition

License Server または DTP から取得するライセンスのタイプを指定します。custom_edition または professional_ edition のいずれかを指定できます。

使用例

soatest.license.network.edition=custom_edition

soatest.license.custom_edition_features

Custom Edition ライセンスの場合に、License Server または DTP にリクエストする機能をカンマ区切りリストで指定します。

使用例

soatest.license.custom_edition_features=RuleWizard,Command Line,SOA,Web,Server API Enabled,Jtest Connect,Message Packs,Advanced Test Generation Desktop,Advanced Test Generation 100 Users

virtualize.license.use_network

ネットワーク ライセンスを使用するかどうかを指定します。ネットワーク ライセンスを使用する場合、Parasoft DTP または License Server (非推奨) への接続も設定する必要があります。 

License Server に接続する場合、次のオプションを設定します:

DTP に接続する場合、次のオプションを設定します:

使用例

次の例は、ネットワーク経由のライセンス取得を有効にします。

virtualize.license.use_network=true

virtualize.license.network.edition

License Server から取得するライセンスのタイプを指定します。custom_edition または professional_ edition のいずれかを指定できます。

使用例

virtualize.license.network.edition=custom_edition

virtualize.license.custom_edition_features

カスタム エディション ライセンスの場合に DTP または License Server にリクエストする機能のリストです。

使用例

virtualize.license.custom_edition_features=Virtualize,Validate,Performance,Extension Pack,Service Enabled,Unlimited Hits/Day

dtp.server

DTP サーバーのホスト名を指定します。また、virtualize.license.use_network オプションを true に設定する必要があります( virtualize.license.use_network を参照)。

使用例

dtp.server=main1.parasoft.com

dtp.port

DTP サーバーのポート番号を指定します。また、virtualize.license.use_network オプションを true に設定する必要があります( virtualize.license.use_network を参照)。

使用例

dtp.port=8080

dtp.user

DTP の認証に使用するユーザー名を指定します。このオプションを指定する場合、virtualize.license.use_network オプションを true に設定する必要もあります ( virtualize.license.use_network を参照)。

使用例

dtp.user=admin

dtp.password

DTP の認証に使用するパスワードを指定します。このオプションを指定する場合、virtualize.license.use_network オプションを true に設定する必要もあります ( virtualize.license.use_network を参照)。

使用例

dtp.user=mypassword


license.network.host

License Server のホスト名を指定します。また、virtualize.license.use_network オプションを true に設定する必要があります( virtualize.license.use_network を参照)。このオプションは、バージョン 9.10.3 で非推奨になりました。代わりに dtp.server オプションを使用するべきです。

license.network.port

License Server のポート番号を指定します。また、virtualize.license.use_network オプションを true に設定する必要があります( virtualize.license.use_network を参照)。このオプションは、バージョン 9.10.3 で非推奨になりました。代わりに dtp.port オプションを使用するべきです。

license.network.user

license.network.host および license.network.port オプションで指定されたセカンダリ DTP サーバーでの認証用のユーザー名を指定します。license.network.use.specified.server オプションと license.network.auth.enabled オプションを true に設定する必要があります。

例: license.network.user=JohnDoe

license.network.password

license.network.host および license.network.port オプションで指定されたセカンダリ DTP サーバーでの認証用のユーザー パスワードを指定します。license.network.use.specified.server オプションと license.network.auth.enabled オプションを true に設定し、license.network.user を設定する必要があります。

認証と安全な接続を確実に行うために、パスワードをエンコードすることを強く推奨します。-encodepass フラグを指定して Virtualize のコマンドライン インスタンスを実行することで、パスワードをエンコードできます。コマンドラインツールは、構成ファイルで使用できるエンコードされた文字列を生成します。例:

soatestcli.exe -encodepass <your_password> 

virtualizecli.exe -encodepass <your_password> 

コマンドライン ツールはエンコードされた文字列を生成します。これは、SOAtest および Virtualize Server 構成ファイルの password プロパティの代わりに使用できます。 詳細については「CLI オプション」を参照してください。  

license.network.use.specified.server

このオプションにより、サーバーは「DTP とライセンスサーバー」または「DTP の 2 つのインスタンス」のいずれかに同時に接続できます。true に設定した場合、license.network.connection.type 設定でライセンス ネットワーク接続タイプを指定します。 

license.network.connection.type

このオプションは、DTP/License Server に HTTP 経由で接続するか TCP 経由で接続するかを指定します。 セキュア ポート (SSL) を介した HTTP を推奨します。  

デフォルトは http です。

license.network.auth.enabled

license.network.host  および license.network.port オプションで指定されたセカンダリ DTP サーバーでの認証を有効化/無効化します。

このオプションでは、license.network.use.specified.server オプションを true に設定する必要があります。

virtualize.license.local.password

ローカルな Virtualize ライセンスのパスワードを指定します。また、virtualize.license.use_network オプションを false に設定する必要があります( virtualize.license.use_network を参照)。

virtualize.license.local.expiration

ローカルな Virtualize ライセンスの有効期限を指定します。また、virtualize.license.use_network オプションを false に設定する必要があります( virtualize.license.use_network を参照)。

usage.reporting.enabled

匿名の使用情報の収集と Parasoft への送信を有効/無効にします。詳細については、https://www.parasoft.com/privacy-policy のプライバシー ステートメントをお読みください。

使用例

次の例は、匿名の使用状況データのレポートを有効にします。

usage.reporting.enabled=true 

レポート設定


session.tag

テスト セッションからの署名結果に対するタグを指定します。タグには、文字列、1 個以上の変数、またはそれらの組み合わせを使用できます。似た実行を区別できるよう、異なるテスト セッションのレポートには異なるセッション タグを使用するべきです。デフォルトは session.tag=${config_name} です。

使用例

セッション タグを用いることで、特定テスト環境の特定コード ブランチで実施された特定の解析タイプを表現できます。以下の設定は、異なる OS についてマスター ブランチでの機能テストを特定できます。

session.tag=ft_master_${os}

build.id

結果を表すために使用するビルド ID を指定します。ビルド ID はビルドごとに固有かもしれませんが、特定のビルドで実行された複数のテスト セッションを表すケースも考えられます。デフォルトは ${dtp_project}-${time} です。

使用例

デフォルトのビルド ID には、DTP プロジェクトの名前およびビルドの日付が含まれます。たとえば ATM プロジェクトであれば、レポートに含まれるビルド ID は以下のようになるでしょう。ATM-2017-07-07 

以下の設定は、プロジェクト名と環境変数 BUILD で渡されるビルド番号を組み合わせたカスタム ビルド ID を指定します。

build.id=${dtp_project}-${env_var:BUILD}

ABC プロジェクトで、CI サーバーのビルド番号が 114 の場合は、ABC-114 と解決することがあります。

report.format

この設定は、レポート形式を指定します。複数の形式でレポートをパブリッシュするには、形式の値をカンマ区切りリストで指定します。デフォルトでは、データを含む XML レポートと、データを表示するための HTML ファイルが公開されます。以下の値がサポートされています。

report.custom.extension

この設定は、カスタム レポートのファイル拡張子を指定します。カスタム形式は XSL ファイルで定義されます。report.format オプションはカスタムに設定する必要があり、 report.custom.xsl.file オプションも構成する必要があります。

report.custom.xsl.file

この設定は、カスタム レポート形式の作成に使用する XSL ファイルへのパスを指定します。Windows でファイルパスを指定するときは、2 つのバックスラッシュを使用してください。

report.developer_errors

開発者のエラーの詳細をマネージャー レポートに含めるかどうかを指定します。レポートに開発者エラーを含めるには true に設定します。レポートから開発者エラーを除外するには false に設定します。デフォルト値は true です。

report.developer_reports

マネージャー用のサマリー レポートに加えて、すべての開発者について詳細レポートを生成するかどうかを指定します。開発者用の詳細レポート生成するには、 true に設定します。生成しない場合は false に設定します。デフォルトは true です。

report.authors_details

開発者ごとに割り当てられたタスクの数およびタスク タイプについての概要をレポートに含めるかどうかを指定します。true に設定すると、開発者ごとに割り当てられたタスク タイプとタスクの数がレポートに含まれます。false に設定すると、開発者ごとに割り当てられたタスク タイプとタスクの数がレポートから除外されます。デフォルト値は true です。

report.testcases_details

テストケースの詳細をレポートに含めるかどうかを指定します。true に設定すると、テスト ケースの詳細がレポートに含まれます。false に設定すると、テスト ケースの詳細がレポートから除外されます。デフォルト値は false です。

report.associations

テストに関連する要件、欠陥、タスク、および機能要求をレポートに表示するかどうかを指定します。true に設定すると、要件、欠陥、タスク、および機能要求がレポートに含まれます。false に設定すると、要件、欠陥、タスク、および機能要求がレポートから除外されます。デフォルト値は false です。

report.assoc.url.[tag]

この設定は、HTML レポートで関連情報へのリンクを作成します。URL は、課題 ID の [%ID%] または ${id} プレースホルダーを含むクエリー文字列です。サポートされているタグは prfrtaskreq、および testです。

使用例

以下の例は、Bugzilla の PR へのリンクを HTML レポートに追加します。

report.assoc.url.pr=http://bugzilla.company.com/show_bug.cgi?id=[%ID%]

report.failed_tests_only

失敗したテストだけをレポートに含めるかどうかを指定します。このオプションは機能テスト ツールでのみ有効です。true に設定すると、失敗したテストだけがレポートに含まれます。false に設定すると、すべてのテストがレポートに含まれます。デフォルトは false です。

report.env_details

tst の実行時に使用されたアクティブな環境に関する XML レポートで、詳細情報を表示します。デフォルトは false です。

report.output_details

tst の実行時に実行された出力ツールに関する XML レポートで、詳細情報を表示します。デフォルトは false です。

report.test_suites_only

レポートのサマリー セクションに、トップ レベルのスイートだけを表示するか、または個々のテストのツリー ビューを表示するかを指定します。true に設定すると、トップ レベルのスイートだけが表示されます。false に設定すると、個々のテストのツリー ビューが表示されます。デフォルトは true です。

カスタム/外部 Jar の追加

Parasoft Virtualize Server で外部/カスタム jar (例: Parasoft SOAtest/Virtualize のカスタム拡張、サードパーティの Jar、JDBC ドライバーなど)を使用するには、次の操作を行います。

  1. 以下のいずれかの方法で jar ファイルを追加します。
    • jar を <workspace>/VirtualAssets/system_jars フォルダーにコピーします。Parasoft Virtualize Server は、カスタム/外部 jar ファイルをロードする際、このフォルダーを検索します。このフォルダーがまだ存在しない場合、フォルダーを追加します。
    • Swagger ドキュメント (API の使用) の説明に従って REST API の upload オペレーションを使用し、jar をアップロードします。アップロードの際は、親フォルダーとして /VirtualAssets/system_jars を指定する必要があります。/VirtualAssets/system_jars フォルダーがまだ存在しない場合、作成されます。
  2. 次の操作を行って jar をリロードします。
    • jar に Virtualize のカスタム拡張が含まれている場合、サーバーを再起動します。
    • その他の場合、サーバーを再起動するか、/v5/preferences/systemProperties/reload REST API を呼び出します。 CTP を使用している場合は、サービス仮想化インターフェイスからサーバーを更新することもできます。CTP ドキュメントの「ファイルの更新」を参照してください。

設定に関するその他の注意点

Parasoft Virtualize Server が返すレスポンスの "Server" HTTP ヘッダーの値を ‘Parasoft Server’ (これは従来の Eclipase ベースの Virtualize サーバー デプロイメントのデフォルト値です) に変更するには、サーブレット コンテナーの設定を変更する必要があります。

一部のサーブレット コンテナーは、Trace リクエスト (TRACE HTTP メソッドを使用した HTTP リクエスト)を拒否します。使用しているサーブレット コンテナーが Trace リクエストを拒否するが、Parasoft Virtualize Server に (従来の Eclipse ベースの Virtualize Server デプロイメントと同様に) Trace リクエストをサポートさせたい場合、サーブレット コンテナーの設定を適切に変更する必要があります。

  • No labels