はじめに
Ruby のテストフレームワーク Fix の 1.0 をリリースしました。筆者が 2014 年から開発している gem で、今回が最初の安定版です。
Fix の考え方は RFC 2119 から来ています。仕様(specification)は、対象が何を MUST / SHOULD / MAY するかを書くもので、対象がどう作られているかは書きません。 仕様を書いたら、任意の対象をそれに対してテストします。
この記事では、Fix を Rails アプリの中でどう使うかを紹介します。例として小さなマイクロブログ fixrb/microblog を使います。ハンドルを決めて、短い投稿をして、互いにフォローして、タイムラインを読むアプリで、テストフレームワークは Fix だけです。
Fix とは
まず Rails 抜きで、Fix のファイルがどんなものかを見てください。
# duck_fix.rb
require "fix"
class Duck
def walk = "Klop klop!"
def swim = "Swoosh..."
end
Fix :Duck do
on :walk do
it MUST eq "Klop klop!"
end
on :swim do
it MUST eq "Swoosh..."
end
on :speak do
it MAY eq "Quaaaaaack!"
end
end
exit(Fix[:Duck].test { Duck.new })
minitest と同じく、ただの Ruby ファイルです。ruby duck_fix.rb で実行できます(出力は Ruby 3.4 以降のものです)。
duck_fix.rb:11: Success: expected "Klop klop!" to eq "Klop klop!"
duck_fix.rb:15: Success: expected "Swoosh..." to eq "Swoosh..."
duck_fix.rb:19: Info: NoMethodError: undefined method 'speak' for an instance of Duck
このアヒルには speak メソッドがありませんが、それは MAY なので許されます。同じ行が MUST なら Error になり、終了ステータスは 1 です。SHOULD が満たされなければ Warning で、Warning は通ります。つまり結果は 2 種類ではなく 5 種類(Success / Warning / Info / Failure / Error)あり、ステータスを 1 にするのは Failure と Error だけです。
複数のファイルにまたがるテストは、gem fix-command が提供する fix コマンドで実行します。RSpec の rspec コマンドと同じ位置づけで、fix/ 以下の *_fix.rb を 1 ファイル 1 プロセスで順に実行し、すべてのファイルが満たされたときだけステータス 0 を返します。
Rails アプリでの使い方
Gemfile
fix と fix-command は test グループに require: false で入れます。Rails は起動時に環境のグループの gem を require しますが、Fix を必要とするファイルが自分で require "fix" するので、アプリが Fix を読み込むことはありません。
group :test do
gem "fix", require: false
gem "fix-command", require: false
end
ファイル配置
モデルやコントローラの仕様は、Rails のことを何も知りません。eq 302、eq ["Body can't be blank"] と書くだけです。そこでこのアプリでは、仕様とテストをファイルごと分けています。
-
spec/:仕様。1 ファイルにFix :Name do … endを 1 つ。require "fix"以外は何も require しません。Rails も、DB も、仕様の対象となるクラスさえもです。 -
fix/:テスト。fixコマンドが実行するファイルです。対象に必要なものを読み込み、仕様を require して、exit(Fix[:Name].test { … })で終わります。ブロックが対象を組み立てます。
こうすると、結果の各行は仕様のほうの行を指します。もちろん 1 つのファイルに両方を書いても構いません。すでに RSpec が spec/ を使っているなら、仕様は fix/specs/ などに置けばよいでしょう。
アプリを読み込むヘルパー
モデルとコントローラのテストは fix/support/rails.rb を共有します。名前が _fix.rb で終わらないので、fix コマンドがこのファイルを直接実行することはありません。
# fix/support/rails.rb
ENV["RAILS_ENV"] = "test"
require_relative "../../config/environment"
require "rack/test"
ActiveRecord::Migration.maintain_test_schema!
def empty_database
Follow.delete_all
Post.delete_all
User.delete_all
end
def browser(as: nil)
visitor = Rack::Test::Session.new(Rails.application)
visitor.post("/session", handle: as) if as
visitor
end
やっていることは 4 つです。
-
RAILS_ENVを test に強制します。テストは DB を空にするので、シェルがRAILS_ENV=developmentを export していても、development の DB に向かわせるわけにはいきません。 - アプリを起動し、
maintain_test_schema!で test の DB をdb/schema.rbに合わせます。rails/test_helpが minitest に対してしていることと同じです。 - Fix は期待ごとに対象を作り直し、コンテキストごとに子プロセスを fork します。子は親のコピーとして始まりますが、Active Record は fork 後の子で親のコネクションプールを捨て、必要になったときに自分で接続し直します。一方で DB はプロセスの外にあり、対象が書いたものを保持するので、対象はまず DB を空にします。トランザクションで包むことも、ロールバックすることもありません。
- コントローラ用のブラウザを定義します。アプリに対する
Rack::Test::Sessionで、Cookie を持ち、ハンドルを渡せばサインイン済みになります。リクエストはRack::MockResponseを返し、status、body、locationが読めます。
2 つのメソッドはトップレベルに定義しています。対象のブロックからは、Kernel のメソッドと同じように見えます。なお、こうして定義した名前は let の名前には使えなくなります。
モデル
投稿には本文があり、空ではいけず、280 文字を超えてもいけません。仕様 spec/models/post_spec.rb は、それをレコードのメソッド valid?、errors、mentions の言葉で書きます。本文はパラメータです。
# spec/models/post_spec.rb
require "fix"
Fix :Post do
let(:body) { "Good morning, @bob and @carol." }
on :valid? do
it MUST be_true
end
on :mentions do
it MUST eq %w[bob carol]
end
with body: "" do
on :valid? do
it MUST be_false
end
on :errors do
on :full_messages do
it MUST eq ["Body can't be blank"]
end
end
end
with body: "a" * 281 do
on :valid? do
it MUST be_false
end
on :errors do
on :full_messages do
it MUST eq ["Body is too long (maximum is 280 characters)"]
end
end
end
end
テスト fix/models/post_fix.rb は、その本文でユーザーの投稿を作り、errors が埋まるように validate します。
# fix/models/post_fix.rb
require_relative "../support/rails"
require_relative "../../spec/models/post_spec"
exit(Fix[:Post].test do
empty_database
User.create!(handle: "alice").posts.new(body:).tap(&:validate)
end)
ユーザーはブロックの中で、期待ごとに、空にしたばかりの DB に作ります。テストに必要なレコードは対象と同じ場所で作り、ファイルの外側では作りません。外側は親プロセスで 1 回しか走らないからです。
コントローラ
コントローラのテストの対象はレスポンスです。仕様 spec/controllers/posts_spec.rb は、サインイン済みの訪問者とそうでない訪問者について、status、location、body を判定します。
# spec/controllers/posts_spec.rb
require "fix"
Fix :CreatePost do
let(:handle) { "alice" }
let(:body) { "Hello, world!" }
on :status do
it MUST eq 302
end
on :location do
it MUST eq "http://example.org/"
end
with body: "a" * 281 do
on :status do
it MUST eq 422
end
on :body do
it MUST match(/Body is too long/)
end
end
with handle: nil do
on :status do
it MUST eq 302
end
on :location do
it MUST eq "http://example.org/session/new"
end
end
end
テスト fix/controllers/posts_fix.rb は、ユーザーを作り、ハンドルでサインインし、本文を POST して、レスポンスを渡します。
# fix/controllers/posts_fix.rb
require_relative "../support/rails"
require_relative "../../spec/controllers/posts_spec"
exit(Fix[:CreatePost].test do
empty_database
User.create!(handle: "alice")
browser(as: handle).post("/posts", post: { body: })
end)
Rack::Test のリクエストのホストは example.org なので、location はそのようになります。サインインも、訪問者がするのと同じく、サインインフォームが送るリクエストを送ることで行います。このアプリではハンドルだけでサインインでき、パスワードはありません。
実行
bin/rails db:prepare
bundle exec fix
fix は fix/ のファイルを 1 つずつ別プロセスで実行し、各プロセスがアプリを 1 回起動します。実行時間の大半はそこにかかります。各行は spec/ の期待を指し、すべてのファイルが満たされればステータスは 0 です。
minitest / RSpec と違うところ、そのトレードオフ
-
コンテキストごとに fork します。 期待を持つ
onやwithはそれぞれ独立したプロセスで、対象は期待ごとに作り直されます。対象が残したものは次のコンテキストに届きません。テスト対象のコードがexitしても、その期待の Error になるだけです。 - トランザクショナルフィクスチャはありません。 DB はプロセスの外にあるので、対象が毎回 DB を空にして、必要な行をブロック内で作ります。ロールバックはしないので、DB にあるものはコードが書いたものそのままです。考えることは減りますが、一般にロールバックより遅くなります。
- 1 ファイル 1 プロセスで、アプリを起動します。 時間はそこにかかります。
-
出力は素のテキストです。 期待ごとに
file:line: Outcome: summaryが 1 行。色も、ドットも、集計もありません。判定は終了ステータスで行います。 - Fix が持っていないもの。 システムテスト、並列ワーカー、フィクスチャやファクトリは、Fix 自身にはありません。Fix のファイルはただの Ruby なので、既存のテストスイートの隣に置けます。どちらかを選ぶ必要はありません。
-
fork(2)が必要です。 Linux、macOS、BSD で動きます。Windows と JRuby では動きません。Ruby は 3.3 以上です。
まとめ
Fix の仕様は、対象が何をすべきかを MUST / SHOULD / MAY で書き、Rails のことは何も知りません。Rails アプリでは、アプリを読み込んで DB を空にするヘルパーが 1 つあれば、モデルもコントローラも同じ形でテストできます。
ガイドの該当ページ(ヘルパーの全文とコメント付き):https://fixrb.dev/gems/fix/v1/in-a-rails-application/
ガイドの最初から読むなら:https://fixrb.dev/gems/fix/v1/
ロールバックではなく DB を空にするというやり方をどう感じるか、コメントで聞かせてもらえると嬉しいです。