nablarch.test.junit5.extension.event

Class TestEventDispatcherExtension

java.lang.Object

nablarch.test.junit5.extension.event.TestEventDispatcherExtension

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.TestInstancePostProcessor

Direct Known Subclasses:

BasicHttpRequestTestExtension, BatchRequestTestExtension, DbAccessTestExtension, EntityTestExtension, HttpRequestTestExtension, IntegrationTestExtension, MessagingRequestTestExtension, SimpleRestTestExtension, TestSupportExtension

@Published(tag="architect")
public abstract class TestEventDispatcherExtension
extends java.lang.Object
implements org.junit.jupiter.api.extension.TestInstancePostProcessor, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.AfterEachCallback

NTF の JUnit 5 用 Extension の基底となる抽象クラス。

このクラスは、 TestEventDispatcher が提供する JUnit 4 用の拡張機能を、 JUnit 5 の Extension の仕組みで再現する。

各 Extension はこのクラスを継承して作成することで、共通する部分の処理を省略できる。

Field Summary

Fields

Modifier and Type	Field and Description
protected TestEventDispatcher	support Extension が生成しテストクラスにインジェクションする、サポートクラスのインスタンス。

Constructor Summary

Constructors

Constructor and Description
TestEventDispatcherExtension()

Method Summary

Modifier and Type	Method and Description
void	afterAll(org.junit.jupiter.api.extension.ExtensionContext context)
void	afterEach(org.junit.jupiter.api.extension.ExtensionContext context) テストメソッドの後処理を実行する。
void	beforeAll(org.junit.jupiter.api.extension.ExtensionContext context)
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext context) テストメソッドの前処理を実行する。
protected abstract TestEventDispatcher	createSupport(java.lang.Object testInstance, org.junit.jupiter.api.extension.ExtensionContext context) テストインスタンスにインジェクションするサポートクラスのインスタンスを生成する。
protected <A extends java.lang.annotation.Annotation> A	findAnnotation(java.lang.Object testInstance, java.lang.Class<A> annotationClass) 指定されたテストインスタンスのクラスに設定されたアノテーションを取得する。
void	postProcessTestInstance(java.lang.Object testInstance, org.junit.jupiter.api.extension.ExtensionContext context)
protected java.util.List<org.junit.rules.TestRule>	resolveTestRules() テストに対して適用する JUnit 4 の TestRule のリストを取得する。

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

support

protected TestEventDispatcher support

Extension が生成しテストクラスにインジェクションする、サポートクラスのインスタンス。

このフィールドは、 postProcessTestInstance(Object, ExtensionContext) が実行されたときに初期化される。 設定される値は、 createSupport(Object, ExtensionContext) が返却したインスタンスが使用される。

Constructor Detail

TestEventDispatcherExtension

public TestEventDispatcherExtension()

Method Detail

postProcessTestInstance

public void postProcessTestInstance(java.lang.Object testInstance,
                                    org.junit.jupiter.api.extension.ExtensionContext context)
                             throws java.lang.Exception

Specified by:

postProcessTestInstance in interface org.junit.jupiter.api.extension.TestInstancePostProcessor

Throws:

java.lang.Exception

createSupport

protected abstract TestEventDispatcher createSupport(java.lang.Object testInstance,
                                                     org.junit.jupiter.api.extension.ExtensionContext context)

テストインスタンスにインジェクションするサポートクラスのインスタンスを生成する。

Parameters:

testInstance - テストインスタンス

context - コンテキスト

Returns:

サポートクラスのインスタンス

beforeAll

public void beforeAll(org.junit.jupiter.api.extension.ExtensionContext context)

Specified by:

beforeAll in interface org.junit.jupiter.api.extension.BeforeAllCallback

beforeEach

public void beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
                throws java.lang.Exception

テストメソッドの前処理を実行する。

Specified by:

beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

Parameters:

context - コンテキスト

Throws:

java.lang.Exception - 例外がスローされた場合

resolveTestRules

protected java.util.List<org.junit.rules.TestRule> resolveTestRules()

テストに対して適用する JUnit 4 の TestRule のリストを取得する。

JUnit 4 時代に作成した独自のサポートクラスを移植する場合は、 このメソッドをオーバーライドしてサポートクラスで宣言したルールインスタンスを リストにして返却するように実装する。
オーバーライドした場合は、親クラスが返したリストに追加する形でルールを追加すること。 以下に実装例を示す。

 public List<TestRule> resolveTestRules() {
     // 親の resolveTestRules() が返したリストをベースにする
     List<TestRule> testRules = new ArrayList<>(super.resolveTestRules());
     // 独自の TestRule を追加する
     testRules.add(((YourSupport)support).yourTestRule);
     return testRules;
 }
 

Returns:

テストに適用したい JUnit 4 の TestRule のリスト

afterEach

public void afterEach(org.junit.jupiter.api.extension.ExtensionContext context)
               throws java.lang.Exception

テストメソッドの後処理を実行する。

Specified by:

afterEach in interface org.junit.jupiter.api.extension.AfterEachCallback

Parameters:

context - コンテキスト

Throws:

java.lang.Exception - 例外がスローされた場合

afterAll

public void afterAll(org.junit.jupiter.api.extension.ExtensionContext context)

Specified by:

afterAll in interface org.junit.jupiter.api.extension.AfterAllCallback

findAnnotation

protected <A extends java.lang.annotation.Annotation> A findAnnotation(java.lang.Object testInstance,
                                                                       java.lang.Class<A> annotationClass)

指定されたテストインスタンスのクラスに設定されたアノテーションを取得する。

Type Parameters:

A - アノテーションの型

Parameters:

testInstance - テストインスタンス(null不可)

annotationClass - 取得するアノテーションの型

Returns:

テストクラスに設定されたアノテーション