3.2.11. JUnit 5用拡張機能¶

// 1. BasicHttpRequestTest の baseUri を指定する
@BasicHttpRequestTest(baseUri = "/test/")
class YourTestClass {
    // 2. BasicHttpRequestTestTemplate のインジェクション方法は、他と変わらない
    BasicHttpRequestTestTemplate support;

    @Test
    void test() {
        support.execute();
    }
}

public class CustomTestSupport extends TestSupport {
    // テストクラスの Class インスタンスを TestSupport のコンストラクタに渡せるように実装する
    public CustomTestSupport(Class<?> testClass) {
        super(testClass);
    }

    // 独自の拡張メソッドを実装する
}

public class CustomTestSupportExtension extends TestSupportExtension {

    // createSupport() をオーバーライドし、独自拡張クラスのインスタンスを返すように実装する
    @Override
    protected TestEventDispatcher createSupport(Object testInstance, ExtensionContext context) {
        return new CustomTestSupport(testInstance.getClass());
    }
}

..
import org.junit.jupiter.api.extension.ExtendWith;

// 1. ExtendWith で独自拡張用のExtensionをテストクラスに適用する
@ExtendWith(CustomTestSupportExtension.class)
class YourTest {
    // 2. 独自拡張クラスをインスタンス変数で宣言する
    CustomTestSupport support;

    @Test
    void test() {
        // 3. テスト内で独自拡張クラスを使用する
        support.customMethod();
    }
}

public class CustomHttpRequestTestSupport extends BasicHttpRequestTestTemplate {
    private final String baseUri;

    // baseUri を外部から連携できるように実装しておく
    public CustomHttpRequestTestSupport(Class<?> testClass, String baseUri) {
        super(testClass);
        this.baseUri = baseUri;
    }

    @Override
    protected String getBaseUri() {
        return baseUri;
    }
}

import org.junit.jupiter.api.extension.ExtendWith;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
// この後作成する独自拡張用のExtensionを指定する
@ExtendWith(CustomHttpRequestTestExtension.class)
public @interface CustomHttpRequestTest {
    // baseUri を渡せるように宣言する
    String baseUri();
}

public class CustomHttpRequestTestExtension extends BasicHttpRequestTestExtension {

    @Override
    protected TestEventDispatcher createSupport(Object testInstance, ExtensionContext context) {
        // テストクラスからアノテーションの情報を取得する
        CustomHttpRequestTest annotation = findAnnotation(testInstance, CustomHttpRequestTest.class);
        // 独自拡張クラスのコンストラクタに baseUri の情報を連携する
        return new CustomHttpRequestTestSupport(testInstance.getClass(), annotation.baseUri());
    }
}

// 独自の合成アノテーションをテストクラスに設定する(baseUri も設定する)
@CustomHttpRequestTest(baseUri = "/custom/")
class YourTest {
    // 独自拡張クラスをフィールドで宣言する
    CustomHttpRequestTestSupport support;

    @Test
    void test() {
        // 独自拡張クラスをテストで使用する
        support.customMethod();
    }
}

@Override
public void beforeAll(ExtensionContext context) {
    // 必ず最初に親のメソッドを実行する
    super.beforeAll(context);

    // 独自の事前処理を実装する
    ...
}

import org.junit.Rule;
import org.junit.rules.Timeout;
import java.util.concurrent.TimeUnit;

public class CustomTestSupport extends TestSupport {
    // JUnit 4のTestRuleを使用している
    @Rule
    public Timeout timeout = new Timeout(1000, TimeUnit.MILLISECONDS);

    public CustomTestSupport(Class<?> testClass) {
        super(testClass);
    }
}

public class CustomTestSupportExtension extends TestSupportExtension {

    @Override
    protected TestEventDispatcher createSupport(Object testInstance, ExtensionContext context) {
        return new CustomTestSupport(testInstance.getClass());
    }

    // 1. resolveTestRules メソッドをオーバーライドする
    @Override
    protected List<TestRule> resolveTestRules() {
        // 2. 親クラスの resolveTestRules() の結果をベースにしてリストを生成する
        List<TestRule> rules = new ArrayList<>(super.resolveTestRules());
        // 3. 独自拡張クラスで定義しているTestRuleをリストに追加する
        rules.add(((CustomTestSupport) support).timeout);
        // 4. 生成したリストを返却する
        return rules;
    }
}