このセクションは、Gradle 用 Jtest タスクおよびパラメーターの情報を提供します。以下のタスクがあります。

jtest

Jtest を実行する Gradle タスクです。

属性

projectNameTemplate

名前設定可能な値/データ型説明必須
compilationCompilation

手動コンパイル データの記述です。詳細については「コンパイル データの手動カスタマイズ」を参照してください。

いいえ
compilationsList手動コンパイル データの記述のリストです。詳細については「コンパイル データの手動カスタマイズ」を参照してください。いいえ
dataUpdateString

ビルドから収集されたコンパイル データを手動で更新できます。

ユーザー プロパティ: jtest.dataUpdate

いいえ
configString

ビルトイン/DTP/ユーザー定義テスト コンフィギュレーション名です。

ユーザー プロパティ: jtest.config

いいえ
excludeString

選択されたリソースのうち、解析対象から除外するファイルまたはパッケージのサブセットを指定します。修飾名または複数のファイル名に一致する Ant glob パターンを指定できます。

ユーザー プロパティ: jtest.exclude

いいえ
excludesList

exclude パラメーターの List です。

ユーザー プロパティ: jtest.excludes

いいえ
excludeTestSourcestrue | false

テスト ソースを解析対象から除外します。

ユーザー プロパティ: jtest.excludeTestSources

いいえ
failtrue | false

違反がレポートされた場合、ビルドを失敗させます。

ユーザー プロパティ: jtest.fail

いいえ
homePath

Jtest のインストール ディレクトリです。定義されていない場合、PATH 上で指定された Jtest の場所を使用します。

ユーザー プロパティ: jtest.home

推奨
ignoredIdsList

無視するコンパイル ID の List です。

ユーザー プロパティ: jtest.ignoredids

いいえ
includeString

選択された リソースの中から、解析対象に含めるファイルまたはパッケージのサブセットを指定します。

ユーザー プロパティ: jtest.include

いいえ
includesList

include パラメーターのリストです。

ユーザー プロパティ: jtest.includes

いいえ
publishtrue | falseローカル解析の結果を DTP サーバーにパブリッシュするかどうかを指定します。

ユーザー プロパティ: jtest.publish

いいえ
reportPath

レポートが作成されるディレクトリを指定します。

ユーザー プロパティ: jtest.report

いいえ
resourceString

解析の入力スコープを指定します。リソースが指定されていない場合、ビルドされたすべてのプロジェクトのリソースが解析されます。

ユーザー プロパティ: jtest.resource

いいえ
resourcesList

resource パラメーターのリストです。

ユーザー プロパティ: jtest.resources

いいえ
settingsPath

カスタム設定が保存された *.properties ファイルへの絶対パスまたは相対パスです。

ユーザー プロパティ: jtest.settings

いいえ
settingsListList

settings パラメーターのリストです。

ユーザー プロパティ: jtest.settingsList

いいえ
showDetailstrue | false

より詳細な進捗情報を表示します。

ユーザー プロパティ: jtest.showdetails

いいえ
showSettingstrue | false

現在の設定およびカスタマイズの状況を出力します。各構成エントリがどこで指定されているか (.properties ファイルなど) を表示します。

ユーザー プロパティ: jtest.showsettings

いいえ
projectNameTemplateString

プロジェクト名のテンプレートです。[groupId]、[artifactId]、[version] および [basedir] オプションを使用してパターンを構成できます。

ユーザー プロパティ: jtest.projectNameTemplate

いいえ
skiptrue | false

Jtest の実行のスキップを有効または無効にします。true を設定した場合、jtest.data.json データ ファイルだけが生成されます。

ユーザー プロパティ: jtest.skip

いいえ

パラメーターの詳細

config

テスト コンフィギュレーション名です。次のタイプがサポートされています。

  • ビルトイン テスト コンフィギュレーション 例: "builtin://Recommended Rules"
  • DTP テスト コンフィギュレーション 例: "dtp://New Config"
  • ユーザー定義テスト コンフィギュレーション 例: "user://Your Config"

ユーザー定義コンフィギュレーションは [INSTALL_DIR]/configs/user ディレクトリに *.properties ファイルとして格納する必要があります。


dataUpdate

ビルドから収集されたコンパイル データを手動で更新できます。

  • サポートされるアクション: prepend, append, and set.
  • サポートされるデータ型: classpath、bootpath、sourcepath、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 中のプロジェクト名が作成されます:"groupId:artifactId "このパラメーターを指定すると、[groupId]、[artifactId]、[version] および [basedir] オプションを使用してパターンを設定できます。たとえば、プロジェクト名を Eclipse のプロジェクト名と合わせることができます。

すでに DTP と統合されているプロジェクトのパターンを変更すると、DTP はプロジェクトを認識できなくなります。DTP は、パターンを変更した後のプロジェクトを別のプロジェクトとして認識します。詳細については、DTP のマニュアルを参照してください。

パラメーター型の詳細

すべてのサンプルは、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 タスクです。

パラメーター

名前設定可能な値/データ型説明必須
homePath

Jtest のインストール ディレクトリです。

ユーザー プロパティ: jtest.home

はい
skiptrue | false

Jtest タスクをスキップするかどうかを指定します。

デフォルト値: false

ユーザー プロパティ: jtest.skip

いいえ
runtimeDataLocationPath

カバレッジ実行データが保存されるファイルのパスです。

ユーザー プロパティ: jtest.runtimeDataLocation

いいえ
metadataLocationPath

カバレッジ メタデータが保存されるファイルのパスです。

ユーザー プロパティ: jtest.metadataLocation

いいえ
coverage

カバレッジの収集の設定を行うパラメーターのセットです。

  • jtest.coverage.skip - カバレッジを無効化します。
  • jtest.coverage.includes - インストゥルメントに含めるクラスの <Glob> パターンを指定します。カバレッジ情報が収集されます。
  • jtest.coverage.excludes - インストゥルメントから除外するクラスの <Glob> パターンを指定します。カバレッジ情報は収集されません。
  • jtest.coverage.testIncludes - インストゥルメントに含めるテスト クラスの <Glob> パターンです。テスト ケースにはカバレッジ情報が割り当てられます。
  • jtest.coverage.testExcludes - インストゥルメントから除外するテスト クラスの <Glob> パターンです。テスト ケースにはカバレッジ情報が割り当てられません。
いいえ

パラメーターの詳細

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 引数を生成するスクリプト

コマンド ライン実行

コマンド ラインから実行する場合は、このタスクを実行する前に、必ずクラスをコンパイルしてください (compile フェーズ)。

テスト クラスの除外

jtest-monitor タスクが実行された場合、Gradle はテスト クラスを認識しません。テスト クラスのカバレッジ情報が収集されないよう、jtest.exclude を使用してテストを含むパッケージへのパス (-Djtest.exclude=path:**/test/** など) を指定することを強く推奨します。

パラメーター

名前設定可能な値/データ型説明必須
agentServerEnabledtrue | false

Agent サーバーの有効化スイッチです。

ユーザー プロパティ: jtest.agentServerEnabled

いいえ
autostartAgenttrue | false

自動的にカバレッジの収集を有効化するスイッチです。

ユーザー プロパティ: jtest.autostartAgent

いいえ
compilationCompilation手動コンパイル データの記述です。詳細については「コンパイル データの手動カスタマイズ」を参照してください。いいえ
coverage

カバレッジの収集の設定を行うパラメーターのセットです。

  • jtest.coverage.skip - カバレッジを無効化します。
  • jtest.coverage.includes - インストゥルメントに含めるクラスの <Glob> パターンを指定します。カバレッジ情報が収集されます。
  • jtest.coverage.excludes - インストゥルメントから除外するクラスの <Glob> パターンを指定します。カバレッジ情報は収集されません。
  • jtest.coverage.testIncludes - インストゥルメントに含めるテスト クラスの <Glob> パターンです。テスト ケースにはカバレッジ情報が割り当てられます。
  • jtest.coverage.testExcludes - インストゥルメントから除外するテスト クラスの <Glob> パターンです。テスト ケースにはカバレッジ情報が割り当てられません。

excludeString

選択されたリソースのうち、解析対象から除外するファイルまたはパッケージのサブセットを指定します。修飾名または複数のファイル名に一致する Ant glob パターンを指定できます。

ユーザー プロパティ: jtest.exclude

いいえ
excludesList

exclude パラメーターのリストです。

ユーザー プロパティ: jtest.excludes

いいえ
homePath

Jtest のインストール ディレクトリです。

ユーザー プロパティ: jtest.home

推奨
ignoredIdsList

無視するコンパイル ID の List です。

ユーザー プロパティ: jtest.ignoredids

いいえ
includeString

選択された リソースの中から、解析対象に含めるファイルまたはパッケージのサブセットを指定します。

ユーザー プロパティ: jtest.include

いいえ
includesList

include パラメーターのリストです。

ユーザー プロパティ: jtest.includes

いいえ

monitorLocation

Path

モニター パッケージが作成される場所へのパスです。

ユーザー プロパティ: jtest.monitorLocation

いいえ
publishtrue | falseローカル解析の結果を DTP サーバーにパブリッシュするかどうかを指定します。

ユーザー プロパティ: jtest.publish

いいえ
reportPath

レポートが作成されるディレクトリを指定します。

ユーザー プロパティ: jtest.report

いいえ
resourceString

解析の入力スコープを指定します。リソースが指定されていない場合、ビルドされたすべてのプロジェクトのリソースが解析されます。

ユーザー プロパティ: jtest.resource

いいえ
resourcesList

resource パラメーターのリストです。

ユーザー プロパティ: jtest.resources

いいえ
settingsPath

カスタム設定が保存された *.properties ファイルへの絶対パスまたは相対パスです。

ユーザー プロパティ: jtest.settings

いいえ
settingsListList

settings パラメーターのリストです。

ユーザー プロパティ: jtest.settingsList

いいえ
showDetailstrue | false

より詳細な進捗情報を表示します。

ユーザー プロパティ: jtest.showdetails

いいえ
showSettingstrue | false

現在の設定およびカスタマイズの状況を出力します。各構成エントリがどこで指定されているか (.properties ファイルなど) を表示します。

ユーザー プロパティ: jtest.showsettings

いいえ
projectNameTemplateString

プロジェクト名のテンプレートです。[groupId]、[artifactId]、[version] および [basedir] オプションを使用してパターンを構成できます。

ユーザー プロパティ: jtest.projectNameTemplate

いいえ
skiptrue | false

Jtest の実行のスキップを有効または無効にします。true を設定した場合、jtest.data.json データ ファイルだけが生成されます。

ユーザー プロパティ: jtest.skip

いいえ

パラメーターの詳細

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 中のプロジェクト名が作成されます:"groupId:artifactId "このパラメーターを指定すると、[groupId]、[artifactId]、[version] および [basedir] オプションを使用してパターンを設定できます。たとえば、プロジェクト名を Eclipse のプロジェクト名と合わせることができます。

すでに DTP と統合されているプロジェクトのパターンを変更すると、DTP はプロジェクトを認識できなくなります。DTP は、パターンを変更した後のプロジェクトを別のプロジェクトとして認識します。詳細については、DTP のマニュアルを参照してください。

パラメーター型の詳細

すべてのサンプルは、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 に付属のテスト影響分析プラグインによって設定され、プロジェクトのテスト影響分析の実行を可能にします (「テスト影響分析」を参照)。

必須パラメーター

名前ユーザー プロパティ設定可能な値/データ型説明
coverageFileparasoft.coverage.filePath

解析時に Jtest によって生成された coverage.xml ファイルへのパスです。ファイルには実行中に収集されたカバレッジ データが保存されています。

デフォルト値: target/jtest/coverage.xml

testFileparasoft.test.filePath

解析時に Jtest によって生成された report.xml ファイルへのパスです。ファイルには実行された単体テストに関する情報が保存されています。

デフォルト値: target/jtest/report.xml

jtestHomejtest.homePath

Jtest のインストール ディレクトリへのパスです。Gradle の設定または JTEST_HOME 環境変数によってすでに Jtest のインストール ディレクトリが設定されている場合は、このパラメーターは不要です。

任意パラメーター

名前ユーザー プロパティ設定可能な値/データ型説明
runFailingTestsparasoft.runFailingTeststrue | false

変更の影響を受けていなくても、前回失敗したすべてのテストを現在のテスト実行に含めます。

デフォルト値: false

runModifiedTestsparasoft.runModifiedTeststrue | false

変更されたテストおよび新規テストの両方をテスト実行に含めます。

デフォルト値: true

settingsFilesjtest.settingsPath

カスタム設定を含む .properties ファイルへのパスを指定します。

カンマ区切りのリストを使用して複数のファイルを指定できます。ファイルは実行前にマージされます。

Jtest インストール ディレクトリにある jtest.properties ファイルの設定は自動的に含められます。

  • No labels