【Rspec】基本的な書き方、タグなど

Rspecコードの基本形

Rspecの基本形は下記のようになります。

RspecにはSystem SpecやModel Spec等様々なSpecの種類が存在しますが基本的にどのSpecを使う場合でも同じ感じで記述します。

構文の役割

Rspecの構文にはそれぞれ役割があるので把握しておきましょう。

describe

テスト対象の機能を記述します。

System Specでは

一連の操作により動作確認をしたい機能や処理の名前を記述します。

Model Specでは

モデルクラス名やメソッド名を記述します。

例

context

テストの様々な条件の概要を記述します。Rspecではcontextはdescribeのエイリアスになっているのでdescribeの代わりにcontextを使ったとしても動作はします。

例

before

テストコードを実行する前にこちらに記述された内容を実行してくれるのでテストの「前提条件」を記述するために使います。describeの中に複数のテストケースを記述する場合はこちらに事前処理をまとめて記述すれば共通化にもなります。なお、beforeの処理は後続のitの処理が実行されるたびに実行されることになります。

また、beforeブロックの中で変数を使う場合はテスト全体でアクセスできる必要があるためローカル変数ではなくインスタンス変数（@付きの変数）にする必要があります。

after

テストの後処理を記述します。Rspecではデータベースの後片付けをデフォルトでやってくれるのでこのフックを使うことはほとんどありません。

it

期待する動作の詳細や条件を記載します。実際にテストコードとして具体的に記述するのはこのブロック内になります。こちらが期待通り動作すればテスト成功の集計が1件増加することになります。例外が発生した場合はエラー（Error）、例外は起きていないが想定外の場合は失敗（Failure）にカウントされます。

なお、DBの状態は次のitが実行される場合は元に戻されるため、あるテストケースの結果によって別のテストケースが影響を受けるということが無いようになっています。（逆に言えばテストデータは他のテストケースの影響を受けないこと前提で作る必要があります。）

itの中に記述するチェック内容

一例ですが、下記のように記述をします。

expect(page)

というのがpageが画面のことを表していてpageに期待するという意味になります。RSpec2.10以前はshouldを使っていましたがメタプログラミングを使っておりバグが発生したためexpectに置き換わりました。

to_have_content '内容'

「内容」という内容がページ内にあるはずだということを指定します。これをRspecでは「マッチャ（Matcher)」といいます。

itの命名規則

英語で記述する場合は下記のように動詞から始めるのが通常のようです。

ネストさせる。

基本的に業務ではdescribe文をネストさせて下記のように階層構造でテストコードを記述することが一般的です。

一番外側のdescribe

Specファイルのテーマを記述します。（例で言えば○○アプリ）

内側のdescribe

細かい機能を記述します。

タグとは？

いくつかあるテストのうち特定のテストコードのみタグ付けして実行することができる機能です。

タグの書き方

タグ名にはfocusというタグ名がよく使われます。

なお、タグはitだけでなく「describeブロック」や「contextブロック」にも付けることは可能です。その場合はブロック内の全テストにそのタグが適用されます。

実行方法

特定のタグを実行する

特定のタグをスキップする

タグ名の最初にチルダを付けるとそのタグの実行だけを逆にスキップすることが可能です。