Merge pull request #111 from honeybadger-io/checkins-sync

feat: checkins-sync command to synchronize checkins from config file

Author: subzero10

CHANGELOG.md

@@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [3.16.0] - 2023-10-06
 ### Added
-- Synchronize checkins `honeybadger:checkins:sync`
+- Synchronize checkins with `honeybadger:checkins:sync`
 
 ## [3.15.2] - 2023-08-06
 ### Changed

composer.json

@@ -22,7 +22,7 @@
     ],
     "require": {
         "php": "^7.2|^8.0",
-        "honeybadger-io/honeybadger-php": "^2.14.1",
+        "honeybadger-io/honeybadger-php": "^2.15.0",
         "sixlive/dotenv-editor": "^1.1|^2.0",
         "illuminate/console": "^7.0|^8.0|^9.0|^10.0",
         "illuminate/support": "^7.0|^8.0|^9.0|^10.0",

config/honeybadger.php

@@ -8,6 +8,11 @@
      */
     'api_key' => env('HONEYBADGER_API_KEY'),
 
+    /**
+     * Your personal authentication token. Get this from authentication tab in your User Settings page.
+     */
+    'personal_auth_token' => env('HONEYBADGER_PERSONAL_AUTH_TOKEN'),
+
     /**
      * The application environment.
      */
@@ -128,4 +133,12 @@
             Breadcrumbs\ViewRendered::class,
         ],
     ],
+
+    /**
+     * Define your checkins here and synchronize them to Honeybadger with the
+     * honeybadger:checkins:sync artisan command.
+     * The recommended approach is to run this command as part of your deploy process.
+     * Learn more about checkins at https://docs.honeybadger.io/api/reporting-check-ins/
+     */
+    'checkins' =>  [],
 ];

src/Commands/HoneybadgerCheckinsSyncCommand.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Honeybadger\HoneybadgerLaravel\Commands;
+
+use Honeybadger\Contracts\SyncCheckins;
+use Illuminate\Console\Command;
+
+class HoneybadgerCheckinsSyncCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'honeybadger:checkins:sync';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Synchronize checkins to Honeybadger';
+
+    /**
+     * Execute the console command.
+     *
+     * @return mixed
+     */
+    public function handle(SyncCheckins $checkinsManager)
+    {
+        $localCheckins = config('honeybadger.checkins', []);
+        $result = $checkinsManager->sync($localCheckins);
+        $this->info('Checkins were synchronized with Honeybadger.');
+        $this->table(['Id', 'Name', 'Schedule Type', 'Cron Schedule', 'Cron Timezone', 'Grace Period', 'Status'], array_map(function ($checkin) {
+            return [
+                $checkin->id,
+                $checkin->name,
+                $checkin->scheduleType,
+                $checkin->cronSchedule,
+                $checkin->cronTimezone,
+                $checkin->gracePeriod,
+                $checkin->isDeleted() ? '❌ Removed' : '✅ Synchronized',
+            ];
+        }, $result));
+    }
+}

src/HoneybadgerServiceProvider.php

@@ -3,6 +3,9 @@
 namespace Honeybadger\HoneybadgerLaravel;
 
 use GuzzleHttp\Client;
+use Honeybadger\CheckinsManager;
+use Honeybadger\Contracts\SyncCheckins;
+use Honeybadger\HoneybadgerLaravel\Commands\HoneybadgerCheckinsSyncCommand;
 use Honeybadger\LogHandler;
 use Honeybadger\Honeybadger;
 use Honeybadger\Contracts\Reporter;
@@ -14,6 +17,7 @@
 use Honeybadger\HoneybadgerLaravel\Contracts\Installer as InstallerContract;
 use Illuminate\Console\Scheduling\Event;
 use Illuminate\Support\Facades\Blade;
+use Illuminate\Support\Facades\Log;
 use Illuminate\Support\ServiceProvider;
 
 class HoneybadgerServiceProvider extends ServiceProvider
@@ -46,6 +50,7 @@ public function register()
         $this->mergeConfigFrom(__DIR__.'/../config/honeybadger.php', 'honeybadger');
 
         $this->registerReporters();
+        $this->registerCheckinsSync();
 
         $this->app->bind(LogHandler::class, function ($app) {
             return new LogHandler($app[Reporter::class]);
@@ -72,6 +77,7 @@ private function registerCommands()
         $this->commands([
             'command.honeybadger:test',
             'command.honeybadger:checkin',
+            'command.honeybadger:checkins:sync',
             'command.honeybadger:install',
             'command.honeybadger:deploy',
         ]);
@@ -92,6 +98,11 @@ private function bindCommands()
             HoneybadgerCheckinCommand::class
         );
 
+        $this->app->bind(
+            'command.honeybadger:checkins:sync',
+            HoneybadgerCheckinsSyncCommand::class
+        );
+
         $this->app->bind(
             'command.honeybadger:install',
             HoneybadgerInstallCommand::class
@@ -174,6 +185,13 @@ protected function setUpAutomaticBreadcrumbs()
         }
     }
 
+    protected function registerCheckinsSync(): void
+    {
+        $this->app->singleton(SyncCheckins::class, function ($app) {
+            return new CheckinsManager($app['config']['honeybadger']);
+        });
+    }
+
     protected function registerReporters(): void
     {
         $this->app->singleton(Reporter::class, function ($app) {

tests/Commands/HoneybadgerCheckinsSyncCommandTest.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Honeybadger\Tests\Commands;
+
+use Honeybadger\Contracts\SyncCheckins;
+use Honeybadger\Tests\TestCase;
+use Illuminate\Support\Facades\Config;
+
+class HoneybadgerCheckinsSyncCommandTest extends TestCase
+{
+    const CHECKINS = [
+        [
+            'project_id' => 'p1234',
+            'name' => 'simple checkin test',
+            'scheduleType' => 'simple',
+            'report_period' => '1 day',
+        ],
+        [
+            'project_id' => 'p1234',
+            'name' => 'cron checkin test',
+            'scheduleType' => 'cron',
+            'cron_schedule' => '0 * * * *',
+        ],
+    ];
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        Config::set('honeybadger', [
+            'personal_auth_token' => '1234567890',
+            'checkins' => self::CHECKINS,
+        ]);
+    }
+
+    /** @test */
+    public function it_reads_checkins_from_config()
+    {
+        $mock = $this->createMock(SyncCheckins::class);
+        $mock->expects($this->once())
+            ->method('sync')
+            ->with(self::CHECKINS);
+
+        $this->app->instance(SyncCheckins::class, $mock);
+
+        $this->artisan('honeybadger:checkins:sync');
+    }
+}