X-Git-Url: https://yaffs.net/gitweb/?a=blobdiff_plain;f=web%2Fcore%2Fmodules%2Fmedia%2Ftests%2Fsrc%2FKernel%2FMediaSourceTest.php;h=ecf17785047e07786aa270aa5c031b2f6b68bc92;hb=1c1cb0980bfa6caf0c24cce671b6bb541dc87583;hp=fc30326fb1dd49b0524918f590bc66461c997098;hpb=9917807b03b64faf00f6a1f29dcb6eafc454efa5;p=yaffs-website diff --git a/web/core/modules/media/tests/src/Kernel/MediaSourceTest.php b/web/core/modules/media/tests/src/Kernel/MediaSourceTest.php index fc30326fb..ecf177850 100644 --- a/web/core/modules/media/tests/src/Kernel/MediaSourceTest.php +++ b/web/core/modules/media/tests/src/Kernel/MediaSourceTest.php @@ -15,6 +15,72 @@ use Drupal\media\Entity\MediaType; */ class MediaSourceTest extends MediaKernelTestBase { + /** + * Tests that metadata is correctly mapped irrespective of how media is saved. + */ + public function testSave() { + $field_storage = FieldStorageConfig::create([ + 'entity_type' => 'media', + 'field_name' => 'field_to_map_to', + 'type' => 'string', + ]); + $field_storage->save(); + + FieldConfig::create([ + 'field_storage' => $field_storage, + 'bundle' => $this->testMediaType->id(), + 'label' => 'Field to map to', + ])->save(); + + // Set an arbitrary metadata value to be mapped. + $this->container->get('state') + ->set('media_source_test_attributes', [ + 'attribute_to_map' => [ + 'title' => 'Attribute to map', + 'value' => 'Snowball', + ], + 'thumbnail_uri' => [ + 'value' => 'public://TheSisko.png', + ], + ]); + $this->testMediaType->setFieldMap([ + 'attribute_to_map' => 'field_to_map_to', + ])->save(); + + /** @var \Drupal\Core\Entity\EntityStorageInterface $storage */ + $storage = $this->container->get('entity_type.manager') + ->getStorage('media'); + + /** @var \Drupal\media\MediaInterface $a */ + $a = $storage->create([ + 'bundle' => $this->testMediaType->id(), + ]); + /** @var \Drupal\media\MediaInterface $b */ + $b = $storage->create([ + 'bundle' => $this->testMediaType->id(), + ]); + + // Set a random source value on both items. + $a->set($a->getSource()->getSourceFieldDefinition($a->bundle->entity)->getName(), $this->randomString()); + $b->set($b->getSource()->getSourceFieldDefinition($b->bundle->entity)->getName(), $this->randomString()); + + $a->save(); + $storage->save($b); + + // Assert that the default name was mapped into the name field for both + // media items. + $this->assertFalse($a->get('name')->isEmpty()); + $this->assertFalse($b->get('name')->isEmpty()); + + // Assert that arbitrary metadata was mapped correctly. + $this->assertFalse($a->get('field_to_map_to')->isEmpty()); + $this->assertFalse($b->get('field_to_map_to')->isEmpty()); + + // Assert that the thumbnail was mapped correctly from the source. + $this->assertSame('public://TheSisko.png', $a->thumbnail->entity->getFileUri()); + $this->assertSame('public://TheSisko.png', $b->thumbnail->entity->getFileUri()); + } + /** * Tests default media name functionality. */ @@ -23,13 +89,13 @@ class MediaSourceTest extends MediaKernelTestBase { /** @var \Drupal\media\MediaInterface $media */ $media = Media::create(['bundle' => $this->testMediaType->id()]); $media_source = $media->getSource(); - $this->assertEquals('default_name', $media_source->getPluginDefinition()['default_name_metadata_attribute'], 'Default metadata attribute is not used for the default name.'); - $this->assertEquals('media:' . $media->bundle() . ':' . $media->uuid(), $media_source->getMetadata($media, 'default_name'), 'Value of the default name metadata attribute does not look correct.'); - $this->assertEquals('media:' . $media->bundle() . ':' . $media->uuid(), $media->getName(), 'Default name was not used correctly by getName().'); - $this->assertEquals($media->getName(), $media->label(), 'Default name and label are not the same.'); + $this->assertSame('default_name', $media_source->getPluginDefinition()['default_name_metadata_attribute'], 'Default metadata attribute is not used for the default name.'); + $this->assertSame('media:' . $media->bundle() . ':' . $media->uuid(), $media_source->getMetadata($media, 'default_name'), 'Value of the default name metadata attribute does not look correct.'); + $this->assertSame('media:' . $media->bundle() . ':' . $media->uuid(), $media->getName(), 'Default name was not used correctly by getName().'); + $this->assertSame($media->getName(), $media->label(), 'Default name and label are not the same.'); $media->save(); - $this->assertEquals('media:' . $media->bundle() . ':' . $media->uuid(), $media->getName(), 'Default name was not saved correctly.'); - $this->assertEquals($media->getName(), $media->label(), 'The label changed during save.'); + $this->assertSame('media:' . $media->bundle() . ':' . $media->uuid(), $media->getName(), 'Default name was not saved correctly.'); + $this->assertSame($media->getName(), $media->label(), 'The label changed during save.'); // Make sure that the user-supplied name is used. /** @var \Drupal\media\MediaInterface $media */ @@ -39,11 +105,11 @@ class MediaSourceTest extends MediaKernelTestBase { 'name' => $name, ]); $media_source = $media->getSource(); - $this->assertEquals('default_name', $media_source->getPluginDefinition()['default_name_metadata_attribute'], 'Default metadata attribute is not used for the default name.'); - $this->assertEquals('media:' . $media->bundle() . ':' . $media->uuid(), $media_source->getMetadata($media, 'default_name'), 'Value of the default name metadata attribute does not look correct.'); + $this->assertSame('default_name', $media_source->getPluginDefinition()['default_name_metadata_attribute'], 'Default metadata attribute is not used for the default name.'); + $this->assertSame('media:' . $media->bundle() . ':' . $media->uuid(), $media_source->getMetadata($media, 'default_name'), 'Value of the default name metadata attribute does not look correct.'); $media->save(); - $this->assertEquals($name, $media->getName(), 'User-supplied name was not set correctly.'); - $this->assertEquals($media->getName(), $media->label(), 'The user-supplied name does not match the label.'); + $this->assertSame($name, $media->getName(), 'User-supplied name was not set correctly.'); + $this->assertSame($media->getName(), $media->label(), 'The user-supplied name does not match the label.'); // Change the default name attribute and see if it is used to set the name. $name = 'Old Major'; @@ -52,11 +118,11 @@ class MediaSourceTest extends MediaKernelTestBase { /** @var \Drupal\media\MediaInterface $media */ $media = Media::create(['bundle' => $this->testMediaType->id()]); $media_source = $media->getSource(); - $this->assertEquals('alternative_name', $media_source->getPluginDefinition()['default_name_metadata_attribute'], 'Correct metadata attribute is not used for the default name.'); - $this->assertEquals($name, $media_source->getMetadata($media, 'alternative_name'), 'Value of the default name metadata attribute does not look correct.'); + $this->assertSame('alternative_name', $media_source->getPluginDefinition()['default_name_metadata_attribute'], 'Correct metadata attribute is not used for the default name.'); + $this->assertSame($name, $media_source->getMetadata($media, 'alternative_name'), 'Value of the default name metadata attribute does not look correct.'); $media->save(); - $this->assertEquals($name, $media->getName(), 'Default name was not set correctly.'); - $this->assertEquals($media->getName(), $media->label(), 'The default name does not match the label.'); + $this->assertSame($name, $media->getName(), 'Default name was not set correctly.'); + $this->assertSame($media->getName(), $media->label(), 'The default name does not match the label.'); } /** @@ -109,25 +175,25 @@ class MediaSourceTest extends MediaKernelTestBase { 'field_media_test' => 'some_value', ]); $media_source = $media->getSource(); - $this->assertEquals('Snowball', $media_source->getMetadata($media, $attribute_name), 'Value of the metadata attribute is not correct.'); + $this->assertSame('Snowball', $media_source->getMetadata($media, $attribute_name), 'Value of the metadata attribute is not correct.'); $media->save(); - $this->assertEquals('Snowball', $media->get($field_name)->value, 'Metadata attribute was not mapped to the field.'); + $this->assertSame('Snowball', $media->get($field_name)->value, 'Metadata attribute was not mapped to the field.'); // Change the metadata attribute value and re-save the entity. Field value // should stay the same. \Drupal::state()->set('media_source_test_attributes', [ $attribute_name => ['title' => 'Attribute to map', 'value' => 'Pinkeye'], ]); - $this->assertEquals('Pinkeye', $media_source->getMetadata($media, $attribute_name), 'Value of the metadata attribute is not correct.'); + $this->assertSame('Pinkeye', $media_source->getMetadata($media, $attribute_name), 'Value of the metadata attribute is not correct.'); $media->save(); - $this->assertEquals('Snowball', $media->get($field_name)->value, 'Metadata attribute was not mapped to the field.'); + $this->assertSame('Snowball', $media->get($field_name)->value, 'Metadata attribute was not mapped to the field.'); // Now change the value of the source field and make sure that the mapped // values update too. - $this->assertEquals('Pinkeye', $media_source->getMetadata($media, $attribute_name), 'Value of the metadata attribute is not correct.'); + $this->assertSame('Pinkeye', $media_source->getMetadata($media, $attribute_name), 'Value of the metadata attribute is not correct.'); $media->set('field_media_test', 'some_new_value'); $media->save(); - $this->assertEquals('Pinkeye', $media->get($field_name)->value, 'Metadata attribute was not mapped to the field.'); + $this->assertSame('Pinkeye', $media->get($field_name)->value, 'Metadata attribute was not mapped to the field.'); // Remove the value of the mapped field and make sure that it is re-mapped // on save. @@ -135,9 +201,23 @@ class MediaSourceTest extends MediaKernelTestBase { $attribute_name => ['title' => 'Attribute to map', 'value' => 'Snowball'], ]); $media->{$field_name}->value = NULL; - $this->assertEquals('Snowball', $media_source->getMetadata($media, $attribute_name), 'Value of the metadata attribute is not correct.'); + $this->assertSame('Snowball', $media_source->getMetadata($media, $attribute_name), 'Value of the metadata attribute is not correct.'); $media->save(); - $this->assertEquals('Snowball', $media->get($field_name)->value, 'Metadata attribute was not mapped to the field.'); + $this->assertSame('Snowball', $media->get($field_name)->value, 'Metadata attribute was not mapped to the field.'); + } + + /** + * Tests the getSourceFieldValue() method. + */ + public function testGetSourceFieldValue() { + /** @var \Drupal\media\MediaInterface $media */ + $media = Media::create([ + 'bundle' => $this->testMediaType->id(), + 'field_media_test' => 'some_value', + ]); + $media->save(); + $media_source = $media->getSource(); + $this->assertSame('some_value', $media_source->getSourceFieldValue($media)); } /** @@ -147,9 +227,9 @@ class MediaSourceTest extends MediaKernelTestBase { file_put_contents('public://thumbnail1.jpg', ''); file_put_contents('public://thumbnail2.jpg', ''); - // Save a media entity and make sure thumbnail was added. + // Save a media item and make sure thumbnail was added. \Drupal::state()->set('media_source_test_attributes', [ - 'thumbnail_uri' => ['title' => 'Thumbnail', 'value' => 'public://thumbnail1.jpg'], + 'thumbnail_uri' => ['value' => 'public://thumbnail1.jpg'], ]); /** @var \Drupal\media\MediaInterface $media */ $media = Media::create([ @@ -158,48 +238,49 @@ class MediaSourceTest extends MediaKernelTestBase { 'field_media_test' => 'some_value', ]); $media_source = $media->getSource(); - $this->assertEquals('public://thumbnail1.jpg', $media_source->getMetadata($media, 'thumbnail_uri'), 'Value of the thumbnail metadata attribute is not correct.'); + $this->assertSame('public://thumbnail1.jpg', $media_source->getMetadata($media, 'thumbnail_uri'), 'Value of the thumbnail metadata attribute is not correct.'); $media->save(); - $this->assertEquals('public://thumbnail1.jpg', $media->thumbnail->entity->getFileUri(), 'Thumbnail was not added to the media entity.'); - $this->assertEquals('Mr. Jones', $media->thumbnail->title, 'Title text was not set on the thumbnail.'); - $this->assertEquals('Thumbnail', $media->thumbnail->alt, 'Alt text was not set on the thumbnail.'); + $this->assertSame('public://thumbnail1.jpg', $media->thumbnail->entity->getFileUri(), 'Thumbnail was not added to the media item.'); + // We expect the title not to be present on the Thumbnail. + $this->assertEmpty($media->thumbnail->title); + $this->assertSame('', $media->thumbnail->alt); // Now change the metadata attribute and make sure that the thumbnail stays // the same. \Drupal::state()->set('media_source_test_attributes', [ - 'thumbnail_uri' => ['title' => 'Thumbnail', 'value' => 'public://thumbnail2.jpg'], + 'thumbnail_uri' => ['value' => 'public://thumbnail2.jpg'], ]); - $this->assertEquals('public://thumbnail2.jpg', $media_source->getMetadata($media, 'thumbnail_uri'), 'Value of the thumbnail metadata attribute is not correct.'); + $this->assertSame('public://thumbnail2.jpg', $media_source->getMetadata($media, 'thumbnail_uri'), 'Value of the thumbnail metadata attribute is not correct.'); $media->save(); - $this->assertEquals('public://thumbnail1.jpg', $media->thumbnail->entity->getFileUri(), 'Thumbnail was not preserved.'); - $this->assertEquals('Mr. Jones', $media->thumbnail->title, 'Title text was not set on the thumbnail.'); - $this->assertEquals('Thumbnail', $media->thumbnail->alt, 'Alt text was not set on the thumbnail.'); + $this->assertSame('public://thumbnail1.jpg', $media->thumbnail->entity->getFileUri(), 'Thumbnail was not preserved.'); + $this->assertEmpty($media->thumbnail->title); + $this->assertSame('', $media->thumbnail->alt); // Remove the thumbnail and make sure that it is auto-updated on save. $media->thumbnail->target_id = NULL; - $this->assertEquals('public://thumbnail2.jpg', $media_source->getMetadata($media, 'thumbnail_uri'), 'Value of the thumbnail metadata attribute is not correct.'); + $this->assertSame('public://thumbnail2.jpg', $media_source->getMetadata($media, 'thumbnail_uri'), 'Value of the thumbnail metadata attribute is not correct.'); $media->save(); - $this->assertEquals('public://thumbnail2.jpg', $media->thumbnail->entity->getFileUri(), 'New thumbnail was not added to the media entity.'); - $this->assertEquals('Mr. Jones', $media->thumbnail->title, 'Title text was not set on the thumbnail.'); - $this->assertEquals('Thumbnail', $media->thumbnail->alt, 'Alt text was not set on the thumbnail.'); + $this->assertSame('public://thumbnail2.jpg', $media->thumbnail->entity->getFileUri(), 'New thumbnail was not added to the media item.'); + $this->assertEmpty($media->thumbnail->title); + $this->assertSame('', $media->thumbnail->alt); // Change the metadata attribute again, change the source field value too // and make sure that the thumbnail updates. \Drupal::state()->set('media_source_test_attributes', [ - 'thumbnail_uri' => ['title' => 'Thumbnail', 'value' => 'public://thumbnail1.jpg'], + 'thumbnail_uri' => ['value' => 'public://thumbnail1.jpg'], ]); $media->field_media_test->value = 'some_new_value'; - $this->assertEquals('public://thumbnail1.jpg', $media_source->getMetadata($media, 'thumbnail_uri'), 'Value of the thumbnail metadata attribute is not correct.'); + $this->assertSame('public://thumbnail1.jpg', $media_source->getMetadata($media, 'thumbnail_uri'), 'Value of the thumbnail metadata attribute is not correct.'); $media->save(); - $this->assertEquals('public://thumbnail1.jpg', $media->thumbnail->entity->getFileUri(), 'New thumbnail was not added to the media entity.'); - $this->assertEquals('Mr. Jones', $media->thumbnail->title, 'Title text was not set on the thumbnail.'); - $this->assertEquals('Thumbnail', $media->thumbnail->alt, 'Alt text was not set on the thumbnail.'); + $this->assertSame('public://thumbnail1.jpg', $media->thumbnail->entity->getFileUri(), 'New thumbnail was not added to the media item.'); + $this->assertEmpty($media->thumbnail->title); + $this->assertSame('', $media->thumbnail->alt); // Change the thumbnail metadata attribute and make sure that the thumbnail // is set correctly. \Drupal::state()->set('media_source_test_attributes', [ - 'thumbnail_uri' => ['title' => 'Should not be used', 'value' => 'public://thumbnail1.jpg'], - 'alternative_thumbnail_uri' => ['title' => 'Should be used', 'value' => 'public://thumbnail2.jpg'], + 'thumbnail_uri' => ['value' => 'public://thumbnail1.jpg'], + 'alternative_thumbnail_uri' => ['value' => 'public://thumbnail2.jpg'], ]); \Drupal::state()->set('media_source_test_definition', ['thumbnail_uri_metadata_attribute' => 'alternative_thumbnail_uri']); $media = Media::create([ @@ -208,18 +289,18 @@ class MediaSourceTest extends MediaKernelTestBase { 'field_media_test' => 'some_value', ]); $media_source = $media->getSource(); - $this->assertEquals('public://thumbnail1.jpg', $media_source->getMetadata($media, 'thumbnail_uri'), 'Value of the metadata attribute is not correct.'); - $this->assertEquals('public://thumbnail2.jpg', $media_source->getMetadata($media, 'alternative_thumbnail_uri'), 'Value of the thumbnail metadata attribute is not correct.'); + $this->assertSame('public://thumbnail1.jpg', $media_source->getMetadata($media, 'thumbnail_uri'), 'Value of the metadata attribute is not correct.'); + $this->assertSame('public://thumbnail2.jpg', $media_source->getMetadata($media, 'alternative_thumbnail_uri'), 'Value of the thumbnail metadata attribute is not correct.'); $media->save(); - $this->assertEquals('public://thumbnail2.jpg', $media->thumbnail->entity->getFileUri(), 'Correct metadata attribute was not used for the thumbnail.'); - $this->assertEquals('Mr. Jones', $media->thumbnail->title, 'Title text was not set on the thumbnail.'); - $this->assertEquals('Thumbnail', $media->thumbnail->alt, 'Alt text was not set on the thumbnail.'); + $this->assertSame('public://thumbnail2.jpg', $media->thumbnail->entity->getFileUri(), 'Correct metadata attribute was not used for the thumbnail.'); + $this->assertEmpty($media->thumbnail->title); + $this->assertSame('', $media->thumbnail->alt); // Enable queued thumbnails and make sure that the entity gets the default // thumbnail initially. \Drupal::state()->set('media_source_test_definition', []); \Drupal::state()->set('media_source_test_attributes', [ - 'thumbnail_uri' => ['title' => 'Should not be used', 'value' => 'public://thumbnail1.jpg'], + 'thumbnail_uri' => ['value' => 'public://thumbnail1.jpg'], ]); $this->testMediaType->setQueueThumbnailDownloadsStatus(TRUE)->save(); $media = Media::create([ @@ -227,40 +308,37 @@ class MediaSourceTest extends MediaKernelTestBase { 'name' => 'Mr. Jones', 'field_media_test' => 'some_value', ]); - $this->assertEquals('public://thumbnail1.jpg', $media->getSource()->getMetadata($media, 'thumbnail_uri'), 'Value of the metadata attribute is not correct.'); + $this->assertSame('public://thumbnail1.jpg', $media->getSource()->getMetadata($media, 'thumbnail_uri'), 'Value of the metadata attribute is not correct.'); $media->save(); - $this->assertEquals('public://media-icons/generic/generic.png', $media->thumbnail->entity->getFileUri(), 'Default thumbnail was not set initially.'); - $this->assertEquals('Mr. Jones', $media->thumbnail->title, 'Title text was not set on the thumbnail.'); - $this->assertEquals('Thumbnail', $media->thumbnail->alt, 'Alt text was not set on the thumbnail.'); + $this->assertSame('public://media-icons/generic/generic.png', $media->thumbnail->entity->getFileUri(), 'Default thumbnail was not set initially.'); + $this->assertEmpty($media->thumbnail->title); + $this->assertSame('', $media->thumbnail->alt); // Process the queue item and make sure that the thumbnail was updated too. $queue_name = 'media_entity_thumbnail'; /** @var \Drupal\Core\Queue\QueueWorkerInterface $queue_worker */ $queue_worker = \Drupal::service('plugin.manager.queue_worker')->createInstance($queue_name); $queue = \Drupal::queue($queue_name); - $this->assertEquals(1, $queue->numberOfItems(), 'Item was not added to the queue.'); + $this->assertSame(1, $queue->numberOfItems(), 'Item was not added to the queue.'); $item = $queue->claimItem(); - $this->assertEquals($media->id(), $item->data['id'], 'Queue item that was created does not belong to the correct entity.'); + $this->assertSame($media->id(), $item->data['id'], 'Queue item that was created does not belong to the correct entity.'); $queue_worker->processItem($item->data); $queue->deleteItem($item); - $this->assertEquals(0, $queue->numberOfItems(), 'Item was not removed from the queue.'); + $this->assertSame(0, $queue->numberOfItems(), 'Item was not removed from the queue.'); $media = Media::load($media->id()); - $this->assertEquals('public://thumbnail1.jpg', $media->thumbnail->entity->getFileUri(), 'Thumbnail was not updated by the queue.'); - $this->assertEquals('Mr. Jones', $media->thumbnail->title, 'Title text was not set on the thumbnail.'); - $this->assertEquals('Thumbnail', $media->thumbnail->alt, 'Alt text was not set on the thumbnail.'); + $this->assertSame('public://thumbnail1.jpg', $media->thumbnail->entity->getFileUri(), 'Thumbnail was not updated by the queue.'); + $this->assertEmpty($media->thumbnail->title); + $this->assertSame('', $media->thumbnail->alt); - // Set alt and title metadata attributes and make sure they are used for the - // thumbnail. + // Set the alt metadata attribute and make sure it's used for the thumbnail. \Drupal::state()->set('media_source_test_definition', [ 'thumbnail_alt_metadata_attribute' => 'alt', - 'thumbnail_title_metadata_attribute' => 'title', ]); \Drupal::state()->set('media_source_test_attributes', [ - 'alt' => ['title' => 'Alt text', 'value' => 'This will be alt.'], - 'title' => ['title' => 'Title text', 'value' => 'This will be title.'], + 'alt' => ['value' => 'This will be alt.'], ]); $media = Media::create([ 'bundle' => $this->testMediaType->id(), @@ -268,13 +346,13 @@ class MediaSourceTest extends MediaKernelTestBase { 'field_media_test' => 'some_value', ]); $media->save(); - $this->assertEquals('Boxer', $media->getName(), 'Correct name was not set on the media entity.'); - $this->assertEquals('This will be title.', $media->thumbnail->title, 'Title text was not set on the thumbnail.'); - $this->assertEquals('This will be alt.', $media->thumbnail->alt, 'Alt text was not set on the thumbnail.'); + $this->assertSame('Boxer', $media->getName(), 'Correct name was not set on the media item.'); + $this->assertEmpty($media->thumbnail->title); + $this->assertSame('This will be alt.', $media->thumbnail->alt); } /** - * Tests the media entity constraints functionality. + * Tests the media item constraints functionality. */ public function testConstraints() { // Test entity constraints. @@ -359,17 +437,17 @@ class MediaSourceTest extends MediaKernelTestBase { // Test field storage. $this->assertTrue($field_storage->isNew(), 'Field storage is saved automatically.'); $this->assertFalse($field_storage->isLocked(), 'Field storage is not locked.'); - $this->assertEquals('string', $field_storage->getType(), 'Field is not of correct type.'); - $this->assertEquals('field_media_test_1', $field_storage->getName(), 'Incorrect field name is used.'); - $this->assertEquals('media', $field_storage->getTargetEntityTypeId(), 'Field is not targeting media entities.'); + $this->assertSame('string', $field_storage->getType(), 'Field is not of correct type.'); + $this->assertSame('field_media_test_1', $field_storage->getName(), 'Incorrect field name is used.'); + $this->assertSame('media', $field_storage->getTargetEntityTypeId(), 'Field is not targeting media entities.'); // Test field. $this->assertTrue($field->isNew(), 'Field is saved automatically.'); - $this->assertEquals('field_media_test_1', $field->getName(), 'Incorrect field name is used.'); - $this->assertEquals('string', $field->getType(), 'Field is of incorrect type.'); + $this->assertSame('field_media_test_1', $field->getName(), 'Incorrect field name is used.'); + $this->assertSame('string', $field->getType(), 'Field is of incorrect type.'); $this->assertTrue($field->isRequired(), 'Field is not required.'); $this->assertEquals('Test source', $field->label(), 'Incorrect label is used.'); - $this->assertEquals('test_type', $field->getTargetBundle(), 'Field is not targeting correct bundle.'); + $this->assertSame('test_type', $field->getTargetBundle(), 'Field is not targeting correct bundle.'); // Fields should be automatically saved only when creating the media type // using the media type creation form. Make sure that they are not saved @@ -394,17 +472,17 @@ class MediaSourceTest extends MediaKernelTestBase { // Test field storage. $this->assertTrue($field_storage->isNew(), 'Field storage is saved automatically.'); $this->assertFalse($field_storage->isLocked(), 'Field storage is not locked.'); - $this->assertEquals('string_long', $field_storage->getType(), 'Field is of incorrect type.'); - $this->assertEquals('field_media_test_constraints_1', $field_storage->getName(), 'Incorrect field name is used.'); - $this->assertEquals('media', $field_storage->getTargetEntityTypeId(), 'Field is not targeting media entities.'); + $this->assertSame('string_long', $field_storage->getType(), 'Field is of incorrect type.'); + $this->assertSame('field_media_test_constraints_1', $field_storage->getName(), 'Incorrect field name is used.'); + $this->assertSame('media', $field_storage->getTargetEntityTypeId(), 'Field is not targeting media entities.'); // Test field. $this->assertTrue($field->isNew(), 'Field is saved automatically.'); - $this->assertEquals('field_media_test_constraints_1', $field->getName(), 'Incorrect field name is used.'); - $this->assertEquals('string_long', $field->getType(), 'Field is of incorrect type.'); + $this->assertSame('field_media_test_constraints_1', $field->getName(), 'Incorrect field name is used.'); + $this->assertSame('string_long', $field->getType(), 'Field is of incorrect type.'); $this->assertTrue($field->isRequired(), 'Field is not required.'); $this->assertEquals('Test source with constraints', $field->label(), 'Incorrect label is used.'); - $this->assertEquals('test_constraints_type', $field->getTargetBundle(), 'Field is not targeting correct bundle.'); + $this->assertSame('test_constraints_type', $field->getTargetBundle(), 'Field is not targeting correct bundle.'); } /** @@ -420,26 +498,101 @@ class MediaSourceTest extends MediaKernelTestBase { /** @var \Drupal\media\MediaSourceInterface $source */ $source = $manager->createInstance('test', []); $source->submitConfigurationForm($form, $form_state); - $expected = ['test_config_value' => 'Somewhere over the rainbow.', 'source_field' => 'field_media_test_1']; - $this->assertEquals($expected, $source->getConfiguration(), 'Submitted values were saved correctly.'); + $expected = ['source_field' => 'field_media_test_1', 'test_config_value' => 'Somewhere over the rainbow.']; + $this->assertSame($expected, $source->getConfiguration(), 'Submitted values were saved correctly.'); // Try to save a NULL value. $form_state->setValue('test_config_value', NULL); $source->submitConfigurationForm($form, $form_state); $expected['test_config_value'] = NULL; - $this->assertEquals($expected, $source->getConfiguration(), 'Submitted values were saved correctly.'); + $this->assertSame($expected, $source->getConfiguration(), 'Submitted values were saved correctly.'); // Make sure that the config keys are determined correctly even if the // existing value is NULL. $form_state->setValue('test_config_value', 'Somewhere over the rainbow.'); $source->submitConfigurationForm($form, $form_state); $expected['test_config_value'] = 'Somewhere over the rainbow.'; - $this->assertEquals($expected, $source->getConfiguration(), 'Submitted values were saved correctly.'); + $this->assertSame($expected, $source->getConfiguration(), 'Submitted values were saved correctly.'); // Make sure that a non-relevant value will be skipped. $form_state->setValue('not_relevant', 'Should not be saved in the plugin.'); $source->submitConfigurationForm($form, $form_state); - $this->assertEquals($expected, $source->getConfiguration(), 'Submitted values were saved correctly.'); + $this->assertSame($expected, $source->getConfiguration(), 'Submitted values were saved correctly.'); + } + + /** + * Tests different display options for the source field. + */ + public function testDifferentSourceFieldDisplays() { + $id = 'test_different_displays'; + $field_name = 'field_media_different_display'; + + $this->createMediaTypeViaForm($id, $field_name); + + // Source field not in displays. + $display = entity_get_display('media', $id, 'default'); + $components = $display->getComponents(); + $this->assertArrayHasKey($field_name, $components); + $this->assertSame('entity_reference_entity_id', $components[$field_name]['type']); + + $display = entity_get_form_display('media', $id, 'default'); + $components = $display->getComponents(); + $this->assertArrayHasKey($field_name, $components); + $this->assertSame('entity_reference_autocomplete_tags', $components[$field_name]['type']); + } + + /** + * Tests hidden source field in media type. + */ + public function testHiddenSourceField() { + $id = 'test_hidden_source_field'; + $field_name = 'field_media_hidden'; + + $this->createMediaTypeViaForm($id, $field_name); + + // Source field not in displays. + $display = entity_get_display('media', $id, 'default'); + $this->assertArrayNotHasKey($field_name, $display->getComponents()); + + $display = entity_get_form_display('media', $id, 'default'); + $this->assertArrayNotHasKey($field_name, $display->getComponents()); + } + + /** + * Creates a media type via form submit. + * + * @param string $source_plugin_id + * Source plugin ID. + * @param string $field_name + * Source field name. + */ + protected function createMediaTypeViaForm($source_plugin_id, $field_name) { + /** @var \Drupal\media\MediaTypeInterface $type */ + $type = MediaType::create(['source' => $source_plugin_id]); + + $form = $this->container->get('entity_type.manager') + ->getFormObject('media_type', 'add') + ->setEntity($type); + + $form_state = new FormState(); + $form_state->setValues([ + 'label' => 'Test type', + 'id' => $source_plugin_id, + 'op' => t('Save'), + ]); + + /** @var \Drupal\Core\Entity\EntityFieldManagerInterface $field_manager */ + $field_manager = \Drupal::service('entity_field.manager'); + + // Source field not created yet. + $fields = $field_manager->getFieldDefinitions('media', $source_plugin_id); + $this->assertArrayNotHasKey($field_name, $fields); + + \Drupal::formBuilder()->submitForm($form, $form_state); + + // Source field exists now. + $fields = $field_manager->getFieldDefinitions('media', $source_plugin_id); + $this->assertArrayHasKey($field_name, $fields); } }