このセクションは、Gradle 用 Jtest タスクおよびパラメーターの情報を提供します。以下のタスクがあります。
jtest
Jtest を実行する Gradle タスクです。
属性
名前 | 設定可能な値/データ型 | 説明 | 必須 |
---|---|---|---|
compilation | Compilation | 手動コンパイル データの記述です。詳細については「コンパイル データの手動カスタマイズ」を参照してください。 | いいえ |
compilations | List | 手動コンパイル データの記述のリストです。詳細については「コンパイル データの手動カスタマイズ」を参照してください。 | いいえ |
dataUpdate | String | ビルドから収集されたコンパイル データを手動で更新できます。 ユーザー プロパティ: | いいえ |
config | String | ビルトイン/DTP/ユーザー定義テスト コンフィギュレーション名です。 ユーザー プロパティ: | いいえ |
exclude | String | 選択されたリソースのうち、解析対象から除外するファイルまたはパッケージのサブセットを指定します。修飾名または複数のファイル名に一致する Ant glob パターンを指定できます。 ユーザー プロパティ: | いいえ |
excludes | List | exclude パラメーターの List です。 ユーザー プロパティ: | いいえ |
excludeTestSources | true | false | テスト ソースを解析対象から除外します。 デフォルト値: ユーザー プロパティ: | いいえ |
fail | true | false | 違反がレポートされた場合、ビルドを失敗させます。 ユーザー プロパティ: | いいえ |
home | Path | Jtest のインストール ディレクトリです。定義されていない場合、PATH 上で指定された Jtest の場所を使用します。 ユーザー プロパティ: | 推奨 |
ignoredIds | List | 無視するコンパイル ID の List です。 ユーザー プロパティ: | いいえ |
include | String | 選択された リソースの中から、解析対象に含めるファイルまたはパッケージのサブセットを指定します。 ユーザー プロパティ: | いいえ |
includes | List | include パラメーターのリストです。 ユーザー プロパティ: | いいえ |
publish | true | false | ローカル解析の結果を DTP サーバーにパブリッシュするかどうかを指定します。 ユーザー プロパティ: | いいえ |
report | Path | レポートが作成されるディレクトリを指定します。 ユーザー プロパティ: | いいえ |
resource | String | 解析の入力スコープを指定します。リソースが指定されていない場合、ビルドされたすべてのプロジェクトのリソースが解析されます。 ユーザー プロパティ: | いいえ |
resources | List | resource パラメーターのリストです。 ユーザー プロパティ: | いいえ |
settings | Path | カスタム設定が保存された *.properties ファイルへの絶対パスまたは相対パスです。 ユーザー プロパティ: jtest.settings | いいえ |
settingsList | List | settings パラメーターのリストです。 ユーザー プロパティ: | いいえ |
showDetails | true | false | より詳細な進捗情報を表示します。 ユーザー プロパティ: jtest.showdetails | いいえ |
showSettings | true | false | 現在の設定およびカスタマイズの状況を出力します。各構成エントリがどこで指定されているか (.properties ファイルなど) を表示します。 ユーザー プロパティ: | いいえ |
projectNameTemplate | String | プロジェクト名のテンプレートです。[group]、[name]、[version]、[path]、および [basedir] オプションを使用してパターンを構成できます。 ユーザー プロパティ: | いいえ |
skip | true | false | Jtest の実行のスキップを有効または無効にします。 ユーザー プロパティ: | いいえ |
パラメーターの詳細
config
テスト コンフィギュレーション名です。次のタイプがサポートされています。
- ビルトイン テスト コンフィギュレーション 例:
"builtin://Recommended Rules"
- DTP テスト コンフィギュレーション 例:
"dtp://New Config"
- ユーザー定義テスト コンフィギュレーション 例:
"user://Your Config"
ユーザー定義コンフィギュレーションは [INSTALL_DIR]/configs/user ディレクトリに *.properties ファイルとして格納する必要があります。
dataUpdate
ビルドから収集されたコンパイル データを手動で更新できます。
- サポートされるアクション: prepend, append, and set.
- サポートされるデータ型: classpath、bootpath、sourcepath、resourcepath、binarypath、sourcecode (set のみ)、encoding (set のみ)
- スコープ: 収集されたすべてのプロジェクト データが更新されます。
詳細については「コンパイル データの手動カスタマイズ」および「コンパイル データ モデル」を参照してください。
exclude
選択されたリソースのうち、解析対象から除外するファイルまたはパッケージのサブセットを指定します。修飾名を指定できます。複数のファイル名に一致する glob パターンを使用できます。
例 1: 次のパターンは、com.parasoft パッケージおよびそのサブパッケージのすべてのファイルを除外します: /com/parasoft/**
例 2: 次のパターンは、com.parasoft.jtest パッケージのすべてのファイルを除外しますが、サブパッケージのファイルは除外しません: /com/parasoft/jtest/*
例 3: 次のパターンは、指定されたディレクトリおよびそのサブディレクトリにあるすべてのファイルを除外します: path:/home/user/project/src/test/java/**
include
選択された リソースの中から、解析対象に含めるファイルまたはパッケージのサブセットを指定します。複数のファイル名に一致する glob パターンを使用できます。
例 1: 次のパターンは、com.parasoft パッケージおよびそのサブパッケージのすべてのファイルを含めます: /com/parasoft/**
例 2: 次のパターンは、com.parasoft.jtest パッケージのすべてのファイルを含めますが、サブパッケージのファイルは含めません: /com/parasoft/jtest/*
例 3: 次のパターンは、指定されたディレクトリおよびそのサブディレクトリにあるすべてのファイルを含めます: path:/home/user/project/src/test/java/**
resource
解析の入力スコープを指定します。リソースが指定されていない場合、ビルドされたすべてのプロジェクトのリソースが解析されます。
次のパターンを使用してパスを指定します: ${ProjectName}/my/src/dir/my/package/file.java"以下のワイルドカードを使用できます。
- ? - 1 文字に一致します。
- * - (パスの区切り文字 / を除く) 0 個以上の文字に一致します 。
- ** - パス区切り文字 / を含むパス全体に一致します。
settings
カスタム設定が保存された *.properties ファイルへの絶対パスまたは相対パスです。
projectNameTemplate
プロジェクト名のテンプレートです。デフォルトでは、次のパターンを使用して json 中のプロジェクト名が作成されます: "group:name"。このパラメーターを指定すると、[group]、[name]、[version]、[path] および [basedir] オプションを使用してパターンを設定できます。たとえば、プロジェクト名を Eclipse のプロジェクト名と合わせることができます。
パラメーター型の詳細
すべてのサンプルは、Jtest Plugin for Gradle がビルドスクリプトに適切に適用されていることを前提としています。詳細については「Jtest Plugin for Gradle の設定」を参照してください。
Compilation 型
- 属性: Compilation
- ネストされたオブジェクト
jtest { home = "path/to/jtest" compilation { id = "main" override = true } }
List 型
- 属性: resources
- ビルド中に収集されたリソースと比較するリソースのパターンのリストを指定します。
jtest { home = "path/to/jtest" resources = [ "**.java", "myGradleProjectName/src/com/mycompany/models/**/*.properties" ] }
String 型
- 属性: Exclude
- 選択されたリソースのうち、解析対象から除外するファイルまたはパッケージのサブセットを指定します。
jtest { home = "path/to/jtest" exclude = "com/mycompany/models/**/NotInteresting*.properties" }
詳細については「コンパイル データ モデル」を参照してください。
jtest-agent
Jtest でカバレッジを収集するための Gradle タスクです。
パラメーター
名前 | 設定可能な値/データ型 | 説明 | 必須 |
---|---|---|---|
home | Path | Jtest のインストール ディレクトリです。 ユーザー プロパティ: | はい |
enableJacoco | true | false | Jacoco エンジンを使用した行カバレッジの収集を有効/無効にします。 デフォルト値: ユーザー プロパティ: | いいえ |
skip | true | false | Jtest タスクをスキップするかどうかを指定します。 デフォルト値: ユーザー プロパティ: | いいえ |
runtimeDataLocation | Path | カバレッジ実行データが保存されるファイルのパスです。 ユーザー プロパティ: | いいえ |
metadataLocation | Path | カバレッジ メタデータが保存されるファイルのパスです。 ユーザー プロパティ: | いいえ |
coverage | カバレッジの収集の設定を行うパラメーターのセットです。
| いいえ |
パラメーターの詳細
coverage
デフォルト値:
jtest { /* other parameters */ coverage { skip = false includes = [ 'package/**' ] excludes = [ ] testIncludes = [ 'package/Test.class' ] testExcludes = [ ] } }
runtimeDataLocation
デフォルト値: ${basedir}/parasoft/jtest-instrument/runtimedata.data
metadataLocation
デフォルト値: ${basedir}/parasoft/jtest-instrument/metadata.data
jtest-monitor
ビルドをスキャンして Jtest Java エージェントの設定を生成し、monitorLocation パラメーターで指定された場所にモニター パッケージを作成します。
モニターパッケージには、以下が含まれます。
- static_coverage.xml - 静的カバレッジ データを格納したファイル
- agent.jar - Jtest Java カバレッジ エージェントの jar アーカイブ
- agent.properties - ビルド処理中に生成されたスコープ パラメーターおよびその他の属性を含むエージェント設定ファイル
- agent.sh/agent.bat - アプリケーションのモニタリングに必要な Jtest Java エージェント VM 引数を生成するスクリプト
パラメーター
名前 | 設定可能な値/データ型 | 説明 | 必須 |
---|---|---|---|
agentServerEnabled | true | false | Agent サーバーの有効化スイッチです。 ユーザー プロパティ: jtest.agentServerEnabled | いいえ |
autostartAgent | true | false | 自動的にカバレッジの収集を有効化するスイッチです。 ユーザー プロパティ: | いいえ |
compilation | Compilation | 手動コンパイル データの記述です。詳細については「コンパイル データの手動カスタマイズ」を参照してください。 | いいえ |
coverage | カバレッジの収集の設定を行うパラメーターのセットです。
| ||
enableJacoco | true | false | Jacoco エンジンを使用した行カバレッジの収集を有効/無効にします。 デフォルト値: ユーザー プロパティ: | いいえ |
exclude | String | 選択されたリソースのうち、解析対象から除外するファイルまたはパッケージのサブセットを指定します。修飾名または複数のファイル名に一致する Ant glob パターンを指定できます。 ユーザー プロパティ: | いいえ |
excludes | List | exclude パラメーターのリストです。 ユーザー プロパティ: | いいえ |
home | Path | Jtest のインストール ディレクトリです。 ユーザー プロパティ: | 推奨 |
ignoredIds | List | 無視するコンパイル ID の List です。 ユーザー プロパティ: | いいえ |
include | String | 選択された リソースの中から、解析対象に含めるファイルまたはパッケージのサブセットを指定します。 ユーザー プロパティ: | いいえ |
includes | List | include パラメーターのリストです。 ユーザー プロパティ: | いいえ |
monitorLocation | Path | モニター パッケージが作成される場所へのパスです。 ユーザー プロパティ: jtest.monitorLocation | いいえ |
publish | true | false | ローカル解析の結果を DTP サーバーにパブリッシュするかどうかを指定します。 ユーザー プロパティ: | いいえ |
report | Path | レポートが作成されるディレクトリを指定します。 ユーザー プロパティ: | いいえ |
resource | String | 解析の入力スコープを指定します。リソースが指定されていない場合、ビルドされたすべてのプロジェクトのリソースが解析されます。 ユーザー プロパティ: | いいえ |
resources | List | resource パラメーターのリストです。 ユーザー プロパティ: | いいえ |
settings | Path | カスタム設定が保存された *.properties ファイルへの絶対パスまたは相対パスです。 ユーザー プロパティ: jtest.settings | いいえ |
settingsList | List | settings パラメーターのリストです。 ユーザー プロパティ: | いいえ |
showDetails | true | false | より詳細な進捗情報を表示します。 ユーザー プロパティ: jtest.showdetails | いいえ |
showSettings | true | false | 現在の設定およびカスタマイズの状況を出力します。各構成エントリがどこで指定されているか (.properties ファイルなど) を表示します。 ユーザー プロパティ: | いいえ |
projectNameTemplate | String | プロジェクト名のテンプレートです。[group]、[name]、[version]、[path]、および [basedir] オプションを使用してパターンを構成できます。 ユーザー プロパティ: | いいえ |
skip | true | false | Jtest の実行のスキップを有効または無効にします。 ユーザー プロパティ: | いいえ |
パラメーターの詳細
exclude
選択されたリソースのうち、解析対象から除外するファイルまたはパッケージのサブセットを指定します。修飾名を指定できます。複数のファイル名に一致する glob パターンを使用できます。
例 1: 次のパターンは、com.parasoft パッケージおよびそのサブパッケージのすべてのファイルを除外します: /com/parasoft/**
例 2: 次のパターンは、com.parasoft.jtest パッケージのすべてのファイルを除外しますが、サブパッケージのファイルは除外しません: /com/parasoft/jtest/*
例 3: 次のパターンは、指定されたディレクトリおよびそのサブディレクトリにあるすべてのファイルを除外します: path:/home/user/project/src/test/java/**
include
選択された リソースの中から、解析対象に含めるファイルまたはパッケージのサブセットを指定します。複数のファイル名に一致する glob パターンを使用できます。
例 1: 次のパターンは、com.parasoft パッケージおよびそのサブパッケージのすべてのファイルを含めます: /com/parasoft/**
例 2: 次のパターンは、com.parasoft.jtest パッケージのすべてのファイルを含めますが、サブパッケージのファイルは含めません: /com/parasoft/jtest/*
例 3: 次のパターンは、指定されたディレクトリおよびそのサブディレクトリにあるすべてのファイルを含めます: path:/home/user/project/src/test/java/**
resource
解析の入力スコープを指定します。リソースが指定されていない場合、ビルドされたすべてのプロジェクトのリソースが解析されます。
次のパターンを使用してパスを指定します: ${ProjectName}/my/src/dir/my/package/file.java"以下のワイルドカードを使用できます。
- ? - 1 文字に一致します。
- * - (パスの区切り文字 / を除く) 0 個以上の文字に一致します 。
- ** - パス区切り文字 / を含むパス全体に一致します。
settings
カスタム設定が保存された *.properties ファイルへの絶対パスまたは相対パスです。
projectNameTemplate
プロジェクト名のテンプレートです。デフォルトでは、次のパターンを使用して json 中のプロジェクト名が作成されます: "group:name"。このパラメーターを指定すると、[group]、[name]、[version]、[path] および [basedir] オプションを使用してパターンを設定できます。たとえば、プロジェクト名を Eclipse のプロジェクト名と合わせることができます。
パラメーター型の詳細
すべてのサンプルは、Jtest Plugin for Gradle がビルドスクリプトに適切に適用されていることを前提としています。詳細については「Jtest Plugin for Gradle の設定」を参照してください。
Compilation 型
- 属性: Compilation
- ネストされたオブジェクト
jtest { home = "path/to/jtest" compilation { id = "main" override = true } }
List 型
- 属性: resources
- ビルド中に収集されたリソースと比較するリソースのパターンのリストを指定します。
jtest { home = "path/to/jtest" resources = [ "**.java", "myGradleProjectName/src/com/mycompany/models/**/*.properties" ] }
String 型
- 属性: Exclude
- 選択されたリソースのうち、解析対象から除外するファイルまたはパッケージのサブセットを指定します。
jtest { home = "path/to/jtest" exclude = "com/mycompany/models/**/NotInteresting*.properties" }
詳細については「コンパイル データ モデル」を参照してください。
affectedTests
このゴールは、Jtest に付属のテスト影響分析プラグインによって設定され、プロジェクトのテスト影響分析の実行を可能にします (「テスト影響分析」を参照)。
必須パラメーター
名前 | ユーザー プロパティ | 設定可能な値/データ型 | 説明 |
---|---|---|---|
referenceCoverageFile | jtest.referenceCoverageFile | Path | URL | 解析時に Jtest によって生成された coverage.xml ファイルへのパスです。ファイルには実行中に収集されたカバレッジ データが保存されています。 URL を指定した場合、ファイルは Jtest 実行ディレクトリにダウンロードされ、clean コマンドを使用して Gradle を実行するたびに削除されます。デフォルトのダウンロードされる場所を変更するには、 デフォルト値: |
referenceReportFile | jtest.referenceReportFile | Path | URL | 解析時に Jtest によって生成された report.xml ファイルへのパスです。ファイルには実行された単体テストに関する情報が保存されています。 URL を指定した場合、ファイルは Jtest 実行ディレクトリにダウンロードされ、clean コマンドを使用して Gradle を実行するたびに削除されます。デフォルトのダウンロードされる場所を変更するには、 デフォルト値: |
jtestHome | jtest.home | Path | Jtest のインストール ディレクトリへのパスです。Gradle の設定または JTEST_HOME 環境変数によってすでに Jtest のインストール ディレクトリが設定されている場合は、このパラメーターは不要です。 |
任意パラメーター
名前 | ユーザー プロパティ | 設定可能な値/データ型 | 説明 |
---|---|---|---|
referenceStore | jtest.referenceStore | Path |
ファイルが指定されたディレクトリから削除されるまで、キャッシュ ファイルはテスト影響分析のベースラインとして使用されます。ファイルが削除されると、URL から再ダウンロードされます。 |
runFailedTests | jtest.runFailedTests | true | false | 変更の影響を受けていなくても、前回失敗したすべてのテストを現在のテスト実行に含めます。 デフォルト値: |
runModifiedTests | jtest.runModifiedTests | true | false | 変更されたテストおよび新規テストの両方をテスト実行に含めます。 デフォルト値: |
settings | jtest.settings | Path | カスタム設定を含む .properties ファイルへのパスを指定します。 |
settingsList | jtest.settingsList |
Jtest インストール ディレクトリにある jtest.properties ファイルの設定は自動的に含められます。 |