【Rails】Capybaraのfill_inメソッドを実行すると「既存レコードの内容+指定した内容」がセットされる事象の原因と対処【RSpec】

はじめに

RSpec + Capybaraを使用して、Railsアプリの統合テストを実装しています。とあるモデルの編集画面において、入力フォームの内容を書き換えた上で送信し、レコードが更新されることを確認します。

入力フォームの内容を書き換えるにはCapybaraのfill_inメソッドを使います。

fill_in 'ラベル', with: '書き換える内容'

今回は編集画面のため、画面にアクセスした時点で既存レコードの内容がセットされています。fill_inメソッドが実行されると、既存レコードの内容は削除され、withで指定した内容に書き換えられます。

しかし、条件は不明ですが、指定した内容で書き換えられるのではなく、既存レコードの内容+指定した内容がセットされるという事象に遭遇しました。

今回は、fill_inメソッドを実行すると既存レコードの内容+指定した内容がセットされる事象の原因と対処について記載します。

  • Capybara 3.33.0
  • Selenium-WebDriver 3.142.7

既存レコードの内容+指定した内容がセットされる

事象

事象が発生したコードは以下のようになります。

_form.html.erb

<%= form.label, :field_1, 'フィールド1' %>
<%= form.text_field :field_1%>

<%= form.label, :field_2, 'フィールド2' %>
<%= form.text_field :field_2%>

feature_spec.rb

fill_in 'フィールド1', with: 'updated_field_1'
fill_in 'フィールド2', with: 'updated_field_2'

特筆すべきこともない、いたってシンプルでオーソドックスなコードかと思います。編集画面のため、画面にアクセスした時点でフィールド1およびフィールド2には既存レコードの内容がセットされており、それをfill_inメソッドで書き換えようとしたのですが、フィールド2は想定通り指定した内容で書き換えられましたが、なぜかフィールド1だけ既存レコードの内容+指定した内容がセットされてしまいました。

対象フィールド fill_in実行前 fill_in実行後
フィールド1 (既存レコードの内容) (既存レコードの内容)updated_field_1
フィールド2 (既存レコードの内容) updated_field_2

原因

おそらく、Capybaraのバグではないかと思います。以下のIssueで言及されています(Capybaraのリポジトリではないですが)。以下のIssueにおいて、NGMarmaduke氏が原因と思われる該当コードを特定しています。

対処

上記のIssueに書いてありますが、fill_inメソッドにfill_options: { clear: :backspace }オプションを追加することで、指定した内容で書き換えられるようになります。その他、直前で空文字をセットするとか、バックスペースキーを入力するとかいくつか対処法があるようですが、一行で書ける方法がエレガントでいいと思います。

feature_spec.rb

# オプション指定
fill_in 'フィールド1', with: 'updated_field_1', fill_options: { clear: :backspace }

# 直前で空文字をセット
fill_in 'フィールド1', with: ''
fill_in 'フィールド1', with: 'updated_field_1'

# 直前でバックスペースキーを入力
find('フィールド1').send_keys :backspace
fill_in 'フィールド1', with: 'updated_field_1'

まとめ

今回は、fill_inメソッドを実行すると既存レコードの内容+指定した内容がセットされる事象において、その原因と対処法について記載しました。

本事象については2016年2月にIssueで言及されているにもかかわらず、未だにCapybaraで対処されていない(たぶん)ことを鑑みると、バグではないのかもしれません。ただ、私の環境では事象が発生する条件がわからなかったので、事象が発生した場合は本記事の通り対処する必要があります。

本記事の内容を参考にしていただければと思います。

関連記事

【Rails】RSpecを使った自動テスト《システムスペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 17:07
【Rails】RSpecを使った自動テスト《リクエストスペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 16:06
【Rails】RSpecを使った自動テスト《コントローラースペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 15:39
【Rails】RSpecを使った自動テスト《モデルスペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 11:50
【Rails】RSpecを使った自動テスト《基本編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月10日 17:49
【Rails】デザインパターン「Concern」の基本情報と実装方法
# はじめに Ruby on RailsなどのMVCフレームワークで構築したWebシステムにはアンチパターンというものが存在します。システム開発におけるアンチパターンとは、避けるべき悪い設計や実装方法のことを指します。 MVCフレームワーク [...]
2024年7月10日 13:32
【Rails】デザインパターン「Form Object」の基本情報と実装方法
# はじめに Ruby on RailsなどのMVCフレームワークで構築したWebシステムにはアンチパターンというものが存在します。システム開発におけるアンチパターンとは、避けるべき悪い設計や実装方法のことを指します。 MVCフレームワーク [...]
2024年7月6日 22:50
【Rails】デザインパターン「Service Object」の基本情報と実装方法
# はじめに Ruby on RailsなどのMVCフレームワークで構築したWebシステムにはアンチパターンというものが存在します。システム開発におけるアンチパターンとは、避けるべき悪い設計や実装方法のことを指します。 MVCフレームワーク [...]
2024年7月6日 19:59