webapp/bookstack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2025-07-30 04:23:11 +03:00
Code Activity

Filled out base Book API endpoints, added example responses

Browse Source
This commit is contained in:
Dan Brown
2020-01-12 14:45:54 +00:00
parent a8595d8aaf
commit 04a8614136
12 changed files with 284 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
tests/Api/BooksApiTest.php Normal file
View File

@ -0,0 +1,87 @@
<?php namespace Tests;
use BookStack\Entities\Book;
class ApiAuthTest extends TestCase
{
use TestsApi;
protected $baseEndpoint = '/api/books';
public function test_index_endpoint_returns_expected_book()
{
$this->actingAsApiEditor();
$firstBook = Book::query()->orderBy('id', 'asc')->first();
$resp = $this->getJson($this->baseEndpoint . '?count=1&sort=+id');
$resp->assertJson(['data' => [
[
'id' => $firstBook->id,
'name' => $firstBook->name,
'slug' => $firstBook->slug,
]
]]);
}
public function test_create_endpoint()
{
$this->actingAsApiEditor();
$details = [
'name' => 'My API book',
'description' => 'A book created via the API',
];
$resp = $this->postJson($this->baseEndpoint, $details);
$resp->assertStatus(200);
$newItem = Book::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();
$resp->assertJson(array_merge($details, ['id' => $newItem->id, 'slug' => $newItem->slug]));
$this->assertActivityExists('book_create', $newItem);
}
public function test_read_endpoint()
{
$this->actingAsApiEditor();
$book = Book::visible()->first();
$resp = $this->getJson($this->baseEndpoint . "/{$book->id}");
$resp->assertStatus(200);
$resp->assertJson([
'id' => $book->id,
'slug' => $book->slug,
'created_by' => [
'name' => $book->createdBy->name,
],
'updated_by' => [
'name' => $book->createdBy->name,
]
]);
}
public function test_update_endpoint()
{
$this->actingAsApiEditor();
$book = Book::visible()->first();
$details = [
'name' => 'My updated API book',
'description' => 'A book created via the API',
];
$resp = $this->putJson($this->baseEndpoint . "/{$book->id}", $details);
$book->refresh();
$resp->assertStatus(200);
$resp->assertJson(array_merge($details, ['id' => $book->id, 'slug' => $book->slug]));
$this->assertActivityExists('book_update', $book);
}
public function test_delete_endpoint()
{
$this->actingAsApiEditor();
$book = Book::visible()->first();
$resp = $this->deleteJson($this->baseEndpoint . "/{$book->id}");
$resp->assertStatus(204);
$this->assertActivityExists('book_delete');
}
}

17
tests/TestCase.php
View File

@ -1,5 +1,6 @@
<?php namespace Tests;
use BookStack\Entities\Entity;
use Illuminate\Foundation\Testing\DatabaseTransactions;
use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
@ -60,4 +61,20 @@ abstract class TestCase extends BaseTestCase
{
return TestResponse::fromBaseResponse($response);
}
/**
* Assert that an activity entry exists of the given key.
* Checks the activity belongs to the given entity if provided.
*/
protected function assertActivityExists(string $key, Entity $entity = null)
{
$detailsToCheck = ['key' => $key];
if ($entity) {
$detailsToCheck['entity_type'] = $entity->getMorphClass();
$detailsToCheck['entity_id'] = $entity->id;
}
$this->assertDatabaseHas('activities', $detailsToCheck);
}
}