 |
||||||
 |
 |
 |
||||
 |
 |
 |
 |
 |
 |
 |
|
||||||
|
S2JUnit4目次S2JUnit4とはS2JUnit4はJUnit4を拡張したテスティングフレームワークです。 S2JUnit4はアノテーションと命名規則をバランス良く組み合わせ少ないコードで効率のよいテストを可能にします。 S2JUnit4の主な機能には次のものがあります。
前提条件
サンプルS2Unitのサンプルと同様、従業員を従業員番号で検索するDAOをサンプルとします。設定ファイルとテストクラスはそれぞれ以下のようになります。 EmployeeDaoImplTest.dicon<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE components PUBLIC "-//SEASAR//DTD S2Container 2.4//EN"
"http://www.seasar.org/dtd/components24.dtd">
<components>
<include path="javaee5.dicon"/>
<component class="examples.s2junit4.EmployeeDaoImpl">
<property name="getEmployeeHandler">
<component class="org.seasar.extension.jdbc.impl.BasicSelectHandler">
<property name="sql">
"SELECT e.empno, e.ename, e.deptno, d.dname FROM emp e, dept d
WHERE e.empno = ? AND e.deptno = d.deptno"
</property>
<property name="resultSetHandler">
<component class="org.seasar.extension.jdbc.impl.BeanResultSetHandler">
<arg>@examples.s2junit4.Employee@class</arg>
</component>
</property>
</component>
</property>
</component>
</components>
examples.s2junit4.EmployeeDaoImplTestpackage examples.s2junit4;
import static org.seasar.framework.unit.S2Assert.assertEquals;
import org.junit.Ignore;
import org.junit.runner.RunWith;
import org.seasar.framework.unit.Seasar2;
import org.seasar.framework.unit.TestContext;
@RunWith(Seasar2.class)
public class EmployeeDaoImplTest {
private TestContext ctx;
private EmployeeDao dao;
public void getEmployee() throws Exception {
Employee emp = dao.getEmployee(9900);
assertEquals("1", ctx.getExpected(), emp);
}
@Ignore("not implemented.")
public void getEmployeeByName() throws Exception {
}
}
このテストクラスのポイントを説明します。
このテストクラスはs2junit4.diconの記述に従い、設定ファイル、準備値、期待値を自動で読み込みます。
準備値と期待値のExcelを用意する方法はS2Unitのサンプルを参考にしてください。 規約メソッド命名規則
S2JUnit4は命名規則により初期化メソッドやテストメソッドを判別します。また、JUnit4のアノテーションと併用することも可能です。以下は命名規則の一覧です。対応するアノテーションがJUnit4に存在する場合はそのアノテーションを示しています。メソッドのシグネチャはすべて
自動フィールドバインディング自動フィールドバインディングとはコンテナに管理されたコンポーネントを特定のルールに従ってテストクラスのフィールドに自動でセットする機能です。自動フィールドバインディングのルールには以下のものがあります。
自動トランザクション
自動トランザクションとは、すべてのテストメソッド実行前にトランザクションを自動で開始し、テストメソッド実行後にロールバックする機能です。この振る舞いが望ましくない場合は、 自動インクルード自動インクルードとはs2junit4.diconに指定した設定ファイルと、命名規則に従った設定ファイルを自動でインクルードする機能です。命名規則はs2junit.diconで指定できます。自動インクルードが望ましくない場合は、テストコンテキストを利用することで無効にできます。 テストの事前データ命名規則に従ったファイルに事前データを用意しておけば、自動でデータベースに反映できます。命名規則はs2junit4.diconで指定できます。事前データの自動準備が望ましくない場合は、テストコンテキストを利用することで無効にできます。 テストの期待値命名規則に従ったファイルに期待値を用意しておけば、テストコンテキストから期待値を取り出すことができます。命名規則はs2junit4.diconで指定できます。 WARM deploy
テストはデフォルトでWARM deployモードで実行されます。WARM deployが適用されるにはconvention.dicon、creator.dicon、customizer.dicon
がCLASSPATH上に必要です。ただし、s2container.dicon が存在する場合はそこで SMART deploy の設定がされているものと見なし，WARM deploy は設定されません。WARM deployが望ましくない場合は、 主なクラスとインタフェースランナー：Seasar2クラスorg.seasar.framework.unit.Seasar2クラスはorg.junit.runner.Runnerを継承したクラスです。@RunWithにこのランナーを指定することでS2JUnit4のテストクラスとして実行できるようになります。 @RunWith(Seasar2.class)
public class HogeTest {
・・・
}
拡張アサート：S2AssertクラスS2JUnit4ではJUnit4のアサートメソッドに加えS2JUnit4独自のアサートメソッドを利用可能です。S2JUnit4独自のアサートメソッドはorg.seasar.framework.unit.S2Assertクラスに定義されています。S2Assertクラスはstaticインポートして利用してください。S2Assertクラスのアサートメソッドを使用すると以下のことが可能です。
テストコンテキスト：TestContextインタフェーステストコンテキストはテストの実行時情報をもつオブジェクトです。テストコンテキストはorg.seasar.framework.unit.TestContextインタフェースで表されます。テストコンテキストの取得には自動フィールドバインディングを使用してください。TestContextの自動フィールドバインディングは他のコンポーネントとは異なりbefore()メソッド実行直前に行われます。TestContextインタフェースが提供する機能は次のものです。
@RunWith(Seasar2.class)
public class Hoge {
private TestContext ctx; //自動フィールドバインディングにより取得
private EmployeeDao dao;
public void before() {
ctx.setAutoIncluding(false); //自動インクルード機能を無効に設定
ctx.include("hoge.dicon"); //明示的なインクルード
ctx.register(EmployeeDaoImpl.class); //コンポーネントの登録
}
public void hoge() {
assertEquals(ctx.getExpected(), dao.getEmployee()); //期待値を取得
}
}
データアクセッサー：DataAccessorテストクラスからデータベースやExcelファイルのデータに簡単にアクセスできるようにS2JUnit4ではDataAccessorインタフェースを提供しています。自動フィールドバインディングにより取得し使用してください。 @RunWith(Seasar2.class)
public class Hoge {
private DataAccessor accessor; // 自動フィールドバインディングにより取得
public void hoge() {
DataTable table = accessor.readDbByTable("Employee");
DataSet dataSet = accessor.readXls("foo.xls");
...
}
}
アノテーションの利用アノテーションを利用することで、S2JUnit4のデフォルトの振る舞いの変更やモックの利用ができます。JUnit4のアノテーションはS2JUnit4においてもすべて利用可能です。以下ではSeasar2が提供するアノテーションについて説明します。
|
| 変数 | 説明 |
|---|---|
#this |
テストクラスのインスタンスを表します。 |
#method |
テストメソッドのインスタンスを表します。 |
#ENV |
環境設定ファイル(env_ut.txt)の値です．環境設定ファイルが存在しない場合は"ut"です． |
S2JUnit4の設定
S2JUnit4を実行するには設定ファイルs2junit4.diconが必要です。s2junit4.diconでは、S2JUnit4の実行時に利用されるコンポーネントが定義されます。以下は、S2-Tigerの配布ファイルに含まれるs2junit4.diconです。
デフォルトのs2junit4.dicon
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE components PUBLIC "-//SEASAR//DTD S2Container 2.4//EN"
"http://www.seasar.org/dtd/components24.dtd">
<components namespace="s2junit4">
<component name="context" class="org.seasar.framework.unit.impl.InternalTestContextImpl"/>
<component class="org.seasar.framework.unit.impl.DataAccessorImpl"/>
<component class="org.seasar.framework.unit.impl.ConfigFileIncluderImpl">
<initMethod name="addConfigFile">
<arg>"javaee5.dicon"</arg>
</initMethod>
<initMethod name="addConfigFile">
<arg>context.testClassShortName + ".dicon"</arg>
</initMethod>
</component>
<component class="org.seasar.framework.unit.impl.TestDataPreparerImpl">
<initMethod name="addTestDataXlsPath">
<arg>context.testClassShortName + "_" + context.testMethodName + ".xls"</arg>
</initMethod>
<initMethod name="addTestDataXlsPath">
<arg>context.testClassShortName + ".xls"</arg>
</initMethod>
</component>
<component class="org.seasar.framework.unit.impl.ExpectedDataReaderImpl">
<initMethod name="addExpectedDataXlsPath">
<arg>context.testClassShortName + "_" + context.testMethodName + "_Expected" + ".xls"</arg>
</initMethod>
</component>
</components>
ここで定義される各コンポーネントの概略を説明をします。
- org.seasar.framework.unit.impl.InternalTestContextImpl
- org.seasar.framework.unit.InternalTestContextインタフェースの実装です。org.seasar.framework.unit.InternalTestContextインタフェースの実装は必ずs2junit4.dicon内に定義される必要があります。このコンポーネントはテストの実行時情報を提供します。
- 他のコンポーネントはこのコンポーネントを参照することで実行時のテストクラスやテストメソッドの名称を使った命名規則を定義できます。
- org.seasar.framework.unit.impl..DataAccessorImpl
-
org.seasar.framework.unit.DataAccessorインタフェースの実装です。定義は必須ではありません。
データベースやExcelのデータにアクセスするためのメソッドを提供します。 - org.seasar.framework.unit.impl.ConfigFileIncluderImpl
- org.seasar.framework.unit.ConfigFileIncluderインタフェースの実装です。定義は必須ではありません。
- このコンポーネントは設定ファイルのインクルードを行います。デフォルトではjavaee5.diconが固定で指定され、テストケースごとの設定ファイルが命名規約を用いて指定されています。
- org.seasar.framework.unit.impl.TestDataPreparerImpl
- org.seasar.framework.unit.TestDataPreparerの実装です。定義は必須ではありません。
- このコンポーネントはExcelから読み取ったテストデータをデータベースに書き込みます。デフォルトでは事前データをもつExcelのパスが命名規則を用いて指定されています。
- org.seasar.framework.unit.impl.ExpectedReaderImpl
- org.seasar.framework.unit.ExpectedReaderの実装です。定義は必須ではありません。
- このコンポーネントはExcelを読みDataSetを返します。デフォルトでは期待値をもつExcelのパスが命名規則を用いて指定されています。
シンプルなs2junit4.dicon
上述のorg.seasar.framework.unit.impl.InternalTestContextImplはサーブレットAPIのモック機能を持つためServlet APIに依存しています。
しかし、この機能が不要な場合org.seasar.framework.unit.impl.SimpleInternalTestContextを代わりに使用できます。
このクラスはデフォルトでJTAとEJB3を利用しない設定になっているため、
SimpleInternalTestContextを使うとServlet、JTA、EJB3のjarファイルなしでシンプルにS2JUnit4を実行できるようになります。
その場合のs2junit4.diconの設定は次のようになります。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE components PUBLIC "-//SEASAR//DTD S2Container 2.4//EN"
"http://www.seasar.org/dtd/components24.dtd">
<components namespace="s2junit4">
<component name="context" class="org.seasar.framework.unit.impl.SimpleInternalTestContext"/>
<component class="org.seasar.framework.unit.impl.ConfigFileIncluderImpl">
<initMethod name="addConfigFile">
<arg>context.testClassShortName + ".dicon"</arg>
</initMethod>
</component>
</components>
S2JUnit4のカスタマイズ
s2junit4config.diconを使用することでS2JUnit4の内部的な振る舞いをカスタマイズできます（ここで使用するのはs2junit4.diconではなくs2junit4config.diconであることに注意してください）。s2junit4config.diconはCLASSPATHに含める必要があります。以下では、カスタマイズの例をいくつか紹介します。
例1:メソッド命名規則の変更
S2JUnit4のメソッドの命名規則を変更したい場合はs2junit4config.diconを次のように記述します。ここではbefore、afterという名前の代わりにsetUp、tearDownを使うことを示しています。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE components PUBLIC "-//SEASAR//DTD S2Container 2.4//EN"
"http://www.seasar.org/dtd/components24.dtd">
<components>
<component class="org.seasar.framework.unit.S2TestClassMethodsRunner$DefaultProvider"/>
<component class="org.seasar.framework.unit.impl.ConventionTestIntrospector">
<property name="beforeClassMethodName">"setUpClass"</property>
<property name="afterClassMethodName">"tearDownClass"</property>
<property name="beforeMethodName">"setUp"</property>
<property name="afterMethodName">"tearDown"</property>
</component>
</components>
例2:メソッド命名規則の無効化
S2JUnit4のメソッドの命名規則を無効にし、アノテーションでの指定のみを有効にしたい場合はs2junit4config.diconを次のように記述します。
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE components PUBLIC "-//SEASAR//DTD S2Container 2.4//EN" "http://www.seasar.org/dtd/components24.dtd"> <components> <component class="org.seasar.framework.unit.S2TestClassMethodsRunner$DefaultProvider"/> <component class="org.seasar.framework.unit.impl.AnnotationTestIntrospector"/> </components>
Tips
知っていると便利なTipsを紹介します。
テスト実行時にテストケースの名前を取得する
テストケースの名前を知るにはTestContext#getTestMethodName()を利用します。
TestContext ctx;
public void test() throws Exception {
String methodName = ctx.getTestMethodName();
...
}
Excelファイルで作成する事前準備値データや期待値データで空白を除去しない
デフォルトではExcelセルの値に含まれる両端の空白は除去されます。
空白文字として認識させるにはExcelセルの値を"ABC "のようにダブルクォテーションで囲み、
テストクラスのbeforeメソッドやbeforeXxxメソッド内でTestContext#setTrimString()
を呼びfalseを設定します。空白文字が除去されなくなります。
TestContext ctx;
public void before() {
ctx.setTrimString(false);
}
この設定をデフォルトとしてすべてのテストケースに反映させたい場合は、s2junit4.diconを変更します。
<component name="context" class="org.seasar.framework.unit.impl.InternalTestContextImpl"> <property name="trimString">false</property> </component>
データベース上のデータをテーブルごとに完全に置き換える
テストデータの準備方法（追加、置換など）は変更することができます。
データをテーブルごとに完全に置き換えたい場合は、テストクラスのbeforeメソッドやbeforeXxxメソッド内でTestContext#setPreparationType()
を呼びPreparationType.ALL_REPLACEを設定します。
TestContext ctx;
public void before() {
ctx.setPreparationType(PreparationType.ALL_REPLACE);
}
この設定をデフォルトとしてすべてのテストケースに反映させたい場合は、s2junit4.diconを変更します。
<component name="context" class="org.seasar.framework.unit.impl.InternalTestContextImpl"> <property name="preparationType">@org.seasar.framework.unit.PreparationType@ALL_REPLACE</property> </component>
列挙型PreparationTypeにはALL_REPLACEの他にNONE、WRITE、REPLACE
が定義されています。