はじめに

Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。

今回は、RSpecを使ったRailsアプリケーションのテスト方法について、実践的な視点から解説していきます。

モック/スタブ

RSpecにおけるモックとスタブは、テスト中に依存するオブジェクトやメソッドの振る舞いを制御するための重要な概念です。モックはテスト中に特定のメソッド呼び出しを監視し、スタブは特定のメソッドの振る舞いを置き換える役割を果たします。

モック

モックについて

モックは、テスト中に特定のメソッドの呼び出しを監視し、そのメソッドが期待通りに呼び出されることを検証します。主に以下のような場面で使われます。

メソッドの呼び出しの検証
- テスト対象のメソッドが他のオブジェクトの特定のメソッドを呼び出すことを確認する際に使用します。
動作の期待
- メソッドが正しい引数で呼び出されるか、あるいは何回呼び出されるかなどの条件を設定します。

モックの使用例

spec/models/user_spec.rb

require 'rails_helper'

RSpec.describe User, type: :model do
  it "sends a welcome email" do
    user = build_stubbed(:user)  # データベースに保存せずにユーザーオブジェクトを作成

    # メール送信をモック化する
    mailer_double = instance_double(UserMailer)
    allow(UserMailer).to receive(:welcome_email).and_return(mailer_double)
    allow(mailer_double).to receive(:deliver_now)

    expect(UserMailer).to receive(:welcome_email).with(user.email)

    user.send_welcome_email
  end
end

app/models/user.rb

class User < ApplicationRecord
  def send_welcome_email
    UserMailer.welcome_email(email).deliver_now
  end
end

app/mailers/user_mailer.rb

class UserMailer < ApplicationMailer
  def welcome_email(email)
    # メール送信の実装
  end
end

instance_double(UserMailer)
- UserMailerのインスタンスをモック化します。
allow(UserMailer).to receive(:welcome_email).and_return(mailer_double)
- UserMailer.welcome_emailメソッドの呼び出しをモック化し、mailer_doubleを返します。
allow(mailer_double).to receive(:deliver_now)
- deliver_nowメソッドの振る舞いを設定します。
expect(UserMailer).to receive(:welcome_email).with(user.email)
- UserMailer.welcome_emailが指定された引数で呼び出されることを期待します。
user.send_welcome_email
- Userモデルの実際のメソッドを呼び出しますが、内部でUserMailer.welcome_emailがモック化された動作になります。

スタブ

スタブについて

スタブは、特定のメソッドの振る舞いを置き換えるために使用されます。テスト中に実際のメソッドの代わりにスタブを使って、特定の返り値を提供したり、メソッドの呼び出しを無視したりします。

メソッドの返り値の設定
- メソッドが呼び出された際に返す値を設定します。
特定の条件での振る舞いの制御
- メソッドの引数や条件に応じて、異なる返り値を提供する場合に使用します。

スタブの使用例

spec/models/payment_processor_spec.rb

require 'rails_helper'

RSpec.describe PaymentProcessor, type: :model do
  it "processes payment via external gateway" do
    payment = build_stubbed(:payment)  # データベースに保存せずに支払いオブジェクトを作成

    # 外部サービスのクライアントをスタブ化する
    gateway_double = instance_double(PaymentGatewayClient)
    allow(PaymentGatewayClient).to receive(:new).and_return(gateway_double)
    allow(gateway_double).to receive(:process_payment).and_return(true)

    result = PaymentProcessor.process(payment)

    expect(result).to be_truthy
  end
end

app/models/payment_processor.rb

class PaymentProcessor
  def self.process(payment)
    gateway_client = PaymentGatewayClient.new
    gateway_client.process_payment(payment.amount)
  end
end

app/services/payment_gateway_client.rb

class PaymentGatewayClient
  def process_payment(amount)
    # 外部サービスへの実際の処理
    true  # 仮の成功を返す
  end
end

instance_double(PaymentGatewayClient)
- PaymentGatewayClientのインスタンスをスタブ化します。
allow(PaymentGatewayClient).to receive(:new).and_return(gateway_double)
- PaymentGatewayClient.newの呼び出しをスタブ化し、gateway_doubleを返します。
allow(gateway_double).to receive(:process_payment).and_return(true)
- process_paymentメソッドの呼び出しをスタブ化し、仮の成功を返すように設定します。
result = PaymentProcessor.process(payment)
- PaymentProcessorクラスの実際のメソッドを呼び出しますが、内部でPaymentGatewayClientがスタブ化された動作になります。