【Rails】RSpecを使った自動テスト《基本編》

2024年7月11日 11:11

はじめに

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

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

RSpecについて

RSpecは、Railsアプリケーションのテストに広く使われているフレームワークです。RSpecを使うことで読みやすく、保守しやすいテストコードを書くことができます。また、テストの記述が自然言語に近いため、開発者以外のチームメンバーとも仕様について共通理解を持ちやすくなります。

以下にその特徴や利点を説明していきます。

読みやすい構文

RSpecは自然言語に近い形でテストを記述できます。

describe User do
  it "is valid with a name and email" do
    user = User.new(name: "John Doe", email: "john@example.com")
    expect(user).to be_valid
  end
end

このコードは、ユーザーが名前とメールアドレスを持っていれば有効であることをテストしています。

階層的な構造

describeとcontextブロックを使って、テストを論理的にグループ化できます。

describe Order do
  context "with paid status" do
    it "is marked as completed" do
      order = Order.new(status: :paid)
      expect(order).to be_completed
    end
  end

  context "with unpaid status" do
    it "is not marked as completed" do
      order = Order.new(status: :unpaid)
      expect(order).not_to be_completed
    end
  end
end

豊富なマッチャー

RSpecは多様な条件をテストするための直感的なマッチャーを提供しています。

expect(user.name).to eq("John")
expect(users).to include(user)
expect { User.create!(name: nil) }.to raise_error(ActiveRecord::RecordInvalid)

モックとスタブ

外部依存を分離してテストするためのモックとスタブ機能があります。

allow(WeatherService).to receive(:forecast).and_return("Sunny")
expect(WeatherService).to receive(:forecast).with("Tokyo")

ファクトリを使ったテストデータの作成

FactoryBotと組み合わせることで、テストデータを簡単に作成できます。

FactoryBot.define do
  factory :user do
    name { "John Doe" }
    email { "john@example.com" }
  end
end

# テスト内で使用
user = create(:user)

システムスペック

ブラウザ操作を含む統合テストも書けます。

RSpec.describe "User signup", type: :system do
  it "allows a user to sign up" do
    visit signup_path
    fill_in "Name", with: "John Doe"
    fill_in "Email", with: "john@example.com"
    fill_in "Password", with: "password"
    click_button "Sign up"
    expect(page).to have_content "Welcome, John Doe!"
  end
end

RSpecの基本

RSpecの構文

RSpecの基本的な構文要素であるdescribe,context,itについて詳しく説明します。

describe

describeは、テストのグループを定義するために使用されます。通常、テスト対象のクラスやメソッド名を指定します。

describe User do
  # ここにUserクラスに関するテストを書く
end

describe "Authentication" do
  # 認証に関するテストをここに書く
end

describeブロックはネストすることができます。

describe User do
  describe "#full_name" do
    # full_nameメソッドに関するテストをここに書く
  end
end

context

contextはdescribeと同じように動作しますが、特定の状況や条件を表現するために使用されます。

describe Order do
  context "when it's paid" do
    # 支払い済みの注文に関するテストをここに書く
  end

  context "when it's not paid" do
    # 未払いの注文に関するテストをここに書く
  end
end

contextを使うことで、テストの可読性が向上し、異なる状況下での振る舞いを明確に記述できます。

it

itは個々のテストケースを定義します。期待される動作を自然言語で記述します。

describe User do
  it "returns the full name" do
    user = User.new(first_name: "John", last_name: "Doe")
    expect(user.full_name).to eq("John Doe")
  end
end

使用例

これらの要素を組み合わせることで、階層的で読みやすいテストを書くことができます。

describe User do
  describe "#send_email" do
    context "when the user has an email address" do
      it "sends an email" do
        # テストコード
      end
    end

    context "when the user doesn't have an email address" do
      it "raises an error" do
        # テストコード
      end
    end
  end
end

この構造により、テストが何をテストしているのか、どのような状況でテストしているのかが明確になります。また、この階層構造はテスト実行時のレポートにも反映されるため、どのテストが失敗したのかを特定しやすくなります。

expectとマッチャー

RSpecのexpectとマッチャーは、テストの期待値を記述するための重要な要素です。

expect

expect(実際の値).to マッチャー(期待する値)

マッチャー

RSpecのマッチャーには様々な種類があり、それぞれ異なる比較や検証を行うために使用されます。以下に主要なマッチャーとその使用例を示します。

等価性のマッチャー

# 厳密な等価性を検証
expect(1 + 1).to eq(2)

# オブジェクトの同一性を検証
a = [1, 2, 3]
b = a
expect(b).to be(a)

真偽値のマッチャー

# 真偽値を検証
expect(1 < 2).to be_truthy
expect(nil).to be_falsey

# nilであることを検証
expect(nil).to be_nil

比較のマッチャー

# 数値の比較
expect(5).to be > 3
expect(10).to be <= 10

クラスのマッチャー

# クラスの種類を検証
expect("hello").to be_a(String)
expect(5).to be_an(Integer)

述語マッチャー

# 空であることを検証
expect([]).to be_empty

エラーのマッチャー

# エラーが発生することを検証
expect { 1 / 0 }.to raise_error(ZeroDivisionError)

含有のマッチャー

# 配列や文字列に特定の要素が含まれることを検証
expect([1, 2, 3]).to include(2)
expect("hello world").to include("world")

変更のマッチャー

# ブロックの実行前後で値が変化することを検証
count = 0
expect { count += 1 }.to change { count }.by(1)

応答のマッチャー

# メソッドが存在することを検証
expect("hello").to respond_to(:length)

マッチのマッチャー

# 正規表現にマッチすることを検証
expect("email@example.com").to match(/\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i)

これらのマッチャーを適切に組み合わせることで、様々な状況や条件をテストすることができます。また、これらのマッチャーの多くは否定形（not_to）でも使用できます。

before, let, subjectの使い方

before,let,subjectはテストコードを書く際によく使われるDSL（ドメイン特化言語）です。それぞれの使い方を詳しく説明します。

before

beforeブロックは各テストが実行される前に実行されるセットアップコードを定義します。これにより、同じセットアップコードを繰り返し書く必要がなくなります。

RSpec.describe User, type: :model do
  before do
    @user = User.new(name: "Alice", age: 30)
  end

  it "has a valid name" do
    expect(@user.name).to eq("Alice")
  end

  it "has a valid age" do
    expect(@user.age).to eq(30)
  end
end

beforeブロックには以下の2種類があります。

:each（デフォルト）：各テストの前に実行される
:all：すべてのテストの前に一度だけ実行される

RSpec.describe User, type: :model do
  before(:each) do
    # 各テストの前に実行
  end

  before(:all) do
    # すべてのテストの前に一度だけ実行
  end
end

let

letは遅延評価されるヘルパーメソッドを定義します。必要なときに初めて値が評価され、その後はキャッシュされます。これにより、パフォーマンスが向上し、無駄な計算が避けられます。

RSpec.describe User, type: :model do
  let(:user) { User.new(name: "Alice", age: 30) }

  it "has a valid name" do
    expect(user.name).to eq("Alice")
  end

  it "has a valid age" do
    expect(user.age).to eq(30)
  end
end

let!を使うと、明示的にその時点で値を評価します。テストの前に必ず実行されることを保証したい場合に使用します。

RSpec.describe User, type: :model do
  let!(:user) { User.create(name: "Alice", age: 30) }

  it "has a valid name" do
    expect(user.name).to eq("Alice")
  end

  it "has a valid age" do
    expect(user.age).to eq(30)
  end
end

subject

subjectはテストの対象となるオブジェクトを定義します。itブロック内で省略形として使うことができます。デフォルトで名前付きsubjectが提供されるので、特定のオブジェクトに名前を付けたい場合に便利です。

RSpec.describe User, type: :model do
  subject { User.new(name: "Alice", age: 30) }

  it "has a valid name" do
    expect(subject.name).to eq("Alice")
  end

  it "has a valid age" do
    expect(subject.age).to eq(30)
  end
end

名前付きsubjectを定義することもできます。

RSpec.describe User, type: :model do
  subject(:user) { User.new(name: "Alice", age: 30) }

  it "has a valid name" do
    expect(user.name).to eq("Alice")
  end

  it "has a valid age" do
    expect(user.age).to eq(30)
  end
end