Capybaraとは？意味をわかりやすく簡単に解説

text: XEXEQ編集部

Capybaraとは
Capybaraを使ったテストの記述方法
Capybaraの基本的な使い方
Capybaraでページ上の要素を指定する方法
Capybaraでユーザーアクションをシミュレートする方法
Capybaraでのテストの実行とデバッグ
Capybaraを使ったテストの実行方法
Capybaraのテスト実行時のオプション
Capybaraを使ったテストのデバッグ方法
Capybaraのドライバーとその特徴
Rack::Testドライバーの特徴と使い方
Selenium WebDriverの特徴と使い方
Capybara-webkitの特徴と使い方

Capybaraとは

CapybaraはRubyで書かれたWebアプリケーションのテスト自動化フレームワークです。Capybaraを使用することで、Webアプリケーションのユーザーインターフェースを介した操作をシミュレートし、アプリケーションの動作を検証できます。

CapybaraはRSpecやMinitest等のテストフレームワークと組み合わせて使用されることが多いです。Capybaraを使用することで、JavaScriptを含むWebアプリケーションに対しても容易にテストを記述することができるようになります。

Capybaraは複数のドライバーをサポートしています。デフォルトではRack::Testドライバーが使用されますが、Selenium WebDriverやCapybara-webkitなどのドライバーを使用することもできます。ドライバーを切り替えることで、テスト実行環境を柔軟に変更できるのが特徴です。

Capybaraではページ上の要素を簡単に指定することができます。find、all、has_css、has_content等のメソッドを使用して、CSSセレクタやXPathでページ上の要素を指定し、クリックやフォーム入力等のアクションを実行できます。

CapybaraはWebアプリケーションのテスト自動化において非常に強力なツールです。Capybaraを使用することで、ユーザーの操作をシミュレートしたリアルなテストを実現できるため、アプリケーションの品質向上に大きく貢献するでしょう。

Capybaraを使ったテストの記述方法

Capybaraを使ったテストの記述方法に関して、以下3つを簡単に解説していきます。

Capybaraの基本的な使い方
Capybaraでページ上の要素を指定する方法
Capybaraでユーザーアクションをシミュレートする方法

Capybaraの基本的な使い方

Capybaraを使ったテストを記述するにはまずCapybaraをインストールする必要があります。Gemfileに gem 'capybara' を追加し、 bundle install コマンドを実行することでインストールできます。インストール後、テストファイルでCapybaraを require します。

RSpecでCapybaraを使用する場合、 spec/spec_helper.rb や spec/rails_helper.rb に以下のように記述します。これにより、全てのテストファイルでCapybaraを使用できるようになります。

require 'capybara/rspec'

Capybaraでページ上の要素を指定する方法

Capybaraでは find メソッドや all メソッドを使用して、ページ上の要素を指定することができます。これらのメソッドにはCSSセレクタやXPathを引数として渡します。例えば、以下のようにCSSセレクタを使用して要素を指定できます。

find('#user_name').set('John Doe')
all('.checkbox').each { |checkbox| checkbox.check }

また、 has_css? メソッドや has_content? メソッドを使用することで、ページ上に特定の要素やコンテンツが存在するかどうかを判定することもできます。これらのメソッドはテストのアサーションとして使用されることが多いでしょう。

Capybaraでユーザーアクションをシミュレートする方法

Capybaraでは click_on メソッドや fill_in メソッドを使用して、ユーザーのアクションをシミュレートすることができます。例えば、以下のようにボタンのクリックやフォームへの入力を行うことができます。

click_on 'Sign in'
fill_in 'Email', with: 'user@example.com'
fill_in 'Password', with: 'password'
click_button 'Log in'

また、 select メソッドを使用して、セレクトボックスの選択を行ったり、 attach_file メソッドを使用してファイルのアップロードをシミュレートしたりすることもできます。これらのメソッドを組み合わせることで、様々なユーザーアクションをテストに含めることが可能です。

Capybaraでのテストの実行とデバッグ

Capybaraでのテストの実行とデバッグに関して、以下3つを簡単に解説していきます。

Capybaraを使ったテストの実行方法
Capybaraのテスト実行時のオプション
Capybaraを使ったテストのデバッグ方法

Capybaraを使ったテストの実行方法

Capybaraを使ったテストは通常のRSpecやMinitestのテストと同様に実行することができます。RSpecの場合は rspec コマンド、Minitestの場合は rake test コマンドを使用して、テストを実行します。テストファイルを指定して実行することも可能です。

また、Capybaraでは driven_by メソッドを使用して、テスト実行時に使用するドライバーを指定することができます。デフォルトではRack::Testドライバーが使用されますが、必要に応じてSelenium WebDriverやCapybara-webkitなどのドライバーに切り替えることができるでしょう。

Capybaraのテスト実行時のオプション

Capybaraではテスト実行時に様々なオプションを指定することができます。例えば、 default_max_wait_time オプションを使用することで、要素が見つかるまでの最大待ち時間を設定できます。以下のように、 spec/spec_helper.rb や spec/rails_helper.rb で設定します。

Capybara.default_max_wait_time = 5

また、 app_host オプションを使用することで、テスト対象のアプリケーションのURLを指定することもできます。これにより、テスト実行時にアプリケーションのURLを変更することなく、テストを実行できるようになります。

Capybaraを使ったテストのデバッグ方法

Capybaraを使ったテストをデバッグする際には save_and_open_page メソッドや save_and_open_screenshot メソッドが役立ちます。これらのメソッドを使用することで、テスト実行中の任意の時点でページのHTMLソースやスクリーンショットを保存し、確認することができます。

また、 puts メソッドを使用して、テスト実行中の変数の値を出力することもデバッグに有効です。Capybaraのメソッドが期待通りに動作しない場合、 puts メソッドでページの状態を確認しながらテストを進めていくと良いでしょう。