Merge pull request #65 from getsentry/feature/test-command

Add sentry:test artisan command

Author: dcramer

README.md

@@ -125,6 +125,21 @@ return array(
 );
 ```
 
+## Testing with Artisan
+
+You can test your configuration using the provided ``artisan`` command:
+
+```bash
+$ php artisan sentry:test
+[sentry] Client configuration:
+-> server: https://app.getsentry.com/api/3235/store/
+-> project: 3235
+-> public_key: e9ebbd88548a441288393c457ec90441
+-> secret_key: 399aaee02d454e2ca91351f29bdc3a07
+[sentry] Generating test event
+[sentry] Sending test event with ID: 5256614438cf4e0798dc9688e9545d94
+```
+
 ## Adding Context
 
 The mechanism to add context will vary depending on which version of Laravel you're using, but the general approach is the same. Find a good entry point to your application in which the context you want to add is available, ideally early in the process.

src/Sentry/SentryLaravel/SentryLaravelServiceProvider.php

@@ -50,6 +50,16 @@ public function boot()
 
             $this->bindEvents($app);
         }
+        if ($this->app->runningInConsole()) {
+            $this->registerArtisanCommands();
+        }
+    }
+
+    protected function registerArtisanCommands()
+    {
+        $this->commands([
+            SentryTestCommand::class,
+        ]);
     }
 
     protected function bindEvents($app)

src/Sentry/SentryLaravel/SentryLumenServiceProvider.php

@@ -22,6 +22,16 @@ public function boot()
     {
         $this->app->configure('sentry');
         $this->bindEvents($this->app);
+        if ($this->app->runningInConsole()) {
+            $this->registerArtisanCommands();
+        }
+    }
+
+    protected function registerArtisanCommands()
+    {
+        $this->commands([
+            SentryTestCommand::class,
+        ]);
     }
 
     protected function bindEvents($app)

src/Sentry/SentryLaravel/SentryTestCommand.php

@@ -0,0 +1,98 @@
+<?php
+
+namespace Sentry\SentryLaravel;
+
+use Illuminate\Console\Command;
+
+class SentryTestCommand extends Command
+{
+    // XXX(dcramer): Laravel 4.x compatibility
+    protected $name = 'sentry:test';
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'sentry:test';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Generate a test event and send it to Sentry';
+
+    /**
+     * Create a new command instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        parent::__construct();
+    }
+
+    // XXX(dcramer): Laravel 4.x compatibility
+    public function fire()
+    {
+        $this->handle();
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return mixed
+     */
+    public function handle()
+    {
+        // Maximize error reporting
+        $old_error_reporting = error_reporting(E_ALL | E_STRICT);
+
+        try {
+            $client = app('sentry');
+
+            $config = get_object_vars($client);
+            $required_keys = array('server', 'project', 'public_key', 'secret_key');
+
+            $output = "";
+            foreach ($required_keys as $key) {
+                if (empty($config[$key])) {
+                    $this->error("[sentry] ERROR: Missing configuration for $key");
+                }
+                if (is_array($config[$key])) {
+                    $output .= "-> $key: [".implode(", ", $config[$key])."]\n";
+                } else {
+                    $output .= "-> $key: $config[$key]\n";
+                }
+            }
+
+            $this->info("[sentry] Client configuration:\n" . trim($output));
+
+            $this->info('[sentry] Generating test event');
+
+            $ex = $this->generateTestException("command name", array("foo" => "bar"));
+
+            $event_id = $client->captureException($ex);
+
+            $this->info("[sentry] Sending test event with ID: $event_id");
+
+            $last_error = $client->getLastError();
+            if (!empty($last_error)) {
+                $this->error("[sentry] There was an error sending the test event:\n $last_error");
+            }
+        } finally {
+            error_reporting($old_error_reporting);
+        }
+    }
+
+    protected function generateTestException($command, $arg)
+    {
+        // Do something silly
+        try {
+            throw new \Exception('This is a test exception sent from the Raven CLI.');
+        } catch (\Exception $ex) {
+            return $ex;
+        }
+    }
+}