class RelationshipNormalizerTest in Drupal 9
Same name and namespace in other branches
- 8 core/modules/jsonapi/tests/src/Kernel/Normalizer/RelationshipNormalizerTest.php \Drupal\Tests\jsonapi\Kernel\Normalizer\RelationshipNormalizerTest
@coversDefaultClass \Drupal\jsonapi\Normalizer\RelationshipNormalizer @group jsonapi
@internal
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\Tests\jsonapi\Kernel\JsonapiKernelTestBase
- class \Drupal\Tests\jsonapi\Kernel\Normalizer\RelationshipNormalizerTest uses UserCreationTrait
- class \Drupal\Tests\jsonapi\Kernel\JsonapiKernelTestBase
Expanded class hierarchy of RelationshipNormalizerTest
File
- core/
modules/ jsonapi/ tests/ src/ Kernel/ Normalizer/ RelationshipNormalizerTest.php, line 26
Namespace
Drupal\Tests\jsonapi\Kernel\NormalizerView source
class RelationshipNormalizerTest extends JsonapiKernelTestBase {
use UserCreationTrait;
/**
* {@inheritdoc}
*/
protected static $modules = [
'field',
'file',
'image',
'jsonapi',
'node',
'serialization',
'system',
'user',
];
/**
* Static UUID for the referencing entity.
*
* @var string
*/
protected static $referencerId = '2c344ae5-4303-4f17-acd4-e20d2a9a6c44';
/**
* Static UUIDs for use in tests.
*
* @var string[]
*/
protected static $userIds = [
'457fed75-a3ed-4e9e-823c-f9aeff6ec8ca',
'67e4063f-ac74-46ac-ac5f-07efda9fd551',
];
/**
* Static UIDs for use in tests.
*
* @var string[]
*/
protected static $userUids = [
10,
11,
];
/**
* Static UUIDs for use in tests.
*
* @var string[]
*/
protected static $imageIds = [
'71e67249-df4a-4616-9065-4cc2e812235b',
'ce5093fc-417f-477d-932d-888407d5cbd5',
];
/**
* Static UUIDs for use in tests.
*
* @var string[]
*/
protected static $imageUids = [
1,
2,
];
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
// Set up the data model.
// Add the entity schemas.
$this
->installEntitySchema('node');
$this
->installEntitySchema('user');
$this
->installEntitySchema('file');
// Add the additional table schemas.
$this
->installSchema('system', [
'sequences',
]);
$this
->installSchema('node', [
'node_access',
]);
$this
->installSchema('file', [
'file_usage',
]);
NodeType::create([
'type' => 'referencer',
])
->save();
$this
->createEntityReferenceField('node', 'referencer', 'field_user', 'User', 'user', 'default', [
'target_bundles' => NULL,
], 1);
$this
->createEntityReferenceField('node', 'referencer', 'field_users', 'Users', 'user', 'default', [
'target_bundles' => NULL,
], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
$field_storage_config = [
'type' => 'image',
'entity_type' => 'node',
];
FieldStorageConfig::create([
'field_name' => 'field_image',
'cardinality' => 1,
] + $field_storage_config)
->save();
FieldStorageConfig::create([
'field_name' => 'field_images',
'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
] + $field_storage_config)
->save();
$field_config = [
'entity_type' => 'node',
'bundle' => 'referencer',
];
FieldConfig::create([
'field_name' => 'field_image',
'label' => 'Image',
] + $field_config)
->save();
FieldConfig::create([
'field_name' => 'field_images',
'label' => 'Images',
] + $field_config)
->save();
// Set up the test data.
$this
->setUpCurrentUser([], [
'access content',
]);
$this->user1 = User::create([
'name' => $this
->randomMachineName(),
'mail' => $this
->randomMachineName() . '@example.com',
'uuid' => static::$userIds[0],
'uid' => static::$userUids[0],
]);
$this->user1
->save();
$this->user2 = User::create([
'name' => $this
->randomMachineName(),
'mail' => $this
->randomMachineName() . '@example.com',
'uuid' => static::$userIds[1],
'uid' => static::$userUids[1],
]);
$this->user2
->save();
$this->image1 = File::create([
'uri' => 'public:/image1.png',
'uuid' => static::$imageIds[0],
'uid' => static::$imageUids[0],
]);
$this->image1
->save();
$this->image2 = File::create([
'uri' => 'public:/image2.png',
'uuid' => static::$imageIds[1],
'uid' => static::$imageUids[1],
]);
$this->image2
->save();
// Create the node from which all the previously created entities will be
// referenced.
$this->referencer = Node::create([
'title' => 'Referencing node',
'type' => 'referencer',
'status' => 1,
'uuid' => static::$referencerId,
]);
$this->referencer
->save();
// Set up the test dependencies.
$this->referencingResourceType = $this->container
->get('jsonapi.resource_type.repository')
->get('node', 'referencer');
$this->normalizer = new RelationshipNormalizer();
$this->normalizer
->setSerializer($this->container
->get('jsonapi.serializer'));
}
/**
* @covers ::normalize
* @dataProvider normalizeProvider
*/
public function testNormalize($entity_property_names, $field_name, $expected) {
// Links cannot be generated in the test provider because the container
// has not yet been set.
$expected['links'] = [
'self' => [
'href' => Url::fromUri('base:/jsonapi/node/referencer/' . static::$referencerId . "/relationships/{$field_name}", [
'query' => [
'resourceVersion' => 'id:1',
],
])
->setAbsolute()
->toString(),
],
'related' => [
'href' => Url::fromUri('base:/jsonapi/node/referencer/' . static::$referencerId . "/{$field_name}", [
'query' => [
'resourceVersion' => 'id:1',
],
])
->setAbsolute()
->toString(),
],
];
// Set up different field values.
$this->referencer->{$field_name} = array_map(function ($entity_property_name) {
$value = [
'target_id' => $this->{$entity_property_name === 'image1a' ? 'image1' : $entity_property_name}
->id(),
];
switch ($entity_property_name) {
case 'image1':
$value['alt'] = 'Cute llama';
$value['title'] = 'My spirit animal';
break;
case 'image1a':
$value['alt'] = 'Ugly llama';
$value['title'] = 'My alter ego';
break;
case 'image2':
$value['alt'] = 'Adorable llama';
$value['title'] = 'My spirit animal 😍';
break;
}
return $value;
}, $entity_property_names);
$resource_object = ResourceObject::createFromEntity($this->referencingResourceType, $this->referencer);
$relationship = Relationship::createFromEntityReferenceField($resource_object, $resource_object
->getField($field_name));
// Normalize.
$actual = $this->normalizer
->normalize($relationship, 'api_json');
// Assert.
assert($actual instanceof CacheableNormalization);
$this
->assertEquals($expected, $actual
->getNormalization());
}
/**
* Data provider for testNormalize.
*/
public function normalizeProvider() {
return [
'single cardinality' => [
[
'user1',
],
'field_user',
[
'data' => [
'type' => 'user--user',
'id' => static::$userIds[0],
'meta' => [
'drupal_internal__target_id' => static::$userUids[0],
],
],
],
],
'multiple cardinality' => [
[
'user1',
'user2',
],
'field_users',
[
'data' => [
[
'type' => 'user--user',
'id' => static::$userIds[0],
'meta' => [
'drupal_internal__target_id' => static::$userUids[0],
],
],
[
'type' => 'user--user',
'id' => static::$userIds[1],
'meta' => [
'drupal_internal__target_id' => static::$userUids[1],
],
],
],
],
],
'multiple cardinality, all same values' => [
[
'user1',
'user1',
],
'field_users',
[
'data' => [
[
'type' => 'user--user',
'id' => static::$userIds[0],
'meta' => [
'arity' => 0,
'drupal_internal__target_id' => static::$userUids[0],
],
],
[
'type' => 'user--user',
'id' => static::$userIds[0],
'meta' => [
'arity' => 1,
'drupal_internal__target_id' => static::$userUids[0],
],
],
],
],
],
'multiple cardinality, some same values' => [
[
'user1',
'user2',
'user1',
],
'field_users',
[
'data' => [
[
'type' => 'user--user',
'id' => static::$userIds[0],
'meta' => [
'arity' => 0,
'drupal_internal__target_id' => static::$userUids[0],
],
],
[
'type' => 'user--user',
'id' => static::$userIds[1],
'meta' => [
'drupal_internal__target_id' => static::$userUids[1],
],
],
[
'type' => 'user--user',
'id' => static::$userIds[0],
'meta' => [
'arity' => 1,
'drupal_internal__target_id' => static::$userUids[0],
],
],
],
],
],
'single cardinality, with meta' => [
[
'image1',
],
'field_image',
[
'data' => [
'type' => 'file--file',
'id' => static::$imageIds[0],
'meta' => [
'alt' => 'Cute llama',
'title' => 'My spirit animal',
'width' => NULL,
'height' => NULL,
'drupal_internal__target_id' => static::$imageUids[0],
],
],
],
],
'multiple cardinality, all same values, with meta' => [
[
'image1',
'image1',
],
'field_images',
[
'data' => [
[
'type' => 'file--file',
'id' => static::$imageIds[0],
'meta' => [
'alt' => 'Cute llama',
'title' => 'My spirit animal',
'width' => NULL,
'height' => NULL,
'arity' => 0,
'drupal_internal__target_id' => static::$imageUids[0],
],
],
[
'type' => 'file--file',
'id' => static::$imageIds[0],
'meta' => [
'alt' => 'Cute llama',
'title' => 'My spirit animal',
'width' => NULL,
'height' => NULL,
'arity' => 1,
'drupal_internal__target_id' => static::$imageUids[0],
],
],
],
],
],
'multiple cardinality, some same values with same values but different meta' => [
[
'image1',
'image1',
'image1a',
],
'field_images',
[
'data' => [
[
'type' => 'file--file',
'id' => static::$imageIds[0],
'meta' => [
'alt' => 'Cute llama',
'title' => 'My spirit animal',
'width' => NULL,
'height' => NULL,
'arity' => 0,
'drupal_internal__target_id' => static::$imageUids[0],
],
],
[
'type' => 'file--file',
'id' => static::$imageIds[0],
'meta' => [
'alt' => 'Cute llama',
'title' => 'My spirit animal',
'width' => NULL,
'height' => NULL,
'arity' => 1,
'drupal_internal__target_id' => static::$imageUids[0],
],
],
[
'type' => 'file--file',
'id' => static::$imageIds[0],
'meta' => [
'alt' => 'Ugly llama',
'title' => 'My alter ego',
'width' => NULL,
'height' => NULL,
'arity' => 2,
'drupal_internal__target_id' => static::$imageUids[0],
],
],
],
],
],
];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
JsonapiKernelTestBase:: |
protected | function | Creates a field of an entity reference field storage on the bundle. | |
JsonapiKernelTestBase:: |
protected | function | Creates a field of an entity reference field storage on the bundle. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
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:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 3 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
24 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 4 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
RelationshipNormalizerTest:: |
protected static | property | Static UUIDs for use in tests. | |
RelationshipNormalizerTest:: |
protected static | property | Static UUIDs for use in tests. | |
RelationshipNormalizerTest:: |
protected static | property |
Modules to enable. Overrides JsonapiKernelTestBase:: |
|
RelationshipNormalizerTest:: |
protected static | property | Static UUID for the referencing entity. | |
RelationshipNormalizerTest:: |
protected static | property | Static UUIDs for use in tests. | |
RelationshipNormalizerTest:: |
protected static | property | Static UIDs for use in tests. | |
RelationshipNormalizerTest:: |
public | function | Data provider for testNormalize. | |
RelationshipNormalizerTest:: |
protected | function |
Overrides KernelTestBase:: |
|
RelationshipNormalizerTest:: |
public | function | @covers ::normalize @dataProvider normalizeProvider | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. | |
UserCreationTrait:: |
protected | function | Creates an administrative role. | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. |