はじめに

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

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

CI/CDパイプラインへの統合

RSpecをCI/CDパイプラインに統合することで、コードの品質を継続的に確認し、問題を早期に発見することができます。ここでは、GitHub ActionsでのRSpecの実行と、SimpleCovを使ったテストカバレッジの計測について説明します。

GitHub ActionsでのRSpec実行

GitHub Actionsは、GitHubリポジトリに対するイベントに応じてワークフローを自動化するためのツールです。ここでは、RSpecテストを実行するための基本的なワークフローの設定方法を説明します。

GitHubリポジトリにワークフローファイルを作成

GitHubリポジトリのルートに .github/workflowsフォルダを作成し、その中にci.ymlというファイルを作成します。

ci.ymlの設定

ci.ymlファイルに以下の内容を記述します。

.github/workflows/ci.yml

name: CI

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  test:
    runs-on: ubuntu-latest

    services:
      postgres:
        image: postgres:latest
        ports:
          - 5432:5432
        env:
          POSTGRES_USER: postgres
          POSTGRES_PASSWORD: password
        options: >-
          --health-cmd pg_isready
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5

    steps:
    - name: Checkout code
      uses: actions/checkout@v2

    - name: Set up Ruby
      uses: ruby/setup-ruby@v1
      with:
        ruby-version: 3.0

    - name: Install dependencies
      run: bundle install

    - name: Set up database
      run: |
        cp config/database.yml.ci config/database.yml
        bin/rails db:create
        bin/rails db:schema:load

    - name: Run tests
      run: bin/rspec

テストカバレッジの計測（SimpleCov）

SimpleCovは、Rubyプログラムのテストカバレッジを計測するためのツールです。以下の手順でRSpecと統合し、テストカバレッジを計測します。

SimpleCovのインストール

GemfileにSimpleCovを追加し、bundle installを実行します。

Gemfile

group :test do
  gem 'simplecov', require: false
end

RSpecとの統合

spec/spec_helper.rbまたはspec/rails_helper.rbに以下のコードを追加します。

spec/spec_helper.rb または spec/rails_helper.rb

require 'simplecov'
SimpleCov.start 'rails' do
  add_filter '/spec/'
end

RSpec.configure do |config|
  # ...
end

GitHub Actionsでのテストカバレッジレポートの生成

GitHub Actionsのワークフローファイルにテストカバレッジの生成を追加します。

.github/workflows/ci.yml

name: CI

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  test:
    runs-on: ubuntu-latest

    services:
      postgres:
        image: postgres:latest
        ports:
          - 5432:5432
        env:
          POSTGRES_USER: postgres
          POSTGRES_PASSWORD: password
        options: >-
          --health-cmd pg_isready
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5

    steps:
    - name: Checkout code
      uses: actions/checkout@v2

    - name: Set up Ruby
      uses: ruby/setup-ruby@v1
      with:
        ruby-version: 3.0

    - name: Install dependencies
      run: bundle install

    - name: Set up database
      run: |
        cp config/database.yml.ci config/database.yml
        bin/rails db:create
        bin/rails db:schema:load

    - name: Run tests
      run: bin/rspec

    - name: Upload coverage to Codecov
      uses: codecov/codecov-action@v1
      with:
        file: ./coverage/.resultset.json