Merge pull request #68 from getsentry/configuration-test-task

Configuration test task

Author: mitchellhenke

README.md

@@ -78,6 +78,32 @@ config :sentry,
 | `server_name` | False  | None | |
 | `use_error_logger` | False  | False | |
 
+## Testing Your Configuration
+
+To ensure you've set up your configuration correctly we recommend running the
+included mix task.  It can be tested on different Mix environments and will tell you if it is not currently configured to send events in that environment:
+
+```bash
+$ MIX_ENV=dev mix sentry.send_test_event
+Client configuration:
+server: https://sentry.io/
+public_key: public
+secret_key: secret
+included_environments: [:prod]
+current environment_name: :dev
+
+:dev is not in [:prod] so no test event will be sent
+
+$ MIX_ENV=prod mix sentry.send_test_event
+Client configuration:
+server: https://sentry.io/
+public_key: public
+secret_key: secret
+included_environments: [:prod]
+current environment_name: :prod
+
+Sending test event!
+```
 
 ## Docs
 

docs/config.rst

@@ -51,3 +51,30 @@ Optional settings
 
   Set this to true if you want to capture all exceptions that occur even outside of a request cycle. This
   defaults to false.
+
+Testing Your Configuration
+--------------------------
+
+To ensure you've set up your configuration correctly we recommend running the
+included mix task.  It can be tested on different Mix environments and will tell you if it is not currently configured to send events in that environment:
+
+.. code-block:: bash
+  $ MIX_ENV=dev mix sentry.send_test_event
+  Client configuration:
+  server: https://sentry.io/
+  public_key: public
+  secret_key: secret
+  included_environments: [:prod]
+  current environment_name: :dev
+
+  :dev is not in [:prod] so no test event will be sent
+
+  $ MIX_ENV=prod mix sentry.send_test_event
+  Client configuration:
+  server: https://sentry.io/
+  public_key: public
+  secret_key: secret
+  included_environments: [:prod]
+  current environment_name: :prod
+
+  Sending test event!

lib/mix/tasks/sentry.send_test_event.ex

@@ -0,0 +1,39 @@
+defmodule Mix.Tasks.Sentry.SendTestEvent do
+  use Mix.Task
+
+  @shortdoc "Attempts to send a test event to check Sentry configuration"
+
+  def run(_args) do
+    Application.ensure_all_started(:sentry)
+    {endpoint, public_key, secret_key} = case Application.fetch_env(:sentry, :dsn) do
+      {:ok, dsn} when is_binary(dsn) -> Sentry.Client.parse_dsn!(dsn)
+      _ ->
+        Mix.raise "Sentry DSN is not configured in :sentry, :dsn"
+    end
+
+    included_environments = case Application.fetch_env(:sentry, :included_environments) do
+      {:ok, envs} when is_list(envs) -> envs
+      _ ->
+        Mix.raise "Sentry included_environments is not configured in :sentry, :included_environments"
+    end
+
+    environment_name = Application.get_env(:sentry, :environment_name)
+    Mix.shell.info "Client configuration:"
+    Mix.shell.info "server: #{endpoint}"
+    Mix.shell.info "public_key: #{public_key}"
+    Mix.shell.info "secret_key: #{secret_key}"
+    Mix.shell.info "included_environments: #{inspect included_environments}"
+    Mix.shell.info "current environment_name: #{inspect environment_name}\n"
+
+    maybe_send_event(environment_name, included_environments)
+  end
+
+  def maybe_send_event(env_name, included_envs) do
+    if env_name in included_envs do
+      Mix.shell.info "Sending test event!"
+      Sentry.capture_exception(RuntimeError.exception("Testing sending Sentry event"))
+    else
+      Mix.shell.info "#{inspect env_name} is not in #{inspect included_envs} so no test event will be sent"
+    end
+  end
+end

test/client_test.exs

@@ -5,7 +5,7 @@ defmodule Sentry.ClientTest do
 
   test "authorization" do
     {_endpoint, public_key, private_key} = Client.parse_dsn!("https://public:[email protected]/1")
-    assert Client.authorization_header(public_key, private_key) =~ ~r/Sentry sentry_version=5, sentry_client=sentry-elixir\/1.0.0, sentry_timestamp=\d{10}, sentry_key=public, sentry_secret=secret/
+    assert Client.authorization_header(public_key, private_key) =~ ~r/Sentry sentry_version=5, sentry_client=sentry-elixir\/#{Application.spec(:sentry, :vsn)}, sentry_timestamp=\d{10}, sentry_key=public, sentry_secret=secret/
   end
 
   test "parning dsn" do