Ruby
Rails
RubyMine

RubymineでRailsのテストをデバッグする

More than 3 years have passed since last update.

RailsやRubyでの開発で、vimからRubymineに切り替えて数ヶ月が経ちました。エディタのサポート機能では正直「それvimでもできるよ」ということが多いのですが、さすがにRubymineはIDEということもあり、デバッガについてはvimよりも手軽に、かつ使いやすい仕上がりになっています。本記事ではRubymineを使ってRailsのテストをデバッグする場合の基本的な使い方についてまとめてみます。


ブレークポイントを使ったデバッグ

IDEを使わない場合、Railsでのデバッグはpryやデバッグログを見るということが中心になっているかと思いますが、IDEを利用する開発では「デバッガでブレークポイントを設定して見たい箇所で止める」というのが基本的なフローでは無いかなと思います。Rubymineでも、ブレークポイントを使ってIDE上でより簡単にデバッグが可能です。

今回は簡単なデモ用にRailsを使って新規プロジェクトを作りました。このプロジェクトではminitest-railsを使い、Bookというモデルを作成してあります。このminitest-railsが自動的に作ったテストを使って説明をしていきます。


gemの追加

rails new でプロジェクトを作成したら、Rubymineでデバッガを動作させるのに必要なgemをGemfileに追記して、bundle installを走らせます。

  gem 'ruby-debug-ide'

gem 'debase'

今回はminitest-railsを使っているので、そちらもGemfileに追記し、rails g minitest:installを実行してminitestを利用可能にしておきましょう。


デバッガ設定の選択

ここからデバッガの設定になります。まずはデバッガを走らせるための設定をします。メニューから Debug... を選択します。

01_debugger_menu.png

すると、以下のようなポップアップメニューがでてきます

02_choose_debugger_setting.png

RubymineはRailsプロジェクトの場合、自動的にtestとspec用の設定が行われていますので、test:で始まるタスクを選択します。これでデバッガ設定は完了で、以後は Debug... ではなく、Debugをメニューバーから選択することで実行が可能です。なお、このコマンドにはデフォルトで Control + D がショートカットキーとして割り当てられていますので、活用しましょう。


テストの実行とブレークポイントによる中断

今回はデバッガの使い方に関するデモが目的なので、rails g model Book title:string して出来ただけのシンプルなモデルのテストを使います。無意味にlistという配列を定義していますが、これについてはデバッガ実行中の画面で説明します。

03_test.png

上のスクリーンショットで13行目の行番号右側に赤い丸がついていますが、これがブレークポイントです。行番号の右側をマウスでクリックすることでブレークポイントをつけることができます。テストを実行してここを通ると、自動で実行が中断され、その時点でのプログラムに関する情報を見ることができます。


デバッガの実行

ここでDebugコマンドを走らせます。すると、Rubymineの画面下部にデバッグウィンドウが表示されます。

05_stop_at_breakpoint.png

デバッグウィンドウには4つのタブがあります。上記スクリーンショットで表示されているDebuggerタブには、左から順にスタックフレーム、停止されたスコープで参照できる変数、ウォッチ式の3つが表示されています。また、このデバッガ実行時にコードを見てみると、list変数の右側に実行時の値が自動的に表示されているのが分かります。単純にインスタンス変数等の中身を確認したいだけであれば、この画面だけでも十分かもしれません。オブジェクトの中身を見たい場合はデバッグウィンドウのVariablesを利用しましょう。


Watch式

複数の変数の値を同時に見たい場合は、Watch式を入力しておくと便利です。Watch式はDebuggerタブで一番右にあるエリアで、ここに入力した式はプログラムの実行停止時に自動的に評価されて値が表示されます。

07_watches.png

Watch式の入力中には補完も効きます。typo等で存在しないメソッドをwatchするということを避けられていいですね。

08_completion_for_watch_statement.png


Interactive console

Rubymineでも、pryのように停止した箇所でコードを実行することができます。デバッグウィンドウで Interactive consoleタブを選択すると、コンソールが開くので、そこで必要なコマンドを実行しましょう。ただし、日本語の入力や表示は文字が長くなるとうまく動かないケースがあるようです。

06_interactive_console.png


テスト実行ログの確認

log/test.log にはテスト実行時のログが記載されます。普段はそれほど見ないファイルではないかと思いますが、デバッグに手間取った際にデバッグメッセージを仕込んでそれを確認したい場合や、ActiveRecordが投げたSQLの確認に利用すると便利です。テスト実行ログはデバッグウィンドウの Test Logタブで確認できます。

10_test_unit_log.png


その他の機能

他にもRubymineにはステップ実行や、ブレークポイントではなく、指定した例外が発生したときに停止する機能などもあります。

また、今回はテストのデバッグを取り上げましたが、RubyMineでPowを使いながらDebugする方法もあります。複数プロジェクトの開発を同じMac上で行おうとする場合、Powを使うと管理がしやすいため、Powと組み合わせて使えるのは大きなメリットですね。