Merge pull request #234 from getsentry/system-env-list

Allow string for included_environments by splitting on commas

Author: mitchellhenke

lib/sentry/config.ex

@@ -1,6 +1,8 @@
 defmodule Sentry.Config do
   @moduledoc """
   This module provides the functionality for fetching configuration settings and their defaults.
+
+  Sentry supports loading config at runtime, via `{:system, SYSTEM_ENV_KEY}` tuples, where Sentry will read `SYSTEM_ENV_KEY` to get the config value from the system environment at runtime.
   """
 
   @default_included_environments [:dev, :test, :prod]
@@ -19,8 +21,11 @@ defmodule Sentry.Config do
     get_config(:dsn, check_dsn: false)
   end
 
+  @doc """
+  The `:included_environments` config key expects a list, but if given a string, it will split the string on commas to create a list.
+  """
   def included_environments do
-    get_config(:included_environments, default: @default_included_environments, check_dsn: false)
+    get_config(:included_environments, default: @default_included_environments, check_dsn: false, type: :list)
   end
 
   def environment_name do
@@ -108,6 +113,7 @@ defmodule Sentry.Config do
   defp get_config(key, opts \\ []) when is_atom(key) do
     default = Keyword.get(opts, :default)
     check_dsn = Keyword.get(opts, :check_dsn, true)
+    type = Keyword.get(opts, :type)
 
     environment_result = case get_from_application_environment(key) do
       {:ok, value} -> {:ok, value}
@@ -120,11 +126,15 @@ defmodule Sentry.Config do
     end
 
     case result do
-      {:ok, value} -> value
+      {:ok, value} -> convert_type(value, type)
       :not_found -> default
     end
   end
 
+  defp convert_type(value, nil), do: value
+  defp convert_type(value, :list) when is_list(value), do: value
+  defp convert_type(value, :list) when is_binary(value), do: String.split(value, ",")
+
   defp get_from_application_environment(key) when is_atom(key) do
     case Application.fetch_env(:sentry, key) do
       {:ok, {:system, env_var}} -> get_from_system_environment(env_var)

mix.exs

@@ -30,7 +30,7 @@ defmodule Sentry.Mixfile do
       {:plug, "~> 1.0", optional: true},
 
       {:dialyxir, "> 0.0.0", only: :dev},
-      {:ex_doc, "~> 0.16.0", only: :dev},
+      {:ex_doc, "~> 0.18.0", only: :dev},
       {:credo, "~> 0.8", only: [:dev, :test], runtime: false},
       {:bypass, "~> 0.8.0", only: [:test]}
     ]

mix.lock

@@ -1,20 +1,20 @@
-%{"bunt": {:hex, :bunt, "0.2.0", "951c6e801e8b1d2cbe58ebbd3e616a869061ddadcc4863d0a2182541acae9a38", [:mix], []},
+%{"bunt": {:hex, :bunt, "0.2.0", "951c6e801e8b1d2cbe58ebbd3e616a869061ddadcc4863d0a2182541acae9a38", [:mix], [], "hexpm"},
   "bypass": {:hex, :bypass, "0.8.1", "16d409e05530ece4a72fabcf021a3e5c7e15dcc77f911423196a0c551f2a15ca", [:mix], [{:cowboy, "~> 1.0", [hex: :cowboy, repo: "hexpm", optional: false]}, {:plug, "~> 1.0", [hex: :plug, repo: "hexpm", optional: false]}], "hexpm"},
-  "certifi": {:hex, :certifi, "1.1.0", "c9b71a547016c2528a590ccfc28de786c7edb74aafa17446b84f54e04efc00ee", [:rebar3], []},
-  "cowboy": {:hex, :cowboy, "1.1.2", "61ac29ea970389a88eca5a65601460162d370a70018afe6f949a29dca91f3bb0", [:rebar3], [{:cowlib, "~> 1.0.2", [hex: :cowlib, optional: false]}, {:ranch, "~> 1.3.2", [hex: :ranch, optional: false]}]},
-  "cowlib": {:hex, :cowlib, "1.0.2", "9d769a1d062c9c3ac753096f868ca121e2730b9a377de23dec0f7e08b1df84ee", [:make], []},
-  "credo": {:hex, :credo, "0.8.6", "335f723772d35da499b5ebfdaf6b426bfb73590b6fcbc8908d476b75f8cbca3f", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}], "hexpm"},
-  "dialyxir": {:hex, :dialyxir, "0.5.0", "5bc543f9c28ecd51b99cc1a685a3c2a1a93216990347f259406a910cf048d1d7", [:mix], []},
+  "certifi": {:hex, :certifi, "1.1.0", "c9b71a547016c2528a590ccfc28de786c7edb74aafa17446b84f54e04efc00ee", [:rebar3], [], "hexpm"},
+  "cowboy": {:hex, :cowboy, "1.1.2", "61ac29ea970389a88eca5a65601460162d370a70018afe6f949a29dca91f3bb0", [:rebar3], [{:cowlib, "~> 1.0.2", [hex: :cowlib, repo: "hexpm", optional: false]}, {:ranch, "~> 1.3.2", [hex: :ranch, repo: "hexpm", optional: false]}], "hexpm"},
+  "cowlib": {:hex, :cowlib, "1.0.2", "9d769a1d062c9c3ac753096f868ca121e2730b9a377de23dec0f7e08b1df84ee", [:make], [], "hexpm"},
+  "credo": {:hex, :credo, "0.8.10", "261862bb7363247762e1063713bb85df2bbd84af8d8610d1272cd9c1943bba63", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}], "hexpm"},
+  "dialyxir": {:hex, :dialyxir, "0.5.0", "5bc543f9c28ecd51b99cc1a685a3c2a1a93216990347f259406a910cf048d1d7", [:mix], [], "hexpm"},
   "earmark": {:hex, :earmark, "1.2.3", "206eb2e2ac1a794aa5256f3982de7a76bf4579ff91cb28d0e17ea2c9491e46a4", [:mix], [], "hexpm"},
-  "ex_doc": {:hex, :ex_doc, "0.16.3", "cd2a4cfe5d26e37502d3ec776702c72efa1adfa24ed9ce723bb565f4c30bd31a", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, repo: "hexpm", optional: false]}], "hexpm"},
-  "hackney": {:hex, :hackney, "1.8.0", "8388a22f4e7eb04d171f2cf0285b217410f266d6c13a4c397a6c22ab823a486c", [:rebar3], [{:certifi, "1.1.0", [hex: :certifi, optional: false]}, {:idna, "4.0.0", [hex: :idna, optional: false]}, {:metrics, "1.0.1", [hex: :metrics, optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, optional: false]}]},
-  "idna": {:hex, :idna, "4.0.0", "10aaa9f79d0b12cf0def53038547855b91144f1bfcc0ec73494f38bb7b9c4961", [:rebar3], []},
-  "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], []},
-  "mime": {:hex, :mime, "1.1.0", "01c1d6f4083d8aa5c7b8c246ade95139620ef8effb009edde934e0ec3b28090a", [:mix], []},
-  "mimerl": {:hex, :mimerl, "1.0.2", "993f9b0e084083405ed8252b99460c4f0563e41729ab42d9074fd5e52439be88", [:rebar3], []},
+  "ex_doc": {:hex, :ex_doc, "0.18.1", "37c69d2ef62f24928c1f4fdc7c724ea04aecfdf500c4329185f8e3649c915baf", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, repo: "hexpm", optional: false]}], "hexpm"},
+  "hackney": {:hex, :hackney, "1.8.0", "8388a22f4e7eb04d171f2cf0285b217410f266d6c13a4c397a6c22ab823a486c", [:rebar3], [{:certifi, "1.1.0", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "4.0.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "1.0.1", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}], "hexpm"},
+  "idna": {:hex, :idna, "4.0.0", "10aaa9f79d0b12cf0def53038547855b91144f1bfcc0ec73494f38bb7b9c4961", [:rebar3], [], "hexpm"},
+  "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm"},
+  "mime": {:hex, :mime, "1.1.0", "01c1d6f4083d8aa5c7b8c246ade95139620ef8effb009edde934e0ec3b28090a", [:mix], [], "hexpm"},
+  "mimerl": {:hex, :mimerl, "1.0.2", "993f9b0e084083405ed8252b99460c4f0563e41729ab42d9074fd5e52439be88", [:rebar3], [], "hexpm"},
   "plug": {:hex, :plug, "1.4.3", "236d77ce7bf3e3a2668dc0d32a9b6f1f9b1f05361019946aae49874904be4aed", [:mix], [{:cowboy, "~> 1.0.1 or ~> 1.1", [hex: :cowboy, repo: "hexpm", optional: true]}, {:mime, "~> 1.0", [hex: :mime, repo: "hexpm", optional: false]}], "hexpm"},
-  "poison": {:hex, :poison, "3.1.0", "d9eb636610e096f86f25d9a46f35a9facac35609a7591b3be3326e99a0484665", [:mix], []},
-  "ranch": {:hex, :ranch, "1.3.2", "e4965a144dc9fbe70e5c077c65e73c57165416a901bd02ea899cfd95aa890986", [:rebar3], []},
-  "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.1", "28a4d65b7f59893bc2c7de786dec1e1555bd742d336043fe644ae956c3497fbe", [:make, :rebar], []},
+  "poison": {:hex, :poison, "3.1.0", "d9eb636610e096f86f25d9a46f35a9facac35609a7591b3be3326e99a0484665", [:mix], [], "hexpm"},
+  "ranch": {:hex, :ranch, "1.3.2", "e4965a144dc9fbe70e5c077c65e73c57165416a901bd02ea899cfd95aa890986", [:rebar3], [], "hexpm"},
+  "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.1", "28a4d65b7f59893bc2c7de786dec1e1555bd742d336043fe644ae956c3497fbe", [:make, :rebar], [], "hexpm"},
   "ssl_verify_hostname": {:hex, :ssl_verify_hostname, "1.0.5", "2e73e068cd6393526f9fa6d399353d7c9477d6886ba005f323b592d389fb47be", [:make], []},
-  "uuid": {:hex, :uuid, "1.1.7", "007afd58273bc0bc7f849c3bdc763e2f8124e83b957e515368c498b641f7ab69", [:mix], []}}
+  "uuid": {:hex, :uuid, "1.1.8", "e22fc04499de0de3ed1116b770c7737779f226ceefa0badb3592e64d5cfb4eb9", [:mix], [], "hexpm"}}

test/config_test.exs

@@ -37,4 +37,17 @@ defmodule Sentry.ConfigTest do
       refute "test" == Config.source_code_path_pattern()
     end
   end
+
+  describe "included_environments" do
+    test "retrieves and converts string from system environment" do
+      delete_env(:sentry, [:included_environments])
+      modify_system_env(%{"SENTRY_INCLUDED_ENVIRONMENTS" => "test,dev"})
+      assert ["test", "dev"] == Config.included_environments()
+    end
+
+    test "retrieves and converts string from config" do
+      modify_env(:sentry, included_environments: "test,dev")
+      assert ["test", "dev"] == Config.included_environments()
+    end
+  end
 end

test/event_test.exs

@@ -164,9 +164,9 @@ defmodule Sentry.EventTest do
     event = Sentry.Event.transform_exception(exception, [])
 
     assert event.modules == %{bunt: "0.2.0", bypass: "0.8.1", certifi: "1.1.0", cowboy: "1.1.2",
-      cowlib: "1.0.2", credo: "0.8.6", hackney: "1.8.0", idna: "4.0.0",
+      cowlib: "1.0.2", credo: "0.8.10", hackney: "1.8.0", idna: "4.0.0",
       metrics: "1.0.1", mime: "1.1.0", mimerl: "1.0.2", plug: "1.4.3",
       poison: "3.1.0", ranch: "1.3.2", ssl_verify_fun: "1.1.1",
-      uuid: "1.1.7"}
+      uuid: "1.1.8"}
   end
 end

test/support/test_environment_helper.exs

@@ -14,6 +14,21 @@ defmodule Sentry.TestEnvironmentHelper do
     end)
   end
 
+  def delete_env(app, deletes) do
+    original_env = Application.get_all_env(app)
+    Enum.each(deletes, fn key -> Application.delete_env(app, key) end)
+
+    ExUnit.Callbacks.on_exit(fn ->
+      Enum.each deletes, fn key ->
+        if Keyword.has_key?(original_env, key) do
+          Application.put_env(app, key, Keyword.fetch!(original_env, key))
+        else
+          Application.delete_env(app, key)
+        end
+      end
+    end)
+  end
+
   def modify_system_env(overrides) when is_map(overrides) do
     original_env = System.get_env()
     System.put_env(overrides)