Add more tests for Sentry.Sources

Author: whatyouhide

.gitignore

@@ -7,5 +7,8 @@ erl_crash.dump
 /plts/*.plt.hash
 /cover
 
+# Generated by ExUnit's tmp_dir
+/tmp
+
 # Generated by "mix sentry.package_source_code"
 /priv/sentry.map

lib/sentry/sources.ex

@@ -11,9 +11,10 @@ defmodule Sentry.Sources do
 
   @source_code_map_key {:sentry, :source_code_map}
 
-  @spec load_source_code_map_if_present() :: {:loaded, source_map()} | {:error, term()}
-  def load_source_code_map_if_present do
-    path = Path.relative_to_cwd(path_of_packaged_source_code())
+  # Default argument is here for testing.
+  @spec load_source_code_map_if_present(Path.t()) :: {:loaded, source_map()} | {:error, term()}
+  def load_source_code_map_if_present(path \\ path_of_packaged_source_code()) do
+    path = Path.relative_to_cwd(path)
 
     with {:ok, contents} <- File.read(path),
          {:ok, source_map} <- decode_source_code_map(contents) do

test/sentry/config_test.exs

@@ -118,7 +118,15 @@ defmodule Sentry.ConfigTest do
       assert Config.validate!([])[:json_library] == Jason
 
       assert_raise ArgumentError, ~r/invalid value for :json_library option/, fn ->
-        Config.validate!(json_library: URI)
+        Config.validate!(json_library: Atom)
+      end
+
+      assert_raise ArgumentError, ~r/invalid value for :json_library option/, fn ->
+        Config.validate!(json_library: nil)
+      end
+
+      assert_raise ArgumentError, ~r/invalid value for :json_library option/, fn ->
+        Config.validate!(json_library: "not a module")
       end
     end
 

test/sources_test.exs

@@ -1,5 +1,10 @@
 defmodule Sentry.SourcesTest do
-  use Sentry.Case, async: true
+  # Not async because we're capturing IO.
+  use Sentry.Case, async: false
+
+  import ExUnit.CaptureIO
+
+  alias Sentry.Sources
 
   describe "load_files/1" do
     test "loads files" do
@@ -25,7 +30,7 @@ defmodule Sentry.SourcesTest do
                   5 => "end"
                 }
               }} =
-               Sentry.Sources.load_files(
+               Sources.load_files(
                  root_source_code_paths: paths,
                  source_code_exclude_patterns: []
                )
@@ -38,7 +43,7 @@ defmodule Sentry.SourcesTest do
       ]
 
       assert {:error, message} =
-               Sentry.Sources.load_files(
+               Sources.load_files(
                  root_source_code_paths: paths,
                  source_code_exclude_patterns: []
                )
@@ -60,4 +65,62 @@ defmodule Sentry.SourcesTest do
              """
     end
   end
+
+  describe "load_source_code_map_if_present/0" do
+    @tag :tmp_dir
+    test "fails if the source code map at the destination is malformed", %{tmp_dir: tmp_dir} do
+      path = Path.join(tmp_dir, "malformed.map")
+      File.write!(path, "hello!")
+
+      output =
+        capture_io(:stderr, fn ->
+          assert {:error, :decoding_error} = Sources.load_source_code_map_if_present(path)
+        end)
+
+      assert output =~ "Sentry found a source code map file"
+      assert output =~ "but it was unable to decode"
+    end
+
+    @tag :tmp_dir
+    test "stores the source code map in :persistent_term if valid", %{tmp_dir: tmp_dir} do
+      encoded_map = Sources.encode_source_code_map(%{"foo.ex" => %{}})
+      path = Path.join(tmp_dir, "valid.map")
+      File.write!(path, encoded_map)
+      assert {:loaded, map} = Sources.load_source_code_map_if_present(path)
+      assert map == %{"foo.ex" => %{}}
+      assert :persistent_term.get({:sentry, :source_code_map}) == %{"foo.ex" => %{}}
+    after
+      :persistent_term.erase({:sentry, :source_code_map})
+    end
+  end
+
+  describe "get_source_context/3" do
+    test "returns the correct context" do
+      map = %{
+        "foo.ex" => %{
+          1 => "defmodule Foo do",
+          2 => "  def bar do",
+          3 => "    \"bar\"",
+          4 => "  end",
+          5 => "end"
+        },
+        "bar.ex" => %{
+          1 => "defmodule Bar do",
+          2 => "  def baz do",
+          3 => "    \"baz\"",
+          4 => "  end",
+          5 => "end"
+        }
+      }
+
+      assert {pre, context, post} = Sources.get_source_context(map, "foo.ex", 4)
+      assert pre == ["defmodule Foo do", "  def bar do", "    \"bar\""]
+      assert context == "  end"
+      assert post == ["end"]
+    end
+
+    test "works if the file doesn't exist" do
+      assert {[], nil, []} = Sources.get_source_context(%{}, "foo.ex", 4)
+    end
+  end
 end