GrailsでアノテーションベースでBeanを登録する
Grailsではgrails-app/service
ディレクトリ配下などにクラスを置くと自動的にSpringのbeanとして認識されますが、src/groovy
やsrc/java
といったディレクトリでは自動的にはbeanとして登録されません。
src/groovy
、src/java
配下のクラスをbeanとして登録したい場合はSpring Bean DSLを使用して登録することができますが、もう一つの方法としてSpringのcomponent-scan
を使用する方法がGrailsでも提供されています。
component-scan
を使用すると指定したパッケージ配下のクラスに対してアノテーションベースでbean登録ができるようになります。
設定の準備
Grailsでcomponent-scan
を使用するにはConfig.groovyでgrails.spring.bean.packages
を指定します。
grails.spring.bean.packages = ["grails.example"]
これであとはgrails.example
配下にアノテーションベースで定義したクラスを置くことで自動的にbean登録されます。
アノテーションベースでbeanを定義する
Grails特有のルールというのは基本的になくSpringのルールに従うだけです。詳細はSpringのドキュメントを参照してくだい。
いくつかサンプルを紹介します。
Springのアノテーションを使用して登録する
Springの@Component
、@Autowired
、@Qualifier
などを使用して登録します。
package grails.example import org.springframework.beans.factory.annotation.Autowired import org.springframework.beans.factory.annotation.Qualifier import org.springframework.stereotype.Component @Component class MyBean { @Autowired MyBeanHoge myBeanHoge @Autowired @Qualifier("myPiyo") def piyo @Autowired @Qualifier("grailsApplication") def grailsApplication String toString() { "This is MyBean" } } @Component class MyBeanHoge { String toString() { "This is MyBeanHoge" } } @Component("myPiyo") class MyBeanPiyo { String toString() { "This is MyBeanPiyo" } }
JSR330を使って登録する
JSR330の@Inject
、@Named
を使用して登録します。
package grails.example import javax.inject.Inject import javax.inject.Named @Named class NamedBean { @Inject NamedBeanHoge namedBeanHoge @Inject @Named("namedPiyo") def piyo @Inject @Named("grailsApplication") def grailsApplication String toString() { "This is NamedBean" } } @Named class NamedBeanHoge { String toString() { "This is NamedBeanHoge" } } @Named("namedPiyo") class NamedBeanPiyo { String toString() { "This is NamedBeanPiyo" } }
JSR330のアノテーションを使用するには依存ライブラリの追加が必要です。
dependencies { ... compile 'javax.inject:javax.inject:1' }
JSR250系も使える
package grails.example import javax.annotation.PostConstruct import javax.annotation.PreDestroy import javax.inject.Named @Named class PostConstructAndPreDestroyBean { def number @PostConstruct def init() { number = 100 } @PreDestroy def destroy() {} }
Database Migration Pluginでcontextを使用する
LiquibaseではchangeSetにcontext
属性が設定できます。このcontext
属性を使用することで、実行時に適用するchangeSetの範囲を指定できます。
databaseChangeLog = { changeSet(author: "yamkazu", id: "default-ctx") { ... } changeSet(author: "yamkazu", id: "prod-ctx", context: "prod") { ... } changeSet(author: "yamkazu", id: "test-ctx", context: "test") { ... } }
実行時にcontext
を指定するには--contexts
オプションを使用します。
grails> dbm-update --contexts="test"
いくつかの特徴的なルールがあるので以下にまとめます。
- 複数指定する場合はカンマで区切る
- changeSetで
context
が無指定の場合は常に実行される --contexts
を指定しないとすべてのコンテキストが対象になる
後ろ2つが若干わかりにくいですが、--contexts
の指定と実行されるid
は以下のようになります。
- dbm-update -
default-ctx
、test-ctx
、test-ctx
のchangeSetを実行 - dbm-update --contexts="test" -
default-ctx
、test-ctx
のchangeSetを実行 - dbm-update --contexts="test,prod" -
default-ctx
、test-ctx
、test-ctx
のchangeSetを実行
特に指定しないとすべてのコンテキスト実行される点は注意が必要です。例えばtest
のようなコンテキストを作成した時点で、本番環境に適用する際には明示的に何かのコンテキストを指定しないと、test
を含む全てのchangeSetが適用されるといった動作をします。この場合は実際にそのコンテキストが存在するかは別として、明示的に何らかの適当なコンテキストを指定しておく必要があります。
updateOnStart
でアプリケーション起動時に連動させるにはConfig.groovyでgrails.plugin.databasemigration.updateOnStartContext
を指定してください。
grails.plugin.databasemigration.updateOnStartContext="prod"
Database Migration Pluginで毎回実行するchangelogを定義する
runAlways
属性をtrue
に設定することで毎回実行するchangelogを定義できます。runOnChange
属性がtrue
の場合ではchangesetのチェックサムが変更になった時のみ実行しますが、runAlways
属性をtrue
にするとチェックサム変更有無に関係なく毎回実行してくれます。
changeSet(author: "yamkazu", id: "create-dummy-data", runAlways: true, runOnChange: true) { sql("DELETE FROM person") sql(""" |INSERT INTO person ( id, version, name ) VALUES ( nextval('hibernate_sequence'), 0, 'tanaka' ); |INSERT INTO person ( id, version, name ) VALUES ( nextval('hibernate_sequence'), 0, 'sato' ); """.stripMargin()) }
リファレンスを読む限り
Executes the change set on every run, even if it has been run before
と記述されておりrunAlways
だけ付与すれば動くように読めますが現時点(Database Migration Plugin 1.3.2、Liquibase 2.0.5)ではrunOnChange
をtrueにしないとチェックサムのエラーになります。
こんな投稿を発見したが、いまいち直感的じゃない気がします。
Database Migration PluginでNotNull制約のカラムを追加する
既存のデータが存在する場合に、NotNull
制約が付与されたカラムを追加する場合は少し工夫が必要です。単にカラムを追加すると既存のデータがNULL
になってしまうためエラーとなります。これを回避するには一度NotNull
制約を付与せずにカラムを追加し、既存データに対してUPDATE
をかけた上で、NotNull
制約を追加してあげる必要があります。
以下のドメインがあるとします。
class Person { String name }
以下のchangesetでデータベースと同期済みであるとします。
changeSet(author: "yamkazu (generated)", id: "1362294228819-1") { createTable(tableName: "person") { column(name: "id", type: "int8") { constraints(nullable: "false", primaryKey: "true", primaryKeyName: "personPK") } column(name: "version", type: "int8") { constraints(nullable: "false") } column(name: "name", type: "varchar(255)") { constraints(nullable: "false") } } }
さらにデータベースには以下のデータが入っているとします。
id | version | name ----+---------+-------- 1 | 0 | yamada 2 | 0 | sato
単純にカラムを追加するとエラーとなる
ドメインにage
のプロパティを追加します。
class Person { String name Integer age }
この状態でdbm-gorm-diff
コマンドを使用すると以下のようなchangelogを生成します。
changeSet(author: "yamkazu (generated)", id: "1362294947235-1") { addColumn(tableName: "person") { column(name: "age", type: "int4") { constraints(nullable: "false") } } }
このchangesetを反映するためにdbm-update
を実行します。
| Error 2013-03-03 16:19:10,773 [main] ERROR liquibase - Change Set changelog-0.1.groovy::1362294947235-1::yamkazu (generated) failed. Error: Error executing SQL ALTER TABLE person ADD age int4 NOT NULL: ERROR: column "age" contains null values Message: Error executing SQL ALTER TABLE person ADD age int4 NOT NULL: ERROR: column "age" contains null values
期待した通りエラーとなりました。
addNotNullConstraintを使用する
エラーを回避するためには、はじめに記述したように一度NotNull
制約を付与せずにカラムを追加し、既存データに対してUPDATE
をかけた上で、NotNull
制約を追加します。NotNull
制約を追加するにはaddNotNullConstraintが使用できます。
addNotNullConstraintの詳細はリファレンスを参照してください。
changeSet(author: "yamkazu (generated)", id: "1362294947235-1") { addColumn(tableName: "person") { column(name: "age", type: "int4") } sql("UPDATE person SET age = 30") addNotNullConstraint(tableName: "person", columnName: "age") rollback { dropColumn(tableName: "person", columnName: "age") } }
addColumn
でconstraints(nullable: "false")
とせず、(年齢を一律30才としていいかはおいといて)一度値を設定した後に、addNotNullConstraint
を使用してNotNull
制約を追加しています。
rollback
はchangeSet配下に複数のコマンドがある場合は自動でロールバック処理を作成しません。自動生成させるためにchangeSetをコマンド毎に分けるという案もありますが、ここではグループ化して、明示的にroolback
を指定しています。
addNotNullConstraintのdefaultNullValueを使用する
上記では明示的にUPDATE
をsql
コマンドを使用して設定しましたが、単純な値セットだけならばaddNotNullConstraintのdefaultNullValueが使用できます。
changeSet(author: "yamkazu (generated)", id: "1362294947235-1") { addColumn(tableName: "person") { column(name: "age", type: "int4") } addNotNullConstraint(tableName: "person", columnName: "age", defaultNullValue: "30") rollback { dropColumn(tableName: "person", columnName: "age") } }
defaultNullValueを使用すると以下のことを自動でやってくれます。
UPDATE person SET age = '30' WHERE age IS NULL; ALTER TABLE person ALTER COLUMN age SET NOT NULL;
単純な値セットであればdefaultNullValueで十分ですが、他のテーブル、カラムから値を算出するといった場合には使用できないため、その場合は先程のsql
コマンドなどを使用してください。
Database Migration Pluginで任意のSQLを実行する
Database Migration PluginではLiquibaseで使用可能なchangesetのコマンドが、groovyフォーマットのchangesetでも同様に使用可能になっています。
使用可能なコマンドの一覧はLiquibaseのリファレンスを参照してください。
今日はこの中からCustom SQLとCustom SQL Fileについて紹介します。
Custom SQL
changeSet(author: "yamkazu (generated)", id: "create-person") { sql("CREATE TABLE person ( id int8 primary key, name varchar(255) )") sql(""" |INSERT INTO person ( id, name ) VALUES ( 1, 'tanaka' ); |INSERT INTO person ( id, name ) VALUES ( 2, 'sato' ); """.stripMargin()) sql([stripComments: true, splitStatements: false], """ |INSERT INTO person ( id, name ) VALUES ( 3, 'suzuki' ); -- insert suzuki |INSERT INTO person ( id, name ) VALUES ( 4, 'yamamoto' ); -- insert yamamoto """.stripMargin()) rollback { sql("DELETE FROM person") dropTable(tableName: "person") } }
例を見ればだいたい使い方が想像できると思います。
一番シンプルな使い方はsql("...")
形式で実行したいSQLを指定するだけです。
属性を付与しつつ内容を記述する場合はsql([stripComments: true, splitStatements: false],"…")
のように第1引数にmapで属性を指定し、第2引数にクエリーの文字列を指定します。いくつか属性がありますがstripComments
属性にtrue
を指定するとコメントが削除され、splitStatements
にfalse
を指定すると;
でステートメントが分割されず、ひとつの1つのステートメントとして実行されます。
sql
コマンドを使用する際の注意点ですが、自動ロールバックに対応していないということです。createTable
といったコマンドではデフォルトでそれに対するロールバックが定義されていますが、sql
ではそれがないため明示的にrollback
コマンドを使用して、このchangeSetをロールバックする処理を記述する必要があります。
roolback
は直接SQLを記述したりchangeSetで使用可能なコマンドが使用できます。詳細はリファレンスを参照してください。
Custom SQL File
Custom SQL Fileは任意のSQLファイルを実行できます。
changeSet(author: "yamkazu (generated)", id: "create-person") { sqlFile(path: "create-person.sql") sqlFile(path: "sql/person-data-1.sql") sqlFile(path: "/sql/person-data-2.sql", stripComments: true, splitStatements: false) rollback { dropTable(tableName: "person") } }
path
にファイルを指定することで使用できます。ファイルはクラスパスから読みだされchangelog.groovyを起点としてた相対パス、または絶対パスが使用できます。
Custom SQLと同様にCustom SQL Fileも自動ロールバックには対応していないため、自身でロールバック処理を記述する必要があります。
Database Migration Plugin のチェックサム
データベースへの反映履歴を管理するdatabasechangelog
テーブルにはmd5sum
というchangeset
のチェックサムを格納するカラムがあります。
liquibaseのリファレンスには以下のように記述されています。
LiquiBase が変更セットに到達すると、MD5Sum を計算して、”databasechangelog” に MD5Sum を保存します。MD5Sum を保存する意味は、LiquiBase が、ほかの誰かが実行されて以来変更セットを変更していないかどうかを知ることができるためです。変更セットが実行されたときから変更されていた場合、LiquiBase はエラーとともに移行を終了します。というのも、何が変更されたか知ることができず、データベースが変更ログが期待しているのと異なった状態にあるかもしれないからです。もし、適切な理由によって変更セットが変更されていた場合やこのエラーを無視したい場合は、databasechangelog テーブルを更新して、その行の id/author/ファイルのパス名に対応する MD5Sum を null に更新します。次回 LiquiBase が実行されると、MD5Sum の値を適切な値に更新してくれます。
MD5Sum は、”runOnChange” 変更セット属性と一緒に使用されます。普通はただ現在のバージョンが知りたいだけで新しい変更セットを追加したくないのに、更新されたときはいつでも適用したいときがなんどもあるでしょう。このよい例はストアドプロシージャに関するものです。ストアドプロシージャの全体をコピーして新しい変更セットを作るたび、とても長い変更ログが無駄に終わるだけでなく、ソースコード管理システムのマージや差分の機能を失うことになるのです。代わりに、runOnChange = “true” 属性を変更セットにあるストアドプロシージャのテキストにつけましょう。そのストアドプロシージャは、内容が変更されたときだけ再作成されるようになります。
簡単に言うと、changesetを変更しチェックサムが変わった場合に、前者のデフォルトの場合(runOnChange=false
)はエラー、runOnChange=true
の場合は再度実行という動作の違いがあるようです。
書いてある通りなのですが実際に動作させながら検証してみます。
デフォルトの場合
以下のPersonドメインがあるとします。
class Person { String name }
このドメインに対するchangelogを以下のように作成します。
databaseChangeLog = { changeSet(author: "yamkazu (generated)", id: "create-person") { createTable(tableName: "person") { column(name: "id", type: "int8") { constraints(nullable: "false", primaryKey: "true", primaryKeyName: "personPK") } column(name: "version", type: "int8") { constraints(nullable: "false") } column(name: "name", type: "varchar(255)") { constraints(nullable: "false") } } } }
この状態で一度dbm-update
コマンドを使用してデータベースと同期しておきます。同期が成功すると上のchangesetを反映した履歴がdatabasechangelogが書き込まれます。
devDb=# select id, md5sum from databasechangelog; id | md5sum ---------------+------------------------------------ create-person | 3:c2a46c4edd51cd911c9dced0a8fcabe3
changeSetの内容を元にmd5sum
が書き込まれています。この状態でほど作成したchangeSetのname
カラムの型をvarchar(255)
からtext
に変更します。
databaseChangeLog = { changeSet(author: "yamkazu (generated)", id: "create-person") { createTable(tableName: "person") { ... column(name: "name", type: "text") { constraints(nullable: "false") } } } }
同じIDにもかかわらずchangeSetの中身が書き換えられた状態です。この状態でdbm-validate
コマンドを実行します。
grails> dbm-validate | Starting dbm-validate for database test @ jdbc:postgresql://localhost:5432/devDb Validation Error: 1 change sets have changed since they were ran against the database changelog-0.1.groovy::create-person::yamkazu (generated)
このようにchangeSetの中身が変わりチェックサムがことなるためエラーとなります。dbm-update
などの同期処理においても必ず最初にこのvalidateが行われるため、同様にエラーになります(1.3.2までこのエラーがdbm-validate
コマンド以外では握りつぶされていましたが1.3.3で修正される予定です)。
text
への変更をvarchar(255)
に戻して、次はドメインに変更を加えてみます。
class Person { String name Integer age }
age
のプロパティを追加しました。このカラムを追加するchangesetを以下のように作成します。
databaseChangeLog = { ... changeSet(author: "yamkazu (generated)", id: "add-age") { addColumn(tableName: "person") { column(name: "age", type: "int4") { constraints(nullable: "false") } } } }
再度dbm-update
コマンドを使用してデータベースと同期してします。databasechangelogは以下のようになります。
devDb=# select id, md5sum from databasechangelog; id | md5sum ---------------+------------------------------------ create-person | 3:c2a46c4edd51cd911c9dced0a8fcabe3 add-age | 3:2e304646a134a175a22769177941c06a
すでにデータベースに反映が完了して、changesetのcreate-person
とadd-age
を正規化して一つにまとめたいと考えたとします。
databaseChangeLog = { changeSet(author: "yamkazu (generated)", id: "create-person") { createTable(tableName: "person") { column(name: "id", type: "int8") { constraints(nullable: "false", primaryKey: "true", primaryKeyName: "personPK") } column(name: "version", type: "int8") { constraints(nullable: "false") } column(name: "name", type: "varchar(255)") { constraints(nullable: "false") } column(name: "age", type: "int4") { constraints(nullable: "false") } } } }
create-person
のchangesetにage
を追加し、add-age
は削除しました。この状態でdbm-update
を実施すると当然エラーになります。チャックサムが異なるためです。
Validation Error:
1 change sets have changed since they were ran against the database
changelog-0.1.groovy::create-person::yamkazu (generated)
特にデータベースへ反映を行うわけではないがchangesetだけ正規化するとこのような状態になります。この状態を解消するには一度dbm-clear-checksum
を実行します。
grails> dbm-clear-checksums
databasechangelogは以下のようになります。
devDb=# select id, md5sum from databasechangelog; id | md5sum ---------------+-------- create-person | add-age |
このようにmd5sum
の値がクリアされます。この状態で再度dbm-update
を実施するとdatabasechangelogは以下のようになります。
devDb=# select id, md5sum from databasechangelog order by orderexecuted ; id | md5sum ---------------+------------------------------------ create-person | 3:393ba7bc4288b805a68f49b8c3f3f3ee add-age |
今度はエラーとならずにcreate-person
に新たなハッシュ値が書き込まれました。
ちなみにこの時にdbm-rollback-count-sql 1
を実行すると以下になります。
grails> dbm-rollback-count-sql 1 DROP TABLE person; DELETE FROM databasechangelog WHERE ID='create-person' AND AUTHOR='yamkazu (generated)' AND FILENAME='changelog-0.1.groovy';
どうも実行のsqlを見ているとmd5sum
がnullのレコードを対象として動作するようです。少し注意が必要です。
このsqlでロールバックするとadd-age
が残ってしまいますが、特に残っていても害はなさそうですが気になります。dbm-update
のオプションなどで再度チェックサム書いたあとに浮いたレコード削除してくれてもいいようなきもしますが、そんな機能は今のところないようです。
runOnChange=true の場合
runOnChange=true
はchangeSetの属性に設定します。注意点としては当たり前ですがrunOnChange=true
で再実行された際に問題なく動作するクエリを書くことです。
changeSet(author: "yamkazu (generated)", id: "create-one-function", runOnChange: true) { sql(""" | CREATE OR REPLACE FUNCTION one() RETURNS integer | AS 'SELECT 1 AS RESULT;' | LANGUAGE SQL; """.stripMargin()) }
CREATE OR REPLACE
というふうに宣言することで何度実行しても問題ありません。これでfunctionの中の実装が変わると再度実行されます。
SpockでビルトインされているExtensionsとかそのへん
G* Advent Calendar 2012 12日目担当のyamkazuです。こんにちは。
今日はみんな大好きSpockでビルトインされている機能拡張について、いくつかピックアップして紹介します。機能拡張にカテゴライズされないものもあるかもしれませんが、その辺はゆるやかに。
また、この記事はSpock0.7を元に記述していますが、バージョンが変わるとアノテーションが存在しないとかありますので、新しいバージョンが出た場合はそのへんを注意してお読みください。
それではさっそく。
@Ignore
これは説明不要だと思いますが、Ignoreを付与すると指定したフィーチャの実行がスキップされます。アノテーションに理由を書くような使い方もできます。
@Ignore def "xxx"() { expect: true } @Ignore('hogehogeのため') def "yyy"() { expect: true }
スペックに指定すると全体がスキップされます。
@Ignore class IgnoreSpec extends Specification { ... }
@IgnoreRest
IgnoreRestはIgnoreとは対照的に、IgnoreRestが付与されたフィーチャのみを実行します。IDEを使っている場合は対象のフィーチャを決め打ちで実行するのは比較的容易なのですが、コンソールからtestを実行する場合する場合などはそうではありません。このアノテーションを使用すると実行したいフィーチャメソッドを簡単に指定することができます。
class IgnoreRestSpec extends Specification { def "xxx"() { ... } @IgnoreRest def "yyy"() { ... } @IgnoreRest def "zzz"() { ... } }
上記のように複数指定することもでき、この例ではyyy、zzzのみが実行されます。
@IgnoreIf
IgnoreIfは指定されたクロージャの実行結果がtrueの場合にフィーチャの実行がスキップされます。クロージャの中では暗黙的に以下の変数が使用可能です。
- env - System.getenv()のショートカット
- properties - System.getProperties()のショートカット
- javaVersion - Javaのバージョン
以下のように使用します。
@IgnoreIf({ true }) def "trueなので実行されない"() { expect: false } @IgnoreIf({ false }) def "falseなので実行される"() { expect: true } @IgnoreIf({ 1 < 2 }) def "1 < 2 はtrueなので実行されない"() { expect: false } @IgnoreIf({ 1 > 2 }) def "1 > 2 はfalseなので実行される"() { expect: true } @IgnoreIf({ def a = 1 def b = 1 a + b == 2 }) def "closureをcallしているだけなので複数行書いても良い"() { expect: false } @IgnoreIf({ javaVersion > 1.6 }) def "javaVersionでJVMのバージョンが参照できる"() { expect: false } @IgnoreIf({ env["LANG"] != 'C' }) def "envがSystem.getenv()のショートカットになっている"() { expect: false } @IgnoreIf({ properties["os.name"] == 'Mac OS X' }) def "propertiesがSystem.getProperties()のショートカットになっている"() { expect: false }
@FailsWith
Spockでは例外のテストを行う際は、以下のように
then: MyException e = thrown()
thrown()
を使用することができますが、FailsWithはいわゆるJUnit4の@Test(expected = MyException.class)
のような記述の仕方を可能にするアノテーションで、指定した例外でフィーチャが失敗することを宣言できます。
@FailsWith(MyException) def "xxx"() { expect: throw new MyException() } @FailsWith(value = MyException, reason = "hogehogeのため") def "yyy"() { expect: throw new MyException() }
スペックに付与することも可能です。
@FailsWith(MyException) class FailWithSpec extends Specification { ... }
この場合は、スペック上のすべてのフィーチャが指定した例外で失敗することを宣言しています。
@Timeout
Timeoutはフィーチャの実行時間のタイムアウト値を指定することができます。このタイムアウト値を超過した場合はorg.spockframework.runtime.SpockTimeoutError
がスローされます。
@Timeout(1) def "1秒以内に終わる"() { expect: Thread.sleep 500 } @FailsWith(SpockTimeoutError) @Timeout(1) def "1秒以内に終わらない"() { expect: Thread.sleep 1100 }
デフォルトでは単位は秒に設定されています。単位を変更したい場合はunit属性を指定します。
@Timeout(value = 500, unit = TimeUnit.MILLISECONDS) def "500ミリ秒以内に終わる"() { expect: Thread.sleep 250 } @FailsWith(SpockTimeoutError) @Timeout(value = 250, unit = TimeUnit.MILLISECONDS) def "500ミリ秒以内に終わらない"() { expect: Thread.sleep 300 }
@Unroll
通常Spockではwhereのパラメタライズテストを実行すると、そのフィーチャに対し1つの実行結果が出力されます。
def "x + y の合計を計算する"() { expect: x + y == sum where: x | y || sum 1 | 2 || 3 3 | 4 || 7 5 | 6 || 11 }
実行結果
Test Duration Result
x + y の合計を計算する 0.001s passed
Unrollはこのパラメタライズテストをそれぞれの独立したフィーチャとして実行してくれます。また以下のように#でパラメータをフィーチャ名に埋め込むことができます。
@Unroll def "#x + #y の合計は #sum になる"() { ... }
実行結果
Test Duration Result 1 + 2 の合計は 3 になる 0s passed 3 + 4 の合計は 7 になる 0s passed 5 + 6 の合計は 11 になる 0s passed
#形式での参照は引数なしのメソッドあれば、メソッドをチェインして参照することも可能です。詳細はリファレンスを参照してください。
@Shared
通常フィールドで宣言したフィクスチャはフィーチャの実行毎に初期化されます。
def counter = 0 def "counterをインクリメントする"() { expect: counter++ == expectedCounter where: expectedCounter << [0, 0, 0] }
Sharedはフィーチャ間でフィクスチャを共有するSharedFixtureを実現してくれます。生成コストが高いオブジェクトをフィーチャ間で共有したい場合に便利です。
@Shared def counter = 0 def "counterをインクリメントする"() { expect: counter++ == expectedCounter where: expectedCounter << [0, 1, 2] }
@AutoCleanup
AutoCleanupはフィールドに設定することで自動で後処理をしてくれます。デフォルトではcloseメソッドが自動で呼びされます。
@AutoCleanup def closeable = new Closeable()
明示的に呼び出す後処理のメソッドを指定することもできます。
@AutoCleanup("shutdown") def shutdownable = new Shutdownable()
後処理の中に例外が発生した場合に発生した例外を握りつぶしたい場合はquiet属性にtrue
を指定します。デフォルトはfalse
です。
@AutoCleanup(value = 'shutdown', quiet = true) def shutdownable = new Shutdownable()
これらの後処理はフィーチャ実行毎に実行されますが、@Sharedが付与されたフィールドでは全フィーチャの実行後に1度だけ実行されます。
@Stepwise
Stepwiseを使用すると一連のフィーチャをそれぞれ定義した順に実行してくれます。フィーチャが一連のシナリオとして実行されるイメージで、途中のテストが失敗すると以降のテストが実行されません。
@Stepwise class StepwiseSpec extends Specification { def "first"() { expect: true } def "second"() { expect: false } def "third"() { expect: true } }
上記の例ではfirst、second、thirdの順に実行されるはずですが、secondで失敗するため、thirdは実行されません。