Merge pull request #133 from joecorkerton/ignore-requests

Add ignore_localhost config option

config/config.exs

@@ -8,5 +8,6 @@ config :exvcr, [
   ],
   filter_url_params: false,
   filter_request_headers: [],
-  response_headers_blacklist: []
+  response_headers_blacklist: [],
+  ignore_localhost: false
 ]

fixture/vcr_cassettes/ignore_localhost_on.json

@@ -0,0 +1 @@
+[]

fixture/vcr_cassettes/ignore_localhost_unset.json

@@ -0,0 +1,23 @@
+[
+  {
+    "request": {
+      "body": "",
+      "headers": [],
+      "method": "get",
+      "options": [],
+      "request_body": "",
+      "url": "http://localhost:34006/server"
+    },
+    "response": {
+      "binary": false,
+      "body": "test_response_before",
+      "headers": {
+        "server": "Cowboy",
+        "date": "Sun, 08 Apr 2018 12:50:46 GMT",
+        "content-length": "20"
+      },
+      "status_code": 200,
+      "type": "ok"
+    }
+  }
+]

lib/exvcr/config.ex

@@ -77,4 +77,11 @@ defmodule ExVCR.Config do
     blacklist = Enum.map(headers_blacklist, fn(x) -> String.downcase(x) end)
     Setting.set(:response_headers_blacklist, blacklist)
   end
+
+  @doc """
+  Skip recording cassettes for localhost requests when set
+  """
+  def ignore_localhost(value) do
+    Setting.set(:ignore_localhost, value)
+  end
 end

lib/exvcr/config_loader.ex

@@ -52,5 +52,9 @@ defmodule ExVCR.ConfigLoader do
     else
       Config.response_headers_blacklist([])
     end
+
+    if env[:ignore_localhost] != nil do
+      Config.ignore_localhost(env[:ignore_localhost])
+    end
   end
 end

lib/exvcr/handler.ex

@@ -11,7 +11,11 @@ defmodule ExVCR.Handler do
   Get response from either server or cache.
   """
   def get_response(recorder, request) do
-    get_response_from_cache(request, recorder) || get_response_from_server(request, recorder)
+    if ignore_request?(request, recorder) do
+      get_response_from_server(request, recorder, false)
+    else
+      get_response_from_cache(request, recorder) || get_response_from_server(request, recorder, true)
+    end
   end
 
   @doc """
@@ -133,16 +137,27 @@ defmodule ExVCR.Handler do
     end
   end
 
-  defp get_response_from_server(request, recorder) do
-    raise_error_if_cassette_already_exists(recorder, inspect(request))
+  defp get_response_from_server(request, recorder, record?) do
     adapter = ExVCR.Recorder.options(recorder)[:adapter]
     response = :meck.passthrough(request)
                |> adapter.hook_response_from_server
-    Recorder.append(recorder, adapter.convert_to_string(request, response))
-    ExVCR.Checker.add_server_count(recorder)
+    if record? do
+      raise_error_if_cassette_already_exists(recorder, inspect(request))
+      Recorder.append(recorder, adapter.convert_to_string(request, response))
+      ExVCR.Checker.add_server_count(recorder)
+    end
     response
   end
 
+  defp ignore_request?(request, recorder) do
+    ignore_localhost = ExVCR.Recorder.options(recorder)[:ignore_localhost] || ExVCR.Setting.get(:ignore_localhost)
+    if ignore_localhost do
+      Enum.any?(request, &(String.starts_with?("#{&1}", "http://localhost:")))
+    else
+      false
+    end
+  end
+
   defp raise_error_if_cassette_already_exists(recorder, request_description) do
     file_path = ExVCR.Recorder.get_file_path(recorder)
     if File.exists?(file_path) do

test/ignore_localhost_test.exs

@@ -0,0 +1,36 @@
+defmodule ExVCR.IgnoreLocalhostTest do
+  use ExVCR.Mock
+  use ExUnit.Case, async: false
+
+  @port 34006
+  @url "http://localhost:#{@port}/server"
+
+  setup_all do
+    HTTPotion.start
+    :ok
+  end
+
+  test "it does not record localhost requests when the config has been set" do
+    use_cassette "ignore_localhost_on", ignore_localhost: true do
+      HttpServer.start(path: "/server", port: @port, response: "test_response_before")
+      assert HTTPotion.get(@url, []).body =~ ~r/test_response_before/
+      HttpServer.stop(@port)
+      # this method call should NOT be mocked
+      HttpServer.start(path: "/server", port: @port, response: "test_response_after")
+      assert HTTPotion.get(@url, []).body =~ ~r/test_response_after/
+      HttpServer.stop(@port)
+    end
+  end
+
+  test "it records localhost requests when the config has not been set" do
+    use_cassette "ignore_localhost_unset" do
+      HttpServer.start(path: "/server", port: @port, response: "test_response_before")
+      assert HTTPotion.get(@url, []).body =~ ~r/test_response_before/
+      HttpServer.stop(@port)
+      # this method call should be mocked
+      HttpServer.start(path: "/server", port: @port, response: "test_response_after")
+      assert HTTPotion.get(@url, []).body =~ ~r/test_response_before/
+      HttpServer.stop(@port)
+    end
+  end
+end