このトピックでは、コマンドラインで SOAtest を実行するために使用できるコマンドライン オプションについて説明します。このセクションの内容:
基本的な使用方法
SOAtest コマンドライン インターフェイスの使用の詳細については「CLI の使用方法」を参照してください。
SOAtest のコマンドライン オプションを指定するには、二重引用符を使用します。単一引用符はサポートされていません。
soatestcli -<option> "<value>"
例:
soatestcli -config "team://Our Configuration"
実行後、指定されたグループ マネージャーとアーキテクトには、すべてのチーム/プロジェクト タスクをリストしたレポートが自動的に電子メールで送信されます。レポートには、各タスクを担当するチームメンバーも含まれます。設定ファイルに report.mail.on.error.only=true
オプションが含まれていない場合は、タスクがなくてもレポートがメールで送信されます。
適切な前提条件が満たされている場合、SOAtest は、チームメンバーに割り当てられたタスクのみを含むレポートをチームメンバーに自動的にメール送信します。特定のチーム メンバーにタスクが割り当てられていない場合、そのメンバーにレポートは送信されません。
Eclipse から継承されるオプションの詳細については、Eclipse のドキュメントを参照してください。
オプション リファレンス
以下のオプションがあります。
- -appconsole stdout
- -browserTestsVisible
- -config
- -data
- -dataGroupConfig
- -dataSourceName
- -dataSourceRow
- -encodepass
- -environment
- -environmentConfig
- -exclude
- -fail
- -help
- -ignoreMissingResources
- -import
- -include
- -installcertificate
- -J
- -settings
- -machineid
- -prefs
- -property
- -publish
- -resource
- -report
- -router
- -showdetails
- -testName
- -visualStudio
- -version
- -workItems
-appconsole stdout
stdout に verbose 出力を出力します。
GUI からの実行でコンソールに出力される場合と同じ種類の出力を出力します。
-browserTestsVisible
ブラウザー テストで、ブラウザー GUI を開いてテストを再生します。これにより、たとえばコンプライアンスのドキュメントが必要な場合、各テスト ステップの後に表示されるブラウザーのコンテンツを表示してキャプチャすることができます。
-config
テストの実行に使用するテスト コンフィギュレーションを指定します。このパラメーターは必須です。
指定された値は、URL、テスト コンフィギュレーション名、またはローカル ファイルへのパスとして解釈されます。
ファイル名の例:
-config "mylocalconfig.properties"
URL の例:
-config "http://intranet.acme.com/SOAtest/team_config.properties"
ビルトイン コンフィギュレーションの例:
-config "builtin://Demo Configuration" -config "Demo Configuration"
ユーザー定義コンフィギュレーションの例:
-config "user://My First Configuration"
チーム コンフィギュレーションの例:
-config "team://Team Configuration" -config "team://teamconfig.properties"
-data
テストを実行するために使用する Eclipse ワークスペースの場所を指定します。デフォルト値は、現在のユーザーに依存するディレクトリです。-data オプションを使用しない場合は、 <SOATEST_WORKSPACE>\parasoft\workspace の下のデフォルト ワークスペースが使用されます (例: C:\Users\<USER>\parasoft\workspace)。
-dataGroupConfig
データ グループ内のアクティブなデータ ソースを指定します。この引数の後には、テスト実行に含まれる .tstファイル内の各データ グループのアクティブなデータ ソースを指定する XML ファイルの場所を指定する必要があります。XML ファイルは次のフォーマットを使用する必要があります。
<tests> <test> <!--1 or more--> <workspacePath></workspacePath> <dataGroups> <dataGroup> <!--1 or more--> <dataGroupName></dataGroupName> <activeDataSourceName></activeDataSourceName> </dataGroup> </dataGroups> </test> </tests>
datagroupConfig
および environmentConfig
の <workspacePath>
要素には、ファイル システム上のパスではなく、ワークスペース内のリソース (例: .tst) へのパスを含める必要があります。SOAtest UI で .tst ファイルを右クリックして [プロパティ] を選択すると、リソースへの正しいパスを取得できます。たとえば、次の例のパスは /SOAtest Tutorial/Calculator.tst です。
-dataSourceName
実行するテストに関連付けられているデータソースの名前を指定します。詳細については「-dataSourceRow」を参照してください。
-dataSourceRow
指定のデータ ソース行を使用してすべてのテストを実行します。行範囲を表す行番号のリストを指定できます。以下は有効な値の例です。
5
1,2,5
3-9
2-5,7,20-30
また、特定の行のみを使用するようにデータソースが保存されている場合でも、 all
を値として指定して、すべてのデータソース行を強制的に使用するようにできます。
-dataSourceName オプションを使用すると、実行したいテストに関連付けられた行を含むデータソースを指定できます。-dataSourceName
引数はオプションですが、使用する場合は -dataSourceRow
の後に指定する必要があります。
-encodepass
指定された値をエンコードしたものを生成します。エンコードされた文字列がコンソールに出力され、コマンドライン アプリケーションが終了します。このオプションを使用して、DTP または License Server への接続に使用できる安全な文字列を生成することを強く推奨します。例:
soatestcli -encodepass mypassword -config "builtin://Example Configuration"
-config と共に使用する必要があります。
-environment
テストの実行に使用する SOAtest 環境の名前を指定します。SOAtest 環境とは、エンドポイントおよびその他のテスト固有の入力を定義する変数のセットのことです。Virtualize および Continuous Testing Platform で説明されているように、SOAtest 環境を環境エンティティと混同しないようにしてください。
コマンドラインから機能テストを実行するとき、プロジェクトに指定されたアクティブな環境をコマンドラインで指定したもので上書きできます。指定した環境がプロジェクト中にない場合は、代わりにデフォルトのアクティブな環境が使用されます。
-environmentConfig
アクティブな環境変数を指定します。この引数の後ろには、テスト実行に含まれる .tstファイルで使用する環境変数の値を指定する XML ファイルの場所を指定する必要があります。XML ファイルは次のフォーマットを使用する必要があります。
<tests> <test> <!--1 or more--> <workspacePath></workspacePath> <Environment> <Variable> <!--1 or more--> <Name></Name> <Value></Value> </Variable> </Environment> </test> </tests>
datagroupConfig
および environmentConfig
の <workspacePath>
要素には、ファイル システム上のパスではなく、ワークスペース内のリソース (例: .tst) へのパスを含める必要があります。SOAtest UI で .tst ファイルを右クリックして [プロパティ] を選択すると、リソースへの正しいパスを取得できます。たとえば、次の例のパスは /SOAtest Tutorial/Calculator.tst です。
-exclude
テスト中に除外するファイル名、ファイルへのパス、またはファイル名に一致するパターンを指定します。パターン マッチングの構文は、Ant ファイル セットの構文と似ています。以下のワイルド カードをサポートします。
*
(1 個のアスタリスク): 任意の文字に一致します?
(疑問符): 直前の文字の 0 または 1 つに一致します**
(2 個のアスタリスク): 任意のディレクトリに一致します
例:
-exclude **/internal/**
(すべてテストするが、"internal" フォルダーがパスに含まれるクラスは除外する)-exclude **/*Test.xml
(すべてテストするが、ファイル名が Test.xml で終わるファイルは除外する)
-fail
違反がレポートされた場合に、ゼロ以外の終了コードを返してビルドを失敗させます。静的解析の違反は 2、機能テストの違反は 4、その他の問題は 1 を終了コードとして返します。
「CLI 終了コード」も参照してください。
-help
有効なコマンドライン オプションの一覧を表示します。
-ignoreMissingResources
不足しているリソースを無視し、実行時に存在するリソースでテスト実行を継続できるようにします。このオプションを使用しない場合、テスト実行を行うには、-resource
オプションで指定されたすべてのリソースが存在する必要があります。
-import
プロジェクト ファイルをコピーせずに、指定された Eclipse プロジェクトを Eclipse ワークスペースにインポートします。インポートされたプロジェクトは、元の場所にあるファイルを参照します。.project ファイルを指定すると、選択したプロジェクトがインポートされます。ディレクトリを指定して、選択したディレクトリとサブディレクトリにあるすべての Eclipse プロジェクトをインポートします。
例:
-import .project
-import c:\DevelRootDir\
soatestcli
では、複数の -import
フラグを使用して、インポートしたいプロジェクトまたはプロジェクトのセットを指定できます。必要なプロジェクトをすべてインポートした後は、-import オプションを付けずに soatestcli
を実行してテストを実行できます。
-include
テスト中に含めるファイル名、ファイルへのパス、またはファイル名に一致するパターンを指定します。パターン マッチングの構文は、Ant ファイル セットの構文と似ています。以下のワイルド カードをサポートします。
*
(1 個のアスタリスク): 任意の文字に一致します?
(疑問符): 直前の文字の 0 または 1 つに一致します**
(2 個のアスタリスク): 任意のディレクトリに一致します
例:
-include **/Bank.xml
(Bank.xml ファイルをテストする)-include **/ATM/Bank/*.xml
(ATM/Bank フォルダーのすべての .xml ファイルをテストする)-include c:/ATM/Bank/Bank.xml
(c:/ATM/Bank/Bank.xml ファイルだけをテストする)
また、.lst ファイルを -include
オプションで指定して、パターン リストを指定することもできます。たとえば、次のパターンを include.lst というファイルに保存し、-include c:/include.lst
を指定すると、SOAtest は include.lst ファイル内の各行を 1 つのパターンとして扱います。
**/Bank.xml **/ATM/Bank/*.xml c:/ATM/Bank/Bank.xml
include.lst ファイルを指定することで得られる効果は、以下のコマンドと同じです。
-include **/Bank.xml -include **/ATM/Bank/*.xml -include c:/ATM/Bank/Bank.xml"
-installcertificate
SOAtest が HTTPS トラフィックを記録できるようにする Parasoft Root Certificate Authority をインストールします。この証明書は、通常のインストール プロセス ( インストール を参照) でインストールされますが、必要に応じてこのオプションを使って再インストールすることができます。使用例:
soatestcli.exe -installcertificate
-J
追加の JVM オプションを指定します。このオプションは、-vmargs
オプションを介して Eclipse 実行ファイルに渡されます。
Eclipse -vmargs
オプションは、Eclipse の実行に使用する Java VM の動作をカスタマイズするために使用します。このオプションは、コマンドラインの最後に指定する必要があります。実行可能なコマンドラインで指定されていない場合でも、実行ファイルは -vmargs
引数を使用して、適切な引数 (起動されたクラスを含む) を Java へ渡されたコマンドラインに自動的に追加します。そして、Java Main はこの値を eclipse.vmargs に格納します。
次のように使用します。 -vmargs [vmargs*] (Executable, Main)
-settings
実行設定の構成に使用される設定ファイルを指定します。このファイルの設定は、DTP、電子メール、ライセンスなどの詳細設定を指定します。-property
オプションで指定された同じキーの設定は、コマンド内の順序に関係なく、このオプションで渡された設定を上書きします。
設定ファイルはプロパティ ファイルです。これらのファイルは、レポートの設定、レポートの送信先、レポートのラベル付け、使用するメールサーバーとドメインなどをコントロールすることができます。
このオプションを使用すると、SOAtest または Virtualize を起動する実行可能ファイル (例:soatest.exe、virtualize.exe、または eclipse.exe) を使用して、コマンド ラインから GUI に設定をインポートできます。この方法で使用すると、プロパティ ファイル内のすべての設定が、現在ワークスペースにある設定を置き換えます。例:
soatest.exe -settings <path to properties file>
dtp.autoconfig
設定は GUI には適用されず、インポート中に無視されます。
設定ファイルの作成の詳細については、「設定ファイル - オプション」を参照してください。
-machineid
マシン ID を出力します。マシン ID はライセンスの目的で使用されます。
-prefs
インポートする Eclipse ワークスペース環境設定ファイルを指定します。指定された値は、URL またはローカルの Eclipse ワークスペース環境設定ファイルへのパスとして解釈されます。[エクスポート] ウィザードを使用することが、ワークスペース設定ファイルを作成する最善の方法です。[エクスポート] ウィザードを使用するには、次の操作を行います。
- [ファイル] > [エクスポート] を選択します。
- [エクスポート] ウィザードで、[設定] を選択し、[次へ] をクリックします。
- 次のいずれかを実施します。
- すべての設定をファイルに追加するには、[すべてエクスポート] をオンにします。
- 指定した設定だけをファイルに追加するには、インポートしたい設定をチェックします。
- [参照] をクリックし、設定ファイルを保存したい場所を指定します。
- [終了] をクリックします。
SOAtest に適用されないプロパティを削除し、クラスパス プロパティなどの重要なプロパティだけを残すことをお勧めします。また、$(VAR) 表記を使用することで、マシン/ユーザー固有の場所を変数で置き換えることを推奨します。これらの変数は、 相当する Java プロパティで置き換えられます。soatestcli を -J-D オプションで実行することによって、実行時に設定できます (例: soatestcli -J-DHOME=/home/user)。
例:
-prefs "http://intranet.acme.com/SOAtest/workspace.properties"
-prefs "workspace.properties"
-property
コマンドラインで直接 1 つの設定を行うことができます。次の書式を使用します: key=value
このオプションを複数回使用して、同じコマンド ラインで複数の設定を行うことができます。同じキーを持つ前のエントリは上書きされます。また、このオプションで渡された設定は、コマンド内の順序に関係なく、-settings
オプションで指定された同じキーを持つ設定を上書きします。
例:
-property session.tag=sa_linux -property report.dtp.publish=true -property techsupport.auto_creation=true
このオプションを使用すると、SOAtest または Virtualize を起動する実行可能ファイル (例:soatest.exe、virtualize.exe、または eclipse.exe) を使用して、コマンド ラインから GUI に設定をインポートできます。この方法で使用すると、指定した設定が、現在ワークスペースにある設定を置き換えます。例:
soatest.exe -property report.dtp.publish=true
dtp.autoconfig
設定は GUI には適用されず、インポート中に無視されます。
-publish
DTP Report Center へのレポートのパブリッシュを有効または無効にします。DTP5.3.x 以降が必要です。許容値は、DTP にパブリッシュする場合は true
、パブリッシュを無効にする場合は false
です。デフォルトは false
です。
DTP への接続は、設定ファイルで構成されます。
-resource
実行するテスト スイートのパスを指定します。1 つのテスト スイートを実行するには、 ワークスペースから .tst への相対パスを指定します。ディレクトリ内のすべてのテスト スイートを実行するには、 ワークスペースからそのディレクトリへの相対パスを指定します。複数のリソースを指定するには、コマンドでこのオプションを複数回使用します。リソースのパスにスペースや、英数字以外の文字を含むときは、引用符を使用してください。絶対パスを含め、すべてのパスは -data
パラメーターで指定したワークスペースに関連します。
以下の種類のリソースを指定できます。
.tst ファイル | .tst ファイルへのパスを指定して、ファイルに含まれるすべてのテストを実行します。 |
---|---|
ディレクトリ | ワークスペース内のディレクトリへのパスを指定して、ディレクトリ内のすべてのテスト スイートを実行します。 |
.properties ファイル | .properties ファイルへのパスを指定します。ファイル内の com.parasoft.xtest.checkers.resources プロパティに設定された値は、コロンで区切られたリソースのリストとして解釈されます。この方法では 1 個のプロパティ ファイルだけを指定できます。 |
.lst ファイル | .lst ファイルへのパスを指定すると、ファイル中の各行がリソースとして扱われます。コマンドラインでリソースを指定しない場合、すべてのワークスペースがテストされます。 |
Team Project Set File (PSF) | PSF は、インストールされている Eclipse プラグイン機能に応じて、SVN およびその他のソース システムでサポートされます。 |
例:
-resource "Acme Project" -resource "/MyProject/tests/acme" -resource testedprojects.properties
プロジェクトの異なる複数のテストを指定した場合、テストは複数の -resource
パラメーターまたは .lst ファイルで指定された順序で、プロジェクト単位でグループ化されます。
最初のリソースと同じプロジェクトにあるすべてのテストは、別のプロジェクトにあるテストよりも先に実行されます。たとえば、リソースを次の順番で指定した場合:
/ProjectA/A.tst, /ProjectB/B.tst, /ProjectA/C.tst
以下の順序で実行されます。
- /ProjectA/A.tst
- /ProjectA/C.tst
- /ProjectB/B.tst.
-report
レポートを生成し、指定した名前とパスで保存します。レポートには、レポー トデータを含む XML ファイルと、データを表示するための HTML ファイルが含まれています。また、report.format
オプションを使って、PDF またはカスタム形式でレポートを生成するように SOAtest を設定することもできます。このオプションは、設定ファイルで指定します (-settings を参照)。指定された値の一部としてパスが含まれていない場合、レポートは実行ディレクトリに生成されます。
次のすべてのコマンドは、HTML レポート filename.html と XML レポート filename.xml を生成します。
-report filename.xml
-report filename.htm
-report filename.html
指定したパスが ".html"/".htm"/".xml" の拡張子で終わる場合、生成するレポートファイルのパスとして処理されます。そうでない場合は、レポートが生成されるディレクトリのパスとして処理されます。
コマンド内でファイル名を明確に指定し、指定したロケーションにすでにこの名前のファイルが存在する場合、前回のレポートが上書きされます。コマンド内でファイル名を明確に指定しない場合、既存のレポート ファイルは上書きされません。新しいファイルが repXXXX.html という名前で作成されます。XXXX にはランダムな数字が入ります。
-report オプションを指定しない場合、レポートはデフォルト名の "report.xml/html" で現在のディレクトリに作成されます。
-router
テストスイートで検索する引数と、それを置換する値を指定します。
次の例では、searchURI
で指定された URI は、replaceURI
で指定された値に置き換えられます。
-router searchURI:host1.adobe.com replaceURI:host2.adobe.com
次の例では、searchURI
はすべての URI に一致し、それらを replaceURI
で指定された値に置き換えます。
-router searchURI:* replaceURI:http://host2.adobe.com/service
このオプションは SOAP クライアントにだけ適用されます。
この機能は非推奨となりました。代わりに Environment オプションを使用してください。
-showdetails
詳細なテストの進捗情報をコンソールに表示します。
-testName
実行するテストの名前または名前の一部に一致する文字列を指定します。SOAtest は、指定された文字列を含むリソース内のテストを検索しますが、ワイルドカードや正規表現などのプログラムによるパターン マッチングは行いません。テスト名にスペースが含まれている場合は、引用符を使用してください。
次の例では、WSDL Tests
という名前のテストまたはテスト スイートが実行されます。
soatestcli.exe -data "C:\workspace" -resource "MyService.tst" -config "user://Example Configuration" -testName "WSDL Tests"
特定の文字列を含むテストを検索するには、match:
修飾子を使用します。次の例では、MyTest
という文字列を含むすべてのテストが実行されます。
soatestcli.exe -data "C:\workspace" -resource "MyService.tst" -config "user://Example Configuration" -testName match: MyTest
複数のテストを指定するには、-testName
フラグを複数使用します。
soatestcli.exe -data "C:\workspace" -resource "MyService.tst" -config "user://Example Configuration" -testName "name1" -testName "name2"
テストでデータソースのデータを使用する場合は、match:
パラメーターの直後に dataSourceRow:
および dataSourceName:
パラメーターを使用して、テストの実行に使用されるデータ行の範囲を制限できます。dataSourceName:
はオプションですが、使用する場合は dataSourceRow:
パラメーターの後に指定する必要があります。例:
soatestcli.exe -data "C:\workspace" -resource "MyService.tst" -config "user://Example Configuration" -testName match: "MyTest" dataSourceRow: 1 dataSourceName: "MyData"
dataSourceRow:
パラメーターの値は、単一の行または行の範囲として指定できます。以下は有効な値の例です。
5
1,2,5
3-9
2-5,7,20-30
dataSourceRow:
と dataSourceName:
パラメーターは、単独のオプションとしても利用可能です。「-dataSourceRow」および「-dataSourceName」を参照してください。
-visualStudio
Microsoft Visual Studio Team System に結果をレポートします。Microsoft Visual Studio Team System に結果を送信できます。詳細については「Microsoft と SOAtest の使用」を参照してください。
-version
SOAtest のバージョン番号を表示します。
-workItems
作業アイテム ID のカンマ区切りリストを指定します。テスト スコープは、それらの作業アイテムに関連付けられているリソースに制限されます。詳細については「[要件] ビューの操作」を参照してください。