cerebrate-project
/
cerebrate
mirror of https://github.com/cerebrate-project/cerebrate
1
0
Fork 0
Code Issues Releases Wiki Activity

chg: move openapi validator initialization to tests/bootstrap.php so its only parsed once.

pull/80/head
Luciano Righetti 2022-01-19 16:08:50 +01:00
parent 862ea58e49
commit b1f63f190c
3 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
tests/Helper/ApiTestTrait.php
View File

@ -5,14 +5,14 @@ declare(strict_types=1);
namespace App\Test\Helper;
use Cake\TestSuite\IntegrationTestTrait;
use Cake\Http\Exception\NotImplementedException;
use Cake\Core\Configure;
use Cake\Http\ServerRequestFactory;
use Cake\Http\ServerRequest;
use Cake\Http\Exception\NotImplementedException;
use \League\OpenAPIValidation\PSR7\ValidatorBuilder;
use \League\OpenAPIValidation\PSR7\RequestValidator;
use \League\OpenAPIValidation\PSR7\ResponseValidator;
use \League\OpenAPIValidation\PSR7\OperationAddress;
use PHPUnit\Exception as PHPUnitException;
/**
* Trait ApiTestTrait
@ -47,7 +47,7 @@ trait ApiTestTrait
public function setUp(): void
{
parent::setUp();
$this->initializeOpenApiValidator($_ENV['OPENAPI_SPEC'] ?? APP . '../webroot/docs/openapi.yaml');
$this->initializeOpenApiValidator();
}
public function setAuthToken(string $authToken): void
@ -83,16 +83,18 @@ trait ApiTestTrait
}
/**
* Parse the OpenAPI specification and create a validator
* Load OpenAPI specification validator
*
* @param string $specFile
* @return void
*/
public function initializeOpenApiValidator(string $specFile): void
public function initializeOpenApiValidator(): void
{
$this->_validator = (new ValidatorBuilder)->fromYamlFile($specFile);
$this->_requestValidator = $this->_validator->getRequestValidator();
$this->_responseValidator = $this->_validator->getResponseValidator();
if (!$this->_skipOpenApiValidations) {
$this->_validator = Configure::read('App.OpenAPIValidator');
if ($this->_validator === null) {
throw new \Exception('OpenAPI validator is not configured');
}
}
}
/**
@ -102,7 +104,7 @@ trait ApiTestTrait
*/
public function assertRequestMatchesOpenApiSpec(): void
{
$this->_requestValidator->validate($this->_psrRequest);
$this->_validator->getRequestValidator()->validate($this->_psrRequest);
}
/**
@ -115,7 +117,7 @@ trait ApiTestTrait
public function assertResponseMatchesOpenApiSpec(string $endpoint, string $method = 'get'): void
{
$address = new OperationAddress($endpoint, $method);
$this->_responseValidator->validate($address, $this->_response);
$this->_validator->getResponseValidator()->validate($address, $this->_response);
}
/**

2
tests/TestCase/Api/Users/ChangePasswordApiTest.php
View File

@ -36,7 +36,7 @@ class ChangePasswordApiTest extends TestCase
public function setUp(): void
{
parent::setUp();
$this->initializeOpenApiValidator($_ENV['OPENAPI_SPEC'] ?? APP . '../webroot/docs/openapi.yaml');
$this->initializeOpenApiValidator();
$this->collection = new ComponentRegistry();
$this->auth = new FormAuthenticate($this->collection, [

8
tests/bootstrap.php
View File

@ -19,6 +19,10 @@ declare(strict_types=1);
use Cake\Core\Configure;
use Cake\Datasource\ConnectionManager;
use Migrations\TestSuite\Migrator;
use \League\OpenAPIValidation\PSR7\ValidatorBuilder;
use \League\OpenAPIValidation\PSR7\RequestValidator;
use \League\OpenAPIValidation\PSR7\ResponseValidator;
use \League\OpenAPIValidation\PSR7\OperationAddress;
/**
* Test runner bootstrap.
@ -64,3 +68,7 @@ if (!$_ENV['SKIP_DB_MIGRATIONS']) {
} else {
echo "[ * ] Skipping DB migrations ...\n";
}
$specFile = $_ENV['OPENAPI_SPEC'] ?? APP . '../webroot/docs/openapi.yaml';
// Initialize OpenAPI spec validator
Configure::write('App.OpenAPIValidator', (new ValidatorBuilder)->fromYamlFile($specFile));