class EntityRevisionParamConverterTest
Same name in other branches
- 9 core/tests/Drupal/Tests/Core/ParamConverter/EntityRevisionParamConverterTest.php \Drupal\Tests\Core\ParamConverter\EntityRevisionParamConverterTest
- 8.9.x core/tests/Drupal/Tests/Core/ParamConverter/EntityRevisionParamConverterTest.php \Drupal\Tests\Core\ParamConverter\EntityRevisionParamConverterTest
- 10 core/tests/Drupal/Tests/Core/ParamConverter/EntityRevisionParamConverterTest.php \Drupal\Tests\Core\ParamConverter\EntityRevisionParamConverterTest
@coversDefaultClass \Drupal\Core\ParamConverter\EntityRevisionParamConverter @group entity
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\RandomGeneratorTrait
- class \Drupal\Tests\Core\ParamConverter\EntityRevisionParamConverterTest extends \Drupal\Tests\UnitTestCase
Expanded class hierarchy of EntityRevisionParamConverterTest
File
-
core/
tests/ Drupal/ Tests/ Core/ ParamConverter/ EntityRevisionParamConverterTest.php, line 20
Namespace
Drupal\Tests\Core\ParamConverterView source
class EntityRevisionParamConverterTest extends UnitTestCase {
/**
* The tested entity revision param converter.
*
* @var \Drupal\Core\ParamConverter\EntityRevisionParamConverter
*/
protected $converter;
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->converter = new EntityRevisionParamConverter($this->prophesize(EntityTypeManagerInterface::class)
->reveal(), $this->prophesize(EntityRepositoryInterface::class)
->reveal());
}
protected function getTestRoute() {
$route = new Route('/test/{test_revision}');
$route->setOption('parameters', [
'test_revision' => [
'type' => 'entity_revision:test',
],
]);
return $route;
}
/**
* @covers ::applies
*/
public function testNonApplyingRoute() : void {
$route = new Route('/test');
$this->assertFalse($this->converter
->applies([], 'test_revision', $route));
}
/**
* @covers ::applies
*/
public function testApplyingRoute() : void {
$route = $this->getTestRoute();
$this->assertTrue($this->converter
->applies($route->getOption('parameters')['test_revision'], 'test_revision', $route));
}
/**
* Tests the convert() method.
*
* @dataProvider providerTestConvert
*
* @covers ::convert
*/
public function testConvert($value, array $definition, array $defaults, $expected_result) : void {
$storage = $this->prophesize(RevisionableStorageInterface::class);
$storage->loadRevision('valid_id')
->willReturn((object) [
'revision_id' => 'valid_id',
]);
$storage->loadRevision('invalid_id')
->willReturn(NULL);
$entity_type_manager = $this->prophesize(EntityTypeManagerInterface::class);
$entity_type_manager->getStorage('entity_test')
->willReturn($storage->reveal());
$entity_repository = $this->prophesize(EntityRepositoryInterface::class);
$converter = new EntityRevisionParamConverter($entity_type_manager->reveal(), $entity_repository->reveal());
$result = $converter->convert($value, $definition, 'test_revision', $defaults);
$this->assertEquals($expected_result, $result);
}
/**
* Provides test data for testConvert.
*/
public static function providerTestConvert() {
$data = [];
// Existing entity type.
$data[] = [
'valid_id',
[
'type' => 'entity_revision:entity_test',
],
[
'test_revision' => 'valid_id',
],
(object) [
'revision_id' => 'valid_id',
],
];
// Invalid ID.
$data[] = [
'invalid_id',
[
'type' => 'entity_revision:entity_test',
],
[
'test_revision' => 'invalid_id',
],
NULL,
];
// Entity type placeholder.
$data[] = [
'valid_id',
[
'type' => 'entity_revision:{entity_type}',
],
[
'test_revision' => 'valid_id',
'entity_type' => 'entity_test',
],
(object) [
'revision_id' => 'valid_id',
],
];
return $data;
}
/**
* Tests the convert() method with an invalid entity type ID.
*
* @covers ::convert
*/
public function testConvertWithInvalidEntityType() : void {
$entity_type_manager = $this->prophesize(EntityTypeManagerInterface::class);
$entity_type_manager->getStorage('invalid_entity_type_id')
->willThrow(new InvalidPluginDefinitionException('invalid_entity_type_id'));
$entity_repository = $this->prophesize(EntityRepositoryInterface::class);
$converter = new EntityRevisionParamConverter($entity_type_manager->reveal(), $entity_repository->reveal());
$this->expectException(InvalidPluginDefinitionException::class);
$converter->convert('valid_id', [
'type' => 'entity_revision:invalid_entity_type_id',
], 'foo', [
'foo' => 'valid_id',
]);
}
/**
* Tests the convert() method with an invalid dynamic entity type ID.
*
* @covers ::convert
*/
public function testConvertWithInvalidType() : void {
$this->expectException(ParamNotConvertedException::class);
$this->expectExceptionMessage('The type definition "entity_revision_{entity_type_id}" is invalid. The expected format is "entity_revision:<entity_type_id>".');
$this->converter
->convert('valid_id', [
'type' => 'entity_revision_{entity_type_id}',
], 'foo', [
'foo' => 'valid_id',
]);
}
/**
* Tests the convert() method with an invalid dynamic entity type ID.
*
* @covers ::convert
*/
public function testConvertWithInvalidDynamicEntityType() : void {
$this->expectException(ParamNotConvertedException::class);
$this->expectExceptionMessage('The "foo" parameter was not converted because the "invalid_entity_type_id" parameter is missing.');
$this->converter
->convert('valid_id', [
'type' => 'entity_revision:{invalid_entity_type_id}',
], 'foo', [
'foo' => 'valid_id',
]);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
EntityRevisionParamConverterTest::$converter | protected | property | The tested entity revision param converter. | |
EntityRevisionParamConverterTest::getTestRoute | protected | function | ||
EntityRevisionParamConverterTest::providerTestConvert | public static | function | Provides test data for testConvert. | |
EntityRevisionParamConverterTest::setUp | protected | function | Overrides UnitTestCase::setUp | |
EntityRevisionParamConverterTest::testApplyingRoute | public | function | @covers ::applies | |
EntityRevisionParamConverterTest::testConvert | public | function | Tests the convert() method. | |
EntityRevisionParamConverterTest::testConvertWithInvalidDynamicEntityType | public | function | Tests the convert() method with an invalid dynamic entity type ID. | |
EntityRevisionParamConverterTest::testConvertWithInvalidEntityType | public | function | Tests the convert() method with an invalid entity type ID. | |
EntityRevisionParamConverterTest::testConvertWithInvalidType | public | function | Tests the convert() method with an invalid dynamic entity type ID. | |
EntityRevisionParamConverterTest::testNonApplyingRoute | public | function | @covers ::applies | |
ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. | |
ExpectDeprecationTrait::getCallableName | private static | function | Returns a callable as a string suitable for inclusion in a message. | |
ExpectDeprecationTrait::setUpErrorHandler | public | function | Sets up the test error handler. | |
ExpectDeprecationTrait::tearDownErrorHandler | public | function | Tears down the test error handler. | |
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | |
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | |
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
UnitTestCase::$root | protected | property | The app root. | |
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::getStringTranslationStub | public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase::setUpBeforeClass | public static | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.