質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.00%

Rspecのダブルの扱い方について

受付中

回答 1

投稿

  • 評価
  • クリップ 0
  • VIEW 1,449

yusukexyusuke

score 40

よろしくお願いしますm(__)m
Rspecでテストケースを書いていて疑問に思った点がありました。

自分なりに調べて理解したつもりなのですが、
私の解釈があっているかどうかチェックしてただけないでしょうか。

間違っている箇所がありましたら
ご指摘いただけると幸いです。

どうか宜しくお願い致します!!!!

///////////////////////////////ここから

テストケースでモックやスタブを作るということは
テストを走らせた時のアプリケーションの挙動を変更するということである。

class Hoge
  def hoge
    "hogehoge"
  end 
end

というメソッドがあって

let(:class) { described_class.new }
it do
allow(class).to receive(:hoge).and_return('piyopiyo')
end

というスタブを作ったら、
テストを実行し、hogeメソッドが実行された時に"piyopiyo"が返り値となるようになる。

binding.pryで止めてhogeを実行すると以下のようになる。

[1] pry(#<ConfirmContractRenewal::Base>)> hoge
"piyopiyo"

ちなみに

allow(class).to receive(:hoge)

and_return('piyopiyo')を指定しないと、

[1] pry(#<ConfirmContractRenewal::Base>)> hoge
nil

となる

 疑問点

今回疑問に思った箇所は

# class
class Hoge
  NotificationMailer.delay.auto_contract_renewal(plan)
end

# rspec
RSpec.describe Hoge do
  let(:delay) { double('delay') }
  it do
    allow(NotificationMailer).to receive(:delay).and_return(delay)
    expect(delay).to receive(:auto_contract_renewal).exactly(10).times
  end
end


ここのexpect(delay)の箇所でdelayが:auto_contract_renewalメソッドを持ってる体でテストを行えるのか?
が疑問だった。
だってdelayってただの空のダブルオブジェクトでしょ?

 検証

本来はNotificationMailer.delayを実行すれば、delayメソッドがオブジェクト(以下オブジェクト①とする)を返す。
そしてそのオブジェクト①がauto_contract_renewalメソッドを持っている。

スタブを作成してテストを実行すると
本来NotificationMailer.delayが返すオブジェクトがダブルオブジェクトになる。

ダブルとは『代役』とか『影武者』という意味である。
ダブルオブジェクトとは①の代役である
なのでオブジェクト①が持っているメソッドを使えるように振る舞うことが出来る。

ここでもbinding.pryで止めて検証

[16] pry(#<ConfirmContractRenewal::Base>)> NotificationMailer.delay
#<Double "delay">

[18] pry(#<ConfirmContractRenewal::Base>)> NotificationMailer.delay.class
RSpec::Mocks::Double < Object

[19] pry(#<ConfirmContractRenewal::Base>)> NotificationMailer.delay.methods.grep(/auto/)
[
    [0] auto_contract_renewal(*args, &block) #<Double "delay">
    [1]          autoload_all(*paths)        RSpec::Mocks::Double (RequireAll)
    [2]          autoload_rel(*paths)        RSpec::Mocks::Double (RequireAll)
]

となる。
ダブルオブジェクトがauto_contract_renewalと持っている。
これが

ここのexpect(delay)の箇所でdelayが:auto_contract_renewalメソッドを持ってる体でテストを行えるのか?
が疑問だった。

の答えになった。

///////////////////////////////ここまで

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

0

質問の意図からずれてたら済みませんが、以下見解です。

expect(delay).to receive(:auto_contract_renewal).exactly(10).times


このコード記述の時点ではdelay.auto_contract_renewalが呼ばれるというわけでは無く、「delayオブジェクトは10回auto_contract_renewalメソッドが呼ばれる」というモック(テスト仕様)を定義したことになるので、RSpecはこのテスト仕様の通りauto_contract_renewalが呼ばれるかをチェックするためにメソッドを用意してメソッドの呼び出される回数のカウントを開始しているのだろうと思います。

疑問点にかかれたHogeクラスとそのテストケースだとdelayメソッドが呼ばれるのはクラスロード時の1回のみですので、it内で丁度10回auto_contract_renewalメソッドが呼ばれるトリガーとなる呼び出しが存在しないため必ずテストは失敗するかと思います。

テストとして成り立たせるためにはモックを記述した後にそれが指定したとおりに呼ばれるためのトリガとなるコードを記述させなくてはいけません。クラスロードだと呼び出しにくいのですが、、、例えばauto_contract_renewalが2回必ず呼ばれるメソッドがあったとしたら、それを5回呼び出してみる等になります。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2016/08/30 08:53

    > toshi3221さん
    ご回答ありがとうございます!


    > it内で丁度10回auto_contract_renewalメソッドが呼ばれるトリガーとなる呼び出しが存在しないため必ずテストは失敗するかと思います。

    処理の記述を端折ってしまったのですが、クラスの中で
    NotificationMailer.delay.auto_contract_renewal(plan)
    をn回呼ぶ処理があります。

    > it内で丁度10回auto_contract_renewalメソッドが呼ばれるトリガー

    とは例えばどのような記述を書かれたりするのでしょうか!?
    教えていただけないでしょうか。

    宜しくお願い致します。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 90.00%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる