Add excoveralls for code coverage

Author: whatyouhide

.gitignore

@@ -5,3 +5,4 @@ erl_crash.dump
 /doc
 /priv/plts/*.plt
 /priv/plts/*.plt.hash
+/cover

coveralls.json

@@ -0,0 +1,5 @@
+{
+  "coverage_options": {
+    "treat_no_relevant_lines_as_covered": true
+  }
+}

mix.exs

@@ -19,6 +19,10 @@ defmodule Sentry.Mixfile do
         plt_add_deps: :app_tree,
         plt_add_apps: [:mix, :ex_unit]
       ],
+      test_coverage: [tool: ExCoveralls],
+      preferred_cli_env: [
+        "coveralls.html": :test
+      ],
       name: "Sentry",
       docs: [
         extra_section: "Guides",
@@ -73,12 +77,15 @@ defmodule Sentry.Mixfile do
       {:jason, "~> 1.1", optional: true},
       {:plug, "~> 1.6", optional: true},
       {:plug_cowboy, "~> 2.3", optional: true},
+
+      # Dev and test dependencies
+      {:bypass, "~> 2.0", only: [:test]},
       {:dialyxir, "~> 1.0", only: [:test, :dev], runtime: false},
       {:ex_doc, "~> 0.29.0", only: :dev},
-      {:bypass, "~> 2.0", only: [:test]},
+      {:excoveralls, "~> 0.17.1", only: [:test]},
+      {:mox, "~> 1.0", only: [:test]},
       {:phoenix, "~> 1.5", only: [:test]},
-      {:phoenix_html, "~> 2.0", only: [:test]},
-      {:mox, "~> 1.0", only: [:test]}
+      {:phoenix_html, "~> 2.0", only: [:test]}
     ]
   end
 

mix.lock

@@ -9,6 +9,7 @@
   "earmark_parser": {:hex, :earmark_parser, "1.4.32", "fa739a0ecfa34493de19426681b23f6814573faee95dfd4b4aafe15a7b5b32c6", [:mix], [], "hexpm", "b8b0dd77d60373e77a3d7e8afa598f325e49e8663a51bcc2b88ef41838cca755"},
   "erlex": {:hex, :erlex, "0.2.6", "c7987d15e899c7a2f34f5420d2a2ea0d659682c06ac607572df55a43753aa12e", [:mix], [], "hexpm", "2ed2e25711feb44d52b17d2780eabf998452f6efda104877a3881c2f8c0c0c75"},
   "ex_doc": {:hex, :ex_doc, "0.29.4", "6257ecbb20c7396b1fe5accd55b7b0d23f44b6aa18017b415cb4c2b91d997729", [:mix], [{:earmark_parser, "~> 1.4.31", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "2c6699a737ae46cb61e4ed012af931b57b699643b24dabe2400a8168414bc4f5"},
+  "excoveralls": {:hex, :excoveralls, "0.17.1", "83fa7906ef23aa7fc8ad7ee469c357a63b1b3d55dd701ff5b9ce1f72442b2874", [:mix], [{:castore, "~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "95bc6fda953e84c60f14da4a198880336205464e75383ec0f570180567985ae0"},
   "hackney": {:hex, :hackney, "1.17.4", "99da4674592504d3fb0cfef0db84c3ba02b4508bae2dff8c0108baa0d6e0977c", [:rebar3], [{:certifi, "~>2.6.1", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "~>6.1.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "~>1.0.0", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "~>1.1", [hex: :mimerl, repo: "hexpm", optional: false]}, {:parse_trans, "3.3.1", [hex: :parse_trans, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "~>1.1.0", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}, {:unicode_util_compat, "~>0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "de16ff4996556c8548d512f4dbe22dd58a587bf3332e7fd362430a7ef3986b16"},
   "idna": {:hex, :idna, "6.1.1", "8a63070e9f7d0c62eb9d9fcb360a7de382448200fbbd1b106cc96d3d8099df8d", [:rebar3], [{:unicode_util_compat, "~>0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "92376eb7894412ed19ac475e4a86f7b413c1b9fbb5bd16dccd57934157944cea"},
   "jason": {:hex, :jason, "1.2.2", "ba43e3f2709fd1aa1dce90aaabfd039d000469c05c56f0b8e31978e03fa39052", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "18a228f5f0058ee183f29f9eae0805c6e59d61c3b006760668d8d18ff0d12179"},

test/config_test.exs

@@ -1,5 +1,6 @@
 defmodule Sentry.ConfigTest do
   use ExUnit.Case
+  import ExUnit.CaptureIO
   import Sentry.TestEnvironmentHelper
   alias Sentry.Config
 
@@ -36,6 +37,11 @@ defmodule Sentry.ConfigTest do
       modify_env(:sentry, included_environments: [:test, :dev])
       assert Config.included_environments() == ["test", "dev"]
     end
+
+    test "defaults to [\"prod\"]" do
+      delete_env(:sentry, :included_environments)
+      assert Config.included_environments() == ["prod"]
+    end
   end
 
   describe "environment_name/0" do
@@ -57,4 +63,38 @@ defmodule Sentry.ConfigTest do
       end
     end
   end
+
+  describe "validate_log_level!/0" do
+    test "raises for invalid log levels" do
+      modify_env(:sentry, log_level: :invalid)
+
+      assert_raise ArgumentError, ":invalid is not a valid :log_level configuration", fn ->
+        Config.validate_log_level!()
+      end
+    end
+  end
+
+  describe "assert_dsn_has_no_query_params!/0" do
+    test "raises if DSN has query params" do
+      modify_env(:sentry, dsn: "https://public:[email protected]/1?send_max_attempts=5")
+
+      assert_raise ArgumentError, ~r/using a Sentry DSN/, fn ->
+        Config.assert_dsn_has_no_query_params!()
+      end
+    end
+  end
+
+  describe "warn_for_deprecated_env_vars!/0" do
+    test "emits the right warning" do
+      delete_env(:sentry, :included_environments)
+      modify_system_env(%{"SENTRY_INCLUDED_ENVIRONMENTS" => "test,dev"})
+
+      output =
+        capture_io(:stderr, fn ->
+          assert :ok = Config.warn_for_deprecated_env_vars!()
+        end)
+
+      assert output =~ "setting SENTRY_INCLUDED_ENVIRONMENTS is deprecated"
+    end
+  end
 end

test/event_test.exs

@@ -381,6 +381,7 @@ defmodule Sentry.EventTest do
              :cowlib,
              :dialyxir,
              :erlex,
+             :excoveralls,
              :hackney,
              :idna,
              :jason,

test/sentry_test.exs

@@ -85,4 +85,13 @@ defmodule SentryTest do
     assert {event_id, nil} = Sentry.get_last_event_id_and_source()
     assert is_binary(event_id)
   end
+
+  test "ignores events without message and exception" do
+    log =
+      capture_log(fn ->
+        assert Sentry.send_event(Sentry.Event.create_event([])) == :ignored
+      end)
+
+    assert log =~ "Sentry: unable to parse exception"
+  end
 end

test/support/test_environment_helper.ex

@@ -14,6 +14,19 @@ defmodule Sentry.TestEnvironmentHelper do
     end)
   end
 
+  def delete_env(app, key) do
+    original_env = Application.fetch_env(app, key)
+
+    Application.delete_env(app, key)
+
+    ExUnit.Callbacks.on_exit(fn ->
+      case original_env do
+        {:ok, val} -> Application.put_env(app, key, val)
+        :error -> :ok
+      end
+    end)
+  end
+
   def modify_system_env(overrides) when is_map(overrides) do
     original_env = System.get_env()
     System.put_env(overrides)