環境
Mac 11.0.1
Ruby 2.6.5
Rails 6.0.0
bundlerを使用
テストで使うgem
rspec-rails 4.0.0
factory_bot_rails 6.1.0
faker 2.16.0
タイトルの通り、RSpecによるモデル単体テストの一連の流れを紹介しています。技術的なことに関しては書いていません。ご了承ください。
目次
- gemの導入
- FactoryBotを作成する
- ファイルを作成しテストコードを記述する
- テストを実行する
- まとめ
- 今回の気づき
gemの導入
まずは、Gemfileを開きテストで使うgemを追記します。
上記のgemをgroup :development, :test do~endのなかに記載しましょう。
group :development, :test do
# Call 'byebug' anywhere in the code to stop execution and get a debugger console
gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
gem 'rspec-rails', '~> 4.0.0' ←追記
gem 'factory_bot_rails' ←追記
gem 'faker' ←追記
end
必要なら、pry-railsも導入します。
Gemfileの一番後ろに追記します。
gem "pry-rails" ←追記
pry-railsはデバッグツールの一つで、作業の際にバグの有無を確認したり、処理を止めてソースコードが正しいかを確認できるものです。'binding.pry'という記述をすると処理を止めてコンソールを起動します。
(参考記事：デバックツール(pry-rails)について binding.pryの使い方)
次にターミナルでbundle installを実行します。
% bundle install
次に、RSpecをインストールします。
ターミナルでrails g rspec:installを実行します。
% rails g rspec:install
これにより以下のファイルやディレクトリが作成されます。
.rspec ファイル
spec ディレクトリ
spec/spec_helper.rb ファイル
spec/rails_helper.rb ファイル
次に、テストの結果をターミナルで可視化するために.rspecに--format documentationを追記します。
--require spec_helper
--format documentation ←追記
これで準備は終了です。次は、ファクトリーを作成します。
FactoryBotを作成する
FactoryBotとは、簡単に言えばモデルのインスタンスを簡単に作成できるようにするものです。
それではファイルを作成しましょう。
ターミナルでrails g rspec:model モデル名を実行します。今回モデル名はuserにしておきます。モデル名は単数系で書くようにしましょう。
% rails g rspec:model user
実行すると以下のファイルやディレクトリが作成されます。
spec/models ディレクトリ
spec/models/user_spec.rb ファイル
spec/factories ディレクトリ
spec/factories/users.rb ファイル
もしこの時にfactory_bot_railsを導入していなければ、spec/factoriesとspec/factories/users.rbは作成されません。
factory_bot_railsをテストコード作成後に導入した場合は、自分でディレクトリとファイルを作成する必要があります。また、自分でfactoryを作成する時はモデル名の複数形.rbの名前で作成しましょう。
spec/models/user_spec.rbは後で見ていきます。最初に作成されたspec/factories/users.rb の中身を見てみましょう。
FactoryBot.define do
factory :user do
end
end
facory :user do ~ endの中に記述をしていきます。書き方は簡単でカラム名 {値}と書けば、指定したカラムに値を設定することができます。今回のuserテーブルの設計は次のようにしておきます。
| Column | Type | Option |
|---|---|---|
| nickname | string | null: false |
| string | null: false, unique: true | |
| password | string | null: false |
spec/models/user_spec.rbに以下のように追記しましょう。 |
FactoryBot.define do
factory :user do
nickname {"アプリ君"}
email {Faker::Internet.email}
password {"password"}
end
end
今回、emailに対してFakerを使用しました。Fakerは特定の値をランダムで出力してくれるGemです。Faker::Internet.emailはemailっぽい文字列を出力してくれます。
詳しくはFakerのGitHubをご覧ください。
これでfactoryBotの作成は完了です。
ファイルを作成しテストコードを記述する
次に、実際にテストコードを書いていきます。
先ほど作成されたspec/models/user_spec.rbに記述していきます。作成時には以下のような記述がデフォルトで存在します。
require 'rails_helper'
RSpec.describe User, type: :model do
pending "add some examples to (or delete) #{__FILE__}"
end
RSpec.describe User, type: :model do ~ endのなかに記述していきます。今回は、モデル単体テストの一連の流れの記事なので、マッチャなどに関しては触れずに進めたいと思います。完成系は以下のようになります。
require 'rails_helper'
RSpec.describe User, type: :model do
before do
@user = FactoryBot.build(:user)
end
describe "ユーザー管理機能" do
context "ユーザーの新規登録ができるとき" do
it "情報が正しければ新規登録できる" do
expect(@user).to be_valid
end
end
context "ユーザーの新規登録ができないとき" do
it "nicknameが空では新規登録できない" do
@user.nickname = ""
@user.valid?
expect(@user.errors.full_messages).to include("Nickname can't be blank")
end
it "emailが空では新規登録できない" do
@user.email = ""
@user.valid?
expect(@user.errors.full_messages).to include("Email can't be blank")
end
it "passwordが空では新規登録できない" do
@user.password = ""
@user.valid?
expect(@user.errors.full_messages).to include("Password can't be blank")
end
end
end
end
モデルにはバリデーションの記述をするのを忘れないようにしましょう。
テストを実行する
最後にテストを実行します。
ターミナルで以下を実行しましょう。
% bundle exec rspec spec/models/user_spec.rb
緑で表示されているなら、テスト成功です。赤で表示されているところはテストが失敗しているところなので、機能がしっかり実装できていないかテストコードが間違っている可能性があります。
まとめ
モデル単体テストの一連の流れをまとめると
- gemの導入
- factoryを記述
- テストコードを記述
- ターミナルで実行
今回の気づき
今回、記事で書いたことを確かめるために
- 新規にアプリケーション作成
- テストに必要なgemを導入
-
rails g model userでモデルを作成
という順番で実行した結果、3のモデル作成時にspec/models/user_spec.rbとspec/factories/users.rbも一緒に作成されることが判明しました。
もし、アプリケーション完成後にテストを実行する予定があるなら、アプリ新規作成直後にテストに必要なgemを導入しておくのもいいかもしれません。rails g rspec:model ~~をする必要がなくなります。
何か間違っているところなどがございましたら、ご指摘いただけると嬉しいです。