RSpecの個人的Tips集〜その１〜

はじめに

みなさん、テストコードは書かれているでしょうか？
私も極力書くよう心がけているつもりですが、忙しかったり、難易度が高いテストだとすぐにサボってしまいます。

私は主にRSpecを使用していますが、実は便利なメソッドがたくさんあります。
今回は備忘録を兼ねて記事にまとめたいと思います。
参照するRSpecのバージョンは 3.7 です。

その１として連載形式にしたいと思っていますが、いつ「その２」を書くかは未定です（笑）

テストコードの実行をスキップする

大きな変更があり、既存のテストコードが使えなくなる事があると思います。
そんなときにエラーが出っ放しも気持ち悪いので、実行時にスキップさせます。
ファイル単位でスキップさせる場合は、下記の skip を使用すると良いと思います。

Skip examples

テスト単位でスキップさせるならば、テスト内で skip を使用します。

なお、他にもpendingという方法があります。
こちらの記事に記載がありますが、外的要因による一時的なテスト失敗は、 pending の方が良さそうです。

共通のテストコードを用意する

例えばモデルの concern などでモジュールを用意し、それをモデルに include する事があります。
モジュールの方でテストしても良いのかもしれませんが、テストを共通化し、それを各モデルのテストに取り込みたいと思います。
そんなときにも便利なメソッドがあります。

Shared examples

まずは共通化したいテストを作成します。

それを必要なSpecに取り込みます。

なお、 it_should_behave_like の前に let や before の処理を置いておけばそちらを評価してくれます。

外部APIの返却値をスタブにする

外部APIを使用した処理をテストする場合、返却値をスタブに置き換えた方が良いかと思います。

下記のようなツイッターにツイートするメソッドがあったとして、
（TwitterのAPIについてはちゃんと確認してないのでよしなに解釈してください。。。）

Specの方ではあらかじめこのメソッドについてスタブを置きます。

クラスメソッドの場合は、 allow で良いですが、インスタンスメソッドの場合は allow_any_instance_of を使用します。

RSpec Mocks 3.7

さいごに

簡単なTips集ですが、まとめてみました。
また、私も最近知ったのですが、テストレコードなんかを作成するのに最適なFactoryGirlですが、FactoryBotに名前が変わるそうですね。
こちらの記事で経緯が説明されておりました。

thoughtbot/factory_bot
【翻訳】”Factory Girl”が”Factory Bot”に変わった理由（と移行手順）