BookStack/tests/Api/TestsApi.php

81 lines
2.0 KiB
PHP
Raw Normal View History

2021-06-26 11:23:15 -04:00
<?php
namespace Tests\Api;
2023-05-17 12:56:55 -04:00
use BookStack\Users\Models\User;
trait TestsApi
{
protected string $apiTokenId = 'apitoken';
protected string $apiTokenSecret = 'password';
/**
* Set the given user as the current logged-in user via the API driver.
* This does not ensure API access. The user may still lack required role permissions.
*/
protected function actingAsForApi(User $user): static
{
parent::actingAs($user, 'api');
return $this;
}
/**
* Set the API editor role as the current user via the API driver.
*/
protected function actingAsApiEditor(): static
{
$this->actingAs($this->users->editor(), 'api');
2021-06-26 11:23:15 -04:00
return $this;
}
/**
* Set the API admin role as the current user via the API driver.
*/
protected function actingAsApiAdmin(): static
{
$this->actingAs($this->users->admin(), 'api');
return $this;
}
/**
* Format the given items into a standardised error format.
*/
protected function errorResponse(string $message, int $code): array
{
2021-06-26 11:23:15 -04:00
return ['error' => ['code' => $code, 'message' => $message]];
}
/**
* Get the structure that matches a permission error response.
*/
protected function permissionErrorResponse(): array
{
return $this->errorResponse('You do not have permission to perform the requested action.', 403);
}
2020-05-22 19:28:41 -04:00
/**
* Format the given (field_name => ["messages"]) array
* into a standard validation response format.
*/
protected function validationResponse(array $messages): array
{
2021-06-26 11:23:15 -04:00
$err = $this->errorResponse('The given data was invalid.', 422);
2020-05-22 19:28:41 -04:00
$err['error']['validation'] = $messages;
2021-06-26 11:23:15 -04:00
2020-05-22 19:28:41 -04:00
return $err;
}
2021-06-26 11:23:15 -04:00
/**
* Get an approved API auth header.
*/
protected function apiAuthHeader(): array
{
return [
2021-06-26 11:23:15 -04:00
'Authorization' => "Token {$this->apiTokenId}:{$this->apiTokenSecret}",
];
}
2021-06-26 11:23:15 -04:00
}