説明
概要
エンティティクラスに対するテストクラスを作成します。
例えば、次のようなコードを生成できます。
/**
* {@link Department}のテストクラスです。
*
* @author S2JDBC-Gen
*/
public class DepartmentTest extends S2TestCase {
private JdbcManager jdbcManager;
/**
* 事前処理をします。
*
* @throws Exception
*/
@Override
protected void setUp() throws Exception {
super.setUp();
include("s2jdbc.dicon");
}
/**
* 識別子による取得をテストします。
*
* @throws Exception
*/
public void testFindById() throws Exception {
jdbcManager.from(Department.class).id(1).getSingleResult();
}
/**
* employeesとの外部結合をテストします。
*
* @throws Exception
*/
public void testLeftOuterJoin_employees() throws Exception {
jdbcManager.from(Department.class).leftOuterJoin(employees()).id(1).getSingleResult();
}
}
これはエンティティクラスDepartmentに対するテストクラスです。 テストクラスでは、実際にSQLを発行し次のことを確認します。
- エンティティクラスとテーブルのマッピングが正しいこと
- 関連プロパティの設定が正しいこと
テストクラスは、自由に修正して利用できます。
パラメータ
Antタスクへのパラメータを以下に示します。
トップレベルのパラメータ
| 属性 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|
| classpathDir | エンティティクラスを含むクラスパスのディレクトリです。このディレクトリはタスクの実行時のクラスパスに含まれている必要があります。 | - | YES |
| rootPackageName | ルートパッケージ名です。 | "" | NO |
| entityPackageName | エンティティクラスのパッケージ名です。エンティティクラスは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されているとみなされます。 | "entity" | NO |
| entityClassNamePattern | このタスクで対象とするエンティティ名の正規表現です。 | ".*" | NO |
| ignoreEntityClassNamePattern | このタスクで対象としないエンティティ名の正規表現です。 | "" | NO |
| testClassNameSuffix | テストクラス名のサフィックスです。 | "Test" | NO |
| useNamesClass | "true"の場合、名前クラスを使用します。 | "true" | NO |
| namesClassNameSuffix | 名前クラス名のサフィックスです。 | "Names" | NO |
| namesPackageName | 名前クラスのパッケージ名です。名前インタフェースは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されているとみなされます。 | "entity" | NO |
| useS2junit4 | "true"の場合、S2JUnit4 を使ったテストコードを生成します。"false"の場合、S2Unit を使ったテストコードを生成します。 | "false" | NO |
| templateFileName | テストクラスのテンプレートファイル名です。 | "java/entitytest.ftl" | NO |
| templateFileEncoding | テンプレートファイルのエンコーディングです。 | "UTF-8" | NO |
| templateFilePrimaryDir | テンプレートファイルを検索する際の優先ディレクトリです。 | - | NO |
| javaFileDestDir | Javaファイルの出力先ディレクトリです。 | "src/test/java" | NO |
| javaFileEncoding | Javaファイルのエンコーディングです。 | "UTF-8" | NO |
| overwrite | "true"の場合、テストクラスのJavaファイルを上書きします。 | "false" | NO |
| configPath | JdbcManagerのコンポーネント定義を含む設定ファイルです。このタスクの実行に使用されます。また、テストコードではこの設定ファイルがincludeされます。 | "s2jdbc.dicon" | NO |
| env | 環境名です。 | "ut" | NO |
| jdbcManagerName | JdbcManagerのコンポーネント名です。接続先のデータベースはJdbcManagerのコンポーネント名によって決まります。 | "jdbcManager" | NO |
| factoryClassName | S2JDBC-Genの公開されたインタフェースの実装を作成するファクトリのクラス名です。S2JDBC-Genをカスタマイズする場合に独自のファクトリクラスを指定できます。ここに指定するクラスはorg.seasar.extension.jdbc.gen.internal.factory.Factoryインタフェースを実装している必要があります。 | "org.seasar.extension.jdbc.gen .internal.factory.FactoryImpl" |
NO |
| commandInvokerClassName | S2JDBC-Genのコマンドを呼び出すクラスの名前です。コマンドの呼び出し前後で任意の処理を実行したい場合に指定します。ここに指定するクラスはorg.seasar.extension.jdbc.gen.command.CommandInvokerインタフェースを実装している必要があります。 | "org.seasar.extension.jdbc.gen .internal.command.CommandInvokerImpl" |
NO |
| classpath | このタスクを実行する際のクラスパスです。 | - | classpathrefが指定されていない場合YES |
| classpathref | このタスクを実行する際のクラスパスの参照です。 | - | classpathが指定されていない場合YES |
例
ルートパッケージを指定する
ルートパッケージに"examples"を設定してタスクを実行します。
<gen-entitytest
classpathDir="build/classes"
rootPackageName="examples"
classpathRef="classpath"
/>
独自のテンプレートファイルを使用する
任意のディレクトリに独自のテンプレートファイルを置き、templateFilePrimaryDir属性にそのディレクトリを指定することで、 独自のテンプレートファイルを使用できます。
S2JDBC-Genのテンプレートは、配布ファイルのresources/tempaltesディレクトリ以下にあります。 エンティティのテストクラスのテンプレートはjava/entitytest.ftlになります。 これをコピーして、修正を加えるのが良いでしょう。 テンプレートの記述方法についてはFreeMarker のドキュメントを参照してください。
テンプレートファイルを格納するディレクトリをmytempletesとする場合、 修正した独自テンプレートを使用するにはテンプレートをmytempletes/java/entitytest.ftlと配置し、templateFilePrimaryDir属性にmytempletesを指定します。
<gen-entitytest
classpathDir="build/classes"
rootPackageName="examples"
templateFilePrimaryDir="mytempletes"
classpathRef="classpath"
/>
mytempletes/my-entitytest.ftlのように、テンプレートファイルを任意の名前で配置したい場合は、 templateFilePrimaryDir属性に加え、templateFileName属性も指定します。
<gen-entitytest
classpathDir="build/classes"
rootPackageName="examples"
templateFilePrimaryDir="mytempletes"
templateFileName="my-entitytest.ftl"
classpathRef="classpath"
/>
生成するJavaファイルに共通のヘッダーとしてコピーライトを含める
lib.ftlというファイルを作成し、これをtemplateFilePrimaryDir属性に指定するディレクトリに配置します。 lib.ftlには次のようにcopyrightの定義をします。
<#assign copyright> /* * Copyright 2008-2009 ... * All rights reserved. */ </#assign>
<gen-entitytest
classpathDir="build/classes"
rootPackageName="examples"
templateFilePrimaryDir="mytempletes"
classpathRef="classpath"
/>
copyright.ftlにコピーライトを記述することもできます（過去バージョンとの互換機能として残されています）。 copyright.ftlを使う場合は、#assignタグを使わずコピーライトのみを指定してください。 lib.ftlと同様、copyright.ftlはtemplateFilePrimaryDir属性に指定するディレクトリに配置する必要があります。
生成するJavaファイルにauthorを指定する
lib.ftlというファイルを作成し、これをtemplateFilePrimaryDir属性に指定するディレクトリに配置します。 lib.ftlには次のようにauthorの定義をします。
<#assign author="Nakamura">
<gen-entitytest
classpathDir="build/classes"
rootPackageName="examples"
templateFilePrimaryDir="mytempletes"
classpathRef="classpath"
/>