このセクションでは、単体テストアシスタントを設定する方法を説明します。

このセクションの内容

全般的なオプションの設定

UTA の全般的なオプションを設定するには、[Parasoft] メニューの [設定] > [単体テストアシスタント] をクリックします。

テストソースフォルダー

UTA で作成したテストを保存する場所のルートディレクトリを指定します。デフォルトでは、[プロジェクト設定に基づく] オプションがオンであり、プロジェクトの設定を読み取ってテストを保存する場所を決定します。プロジェクトにテストの場所が指定されていない場合、プロジェクトの設定を更新してテストソースフォルダーを指定するか、いずれかの事前定義済みパターンに切り替えるか、以下の変数を使用して手動でパターンを作成します。

${project_name} - テスト対象クラスを含むプロジェクト (Intelli の場合はモジュール) の名前
${source_folder} - プロジェクトのソースファイルを含むフォルダーの名前

テストクラス名のパターン

このオプションを使用すると、テストのパッケージおよびクラス名のパターンを指定できます。デフォルトのパターンは "${package_name}.${class_name}${test_kind}Test" であり、テストをテスト対象クラスと同じパッケージに含め、クラス名に "${test_kind}Test" という接尾辞を付加します。以下の変数を使用してカスタムパターンを指定することもできます。

${class_name} - テスト対象クラスの名前
${package_name} - テスト対象クラスを含むパッケージの名前
${test_kind} - テストタイプの名前。これはファイル名に追加されます。この変数は次の値を取ることができます:
- Spring - Spring テストを JUnit 4 および 5 の他のテストと区別します。
- Parameterized - パラメータライズドテストを JUnit 4 の通常のテストと区別します。JUnit 5 では、通常のテストケースとパラメータライズされたテストケースが同じファイルに追加されます。

Spring テストまたはパラメータライズドテスト以外のテストでは、${test_kind} 変数は空文字に解決されます。

新規テストのテストフレームワーク

UTA が新規テストの作成に使用するテストフレームワークを指定します。JUnit 4 または JUnit 5 を選択できます。

テスト作成オプション

private メソッドのテストを作成

private メソッドの単体テストを作成します。このオプションがオンの場合:

エディターで private メソッドを選択したとき、単体テストアシスタントビューに private メソッドの単体テストを作成するためのアクションリンクが表示されます (「private メソッドに対するテストの作成」を参照)。
[テストスイートの作成] オプションを使用して単一のクラスのテストを作成している場合、ダイアログで private メソッドを選択できます (「1 つのファイルに対してテストスイートを作成」を参照)。
[テストスイートの作成] オプションを使用して複数のクラスのテストを作成している場合、自動的に private メソッドのテストが作成されます (「複数のファイルに対してテストスイートを作成」を参照)。

テストにタイムアウトを設定 (ミリ秒)

[テストスイートの作成] オプションで作成されたテストスイートの実行の制限時間をミリ秒単位で指定します。制限時間を超過した場合、テスト実行が中止され、テストスイートは失敗します。また、エラー情報が UTA インターフェイスの推奨事項として表示されます。「テストスイートの作成」を参照してください。

サンプルアサーションの生成

このオプションがオンの場合、UTA は基本的なテストケースを作成する際、コードのコメントとして自動的にアサーションテンプレートを生成します。詳細は「基本的な単体テストの作成」を参照してください。

[テストスイートの作成] オプションを使用して作成されたテストスイートには、このオプションは適用されません。

カバレッジを増加させるテストケースだけを追加する

このオプションがオンの場合、カバレッジを増加させるテストケースだけが一括作成時に追加されます (「複数のファイルに対してテストスイートを作成」を参照)。

ファクトリメソッドオプション

タグ付けされたファクトリメソッドを自動的に発見

このオプションが有効な場合、UTA は以下を実行します。

IDE 起動時にすべてのプロジェクトをスキャンしてファクトリメソッドを探します。
プロジェクトが変更されたとき (たとえば Java ファイルまたはプロジェクトを作成または削除したとき)、ファクトリメソッドの更新を検索します。

詳細については「ファクトリメソッドの設定」を参照してください。

パラメータライズドテスト

作成アクションの有効化

このオプションがオンの場合、UTA はパラメータライズドテストケースを作成するためのアクションリンクを表示します。「パラメータライズされた単体テストの作成」を参照してください。

パラメータライズドテストは、[新規テストのテストフレームワーク] オプションで設定したテストフレームワークに依存します。

JUnit 5 の場合、[Unit 5 Parameterized] が自動的にオンになります。
JUnit 4 の場合、パラメータライズドテストケースの作成に使用するフレームワークを選択してください。

[テストスイートの作成] オプションを使用して作成されたテストスイートには、このオプションは適用されません。

詳細設定

パラメータライズドテストケース作成のための入力データを設定します。

1 つのテストケースに対して作成されるパラメーターセットの最大数

1 つのテストケースに対して作成されるパラメーターバリアントの最大行数を指定します。

テストデータの生成先

テストケースが保存される場所を指定します。ドロップダウンメニューから [コード] または [CSV] を選択します。

CSV について

CSV 形式は、JUnitParams および JUnit 5 のパラメータライズテストタイプでサポートされています。
CSV は UTF-8 文字エンコーディングをサポートしています。
CSV ファイルは Java ファイルと同じフォルダーに保存されます。ビルドシステムで指定されたリソースフォルダーと場所が一致していない場合、CSV ファイルを適切な場所にコピーします。

パラメータライズ値

[タイプの選択] ドロップダウンメニューからデータタイプを選択し、リストの値を追加、編集、削除することで、デフォルトの値のリストをカスタマイズできます。[検索] フィールドを使用すると、特定の値をすばやく検索できます。

文字エンコーディング

新しい値を追加する場合、ファイルが正しく生成されるよう、値の文字エンコーディングは、ファイルの保存時に使用される文字エンコーディングと一致していなければなりません。

Spring フレームワークテスト

作成アクションの有効化

このオプションがオンの場合、UTA は Spring テストケースを作成するためのアクションリンクを表示します。「Spring 単体テストの作成」を参照してください。

[テストスイートの作成] オプションを使用して作成されたテストスイートには、このオプションは適用されません。

デフォルトの ContextConfiguration 属性

Spring テスト作成時に ContextConfiguration アノテーションに含める属性を指定します。「ContextConfiguration アノテーションによる Spring テストの設定」を参照してください。

実行モニターオプションの設定

UTA 実行モニターオプションを設定すると、テスト実行時のデータ収集の制限値を指定できます。さらに、制限を超過するのを防ぐため、UTA によるテスト実行時にモニターから除外するパッケージやクラスを指定できます。

UTA のモックオプションを設定するには、[Parasoft] メニューの [設定] > [単体テストアシスタント] > [実行モニター] をクリックします。

除外するパッケージおよびクラス

モニターから除外するパッケージおよびクラスのリストを指定します。[新規] をクリックし、パッケージまたはクラスの修飾名を指定します (ワイルドカードはサポートされていません)。

実行フローデータ収集の制限

これらのオプションを設定すると、実行時のデータ収集の制限値を指定できます。

メソッド呼び出しの最大の深さ - 解析中のメソッド呼び出しの最大の深さを指定します。
単一のメソッドからのメソッド呼び出し最大回数 - 単一のメソッドからのサブメソッド呼び出しの最大回数を指定します。
メソッド呼び出し合計回数 - 解析中のメソッド呼び出し合計回数の最大値を指定します。

モックオプションの設定

UTA のモックオプションを設定するには、[Parasoft] メニューの [設定] > [単体テストアシスタント] > [モック] をクリックします。

有効化

テストの作成および実行時にオブジェクトのモックを有効または無効にします。

モックにヘルパーメソッドを使用

ヘルパーメソッドの使用を有効または無効にします。このオプションが有効な場合、生成されるテストクラスは、通常のテストメソッドとオブジェクトを準備するがアサーションを作成しないヘルパーメソッドを分離します。

静的メソッドおよびコンストラクターのモックを有効化 (Mockito inline 3.5 以降が必要)

情報

バージョン 2022.1 以降、static メソッドおよびコンストラクターのモックは Mockito で作成されます。この機能を利用するには、プロジェクトを更新して static メソッドおよびコンストラクターをサポートするバージョンの Mockito をインクルードする必要があります。手動で作成したモックについて Powermock with Mockito を引き続き利用したい場合、Mockito バージョン 3.12.4 を使用することを推奨します。Jtest 2022.1 より前のバージョンまたは手動で作成され、PowerMock を使用するテストは、テストが失敗しないよう更新する必要があります。詳細は「PowerMock with mockito-inline の実行でテストが失敗する場合」を参照してください。

UTA はテーブルで指定されたパターンに一致するメソッドを自動的にモック化します。新しいメソッドまたはパターンを追加するには、[新規] をクリックします。パターンの比較には修飾されたメソッド名およびワイルドカード (*) を使用します。.* または <init> で終わるパターンはコンストラクターに一致します。たとえば、次の設定は以下をモックします。

名前の末尾が "Service" であるすべてのクラスのすべてのコンストラクター
"com.example" に含まれるすべてのサブパッケージ内のすべての DAO クラスのすべての静的メソッドおよびコンストラクター
InternalUtil クラスのすべてのメソッド

指定されたパターンがクラスのすべてのメソッドに一致する場合、UTA は mockStatic() メソッドを使用してクラスの静的メソッドをモックします。mockStatic() メソッドの詳細については、「mockStatic」を参照してください。
テーブルで指定された static メソッドおよびコンストラクターだけがモックされます。UTA はテスト作成時に自動的にモックをテストテンプレートに追加するか、テスト実行後にモックを追加するのに役立つ推奨事項を表示します (「モックの作成」を参照)。

推奨事項の設定

テスト実行後に UTA が表示する推奨事項のタイプを指定します。

UTA の推奨事項を設定するには、[Parasoft] メニューの [設定] > [推奨事項] をクリックします。

以下のタイプの推奨事項を有効または無効にできます。

他のスレッド - テストの状態に影響を与える可能性があるサイドスレッドを検出します。
アクセスできないフィールドのアサーション - 実行中に変更されたアクセスできないフィールドを検出し、アサーションテンプレートを生成します。
ファイルが作成されました - テスト実行中に作成されたが、実行後に削除されていないファイルを検出します。
モック可能な呼び出し - テストを適切に分離するために変更可能なモックオブジェクトへの呼び出しを検出します。
モック可能な静的呼び出し - モックするよう設定されている静的メソッドの呼び出しを検出します (「モックオプションの設定」を参照)。
アサーションなし - アサーションが行われていないケースを検出します。
静的なフィールドの変更 - テスト実行中に静的フィールドが変更されたケースを検出します。
システムプロパティの変更 - テスト実行中に変更されたが、実行後に復元されていないシステムプロパティを検出します。
カバーされていないコード - カバーされていないコードブロックを検出します。

UTA に表示される推奨事項のサンプルは、「単体テストアシスタントを使用した単体テストの実行」を参照してください。

テストテンプレートの設定

テストテンプレートを使用すると、テストクラスの構造を制御し、ユーザー固有のテストに必要な共通設定を指定できます。たとえば、セットアップメソッドを追加したり、基底クラスから拡張したりできます。

テストテンプレートが原因でコンパイルエラーが発生した場合、結果としてテストが生成されない可能性があります。生成されたファイルにエラーがあることを示すメッセージがコンソールに表示されます。

UTA テストテンプレートを設定するには、[Parasoft] メニューの [設定] > [テストテンプレート] をクリックします。

新規 - 新規テンプレートを作成し、編集用にテンプレートを開きます。自動で Parasoft のデフォルトテンプレートが用意されます。
編集 - 編集用にテンプレートを開きます。
削除 - テンプレートを削除します。アクティブなテンプレートまたは最後の 1 つのテンプレートを削除しようとした場合、エラーが表示されます。
アクティブとしてマーク - クイック追加アクション (一括作成ではない) で使用されるテンプレートを指定します。

テンプレートの編集

[テンプレートの編集] ダイアログでは、テンプレートの作成/編集を行うことができます。

[テンプレートの編集] ダイアログでは、以下を設定する必要があります。

テンプレート名: - テンプレートの固有の名前です。
クラステンプレート - テンプレートのクラスセクションのソースコードです。テンプレートのエラーをチェックするため、入力時に基本的な検証が行われます。
- 変数の形式が誤っているか、変数が認識されていない場合、エラーメッセージ (「不明または無効な変数」) が表示されます。
- テンプレートが基本的な構文チェックに適合しない場合、エラーが表示されます。

以下の変数が認識されます。

- ${className} - テスト対象クラスの修飾されていない名前です。例: MyClass
- ${qualifiedClassName} - テスト対象クラスの完全修飾名です。例: com.company.MyClass
- ${author} - DTP 設定で指定されたユーザー名です。
- ${testClassName} - 作成されるテストの修飾されていない名前です。例: MyClassTest
  名前はテストクラス名のパターンから生成され、テンプレートで編集するべきではありません。テストクラス名を更新する標準的な方法は、テストソースフォルダーを更新することです。

次のサンプルは、共通クラス設定の実装を示しています。

共通基底クラス拡張:

import com.company.BaseTestClass;

public class ${testClassName} extends BaseTestClass
{
}

静的モックのためのセットアップ/ティアダウンメソッドを追加:

import org.junit.jupiter.api.*;
import static org.mockito.Mockito.*;
import java.util.*;

public class ${testClassName}
{
    Set<ScopedMock> staticMocks = new HashSet<>();

    @BeforeEach
    public void setup()
    {
        var mocked = mockStatic(MyUtilClass.class);
        staticMocks.add(mocked);
        mockUtil.when(MyUtilClass::getUserName).thenReturn("testUser");
    }

    @AfterEach
    public void teardown()
    {
        staticMocks.forEach(i -> i.close());
        staticMocks.clear();
    }
}

メソッドテンプレート - 新規テストメソッドのソースコードです。テンプレートのエラーをチェックするため、入力時に基本的な検証が行われます。
- 変数の形式が誤っているか、変数が認識されていない場合、または必須の変数が欠けている場合、エラーメッセージ (「不明または無効な変数」または「メソッドに不足している必須変数」) が表示されます。
- テンプレートが基本的な構文チェックに適合しない場合、エラーが表示されます。

以下の変数が認識されます。

- ${methodSignature} - パラメーターの型を含むテスト対象メソッド名です。例: calc(int, int, String)
- ${qualifiedMethodSignature} - パラメーターの型を含むテスト対象メソッドの完全修飾名です。例: com.company.MyClass#calc(int, int, String)
  この変数は、Javadoc の@see タグで使用すると便利です。
- ${author} - DTP 設定で指定されたユーザー名です。
- ${testAnnotations} (必須) - テストメソッドに追加される自動生成アノテーションのプレースホルダーです。たとえば、JUnit テストには @Test アノテーションが必要です。この変数の前または後ろにカスタムアノテーションを追加できます。
- ${testName} (必須) - テストメソッドの自動生成される名前です。
- ${testBody} (必須) - テストの本文を構成する自動生成ステートメントのプレースホルダーです。生成されるすべてのテストに含めるカスタムコードをこの変数の前または後ろに追加できます。
追加のコードは、テストメソッドの外にも追加できますが、重複につながるため、推奨されません。たとえば、メソッドテンプレートにフィールド "int foo = 0;" を追加すると、テストごとにこのフィールドが追加され、名前が重複します。そのため、追加される要素の名前に ${testName} 変数を含めるか、クラステンプレートにコードを追加することが推奨されます。

次のサンプルは、フィールドを定義して設定するクラスおよびメソッドテンプレートを示しています。

クラステンプレート

public class ${testClassName}
{
    private CustomField customField = null;
}

メソッドテンプレート

${testAnnotations}
public void ${testName}() throws Exception
{
    customField = new CustomField(42, "Testing example");
    customField.init();

    ${testBody}
}

Page tree

Configuring Preferences

全般的なオプションの設定

テスト ソース フォルダー

テスト クラス名のパターン

新規テストのテスト フレームワーク

テスト作成オプション

private メソッドのテストを作成

テストにタイムアウトを設定 (ミリ秒)

サンプル アサーションの生成

カバレッジを増加させるテスト ケースだけを追加する

ファクトリ メソッド オプション

タグ付けされたファクトリ メソッドを自動的に発見

パラメータライズド テスト

作成アクションの有効化

詳細設定

1 つのテスト ケースに対して作成されるパラメーター セットの最大数

テスト データの生成先

パラメータライズ値

Spring フレームワーク テスト

作成アクションの有効化

デフォルトの ContextConfiguration 属性

実行モニター オプションの設定

除外するパッケージおよびクラス

実行フロー データ収集の制限

モック オプションの設定

有効化

モックにヘルパー メソッドを使用

静的メソッドおよびコンストラクターのモックを有効化 (Mockito inline 3.5 以降が必要)

推奨事項の設定

テスト テンプレートの設定

テストソースフォルダー

テストクラス名のパターン

新規テストのテストフレームワーク

サンプルアサーションの生成

カバレッジを増加させるテストケースだけを追加する

ファクトリメソッドオプション

タグ付けされたファクトリメソッドを自動的に発見

パラメータライズドテスト

1 つのテストケースに対して作成されるパラメーターセットの最大数

テストデータの生成先

Spring フレームワークテスト

実行モニターオプションの設定

実行フローデータ収集の制限

モックオプションの設定

モックにヘルパーメソッドを使用

テストテンプレートの設定