Merge pull request #18226 from Godmartinz/audit-notification-rb-19608

Fixes RB-19608 adds safe guards, adds Audit notification for google workspace, adds tests

Author: snipe

app/Notifications/AuditNotification.php

@@ -10,6 +10,11 @@
 use Illuminate\Notifications\Notification;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Str;
+use NotificationChannels\GoogleChat\Card;
+use NotificationChannels\GoogleChat\GoogleChatChannel;
+use NotificationChannels\GoogleChat\GoogleChatMessage;
+use NotificationChannels\GoogleChat\Section;
+use NotificationChannels\GoogleChat\Widgets\KeyValue;
 use NotificationChannels\MicrosoftTeams\MicrosoftTeamsChannel;
 use NotificationChannels\MicrosoftTeams\MicrosoftTeamsMessage;
 use Symfony\Component\Mime\Email;
@@ -33,6 +38,10 @@ public function __construct($params)
         //
         $this->settings = Setting::getSettings();
         $this->params = $params;
+        $item =  $params['item'];
+        if (!$item || !is_object($item)) {
+            throw new \InvalidArgumentException('Notification requires a valid item.');
+        }
     }
 
     /**
@@ -51,6 +60,10 @@ public function via()
 
             $notifyBy[] = MicrosoftTeamsChannel::class;
         }
+        if (Setting::getSettings()->webhook_selected == 'google' && Setting::getSettings()->webhook_endpoint) {
+            Log::debug('using google webhook');
+            $notifyBy[] = GoogleChatChannel::class;
+        }
         return $notifyBy;
     }
 
@@ -84,21 +97,57 @@ public static function toMicrosoftTeams($params)
         $location = $params['location'] ?? '';
         $setting = Setting::getSettings();
 
+        //if somehow a notification triggers without an item, bail out.
+        if(!$item || !is_object($item)){
+            return null;
+        }
+
         if(!Str::contains($setting->webhook_endpoint, 'workflows')) {
             return MicrosoftTeamsMessage::create()
                 ->to($setting->webhook_endpoint)
                 ->type('success')
-                ->title(class_basename(get_class($params['item'])) .' '.trans('general.audited'))
+                ->title(class_basename($item).' '.trans('general.audited'))
                 ->addStartGroupToSection('activityText')
                 ->fact(trans('mail.asset'), $item)
                 ->fact(trans('general.administrator'), $admin_user->present()->viewUrl() . '|' . $admin_user->display_name);
         }
-            $message = class_basename(get_class($params['item'])) . ' Audited By '.$admin_user->display_name;
+            $message = class_basename(get_class($params['item'])) . trans('general.audited_by').' '.$admin_user->display_name;
             $details = [
                 trans('mail.asset') => htmlspecialchars_decode($item->display_name),
                 trans('mail.notes') => $note ?: '',
                 trans('general.location') => $location ?: '',
                 ];
             return [$message, $details];
     }
+    public function toGoogleChat()
+    {
+        $item      = $this->params['item']  ?? null;
+        $admin_user = $this->params['admin'] ?? null;
+        $note      = $this->params['note']  ?? '';
+        $setting   = $this->settings ?? Setting::getSettings();
+
+        $title    = '<strong>' . class_basename($item) . ' ' . trans('general.audited') . '</strong>';
+        $subtitle = htmlspecialchars_decode($item->display_name ?? '');
+        \Log::debug('Google Chat audit payload', [
+            'title'    => $title,
+            'subtitle' => $subtitle,
+            'admin'    => $admin_user->display_name,
+            'note'     => $note,
+        ]);
+        return GoogleChatMessage::create()
+            ->to($setting->webhook_endpoint)
+            ->card(
+                Card::create()
+                    ->header($title, $subtitle)
+                    ->section(
+                        Section::create(
+                            KeyValue::create(
+                                trans('general.audited_by'),
+                                $admin_user?->display_name ?? '',
+                                $note ?? ''
+                            )->onClick(route('hardware.show', $item->id))
+                        )
+                    )
+            );
+    }
 }

resources/lang/en-US/general.php

@@ -39,6 +39,7 @@
     'accept_items'          => 'Accept Items',
     'audit'				    => 'Audit',
     'audited'				=> 'Audited',
+    'audited_by'		    => 'Audited By',
     'audits'				=> 'Audits',
     'audit_report'			=> 'Audit Log',
     'assets'				=> 'Assets',

tests/Feature/Notifications/Webhooks/NotificationTests.php

@@ -0,0 +1,61 @@
+<?php
+namespace Tests\Feature\Notifications\Webhooks;
+
+use App\Models\Asset;
+use App\Models\User;
+use App\Notifications\AuditNotification;
+use Illuminate\Support\Facades\Notification;
+use PHPUnit\Framework\Attributes\Group;
+use Tests\TestCase;
+use Tests\Support\Settings;
+
+#[Group('notifications')]
+class NotificationTests extends TestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        Notification::fake();
+    }
+    public function testAuditNotificationThrowsWhenItemIsNull()
+    {
+        try {
+            new AuditNotification([
+                'item' => null,
+            ]);
+            $this->fail('Expected Error was not thrown');
+        } catch (\Throwable $e) {
+            $this->assertInstanceOf(\InvalidArgumentException::class, $e);
+            $this->assertSame('Notification requires a valid item.', $e->getMessage());
+        }
+    }
+
+    public function testAuditNotificationFires()
+    {
+        $webhook_options = [
+            'enableSlackWebhook',
+            'enableMicrosoftTeamsWebhook',
+            'enableGoogleChatWebhook'
+        ];
+
+        Notification::fake();
+        //tests every webhook option
+        foreach($webhook_options as $option) {
+
+            $this->settings->{$option}();
+
+            $user = User::factory()->create();
+            $item = Asset::factory()->create();
+
+            try {
+                $user->notify(new \App\Notifications\AuditNotification([
+                    'item'  => $item,
+                ]));
+            } catch (\InvalidArgumentException $e) {
+                $this->fail("AuditNotification threw for [{$option}]: {$e->getMessage()}");
+            }
+        }
+            Notification::assertSentTimes(AuditNotification::class, count($webhook_options));
+    }
+}

tests/Support/Settings.php

@@ -93,6 +93,22 @@ public function enableSlackWebhook(): Settings
             'webhook_channel' => '#it',
         ]);
     }
+    public function enableMicrosoftTeamsWebhook(): Settings
+    {
+        return $this->update([
+            'webhook_selected' => 'microsoft',
+            'webhook_endpoint' => 'https://defaultd07ceb04416641fca1b9d3e0ac7600.84.environment.api.powerplatform.com:443/powerautomate/automations/direct/workflows/1babbc7a3cdd4cf99c0fbed4367cf147/triggers/manual/paths/invoke?api-version=1&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=sVXmAYF5luz3oOEjvN-G7mJqEEvFjBTuAG8c3Qmkg',
+        ]);
+    }
+
+    public function enableGoogleChatWebhook(): Settings
+    {
+        return $this->update([
+            'webhook_selected' => 'google',
+            'webhook_botname'  => 'SnipeBot5000',
+            'webhook_endpoint' => 'https://chat.googleapis.com/v1/spaces/AAAATQckuT4/messages?key=AIzaSyDdI0hCZtE6vySjMm-WEfRq3CPzqKqqsHI&token=bZDaFDK4lO78HhHmC8BEWI6aAKkgqX2gFv2gHVAc8',
+        ]);
+    }
 
     public function disableSlackWebhook(): Settings
     {