意図せず外部へのネットワークアクセスをしているテストを、WebMockを使って徐々に外部アクセスを減らす話

最近担当しているRubyのプロジェクトで、テスト実行中に外部のサービスに意図せずアクセスしている（たとえばexamle.comへGETリクエストしていたなど）ケースがあった。これはまずいなと思い、WebMockを使って徐々に外部アクセスを減らしていっているので、その話を書く。

課題: テスト中に意図しない外部アクセスがある

現在のプロジェクトではWebMock gemを使って外部へアクセスしないようにモックしながらテストをしていた。しかしWebMockを、外部アクセスするメソッドのテストをする時だけWebMock.enable!し、終わったらWebMock.disable!するとしていた。つまり必要に思った時だけ以下のようなコードを使い、外部アクセスしないようにしていた。

around do |e|
  WebMock.enable!
  e.run
  WebMock.disable!
end

このやり方は非常に悪い。なぜなら自分は外部アクセスしていないと思っていたが実装上は外部アクセスしている場合、モックを忘れてしまい、テスト中に意図しない外部アクセスを作ってしまうからだ。とくに他のライブラリを使って開発をしているときに、内部実装をすべて理解していないと、このケースを作りやすい。

このような事態を防ぐため、基本的にテスト中は外部アクセスを絶対できないようにしておきつつ、本当に必要な場合だけ許可するという作戦にしておいた方が良い。WebMock + rspecの標準のやり方もこのようになっている。

解決のための作戦: まずは意図しない外部アクセスを新しく作れないようにし、その後既存の外部アクセスをなくす

解決のためにどうするか。2段階に分けて解決する。

意図しない外部アクセスを新しく作れないようにする。既存の外部アクセスは通すようにする
既存の外部アクセスを潰していく

意図しない外部アクセスを新しく作れないように

すべての外部アクセスを潰す手を打つ前に、意図せず外部アクセスをしてしまうという状況をこれ以上作れないようにした方が良い。そうでなければイタチごっこになり得る。とにかく素早く新しい外部アクセスを作れないようにしよう。

WebMockには、外部アクセスをできないようにするが特定のリクエストは許可するというコードが書ける。これを利用する。たとえば既存のコードに意図せずexample.comとmaps.googleapis.comへのアクセスがあったとして、そのリクエストは貫通させつつ、他のリクエストは通さないようにするにはspec/spec_helper.rbに以下のように記述する。

require 'webmock/rspec'

RSpec.configure do |config|
  config.before(:suite) do
    # テスト時にアクセスしても良い外部サイトを定義
    WebMock.disable_net_connect!(
      # localhostにはアクセスしていい
      allow_localhost: true,
      allow: [
        # capybaraがアクセスしている
        'chromedriver.storage.googleapis.com',
        # TODO(webmock): 以下は必ずstubしたい
        'example.com',
        'maps.googleapis.com',
      ],
    )
  end
end

既存のコードでどのような外部アクセスがあるかは、require 'webmock/rspec'を有効にした上で、テストのlogをファイルを出力し、以下のコマンドで抽出すると良い。

$ grep 'Unregistered request' tmp/test.log | perl -pe 's/^.+?Unregistered request: ([^ ]+ [^ ]+) .+$/$1/' | sort | uniq -c | sort -rn
  46 POST http://example.com/aiueo
  39 GET http://maps.googleapis.com/a/b/c
  ...

既存の外部アクセスを潰していく

まずいテストを新しく作れないようにしたら、あとは既存の外部アクセスを潰していくだけだ。さきほどdisable_net_connect!で許可リストを作ったわけなので、その許可リストから1つずつ外し、落ちたテストを修正していくと良い。

diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
index ac49c794d8e..beaf8eed006 100644
--- a/spec/spec_helper.rb
+++ b/spec/spec_helper.rb
@@ -25,7 +25,6 @@ RSpec.configure do |config|
         # capybaraがアクセスしている
         'chromedriver.storage.googleapis.com',
         # TODO(webmock): 以下は必ずstubしたい
-        'example.com',
         'maps.googleapis.com',
       ],
     )