class ResourceTypeRepositoryTest
Same name in other branches
- 9 core/modules/jsonapi/tests/src/Kernel/ResourceType/ResourceTypeRepositoryTest.php \Drupal\Tests\jsonapi\Kernel\ResourceType\ResourceTypeRepositoryTest
- 10 core/modules/jsonapi/tests/src/Kernel/ResourceType/ResourceTypeRepositoryTest.php \Drupal\Tests\jsonapi\Kernel\ResourceType\ResourceTypeRepositoryTest
- 11.x core/modules/jsonapi/tests/src/Kernel/ResourceType/ResourceTypeRepositoryTest.php \Drupal\Tests\jsonapi\Kernel\ResourceType\ResourceTypeRepositoryTest
@coversDefaultClass \Drupal\jsonapi\ResourceType\ResourceTypeRepository @group jsonapi
@internal
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertLegacyTrait, \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\AssertHelperTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\PhpunitCompatibilityTrait
- class \Drupal\Tests\jsonapi\Kernel\JsonapiKernelTestBase extends \Drupal\KernelTests\KernelTestBase
- class \Drupal\Tests\jsonapi\Kernel\ResourceType\ResourceTypeRepositoryTest extends \Drupal\Tests\jsonapi\Kernel\JsonapiKernelTestBase
- class \Drupal\Tests\jsonapi\Kernel\JsonapiKernelTestBase extends \Drupal\KernelTests\KernelTestBase
Expanded class hierarchy of ResourceTypeRepositoryTest
File
-
core/
modules/ jsonapi/ tests/ src/ Kernel/ ResourceType/ ResourceTypeRepositoryTest.php, line 16
Namespace
Drupal\Tests\jsonapi\Kernel\ResourceTypeView source
class ResourceTypeRepositoryTest extends JsonapiKernelTestBase {
/**
* {@inheritdoc}
*/
public static $modules = [
'field',
'node',
'serialization',
'system',
'user',
'jsonapi_test_resource_type_building',
];
/**
* The JSON:API resource type repository under test.
*
* @var \Drupal\jsonapi\ResourceType\ResourceTypeRepository
*/
protected $resourceTypeRepository;
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
// Add the entity schemas.
$this->installEntitySchema('node');
$this->installEntitySchema('user');
// Add the additional table schemas.
$this->installSchema('system', [
'sequences',
]);
$this->installSchema('node', [
'node_access',
]);
$this->installSchema('user', [
'users_data',
]);
NodeType::create([
'type' => 'article',
])->save();
NodeType::create([
'type' => 'page',
])->save();
NodeType::create([
'type' => '42',
])->save();
$this->resourceTypeRepository = $this->container
->get('jsonapi.resource_type.repository');
}
/**
* @covers ::all
*/
public function testAll() {
// Make sure that there are resources being created.
$all = $this->resourceTypeRepository
->all();
$this->assertNotEmpty($all);
array_walk($all, function (ResourceType $resource_type) {
$this->assertNotEmpty($resource_type->getDeserializationTargetClass());
$this->assertNotEmpty($resource_type->getEntityTypeId());
$this->assertNotEmpty($resource_type->getTypeName());
});
}
/**
* @covers ::get
* @dataProvider getProvider
*/
public function testGet($entity_type_id, $bundle, $entity_class) {
// Make sure that there are resources being created.
$resource_type = $this->resourceTypeRepository
->get($entity_type_id, $bundle);
$this->assertInstanceOf(ResourceType::class, $resource_type);
$this->assertSame($entity_class, $resource_type->getDeserializationTargetClass());
$this->assertSame($entity_type_id, $resource_type->getEntityTypeId());
$this->assertSame($bundle, $resource_type->getBundle());
$this->assertSame($entity_type_id . '--' . $bundle, $resource_type->getTypeName());
}
/**
* Data provider for testGet.
*
* @returns array
* The data for the test method.
*/
public function getProvider() {
return [
[
'node',
'article',
'Drupal\\node\\Entity\\Node',
],
[
'node',
'42',
'Drupal\\node\\Entity\\Node',
],
[
'node_type',
'node_type',
'Drupal\\node\\Entity\\NodeType',
],
[
'menu',
'menu',
'Drupal\\system\\Entity\\Menu',
],
];
}
/**
* Ensures that the ResourceTypeRepository's cache does not become stale.
*/
public function testCaching() {
$this->assertEmpty($this->resourceTypeRepository
->get('node', 'article')
->getRelatableResourceTypesByField('field_relationship'));
$this->createEntityReferenceField('node', 'article', 'field_relationship', 'Related entity', 'node');
$this->assertCount(3, $this->resourceTypeRepository
->get('node', 'article')
->getRelatableResourceTypesByField('field_relationship'));
NodeType::create([
'type' => 'camelids',
])->save();
$this->assertCount(4, $this->resourceTypeRepository
->get('node', 'article')
->getRelatableResourceTypesByField('field_relationship'));
}
/**
* Ensures that a naming conflict in the mapping causes an exception to be
* thrown.
*
* @covers ::getFieldMapping
* @dataProvider getFieldMappingProvider
*/
public function testMappingNameConflictCheck($field_name_list) {
$entity_type = \Drupal::entityTypeManager()->getDefinition('node');
$bundle = 'article';
$reflection_class = new \ReflectionClass($this->resourceTypeRepository);
$reflection_method = $reflection_class->getMethod('getFields');
$reflection_method->setAccessible(TRUE);
$this->expectException(\LogicException::class);
$this->expectExceptionMessage("The generated alias '{$field_name_list[1]}' for field name '{$field_name_list[0]}' conflicts with an existing field. Please report this in the JSON:API issue queue!");
$reflection_method->invokeArgs($this->resourceTypeRepository, [
$field_name_list,
$entity_type,
$bundle,
]);
}
/**
* Data provider for testGetFieldMapping.
*
* These field name lists are designed to trigger a naming conflict in the
* mapping: the special-cased names "type" or "id", and the name
* "{$entity_type_id}_type" or "{$entity_type_id}_id", respectively.
*
* @returns array
* The data for the test method.
*/
public function getFieldMappingProvider() {
return [
[
[
'type',
'node_type',
],
],
[
[
'id',
'node_id',
],
],
];
}
/**
* Tests that resource types can be disabled by a build subscriber.
*/
public function testResourceTypeDisabling() {
$this->assertFalse($this->resourceTypeRepository
->getByTypeName('node--article')
->isInternal());
$this->assertFalse($this->resourceTypeRepository
->getByTypeName('node--page')
->isInternal());
$this->assertFalse($this->resourceTypeRepository
->getByTypeName('user--user')
->isInternal());
$disabled_resource_types = [
'node--page',
'user--user',
];
\Drupal::state()->set('jsonapi_test_resource_type_builder.disabled_resource_types', $disabled_resource_types);
Cache::invalidateTags([
'jsonapi_resource_types',
]);
$this->assertFalse($this->resourceTypeRepository
->getByTypeName('node--article')
->isInternal());
$this->assertTrue($this->resourceTypeRepository
->getByTypeName('node--page')
->isInternal());
$this->assertTrue($this->resourceTypeRepository
->getByTypeName('user--user')
->isInternal());
}
/**
* Tests that resource type fields can be aliased per resource type.
*/
public function testResourceTypeFieldAliasing() {
$this->assertSame($this->resourceTypeRepository
->getByTypeName('node--article')
->getPublicName('uid'), 'uid');
$this->assertSame($this->resourceTypeRepository
->getByTypeName('node--page')
->getPublicName('uid'), 'uid');
$resource_type_field_aliases = [
'node--article' => [
'uid' => 'author',
],
'node--page' => [
'uid' => 'owner',
],
];
\Drupal::state()->set('jsonapi_test_resource_type_builder.resource_type_field_aliases', $resource_type_field_aliases);
Cache::invalidateTags([
'jsonapi_resource_types',
]);
$this->assertSame($this->resourceTypeRepository
->getByTypeName('node--article')
->getPublicName('uid'), 'author');
$this->assertSame($this->resourceTypeRepository
->getByTypeName('node--page')
->getPublicName('uid'), 'owner');
}
/**
* Tests that resource type fields can be disabled per resource type.
*/
public function testResourceTypeFieldDisabling() {
$this->assertTrue($this->resourceTypeRepository
->getByTypeName('node--article')
->isFieldEnabled('uid'));
$this->assertTrue($this->resourceTypeRepository
->getByTypeName('node--page')
->isFieldEnabled('uid'));
$disabled_resource_type_fields = [
'node--article' => [
'uid' => TRUE,
],
'node--page' => [
'uid' => FALSE,
],
];
\Drupal::state()->set('jsonapi_test_resource_type_builder.disabled_resource_type_fields', $disabled_resource_type_fields);
Cache::invalidateTags([
'jsonapi_resource_types',
]);
$this->assertFalse($this->resourceTypeRepository
->getByTypeName('node--article')
->isFieldEnabled('uid'));
$this->assertTrue($this->resourceTypeRepository
->getByTypeName('node--page')
->isFieldEnabled('uid'));
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
AssertContentTrait::$content | protected | property | The current raw content. | |||
AssertContentTrait::$drupalSettings | protected | property | The drupalSettings value from the current raw $content. | |||
AssertContentTrait::$elements | protected | property | The XML structure parsed from the current raw $content. | 1 | ||
AssertContentTrait::$plainTextContent | protected | property | The plain-text content of raw $content (text nodes). | |||
AssertContentTrait::assertEscaped | protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |||
AssertContentTrait::assertField | protected | function | Asserts that a field exists with the given name or ID. | |||
AssertContentTrait::assertFieldById | protected | function | Asserts that a field exists with the given ID and value. | |||
AssertContentTrait::assertFieldByName | protected | function | Asserts that a field exists with the given name and value. | |||
AssertContentTrait::assertFieldByXPath | protected | function | Asserts that a field exists in the current page by the given XPath. | |||
AssertContentTrait::assertFieldChecked | protected | function | Asserts that a checkbox field in the current page is checked. | |||
AssertContentTrait::assertFieldsByValue | protected | function | Asserts that a field exists in the current page with a given Xpath result. | |||
AssertContentTrait::assertLink | protected | function | Passes if a link with the specified label is found. | |||
AssertContentTrait::assertLinkByHref | protected | function | Passes if a link containing a given href (part) is found. | |||
AssertContentTrait::assertNoDuplicateIds | protected | function | Asserts that each HTML ID is used for just a single element. | |||
AssertContentTrait::assertNoEscaped | protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. |
|||
AssertContentTrait::assertNoField | protected | function | Asserts that a field does not exist with the given name or ID. | |||
AssertContentTrait::assertNoFieldById | protected | function | Asserts that a field does not exist with the given ID and value. | |||
AssertContentTrait::assertNoFieldByName | protected | function | Asserts that a field does not exist with the given name and value. | |||
AssertContentTrait::assertNoFieldByXPath | protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |||
AssertContentTrait::assertNoFieldChecked | protected | function | Asserts that a checkbox field in the current page is not checked. | |||
AssertContentTrait::assertNoLink | protected | function | Passes if a link with the specified label is not found. | |||
AssertContentTrait::assertNoLinkByHref | protected | function | Passes if a link containing a given href (part) is not found. | |||
AssertContentTrait::assertNoLinkByHrefInMainRegion | protected | function | Passes if a link containing a given href is not found in the main region. | |||
AssertContentTrait::assertNoOption | protected | function | Asserts that a select option in the current page does not exist. | |||
AssertContentTrait::assertNoOptionSelected | protected | function | Asserts that a select option in the current page is not checked. | |||
AssertContentTrait::assertNoPattern | protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |||
AssertContentTrait::assertNoRaw | protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |||
AssertContentTrait::assertNoText | protected | function | Passes if the page (with HTML stripped) does not contains the text. | |||
AssertContentTrait::assertNoTitle | protected | function | Pass if the page title is not the given string. | |||
AssertContentTrait::assertNoUniqueText | protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |||
AssertContentTrait::assertOption | protected | function | Asserts that a select option in the current page exists. | |||
AssertContentTrait::assertOptionByText | protected | function | Asserts that a select option with the visible text exists. | |||
AssertContentTrait::assertOptionSelected | protected | function | Asserts that a select option in the current page is checked. | |||
AssertContentTrait::assertOptionSelectedWithDrupalSelector | protected | function | Asserts that a select option in the current page is checked. | |||
AssertContentTrait::assertOptionWithDrupalSelector | protected | function | Asserts that a select option in the current page exists. | |||
AssertContentTrait::assertPattern | protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |||
AssertContentTrait::assertRaw | protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |||
AssertContentTrait::assertText | protected | function | Passes if the page (with HTML stripped) contains the text. | |||
AssertContentTrait::assertTextHelper | protected | function | Helper for assertText and assertNoText. | |||
AssertContentTrait::assertTextPattern | protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |||
AssertContentTrait::assertThemeOutput | protected | function | Asserts themed output. | |||
AssertContentTrait::assertTitle | protected | function | Pass if the page title is the given string. | |||
AssertContentTrait::assertUniqueText | protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |||
AssertContentTrait::assertUniqueTextHelper | protected | function | Helper for assertUniqueText and assertNoUniqueText. | |||
AssertContentTrait::buildXPathQuery | protected | function | Builds an XPath query. | |||
AssertContentTrait::constructFieldXpath | protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |||
AssertContentTrait::cssSelect | protected | function | Searches elements using a CSS selector in the raw content. | |||
AssertContentTrait::getAllOptions | protected | function | Get all option elements, including nested options, in a select. | |||
AssertContentTrait::getDrupalSettings | protected | function | Gets the value of drupalSettings for the currently-loaded page. | |||
AssertContentTrait::getRawContent | protected | function | Gets the current raw content. | |||
AssertContentTrait::getSelectedItem | protected | function | Get the selected value from a select field. | |||
AssertContentTrait::getTextContent | protected | function | Retrieves the plain-text content from the current raw content. | |||
AssertContentTrait::getUrl | protected | function | Get the current URL from the cURL handler. | 1 | ||
AssertContentTrait::parse | protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |||
AssertContentTrait::removeWhiteSpace | protected | function | Removes all white-space between HTML tags from the raw content. | |||
AssertContentTrait::setDrupalSettings | protected | function | Sets the value of drupalSettings for the currently-loaded page. | |||
AssertContentTrait::setRawContent | protected | function | Sets the raw content (e.g. HTML). | |||
AssertContentTrait::xpath | protected | function | Performs an xpath search on the contents of the internal browser. | |||
AssertHelperTrait::castSafeStrings | protected static | function | Casts MarkupInterface objects into strings. | |||
AssertLegacyTrait::assert | protected | function | ||||
AssertLegacyTrait::assertEqual | protected | function | ||||
AssertLegacyTrait::assertIdentical | protected | function | ||||
AssertLegacyTrait::assertIdenticalObject | protected | function | ||||
AssertLegacyTrait::assertNotEqual | protected | function | ||||
AssertLegacyTrait::assertNotIdentical | protected | function | ||||
AssertLegacyTrait::pass | protected | function | ||||
AssertLegacyTrait::verbose | protected | function | ||||
ConfigTestTrait::configImporter | protected | function | Returns a ConfigImporter object to import test configuration. | |||
ConfigTestTrait::copyConfig | protected | function | Copies configuration objects from source storage to target storage. | |||
JsonapiKernelTestBase::createEntityReferenceField | protected | function | Creates a field of an entity reference field storage on the bundle. | |||
JsonapiKernelTestBase::createTextField | protected | function | Creates a field of an entity reference field storage on the bundle. | |||
KernelTestBase::$backupGlobals | protected | property | Back up and restore any global variables that may be changed by tests. | |||
KernelTestBase::$backupStaticAttributes | protected | property | Back up and restore static class properties that may be changed by tests. | |||
KernelTestBase::$backupStaticAttributesBlacklist | protected | property | Contains a few static class properties for performance. | |||
KernelTestBase::$classLoader | protected | property | ||||
KernelTestBase::$configImporter | protected | property | @todo Move into Config test base class. | 7 | ||
KernelTestBase::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | |||
KernelTestBase::$container | protected | property | ||||
KernelTestBase::$databasePrefix | protected | property | ||||
KernelTestBase::$preserveGlobalState | protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. |
|||
KernelTestBase::$root | protected | property | The app root. | |||
KernelTestBase::$runTestInSeparateProcess | protected | property | Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property. |
|||
KernelTestBase::$siteDirectory | protected | property | ||||
KernelTestBase::$strictConfigSchema | protected | property | Set to TRUE to strict check all configuration saved. | 6 | ||
KernelTestBase::$vfsRoot | protected | property | The virtual filesystem root directory. | |||
KernelTestBase::assertPostConditions | protected | function | 1 | |||
KernelTestBase::bootEnvironment | protected | function | Bootstraps a basic test environment. | |||
KernelTestBase::bootKernel | private | function | Bootstraps a kernel for a test. | |||
KernelTestBase::config | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |||
KernelTestBase::disableModules | protected | function | Disables modules for this test. | |||
KernelTestBase::enableModules | protected | function | Enables modules for this test. | |||
KernelTestBase::getConfigSchemaExclusions | protected | function | Gets the config schema exclusions for this test. | |||
KernelTestBase::getDatabaseConnectionInfo | protected | function | Returns the Database connection info to be used for this test. | 1 | ||
KernelTestBase::getDatabasePrefix | public | function | ||||
KernelTestBase::getExtensionsForModules | private | function | Returns Extension objects for $modules to enable. | |||
KernelTestBase::getModulesToEnable | private static | function | Returns the modules to enable for this test. | |||
KernelTestBase::initFileCache | protected | function | Initializes the FileCache component. | |||
KernelTestBase::installConfig | protected | function | Installs default configuration for a given list of modules. | |||
KernelTestBase::installEntitySchema | protected | function | Installs the storage schema for a specific entity type. | |||
KernelTestBase::installSchema | protected | function | Installs database tables from a module schema definition. | |||
KernelTestBase::isTestInIsolation | Deprecated | protected | function | Returns whether the current test method is running in a separate process. | ||
KernelTestBase::prepareTemplate | protected | function | ||||
KernelTestBase::register | public | function | Registers test-specific services. | Overrides ServiceProviderInterface::register | 26 | |
KernelTestBase::render | protected | function | Renders a render array. | 1 | ||
KernelTestBase::setInstallProfile | protected | function | Sets the install profile and rebuilds the container to update it. | |||
KernelTestBase::setSetting | protected | function | Sets an in-memory Settings variable. | |||
KernelTestBase::setUpBeforeClass | public static | function | 1 | |||
KernelTestBase::setUpFilesystem | protected | function | Sets up the filesystem, so things like the file directory. | 2 | ||
KernelTestBase::stop | protected | function | Stops test execution. | |||
KernelTestBase::tearDown | protected | function | 5 | |||
KernelTestBase::tearDownCloseDatabaseConnection | public | function | @after | |||
KernelTestBase::vfsDump | protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |||
KernelTestBase::__get | Deprecated | public | function | BC: Automatically resolve former KernelTestBase class properties. | ||
KernelTestBase::__sleep | public | function | Prevents serializing any properties. | |||
PhpunitCompatibilityTrait::getMock | Deprecated | public | function | Returns a mock object for the specified class using the available method. | ||
PhpunitCompatibilityTrait::setExpectedException | Deprecated | public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | ||
RandomGeneratorTrait::$randomGenerator | protected | property | The random generator. | |||
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. | 1 | ||
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. | |||
RandomGeneratorTrait::randomStringValidate | public | function | Callback for random string validation. | |||
ResourceTypeRepositoryTest::$modules | public static | property | Modules to enable. | Overrides JsonapiKernelTestBase::$modules | ||
ResourceTypeRepositoryTest::$resourceTypeRepository | protected | property | The JSON:API resource type repository under test. | |||
ResourceTypeRepositoryTest::getFieldMappingProvider | public | function | Data provider for testGetFieldMapping. | |||
ResourceTypeRepositoryTest::getProvider | public | function | Data provider for testGet. | |||
ResourceTypeRepositoryTest::setUp | protected | function | Overrides KernelTestBase::setUp | |||
ResourceTypeRepositoryTest::testAll | public | function | @covers ::all | |||
ResourceTypeRepositoryTest::testCaching | public | function | Ensures that the ResourceTypeRepository's cache does not become stale. | |||
ResourceTypeRepositoryTest::testGet | public | function | @covers ::get @dataProvider getProvider |
|||
ResourceTypeRepositoryTest::testMappingNameConflictCheck | public | function | Ensures that a naming conflict in the mapping causes an exception to be thrown. |
|||
ResourceTypeRepositoryTest::testResourceTypeDisabling | public | function | Tests that resource types can be disabled by a build subscriber. | |||
ResourceTypeRepositoryTest::testResourceTypeFieldAliasing | public | function | Tests that resource type fields can be aliased per resource type. | |||
ResourceTypeRepositoryTest::testResourceTypeFieldDisabling | public | function | Tests that resource type fields can be disabled per resource type. | |||
StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | |||
TestRequirementsTrait::checkModuleRequirements | private | function | Checks missing module requirements. | |||
TestRequirementsTrait::checkRequirements | protected | function | Check module requirements for the Drupal use case. | 1 | ||
TestRequirementsTrait::getDrupalRoot | protected static | function | Returns the Drupal root directory. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.