class ResourceResponseValidatorTest
Same name in other branches
- 8.9.x core/modules/jsonapi/tests/src/Unit/EventSubscriber/ResourceResponseValidatorTest.php \Drupal\Tests\jsonapi\Unit\EventSubscriber\ResourceResponseValidatorTest
- 10 core/modules/jsonapi/tests/src/Unit/EventSubscriber/ResourceResponseValidatorTest.php \Drupal\Tests\jsonapi\Unit\EventSubscriber\ResourceResponseValidatorTest
- 11.x core/modules/jsonapi/tests/src/Unit/EventSubscriber/ResourceResponseValidatorTest.php \Drupal\Tests\jsonapi\Unit\EventSubscriber\ResourceResponseValidatorTest
@coversDefaultClass \Drupal\jsonapi\EventSubscriber\ResourceResponseValidator @group jsonapi
@internal
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait
- class \Drupal\Tests\jsonapi\Unit\EventSubscriber\ResourceResponseValidatorTest extends \Drupal\Tests\UnitTestCase
Expanded class hierarchy of ResourceResponseValidatorTest
File
-
core/
modules/ jsonapi/ tests/ src/ Unit/ EventSubscriber/ ResourceResponseValidatorTest.php, line 24
Namespace
Drupal\Tests\jsonapi\Unit\EventSubscriberView source
class ResourceResponseValidatorTest extends UnitTestCase {
/**
* The subscriber under test.
*
* @var \Drupal\jsonapi\EventSubscriber\ResourceResponseSubscriber
*/
protected $subscriber;
/**
* {@inheritdoc}
*/
public function setUp() : void {
parent::setUp();
// Check that the validation class is available.
if (!class_exists("\\JsonSchema\\Validator")) {
$this->fail('The JSON Schema validator is missing. You can install it with `composer require justinrainbow/json-schema`.');
}
$module_handler = $this->prophesize(ModuleHandlerInterface::class);
$module = $this->prophesize(Extension::class);
$module_path = dirname(__DIR__, 4);
$module->getPath()
->willReturn($module_path);
$module_handler->getModule('jsonapi')
->willReturn($module->reveal());
$subscriber = new ResourceResponseValidator($this->prophesize(LoggerInterface::class)
->reveal(), $module_handler->reveal(), '');
$subscriber->setValidator();
$this->subscriber = $subscriber;
}
/**
* @covers ::doValidateResponse
*/
public function testDoValidateResponse() {
$request = $this->createRequest('jsonapi.node--article.individual', new ResourceType('node', 'article', NULL));
$response = $this->createResponse('{"data":null}');
// Capture the default assert settings.
$zend_assertions_default = ini_get('zend.assertions');
$assert_active_default = assert_options(ASSERT_ACTIVE);
// The validator *should* be called when asserts are active.
$validator = $this->prophesize(Validator::class);
$validator->check(Argument::any(), Argument::any())
->shouldBeCalled('Validation should be run when asserts are active.');
$validator->isValid()
->willReturn(TRUE);
$this->subscriber
->setValidator($validator->reveal());
// Ensure asset is active.
ini_set('zend.assertions', 1);
assert_options(ASSERT_ACTIVE, 1);
$this->subscriber
->doValidateResponse($response, $request);
// The validator should *not* be called when asserts are inactive.
$validator = $this->prophesize(Validator::class);
$validator->check(Argument::any(), Argument::any())
->shouldNotBeCalled('Validation should not be run when asserts are not active.');
$this->subscriber
->setValidator($validator->reveal());
// Ensure asset is inactive.
ini_set('zend.assertions', 0);
assert_options(ASSERT_ACTIVE, 0);
$this->subscriber
->doValidateResponse($response, $request);
// Reset the original assert values.
ini_set('zend.assertions', $zend_assertions_default);
assert_options(ASSERT_ACTIVE, $assert_active_default);
}
/**
* @covers ::validateResponse
* @dataProvider validateResponseProvider
*/
public function testValidateResponse($request, $response, $expected, $description) {
// Expose protected ResourceResponseSubscriber::validateResponse() method.
$object = new \ReflectionObject($this->subscriber);
$method = $object->getMethod('validateResponse');
$method->setAccessible(TRUE);
$this->assertSame($expected, $method->invoke($this->subscriber, $response, $request), $description);
}
/**
* Provides test cases for testValidateResponse.
*
* @return array
* An array of test cases.
*/
public function validateResponseProvider() {
$defaults = [
'route_name' => 'jsonapi.node--article.individual',
'resource_type' => new ResourceType('node', 'article', NULL),
];
$test_data = [
// Test validation success.
[
'json' => <<<'EOD'
{
"data": {
"type": "node--article",
"id": "4f342419-e668-4b76-9f87-7ce20c436169",
"attributes": {
"nid": "1",
"uuid": "4f342419-e668-4b76-9f87-7ce20c436169"
}
}
}
EOD
,
'expected' => TRUE,
'description' => 'Response validation flagged a valid response.',
],
// Test validation failure: no "type" in "data".
[
'json' => <<<'EOD'
{
"data": {
"id": "4f342419-e668-4b76-9f87-7ce20c436169",
"attributes": {
"nid": "1",
"uuid": "4f342419-e668-4b76-9f87-7ce20c436169"
}
}
}
EOD
,
'expected' => FALSE,
'description' => 'Response validation failed to flag an invalid response.',
],
// Test validation failure: "errors" at the root level.
[
'json' => <<<'EOD'
{
"data": {
"type": "node--article",
"id": "4f342419-e668-4b76-9f87-7ce20c436169",
"attributes": {
"nid": "1",
"uuid": "4f342419-e668-4b76-9f87-7ce20c436169"
}
},
"errors": [{}]
}
EOD
,
'expected' => FALSE,
'description' => 'Response validation failed to flag an invalid response.',
],
// Test validation of an empty response passes.
[
'json' => NULL,
'expected' => TRUE,
'description' => 'Response validation flagged a valid empty response.',
],
// Test validation fails on empty object.
[
'json' => '{}',
'expected' => FALSE,
'description' => 'Response validation flags empty array as invalid.',
],
];
$test_cases = array_map(function ($input) use ($defaults) {
[
$json,
$expected,
$description,
$route_name,
$resource_type,
] = array_values($input + $defaults);
return [
$this->createRequest($route_name, $resource_type),
$this->createResponse($json),
$expected,
$description,
];
}, $test_data);
return $test_cases;
}
/**
* Helper method to create a request object.
*
* @param string $route_name
* The route name with which to construct a request.
* @param \Drupal\jsonapi\ResourceType\ResourceType $resource_type
* The resource type for the requested route.
*
* @return \Symfony\Component\HttpFoundation\Request
* The mock request object.
*/
protected function createRequest($route_name, ResourceType $resource_type) {
$request = new Request();
$request->attributes
->set(RouteObjectInterface::ROUTE_NAME, $route_name);
$request->attributes
->set(Routes::RESOURCE_TYPE_KEY, $resource_type);
return $request;
}
/**
* Helper method to create a resource response from arbitrary JSON.
*
* @param string|null $json
* The JSON with which to create a mock response.
*
* @return \Drupal\rest\ResourceResponse
* The mock response object.
*/
protected function createResponse($json = NULL) {
$response = new ResourceResponse();
if ($json) {
$response->setContent($json);
}
return $response;
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
PhpUnitWarnings::$deprecationWarnings | private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |||
PhpUnitWarnings::addWarning | public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |||
ResourceResponseValidatorTest::$subscriber | protected | property | The subscriber under test. | |||
ResourceResponseValidatorTest::createRequest | protected | function | Helper method to create a request object. | |||
ResourceResponseValidatorTest::createResponse | protected | function | Helper method to create a resource response from arbitrary JSON. | |||
ResourceResponseValidatorTest::setUp | public | function | Overrides UnitTestCase::setUp | |||
ResourceResponseValidatorTest::testDoValidateResponse | public | function | @covers ::doValidateResponse | |||
ResourceResponseValidatorTest::testValidateResponse | public | function | @covers ::validateResponse @dataProvider validateResponseProvider |
|||
ResourceResponseValidatorTest::validateResponseProvider | public | function | Provides test cases for testValidateResponse. | |||
UnitTestCase::$randomGenerator | protected | property | The random generator. | |||
UnitTestCase::$root | protected | property | The app root. | 1 | ||
UnitTestCase::assertArrayEquals | Deprecated | protected | function | Asserts if two arrays are equal by sorting them first. | ||
UnitTestCase::getClassResolverStub | protected | function | Returns a stub class resolver. | |||
UnitTestCase::getConfigFactoryStub | public | function | Returns a stub config factory that behaves according to the passed array. | |||
UnitTestCase::getConfigStorageStub | public | function | Returns a stub config storage that returns the supplied configuration. | |||
UnitTestCase::getContainerWithCacheTagsInvalidator | protected | function | Sets up a container with a cache tags invalidator. | |||
UnitTestCase::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | |||
UnitTestCase::getStringTranslationStub | public | function | Returns a stub translation manager that just returns the passed string. | |||
UnitTestCase::randomMachineName | public | function | Generates a unique random string containing letters and numbers. | |||
UnitTestCase::setUpBeforeClass | public static | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.