Add a simple rake task to test the setup in production

Author: codergeek121

README.md

@@ -28,6 +28,16 @@ All exceptions are reported automatically. No additional code required.
 
 Please consult the [official guides](https://guides.rubyonrails.org/error_reporting.html) for an introduction to the error reporting API.
 
+## Test your setup
+
+You can use the built-in rake task `rake email_error_reporter:check` to check if everything works correctly in your setup.
+
+If you're using Kamal, you can run the following command to test the setup in production:
+
+```
+kamal app exec -p 'bundle exec rake email_error_reporter:test_email'
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

lib/tasks/email_error_reporter_tasks.rake

@@ -1,4 +1,12 @@
-# desc "Explaining what the task does"
-# task :email_error_reporter do
-#   # Task goes here
-# end
+desc "Report a test exception"
+namespace :email_error_reporter do
+  task check: :environment do
+    Rails.error.handle { raise "This is a test!" }
+    $stdout.puts <<~TXT
+      Test exception triggered.
+
+      Recipients:
+      #{Rails.application.config.email_error_reporter.to.join("\n").gsub(/^/, "* ")}
+    TXT
+  end
+end

test/dummy/config/environments/development.rb

@@ -73,4 +73,6 @@
 
   # Raise error when a before_action's only/except options reference missing actions
   config.action_controller.raise_on_missing_callback_actions = true
+
+  config.email_error_reporter.to = ["[email protected]"]
 end

test/rake_task_test.rb

@@ -0,0 +1,30 @@
+require "test_helper"
+
+class EmailErrorReporter::ErrorMailerTest < ActionMailer::TestCase
+  test "renders the template correctly" do
+    exception = Exception.new("some message")
+    email = EmailErrorReporter::ErrorMailer.error(
+      exception,
+      handled: true,
+      severity: :info,
+      context: {}
+    )
+    assert_equal [], email.to
+    assert_equal "Exception", email.subject
+    assert_equal read_fixture("error").join, email.body.to_s
+  end
+
+  test "renders a backtrace" do
+    exception = Exception.new("some message")
+    exception.set_backtrace(["foo", "bar"])
+    email = EmailErrorReporter::ErrorMailer.error(
+      exception,
+      handled: true,
+      severity: :info,
+      context: {}
+    )
+    assert_equal [], email.to
+    assert_equal "Exception", email.subject
+    assert_equal read_fixture("error_with_backtrace").join, email.body.to_s
+  end
+end