View Source

サーバーのほとんどの構成設定は、<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> ディレクトリの場所です。サーバーには、/WEB-INF/ フォルダーにある 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

ユーザーアクセスログ

default.logging.xml または debug.logging.xml を変更することで、サーバーのユーザーアクセスログを有効/無効にできます (どちらが使用されているかによります)。ユーザーアクセスログは、WAR インストールではデフォルトで有効になっており、デスクトップインストールではデフォルトで無効になっています。ユーザーアクセスログを無効にするには、ACCESS ローリングファイルアペンダーとアペンダー参照をコメントアウトし、ロガー com.parasoft.webtool.rest.api.web.providers.access.logs のログレベルを trace から off に設定します。virtualizecli のユーザーアクセスログを有効にするには、logging.config.file オプションを指定して実行し、これらの要素が有効になっている xml ファイルを指定します。

デフォルトでは、ログファイルは Tomcat インストールログディレクトリに保存されますが、fileName 属性と filePattern 属性を編集することで変更できます。注意: ユーザー名が使用できない場合は、ログ内のユーザー名の代わりにダッシュ (-) が使用されます。

デフォルトの fileName の例:

fileName="${sys:catalina.home}/logs/soavirt_access.log"

アクセスログがオフになっている default.logging.xml の例:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
 
  <Appenders>
    <Console name="CONSOLE" target="SYSTEM_OUT">
      <PatternLayout pattern="%d{dd-MMM-yyyy HH:mm:ss,SSS} [%p] %m at %l%n" />
    </Console>
 
    <!-- Uncomment this appender when using access logs
    <RollingFile name="ACCESS" fileName="${sys:catalina.home}/logs/soavirt_access.log" filePattern="${sys:catalina.home}/logs/$${date:yyyy-MM}/access-%d{MM-dd-yyyy}-%i.log.gz">
        <PatternLayout pattern="%d{dd-MMM-yyyy HH:mm:ss,SSS} [%p] %m%n" />
        <Policies>
            <TimeBasedTriggeringPolicy />
            <SizeBasedTriggeringPolicy size="50 MB"/>
        </Policies>
    </RollingFile>
     -->
 
  </Appenders>
 
  <Loggers>
    <Logger name="com.parasoft" level="INFO">
      <AppenderRef ref="CONSOLE" />
    </Logger>
    <!-- Set level to "trace" to enable access logs -->
    <Logger name="com.parasoft.webtool.rest.api.web.providers.access.logs" additivity="false" level="off">
      <!-- Uncomment to direct to access log file
      <AppenderRef ref="ACCESS" />
        -->
    </Logger>
    <Logger name="com.parasoft.ptest.lic.client.internal" level="off" />
    <Logger name="com.parasoft.ptest.lic.client.validator" level="off" />
    <Root level="off" />
  </Loggers>
 
</Configuration>

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" というラベルが付いています。これらの設定は同じコンポートを表します。

サーバーを起動し、.properties ファイルに書き込むためにエンドポイントに移動します

http://<HOST>:<PORT>/soavirt/api/v5#!/preferences/preferencesPUT_config
[Try it out!] をクリックし、入力フィールドに JSON オブジェクトとして Continuous Testing Platform (CTP) サーバー設定を入力します。
[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 にログインするためのパスワード (プレーンテキストまたは暗号化されたパスワード) を指定します。

認証と安全な接続を確実に行うために、パスワードを暗号化することを強く推奨します。WAR ディストリビューションには、パスワードを暗号化できるスクリプトが含まれています。使用するには

コマンドラインオプションの詳細については「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 に接続する場合、次のオプションを設定します:

license.network.url

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

dtp.url
dtp.user
dtp.password

使用例

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

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 に接続する場合、次のオプションを設定します:

license.network.url

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

dtp.url
dtp.user
dtp.password

使用例

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

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

DTP サーバーの URL を指定します。https:// プロトコルを忘れずに含めてください。DTP は http:// 接続をサポートしていません。DTP がホストサーバーのルート以外の場所にデプロイされている場合、URL にはコンテキストパス (ホスト名からの相対パス、例: https://server.company.com:8443/contextPath) を含める必要があります。組織でリバースプロキシを使用している場合は、これに該当する可能性があります。リバースプロキシサーバーの構成とコンテキストパスの構成の詳細については、DTP のドキュメントを参照してください。

使用例

https://10.9.1.63:8443

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

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

使用例

dtp.user=admin

認証に OIDC を使用している場合は、DTP または License Server で自動化ユーザーに対して基本認証を有効にすることができます。DTP または License Server のドキュメントの「OpenID Connect の設定」を参照してください。

dtp.password

DTP 認証のパスワードを指定します。また、virtualize.license.use_network オプションを true に設定する必要があります（ virtualize.license.use_network を参照）。

使用例

dtp.user=mypassword

license.network.url

License Server の URL を指定します。https:// プロトコルを忘れずに含めてください。License Server は http:// 接続をサポートしていません。License Server がホストサーバーのルート以外の場所にデプロイされている場合、URL にはコンテキストパス (ホスト名からの相対パス、例: https://server.company.com:8443/contextPath) を含める必要があります。組織でリバースプロキシを使用している場合は、これに該当する可能性があります。リバースプロキシサーバーの構成とコンテキストパスの構成の詳細については、License Server のドキュメントを参照してください。

使用例

https://10.9.1.63:8443

license.network.host (非推奨)

License Server のホスト名を指定します。また、virtualize.license.use_network オプションを true に設定する必要があります（ virtualize.license.use_network を参照）。このオプションは非推奨です。

license.network.port (非推奨)

License Server のポート番号を指定します。また、virtualize.license.use_network オプションを true に設定する必要があります（ virtualize.license.use_network を参照）。このオプションは非推奨です。

license.network.user

license.network.url オプションで指定された License Server の認証用のユーザー名を指定します。license.network.use.specified.server オプションと license.network.auth.enabled オプションを true に設定する必要があります。

例: license.network.user=JohnDoe

license.network.password

license.network.url オプションで指定された License Server の認証用のパスワードを指定します。license.network.use.specified.server オプションと license.network.auth.enabled オプションを true に設定し、license.network.user を設定する必要があります。

認証と安全な接続を確実に行うために、パスワードを暗号化することを強く推奨します。WAR ディストリビューションには、パスワードを暗号化できるスクリプトが含まれています。使用するには

コマンドラインオプションの詳細については「CLI オプション」を参照してください。

license.network.use.specified.server

このオプションにより、サーバーは「DTP とライセンスサーバー」または「DTP の 2 つのインスタンス」のいずれかに同時に接続できます。

license.network.auth.enabled

license.network.url オプションで指定された License Server の認証を有効化/無効化します。

このオプションでは、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

security.kerberos.realm

ネットワークに関連した Kerberos レルムを指定します。慣例により多くの場合は、これはすべて大文字のユーザードメイン名です (例: PARASOFT.COM)。

詳細については「その他の設定」> 「セキュリティの設定」の「Kerberos 認証について」を参照してください。

security.kerberos.kdc.server

Key Distribution Center のホスト名 (例: kdc.parasoft.com) を指定します。

詳細については「その他の設定」> 「セキュリティの設定」の「Kerberos 認証について」を参照してください。

レポート設定

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 ファイルが公開されます。以下の値がサポートされています。

xml (デフォルト)
html (デフォルト)
pdf
csv
custom (使用方法については report.custom.extension および report.custom.xsl.file を参照)

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} プレースホルダーを含むクエリー文字列です。サポートされているタグは pr、fr、task、req、および 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 ドライバーなど)を使用するには、次の操作を行います。

以下のいずれかの方法で jar ファイルを追加します。
- jar を <WORKSPACE>/VirtualAssets/system_jars フォルダーにコピーします。Parasoft Virtualize Server は、カスタム/外部 jar ファイルをロードする際、このフォルダーを検索します。このフォルダーがまだ存在しない場合、フォルダーを追加します。
- Swagger ドキュメント (API の使用) の説明に従って REST API の upload オペレーション (/v5/files/upload) を使用し、jar をアップロードします。アップロードの際は、親フォルダーとして /VirtualAssets/system_jars を指定する必要があります。/VirtualAssets/system_jars フォルダーがまだ存在しない場合、作成されます。
次の操作を行って 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 リクエストをサポートさせたい場合、サーブレットコンテナーの設定を適切に変更する必要があります。

基本設定オプション

parasoft.eula.accepted

使用例

working.dir

logging.config.file

使用例

ユーザー アクセス ログ

scripting.timeout.minutes

使用例

server.hostname

server.port.http

server.port.https

env.manager.server

env.manager.server.name

env.manager.username

env.manager.password

env.manager.notify

env.manager.registry.id

soatest.license.enabled

virtualize.license.enabled

soatest.license.use_network

soatest.license.network.edition

soatest.license.custom_edition_features

virtualize.license.use_network

virtualize.license.network.edition

virtualize.license.custom_edition_features

dtp.url

dtp.server (非推奨)

dtp.port (非推奨)

dtp.user

dtp.password

license.network.url

license.network.host (非推奨)

license.network.port (非推奨)

license.network.user

license.network.password

license.network.use.specified.server

license.network.auth.enabled

virtualize.license.local.password

virtualize.license.local.expiration

usage.reporting.enabled

security.kerberos.realm

security.kerberos.kdc.server

レポート設定

session.tag

build.id

report.format

report.custom.extension

report.custom.xsl.file

report.developer_errors

report.developer_reports

report.authors_details

report.testcases_details

report.associations

report.assoc.url.[tag]

report.failed_tests_only

report.env_details

report.output_details

report.test_suites_only

カスタム/外部 Jar の追加

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

ユーザーアクセスログ