BookStack Code Mirror - bookstack/blob - tests/Actions/WebhookCallTest.php

   1 <?php
   2
   3 namespace Tests\Actions;
   4
   5 use BookStack\Actions\ActivityLogger;
   6 use BookStack\Actions\ActivityType;
   7 use BookStack\Actions\DispatchWebhookJob;
   8 use BookStack\Actions\Webhook;
   9 use BookStack\Auth\User;
  10 use BookStack\Entities\Models\Page;
  11 use Illuminate\Http\Client\Request;
  12 use Illuminate\Support\Facades\Bus;
  13 use Illuminate\Support\Facades\Http;
  14 use Tests\TestCase;
  15
  16 class WebhookCallTest extends TestCase
  17 {
  18     public function test_webhook_listening_to_all_called_on_event()
  19     {
  20         $this->newWebhook([], ['all']);
  21         Bus::fake();
  22         $this->runEvent(ActivityType::ROLE_CREATE);
  23         Bus::assertDispatched(DispatchWebhookJob::class);
  24     }
  25
  26     public function test_webhook_listening_to_specific_event_called_on_event()
  27     {
  28         $this->newWebhook([], [ActivityType::ROLE_UPDATE]);
  29         Bus::fake();
  30         $this->runEvent(ActivityType::ROLE_UPDATE);
  31         Bus::assertDispatched(DispatchWebhookJob::class);
  32     }
  33
  34     public function test_webhook_listening_to_specific_event_not_called_on_other_event()
  35     {
  36         $this->newWebhook([], [ActivityType::ROLE_UPDATE]);
  37         Bus::fake();
  38         $this->runEvent(ActivityType::ROLE_CREATE);
  39         Bus::assertNotDispatched(DispatchWebhookJob::class);
  40     }
  41
  42     public function test_inactive_webhook_not_called_on_event()
  43     {
  44         $this->newWebhook(['active' => false], ['all']);
  45         Bus::fake();
  46         $this->runEvent(ActivityType::ROLE_CREATE);
  47         Bus::assertNotDispatched(DispatchWebhookJob::class);
  48     }
  49
  50     public function test_failed_webhook_call_logs_error()
  51     {
  52         $logger = $this->withTestLogger();
  53         Http::fake([
  54             '*' => Http::response('', 500),
  55         ]);
  56         $webhook = $this->newWebhook(['active' => true, 'endpoint' => 'https://wh.example.com'], ['all']);
  57         $this->assertNull($webhook->last_errored_at);
  58
  59         $this->runEvent(ActivityType::ROLE_CREATE);
  60
  61         $this->assertTrue($logger->hasError('Webhook call to endpoint https://wh.example.com failed with status 500'));
  62
  63         $webhook->refresh();
  64         $this->assertEquals('Response status from endpoint was 500', $webhook->last_error);
  65         $this->assertNotNull($webhook->last_errored_at);
  66     }
  67
  68     public function test_webhook_call_exception_is_caught_and_logged()
  69     {
  70         Http::shouldReceive('asJson')->andThrow(new \Exception('Failed to perform request'));
  71
  72         $logger = $this->withTestLogger();
  73         $webhook = $this->newWebhook(['active' => true, 'endpoint' => 'https://wh.example.com'], ['all']);
  74         $this->assertNull($webhook->last_errored_at);
  75
  76         $this->runEvent(ActivityType::ROLE_CREATE);
  77
  78         $this->assertTrue($logger->hasError('Webhook call to endpoint https://wh.example.com failed with error "Failed to perform request"'));
  79
  80         $webhook->refresh();
  81         $this->assertEquals('Failed to perform request', $webhook->last_error);
  82         $this->assertNotNull($webhook->last_errored_at);
  83     }
  84
  85     public function test_webhook_call_data_format()
  86     {
  87         Http::fake([
  88             '*' => Http::response('', 200),
  89         ]);
  90         $webhook = $this->newWebhook(['active' => true, 'endpoint' => 'https://wh.example.com'], ['all']);
  91         $page = $this->entities->page();
  92         $editor = $this->getEditor();
  93
  94         $this->runEvent(ActivityType::PAGE_UPDATE, $page, $editor);
  95
  96         Http::assertSent(function (Request $request) use ($editor, $page, $webhook) {
  97             $reqData = $request->data();
  98
  99             return $request->isJson()
 100                 && $reqData['event'] === 'page_update'
 101                 && $reqData['text'] === ($editor->name . ' updated page "' . $page->name . '"')
 102                 && is_string($reqData['triggered_at'])
 103                 && $reqData['triggered_by']['name'] === $editor->name
 104                 && $reqData['triggered_by_profile_url'] === $editor->getProfileUrl()
 105                 && $reqData['webhook_id'] === $webhook->id
 106                 && $reqData['webhook_name'] === $webhook->name
 107                 && $reqData['url'] === $page->getUrl()
 108                 && $reqData['related_item']['name'] === $page->name;
 109         });
 110     }
 111
 112     protected function runEvent(string $event, $detail = '', ?User $user = null)
 113     {
 114         if (is_null($user)) {
 115             $user = $this->getEditor();
 116         }
 117
 118         $this->actingAs($user);
 119
 120         $activityLogger = $this->app->make(ActivityLogger::class);
 121         $activityLogger->add($event, $detail);
 122     }
 123
 124     protected function newWebhook(array $attrs = [], array $events = ['all']): Webhook
 125     {
 126         /** @var Webhook $webhook */
 127         $webhook = Webhook::factory()->create($attrs);
 128
 129         foreach ($events as $event) {
 130             $webhook->trackedEvents()->create(['event' => $event]);
 131         }
 132
 133         return $webhook;
 134     }
 135 }