えーJavaで有名なテストツールDBUnitについて。
DbUtilではありませんので間違えないように。(私は最初間違えました・・・)
まだ全然使い込んでるわけではありませんがどんなことができるかというと
- 今あるデータを一度バックアップをとり、初期化して事前データ(エクセルで定義)データを入れられる
- テストが終わったら、事前データとしていれたデータを削除し、バックアップをリストアできる
- 対象となるデータがエクセルで用意した期待データと等しいかをチェックできる。
他にもいろいろあるとは思いますが、私が調べたのはこんなところです。
インストール
まずはインストールからpomでそのままいけます。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
<dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.12</version> </dependency> <dependency> <groupId>commons-collections</groupId> <artifactId>commons-collections</artifactId> <version>3.2.1</version> </dependency> <dependency> <groupId>org.dbunit</groupId> <artifactId>dbunit</artifactId> <version>2.5.1</version> </dependency> <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi</artifactId> <version>3.13</version> </dependency> |
dbunitだけではなく、必要となる周辺ライブラリも合わせてインストールしておきましょう。
ソース
ちなみにエクセルやxmlのパスはsrc/main/resources直下です。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
public class DBUtiliTest { /** * DBのコネクション */ private Connection dbConnet = null; /** * IDatabaseコネクション */ private IDatabaseConnection idbConnect = null; /** * host */ private String dbhost; /** * port */ private String port; /** * DB名 */ private String dbName; /** * DBユーザー */ private String dbUser; /** * DBパス */ private String dbPass; /** * DBユーティリティー */ private DBUtility dbUtility = null; /** * ファイルパス */ private String fileDirPath; /** * バックアップファイル名 */ private String backUpFileName; /** * 事前入力ファイル */ private String preInsFileName; /** * 期待値ファイル名 */ private String expectFileName; @Test public void testStart() { //設定情報の入力 this.initConfData(); //データベースとつなぎます this.connectDbConnect(); //DBunitのデータベースオブジェクトとつなぎます。 this.connecIdbConnect(); //バックアップを取得します。 this.backUP(); //事前データを入力します。 this.preSetData(); //実際にデータを更新する処理です。 //この処理はこのプログラムの中に書かれてはないです。 this.updateTemplate(); //期待値と対象のデータが等しいかどうかのチェックを行います。 this.chechExpectedData(); //最後にテストで行ったデータを削除し、バックアップxmlをリストアします。 this.tearDown(); } /** * 基本データを設定する */ public void initConfData() { this.dbhost = "ホスト情報"; this.dbName = "データベース名"; this.dbUser = "ユーザー"; this.dbPass = "パスワード"; this.backUpFileName = "バックアップとして保存したいxmlファイルの名前"; this.preInsFileName = "事前データとしていれたいエクセルファイルの名前"; this.expectFileName = "期待値となるエクセルファイルの名前"; this.setFileDir(); } /** * DBとの接続 */ private void connectDbConnect() { try { Class.forName("com.mysql.jdbc.Driver"); this.dbConnet = DriverManager.getConnection(this.getDbUrl(), this.dbUser, this.dbPass); } catch (SQLException ex | ClassNotFoundException ex) { Logger.getLogger(DBUtiliTest.class.getName()).log(Level.SEVERE, null, ex); } } /** * IDBとの接続 */ private void connecIdbConnect() { try { this.idbConnect = new DatabaseConnection(this.dbConnet); } catch (DatabaseUnitException ex) { Logger.getLogger(DBUtiliTest.class.getName()).log(Level.SEVERE, null, ex); } } /** * URLの発行 * * @return DBURL */ private String getDbUrl() { return String.format("jdbc:mysql://%s:%s/%s?useUnicode=true&characterEncoding=utf8", this.dbhost, this.port, this.dbName); } /** * 事前データのセット */ public void preSetData() { try { //データセットの取得 IDataSet dataSet = new XlsDataSet(new FileInputStream(this.getPreDataPath())); //セットアップ実行 DatabaseOperation.CLEAN_INSERT.execute(this.idbConnect, dataSet); } catch (IOException | DatabaseUnitException | SQLException ex) { Logger.getLogger(DBUtiliTest.class.getName()).log(Level.SEVERE, null, ex); } } public void chechExpectedData(){ try { IDataSet dataSet = new XlsDataSet(new FileInputStream(this.getExcepctedDataPath())); String sql =" select * from template where id = 1 "; //作成日、更新日など照合の対象とならないデータです。 String[] ignoreCols={"create_dt","update_dt"}; //ここで対象となるデータとエクセルが等しいかをチェックできます。 Assertion.assertEqualsByQuery(dataSet,this.idbConnect,sql,"template", ignoreCols); } catch (IOException | DatabaseUnitException | SQLException ex) { Logger.getLogger(DBUtiliTest.class.getName()).log(Level.SEVERE, null, ex); } } /** * ディレクトリの設定 */ private void setFileDir() { this.fileDirPath = System.getProperty("user.dir") + File.separator + "src" + File.separator + "main" + File.separator + "resources" + File.separator; } /** * バックアップファイルパス * * @return バックアップデータのファイルパス */ private String getBackUpDataPath() { return this.fileDirPath + this.backUpFileName; } /** * 事前データのファイルパス * * @return 事前データファイルパス * */ private String getPreDataPath() { return this.fileDirPath + this.preInsFileName; } /** * 期待値データのファイルパス * * @return 期待値ファイルパス */ private String getExcepctedDataPath() { return this.fileDirPath + this.expectFileName; } /** * データのバックアップ */ public void backUP() { try { // バックアップを取りたいテーブルを列挙 IDataSet dataSet = this.idbConnect.createDataSet(); XmlDataSet.write(dataSet, new FileOutputStream(this.getBackUpDataPath())); } catch (IOException | SQLException | DataSetException ex) { Logger.getLogger(DBUtiliTest.class.getName()).log(Level.SEVERE, null, ex); } } /** * データのリストア */ public void tearDown() { // setUp()で生成したバックアップファイルを引数に再度データをinsert try { IDataSet dataSet = new XmlDataSet(new FileInputStream(this.getBackUpDataPath())); DatabaseOperation.CLEAN_INSERT.execute(this.idbConnect, dataSet); } catch (FileNotFoundException | DatabaseUnitException | SQLException ex) { Logger.getLogger(DBUtiliTest.class.getName()).log(Level.SEVERE, null, ex); } } public void updateTemplate(){ this.dbUtility = new DBUtility(); this.dbUtility.setUrl(this.getDbUrl()); this.dbUtility.setUser(this.dbUser); this.dbUtility.setPassword(this.dbPass); Template template = this.dbUtility.findById(1); template.setDescription("sample2"); this.dbUtility.regist(template); } } |
説明はほぼコード上のコメントに集約されているかと思います。
注意点
- もとからあるデータをバックアップしてからリストアするまでに処理が失敗するとリストアされません。
例外時にリストアのメソッドをいれておかないと面倒です。 - 事前データとして入力する日付の値はyyyy/MM/ddにしておきましょう。
- 期待値のエクセルでは日付をyyyy-MM-ddにしておき、文字列にしておかないとダメです。日付だと自動でyyyy/MM/ddになってしまいます。
参考情報
http://genesis-tdsg.blogspot.jp/2013/07/dbunit_24.html
http://kechanzahorumon.hatenadiary.com/entry/2012/09/11/122847
http://www.masatom.in/pukiwiki/Java/DBUnit/Excel%A5%B7%A1%BC%A5%C8%A4%C7Import,Export%A4%B9%A4%EB/
