The Seasar Project

JUnit CDI Extensions Core

• 概要
• 依存性の注入
• コンテキスト
  • テストクラス・スコープ
• ライフサイクルメソッド
  • JUnit4のライフサイクルメソッド
  • CDIのライフサイクルメソッド
• イベント
• JNDI

Abstract

JUnit CDI Extensions Core は，JUnit4 で CDI を利用したテストを行うための基本機能を提供します．

テストクラスで CDI を利用するには， @RunWith アノテーションに org.seasar.junitcdi.core.runner.CDI クラスを指定します．

@RunWith(CDI.class)
public class XxxTest {
    ...
}

これにより，CDI コンテナが準備されます．

JUnit CDI Extensions では，テストクラス自体も CDI で管理されます． そのため，テストクラスの .class ファイルが作成されるディレクトリには META-INF/beans.xml ファイルが必要です．

Maven2 のディレクトリ構成であれば， src/test/resources/META-INF/beans.xml を作成します．

ファイルの内容は以下のようにルート要素だけで構いません． 詳細は CDI の仕様書を参照してください．

<bean></bean>

Injection

テストクラスも CDI で管理されるため，通常の bean と同じように @Inject アノテーションにより bean が注入されます．

@RunWith(CDI.class)
public class XxxTest {
    @Inject
    XxxBean xxx;
    ...
}

Contexts

JUnit CDI Extensions では，CDI 標準のコンテキスト (スコープ) を利用することができます．

• @ApplicationScoped
• @Session
• @Scoped
• @Singleton
• @Default (デフォルト)

いずれのコンテキストもテストメソッドを実行している間だけ有効で， テストメソッドの実行が終了するとコンテキストはクリアされます．

@TestClassScoped
public class XxxBean {
    ...
}

@RunWith(CDI.class)
public class XxxTest {
    @Inject
    XxxBean xxx;

    @Test
    public void hoge() {
        ...
    }

    @Test
    public void moge() {
        ...
    }
    ...
}

Lifecycle Methods

@RunWith(CDI.class)
public class XxxTest {
    @BeforeMethod
    public void beforeFoo() {
        ...
    }
    @Test
    public void foo() {
        ...
    }
    @AfterMethod
    public void afterFoo() {
        ...
    }
    ...
}

@RunWith(CDI.class)
public class XxxTest {
    @BeforeMethod({"hoge", "moge"})
    public void before() {
        ...
    }
    @Test
    public void hoge() {
        ...
    }
    @Test
    public void moge() {
        ...
    }
    ...
}

@RunWith(CDI.class)
public class XxxTest {
    @PostConstruct
    public void hoge() {
        ...
    }
    @PreDestroy
    public void moge() {
        ...
    }
    ...
}

Events

JUnitの org.junit.runner.notification.RunListener による通知を，CDI のイベントとして任意の bean で受信することが出来ます．

public class XxxBean {
    public void onTestStarted(@Observes @TestStarted Description description) {
        ...
    }
    ...
}

サポートされる通知と対応するアノテーションおよびパラメータの型は以下の通りです．

testRunStarted(Description) および testRunFinished(Result) はサポートされません．

JUnit CDI Extensions 独自のイベントもあります． イベントの型はいずれも org.seasar.junitcdi.core.event.TestInfo です．

以下の例では，テストメソッドが呼び出される直前に onTestMethodStarted() メソッドが呼び出されます．

public class XxxBean {
    public void onTestMethodStarted(@Observes @TestMethodStarted TestInfo testInfo) {
        ...
    }
    ...
}

テストメソッドに Qualifier が指定されると，それがイベントにも反映されます．

以下の例では， hoge() メソッドのように @Hoge で注釈されたテストが実行される前にだけ XxxBean クラスの onHogeStarted() メソッドが呼び出されます．

@Qualifier
@Target( { METHOD, PARAMETER })
@Retention(RUNTIME)
public @interface Hoge {
}

@RunWith(CDI.class)
public class XxxTest {
    @Test
    @Hoge
    public void hoge() {
        ...
    }
    ...
}

public class XxxBean {
    public void onHogeStarted(@Observes @TestStarted @Hoge Description description) {
        ...
    }
    ...
}

テストが正常に実行される際の， ライフサイクルメソッドおよび， RunListener イベントと JUnit CDI Extensions 独自のイベントが発生する順序関係は以下のようになります．

JNDI

JUnit CDI Extensions は，JNDI 経由で CDI コンテナから bean をルックアップする javax.naming.Context を提供します．

これにより，JNDI でルックアップされるコンポーネントや @Resource アノテーションで DI されるコンポーネントを bean として用意しておくこくことができます．

この JNDI Context を利用するには，クラスパスに jndi.properties ファイルを作成して以下の内容を記述します．

java.naming.factory.initial=org.seasar.junitcdi.core.internal.JndiContextFactory

これで InitialContext を利用して CDI コンテナから bean をルックアップすることができます．

DataSource ds = InitialContext.doLookup("java:comp/env/jdbc/DataSource");

あるいは，上記の内容をもった Hashtable を作成して InitialContext を作成します．

Hashtable<Object, Object> env = new Hashtable<Object, Object>();
env.put(Context.INITIAL_CONTEXT_FACTORY, "org.seasar.junitcdi.core.internal.JndiContextFactory");
Context ctx = new InitialContext(env);
DataSource ds = (DataSource) ctx.lookup("java:comp/env/jdbc/DataSource");