NOW MANAGED ON CODEBERG
API: Added to, and updated, testing to cover audit log additions
Dan Brown67df127c2618
diff --git a/app/Activity/ActivityQueries.php b/app/Activity/ActivityQueries.phpindex 9de70f022..86326fb80 100644--- a/app/Activity/ActivityQueries.php+++ b/app/Activity/ActivityQueries.php@@ -66,7 +66,7 @@ class ActivityQueries});$activity = $query->orderBy('created_at', 'desc')- ->with(['entity' => function (Relation $query) {+ ->with(['loggable' => function (Relation $query) {$query->withTrashed();}, 'user.avatar'])->skip($count * ($page - 1))diff --git a/app/Activity/Models/Activity.php b/app/Activity/Models/Activity.phpindex ebe5d66d6..ac9fec517 100644--- a/app/Activity/Models/Activity.php+++ b/app/Activity/Models/Activity.php@@ -15,7 +15,7 @@ use Illuminate\Support\Str;/*** @property string $type* @property User $user- * @property Entity $entity+ * @property Entity $loggable* @property string $detail* @property string $loggable_type* @property int $loggable_iddiff --git a/resources/views/common/activity-item.blade.php b/resources/views/common/activity-item.blade.phpindex 89d44b152..1c970084f 100644--- a/resources/views/common/activity-item.blade.php+++ b/resources/views/common/activity-item.blade.php@@ -16,12 +16,12 @@{{ $activity->getText() }}- @if($activity->entity && is_null($activity->entity->deleted_at))- <a href="{{ $activity->entity->getUrl() }}">{{ $activity->entity->name }}</a>+ @if($activity->loggable && is_null($activity->loggable->deleted_at))+ <a href="{{ $activity->loggable->getUrl() }}">{{ $activity->loggable->name }}</a>@endif- @if($activity->entity && !is_null($activity->entity->deleted_at))- "{{ $activity->entity->name }}"+ @if($activity->loggable && !is_null($activity->loggable->deleted_at))+ "{{ $activity->loggable->name }}"@endif<br>diff --git a/tests/Activity/AuditLogApiTest.php b/tests/Activity/AuditLogApiTest.phpnew file mode 100644index 000000000..75cc364f8--- /dev/null+++ b/tests/Activity/AuditLogApiTest.php@@ -0,0 +1,60 @@+<?php++namespace Activity;++use BookStack\Activity\ActivityType;+use BookStack\Facades\Activity;+use Tests\Api\TestsApi;+use Tests\TestCase;++class AuditLogApiTest extends TestCase+{+ use TestsApi;++ public function test_user_and_settings_manage_permissions_needed()+ {+ $editor = $this->users->editor();++ $assertPermissionErrorOnCall = function () use ($editor) {+ $resp = $this->actingAsForApi($editor)->getJson('/api/audit-log');+ $resp->assertStatus(403);+ $resp->assertJson($this->permissionErrorResponse());+ };++ $assertPermissionErrorOnCall();+ $this->permissions->grantUserRolePermissions($editor, ['users-manage']);+ $assertPermissionErrorOnCall();+ $this->permissions->removeUserRolePermissions($editor, ['users-manage']);+ $this->permissions->grantUserRolePermissions($editor, ['settings-manage']);+ $assertPermissionErrorOnCall();++ $this->permissions->grantUserRolePermissions($editor, ['settings-manage', 'users-manage']);+ $resp = $this->actingAsForApi($editor)->getJson('/api/audit-log');+ $resp->assertOk();+ }++ public function test_index_endpoint_returns_expected_data()+ {+ $page = $this->entities->page();+ $admin = $this->users->admin();+ $this->actingAsForApi($admin);+ Activity::add(ActivityType::PAGE_UPDATE, $page);++ $resp = $this->get("/api/audit-log?filter[loggable_id]={$page->id}");+ $resp->assertJson(['data' => [+ [+ 'type' => 'page_update',+ 'detail' => "({$page->id}) {$page->name}",+ 'user_id' => $admin->id,+ 'loggable_id' => $page->id,+ 'loggable_type' => 'page',+ 'ip' => '127.0.0.1',+ 'user' => [+ 'id' => $admin->id,+ 'name' => $admin->name,+ 'slug' => $admin->slug,+ ],+ ]+ ]]);+ }+}diff --git a/tests/Actions/AuditLogTest.php b/tests/Activity/AuditLogTest.phpsimilarity index 98%rename from tests/Actions/AuditLogTest.phprename to tests/Activity/AuditLogTest.phpindex 5e355ca09..350cd9287 100644--- a/tests/Actions/AuditLogTest.php+++ b/tests/Activity/AuditLogTest.php@@ -1,6 +1,6 @@<?php-namespace Tests\Actions;+namespace Activity;use BookStack\Activity\ActivityType;use BookStack\Activity\Models\Activity;@@ -156,7 +156,7 @@ class AuditLogTest extends TestCase'type' => ActivityType::PAGE_UPDATE,'ip' => '192.123.45.1','user_id' => $editor->id,- 'entity_id' => $page->id,+ 'loggable_id' => $page->id,]);$resp = $this->asAdmin()->get('/settings/audit');@@ -207,7 +207,7 @@ class AuditLogTest extends TestCase'type' => ActivityType::PAGE_UPDATE,'ip' => '127.0.0.1','user_id' => $editor->id,- 'entity_id' => $page->id,+ 'loggable_id' => $page->id,]);}@@ -229,7 +229,7 @@ class AuditLogTest extends TestCase'type' => ActivityType::PAGE_UPDATE,'ip' => '192.123.x.x','user_id' => $editor->id,- 'entity_id' => $page->id,+ 'loggable_id' => $page->id,]);}}diff --git a/tests/Actions/WebhookCallTest.php b/tests/Activity/WebhookCallTest.phpsimilarity index 99%rename from tests/Actions/WebhookCallTest.phprename to tests/Activity/WebhookCallTest.phpindex 16986ba2e..37c87267a 100644--- a/tests/Actions/WebhookCallTest.php+++ b/tests/Activity/WebhookCallTest.php@@ -1,6 +1,6 @@<?php-namespace Tests\Actions;+namespace Activity;use BookStack\Activity\ActivityType;use BookStack\Activity\DispatchWebhookJob;diff --git a/tests/Actions/WebhookFormatTesting.php b/tests/Activity/WebhookFormatTesting.phpsimilarity index 98%rename from tests/Actions/WebhookFormatTesting.phprename to tests/Activity/WebhookFormatTesting.phpindex b4fa49532..edd16ebba 100644--- a/tests/Actions/WebhookFormatTesting.php+++ b/tests/Activity/WebhookFormatTesting.php@@ -1,6 +1,6 @@<?php-namespace Tests\Actions;+namespace Activity;use BookStack\Activity\ActivityType;use BookStack\Activity\Models\Webhook;diff --git a/tests/Actions/WebhookManagementTest.php b/tests/Activity/WebhookManagementTest.phpsimilarity index 99%rename from tests/Actions/WebhookManagementTest.phprename to tests/Activity/WebhookManagementTest.phpindex 05475b699..eb7bb4c15 100644--- a/tests/Actions/WebhookManagementTest.php+++ b/tests/Activity/WebhookManagementTest.php@@ -1,6 +1,6 @@<?php-namespace Tests\Actions;+namespace Activity;use BookStack\Activity\ActivityType;use BookStack\Activity\Models\Webhook;diff --git a/tests/Commands/ClearActivityCommandTest.php b/tests/Commands/ClearActivityCommandTest.phpindex 410a39aa8..a3d7456b6 100644--- a/tests/Commands/ClearActivityCommandTest.php+++ b/tests/Commands/ClearActivityCommandTest.php@@ -18,7 +18,7 @@ class ClearActivityCommandTest extends TestCase$this->assertDatabaseHas('activities', ['type' => 'page_update',- 'entity_id' => $page->id,+ 'loggable_id' => $page->id,'user_id' => $this->users->editor()->id,]);diff --git a/tests/Settings/RecycleBinTest.php b/tests/Settings/RecycleBinTest.phpindex 8adc92f25..33284b4b3 100644--- a/tests/Settings/RecycleBinTest.php+++ b/tests/Settings/RecycleBinTest.php@@ -153,22 +153,22 @@ class RecycleBinTest extends TestCase$this->assertDatabaseHas('activities', ['type' => 'page_delete',- 'entity_id' => $page->id,- 'entity_type' => $page->getMorphClass(),+ 'loggable_id' => $page->id,+ 'loggable_type' => $page->getMorphClass(),]);$this->asAdmin()->delete("/settings/recycle-bin/{$deletion->id}");$this->assertDatabaseMissing('activities', ['type' => 'page_delete',- 'entity_id' => $page->id,- 'entity_type' => $page->getMorphClass(),+ 'loggable_id' => $page->id,+ 'loggable_type' => $page->getMorphClass(),]);$this->assertDatabaseHas('activities', ['type' => 'page_delete',- 'entity_id' => null,- 'entity_type' => null,+ 'loggable_id' => null,+ 'loggable_type' => null,'detail' => $page->name,]);}diff --git a/tests/TestCase.php b/tests/TestCase.phpindex c59f843e9..b63de3076 100644--- a/tests/TestCase.php+++ b/tests/TestCase.php@@ -248,8 +248,8 @@ abstract class TestCase extends BaseTestCase$detailsToCheck = ['type' => $type];if ($entity) {- $detailsToCheck['entity_type'] = $entity->getMorphClass();- $detailsToCheck['entity_id'] = $entity->id;+ $detailsToCheck['loggable_type'] = $entity->getMorphClass();+ $detailsToCheck['loggable_id'] = $entity->id;}if ($detail) {diff --git a/tests/User/UserProfileTest.php b/tests/User/UserProfileTest.phpindex 4bfb3c878..065ae8dc8 100644--- a/tests/User/UserProfileTest.php+++ b/tests/User/UserProfileTest.php@@ -2,8 +2,8 @@namespace Tests\User;-use Activity;use BookStack\Activity\ActivityType;+use BookStack\Facades\Activity;use BookStack\Users\Models\User;use Tests\TestCase;