Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests\media\Kernel;
Chris@0: 
Chris@0: use Drupal\Core\Form\FormState;
Chris@0: use Drupal\field\Entity\FieldConfig;
Chris@0: use Drupal\field\Entity\FieldStorageConfig;
Chris@0: use Drupal\media\Entity\Media;
Chris@0: use Drupal\media\Entity\MediaType;
Chris@0: 
Chris@0: /**
Chris@0:  * Tests media source plugins related logic.
Chris@0:  *
Chris@0:  * @group media
Chris@0:  */
Chris@0: class MediaSourceTest extends MediaKernelTestBase {
Chris@0: 
Chris@0:   /**
Chris@17:    * Tests that metadata is correctly mapped irrespective of how media is saved.
Chris@17:    */
Chris@17:   public function testSave() {
Chris@17:     $field_storage = FieldStorageConfig::create([
Chris@17:       'entity_type' => 'media',
Chris@17:       'field_name' => 'field_to_map_to',
Chris@17:       'type' => 'string',
Chris@17:     ]);
Chris@17:     $field_storage->save();
Chris@17: 
Chris@17:     FieldConfig::create([
Chris@17:       'field_storage' => $field_storage,
Chris@17:       'bundle' => $this->testMediaType->id(),
Chris@17:       'label' => 'Field to map to',
Chris@17:     ])->save();
Chris@17: 
Chris@17:     // Set an arbitrary metadata value to be mapped.
Chris@17:     $this->container->get('state')
Chris@17:       ->set('media_source_test_attributes', [
Chris@17:         'attribute_to_map' => [
Chris@17:           'title' => 'Attribute to map',
Chris@17:           'value' => 'Snowball',
Chris@17:         ],
Chris@17:         'thumbnail_uri' => [
Chris@17:           'value' => 'public://TheSisko.png',
Chris@17:         ],
Chris@17:       ]);
Chris@17:     $this->testMediaType->setFieldMap([
Chris@17:       'attribute_to_map' => 'field_to_map_to',
Chris@17:     ])->save();
Chris@17: 
Chris@17:     /** @var \Drupal\Core\Entity\EntityStorageInterface $storage */
Chris@17:     $storage = $this->container->get('entity_type.manager')
Chris@17:       ->getStorage('media');
Chris@17: 
Chris@17:     /** @var \Drupal\media\MediaInterface $a */
Chris@17:     $a = $storage->create([
Chris@17:       'bundle' => $this->testMediaType->id(),
Chris@17:     ]);
Chris@17:     /** @var \Drupal\media\MediaInterface $b */
Chris@17:     $b = $storage->create([
Chris@17:       'bundle' => $this->testMediaType->id(),
Chris@17:     ]);
Chris@17: 
Chris@17:     // Set a random source value on both items.
Chris@17:     $a->set($a->getSource()->getSourceFieldDefinition($a->bundle->entity)->getName(), $this->randomString());
Chris@17:     $b->set($b->getSource()->getSourceFieldDefinition($b->bundle->entity)->getName(), $this->randomString());
Chris@17: 
Chris@17:     $a->save();
Chris@17:     $storage->save($b);
Chris@17: 
Chris@17:     // Assert that the default name was mapped into the name field for both
Chris@17:     // media items.
Chris@17:     $this->assertFalse($a->get('name')->isEmpty());
Chris@17:     $this->assertFalse($b->get('name')->isEmpty());
Chris@17: 
Chris@17:     // Assert that arbitrary metadata was mapped correctly.
Chris@17:     $this->assertFalse($a->get('field_to_map_to')->isEmpty());
Chris@17:     $this->assertFalse($b->get('field_to_map_to')->isEmpty());
Chris@17: 
Chris@17:     // Assert that the thumbnail was mapped correctly from the source.
Chris@17:     $this->assertSame('public://TheSisko.png', $a->thumbnail->entity->getFileUri());
Chris@17:     $this->assertSame('public://TheSisko.png', $b->thumbnail->entity->getFileUri());
Chris@17:   }
Chris@17: 
Chris@17:   /**
Chris@0:    * Tests default media name functionality.
Chris@0:    */
Chris@0:   public function testDefaultName() {
Chris@0:     // Make sure that the default name is set if not provided by the user.
Chris@0:     /** @var \Drupal\media\MediaInterface $media */
Chris@0:     $media = Media::create(['bundle' => $this->testMediaType->id()]);
Chris@0:     $media_source = $media->getSource();
Chris@17:     $this->assertSame('default_name', $media_source->getPluginDefinition()['default_name_metadata_attribute'], 'Default metadata attribute is not used for the default name.');
Chris@17:     $this->assertSame('media:' . $media->bundle() . ':' . $media->uuid(), $media_source->getMetadata($media, 'default_name'), 'Value of the default name metadata attribute does not look correct.');
Chris@17:     $this->assertSame('media:' . $media->bundle() . ':' . $media->uuid(), $media->getName(), 'Default name was not used correctly by getName().');
Chris@17:     $this->assertSame($media->getName(), $media->label(), 'Default name and label are not the same.');
Chris@0:     $media->save();
Chris@17:     $this->assertSame('media:' . $media->bundle() . ':' . $media->uuid(), $media->getName(), 'Default name was not saved correctly.');
Chris@17:     $this->assertSame($media->getName(), $media->label(), 'The label changed during save.');
Chris@0: 
Chris@0:     // Make sure that the user-supplied name is used.
Chris@0:     /** @var \Drupal\media\MediaInterface $media */
Chris@0:     $name = 'User-supplied name';
Chris@0:     $media = Media::create([
Chris@0:       'bundle' => $this->testMediaType->id(),
Chris@0:       'name' => $name,
Chris@0:     ]);
Chris@0:     $media_source = $media->getSource();
Chris@17:     $this->assertSame('default_name', $media_source->getPluginDefinition()['default_name_metadata_attribute'], 'Default metadata attribute is not used for the default name.');
Chris@17:     $this->assertSame('media:' . $media->bundle() . ':' . $media->uuid(), $media_source->getMetadata($media, 'default_name'), 'Value of the default name metadata attribute does not look correct.');
Chris@0:     $media->save();
Chris@17:     $this->assertSame($name, $media->getName(), 'User-supplied name was not set correctly.');
Chris@17:     $this->assertSame($media->getName(), $media->label(), 'The user-supplied name does not match the label.');
Chris@0: 
Chris@0:     // Change the default name attribute and see if it is used to set the name.
Chris@0:     $name = 'Old Major';
Chris@0:     \Drupal::state()->set('media_source_test_attributes', ['alternative_name' => ['title' => 'Alternative name', 'value' => $name]]);
Chris@0:     \Drupal::state()->set('media_source_test_definition', ['default_name_metadata_attribute' => 'alternative_name']);
Chris@0:     /** @var \Drupal\media\MediaInterface $media */
Chris@0:     $media = Media::create(['bundle' => $this->testMediaType->id()]);
Chris@0:     $media_source = $media->getSource();
Chris@17:     $this->assertSame('alternative_name', $media_source->getPluginDefinition()['default_name_metadata_attribute'], 'Correct metadata attribute is not used for the default name.');
Chris@17:     $this->assertSame($name, $media_source->getMetadata($media, 'alternative_name'), 'Value of the default name metadata attribute does not look correct.');
Chris@0:     $media->save();
Chris@17:     $this->assertSame($name, $media->getName(), 'Default name was not set correctly.');
Chris@17:     $this->assertSame($media->getName(), $media->label(), 'The default name does not match the label.');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests metadata mapping functionality.
Chris@0:    */
Chris@0:   public function testMetadataMapping() {
Chris@0:     $field_name = 'field_to_map_to';
Chris@0:     $attribute_name = 'attribute_to_map';
Chris@0:     $storage = FieldStorageConfig::create([
Chris@0:       'entity_type' => 'media',
Chris@0:       'field_name' => $field_name,
Chris@0:       'type' => 'string',
Chris@0:     ]);
Chris@0:     $storage->save();
Chris@0: 
Chris@0:     FieldConfig::create([
Chris@0:       'field_storage' => $storage,
Chris@0:       'bundle' => $this->testMediaType->id(),
Chris@0:       'label' => 'Field to map to',
Chris@0:     ])->save();
Chris@0: 
Chris@0:     // Save the entity without defining the metadata mapping and check that the
Chris@0:     // field stays empty.
Chris@0:     /** @var \Drupal\media\MediaInterface $media */
Chris@0:     $media = Media::create([
Chris@0:       'bundle' => $this->testMediaType->id(),
Chris@0:       'field_media_test' => 'some_value',
Chris@0:     ]);
Chris@0:     $media->save();
Chris@0:     $this->assertEmpty($media->get($field_name)->value, 'Field stayed empty.');
Chris@0: 
Chris@0:     // Make sure that source plugin returns NULL for non-existing fields.
Chris@0:     $this->testMediaType->setFieldMap(['not_here_at_all' => $field_name])->save();
Chris@0:     $media = Media::create([
Chris@0:       'bundle' => $this->testMediaType->id(),
Chris@0:       'field_media_test' => 'some_value',
Chris@0:     ]);
Chris@0:     $media_source = $media->getSource();
Chris@0:     $this->assertNull($media_source->getMetadata($media, 'not_here_at_all'), 'NULL is not returned if asking for a value of non-existing metadata.');
Chris@0:     $media->save();
Chris@0:     $this->assertTrue($media->get($field_name)->isEmpty(), 'Non-existing metadata attribute was wrongly mapped to the field.');
Chris@0: 
Chris@0:     // Define mapping and make sure that the value was stored in the field.
Chris@0:     \Drupal::state()->set('media_source_test_attributes', [
Chris@0:       $attribute_name => ['title' => 'Attribute to map', 'value' => 'Snowball'],
Chris@0:     ]);
Chris@0:     $this->testMediaType->setFieldMap([$attribute_name => $field_name])->save();
Chris@0:     $media = Media::create([
Chris@0:       'bundle' => $this->testMediaType->id(),
Chris@0:       'field_media_test' => 'some_value',
Chris@0:     ]);
Chris@0:     $media_source = $media->getSource();
Chris@17:     $this->assertSame('Snowball', $media_source->getMetadata($media, $attribute_name), 'Value of the metadata attribute is not correct.');
Chris@0:     $media->save();
Chris@17:     $this->assertSame('Snowball', $media->get($field_name)->value, 'Metadata attribute was not mapped to the field.');
Chris@0: 
Chris@0:     // Change the metadata attribute value and re-save the entity. Field value
Chris@0:     // should stay the same.
Chris@0:     \Drupal::state()->set('media_source_test_attributes', [
Chris@0:       $attribute_name => ['title' => 'Attribute to map', 'value' => 'Pinkeye'],
Chris@0:     ]);
Chris@17:     $this->assertSame('Pinkeye', $media_source->getMetadata($media, $attribute_name), 'Value of the metadata attribute is not correct.');
Chris@0:     $media->save();
Chris@17:     $this->assertSame('Snowball', $media->get($field_name)->value, 'Metadata attribute was not mapped to the field.');
Chris@0: 
Chris@0:     // Now change the value of the source field and make sure that the mapped
Chris@0:     // values update too.
Chris@17:     $this->assertSame('Pinkeye', $media_source->getMetadata($media, $attribute_name), 'Value of the metadata attribute is not correct.');
Chris@0:     $media->set('field_media_test', 'some_new_value');
Chris@0:     $media->save();
Chris@17:     $this->assertSame('Pinkeye', $media->get($field_name)->value, 'Metadata attribute was not mapped to the field.');
Chris@0: 
Chris@0:     // Remove the value of the mapped field and make sure that it is re-mapped
Chris@0:     // on save.
Chris@0:     \Drupal::state()->set('media_source_test_attributes', [
Chris@0:       $attribute_name => ['title' => 'Attribute to map', 'value' => 'Snowball'],
Chris@0:     ]);
Chris@0:     $media->{$field_name}->value = NULL;
Chris@17:     $this->assertSame('Snowball', $media_source->getMetadata($media, $attribute_name), 'Value of the metadata attribute is not correct.');
Chris@0:     $media->save();
Chris@17:     $this->assertSame('Snowball', $media->get($field_name)->value, 'Metadata attribute was not mapped to the field.');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@14:    * Tests the getSourceFieldValue() method.
Chris@14:    */
Chris@14:   public function testGetSourceFieldValue() {
Chris@14:     /** @var \Drupal\media\MediaInterface $media */
Chris@14:     $media = Media::create([
Chris@14:       'bundle' => $this->testMediaType->id(),
Chris@14:       'field_media_test' => 'some_value',
Chris@14:     ]);
Chris@14:     $media->save();
Chris@14:     $media_source = $media->getSource();
Chris@14:     $this->assertSame('some_value', $media_source->getSourceFieldValue($media));
Chris@14:   }
Chris@14: 
Chris@14:   /**
Chris@0:    * Tests the thumbnail functionality.
Chris@0:    */
Chris@0:   public function testThumbnail() {
Chris@0:     file_put_contents('public://thumbnail1.jpg', '');
Chris@0:     file_put_contents('public://thumbnail2.jpg', '');
Chris@0: 
Chris@14:     // Save a media item and make sure thumbnail was added.
Chris@0:     \Drupal::state()->set('media_source_test_attributes', [
Chris@17:       'thumbnail_uri' => ['value' => 'public://thumbnail1.jpg'],
Chris@0:     ]);
Chris@0:     /** @var \Drupal\media\MediaInterface $media */
Chris@0:     $media = Media::create([
Chris@0:       'bundle' => $this->testMediaType->id(),
Chris@0:       'name' => 'Mr. Jones',
Chris@0:       'field_media_test' => 'some_value',
Chris@0:     ]);
Chris@0:     $media_source = $media->getSource();
Chris@17:     $this->assertSame('public://thumbnail1.jpg', $media_source->getMetadata($media, 'thumbnail_uri'), 'Value of the thumbnail metadata attribute is not correct.');
Chris@0:     $media->save();
Chris@17:     $this->assertSame('public://thumbnail1.jpg', $media->thumbnail->entity->getFileUri(), 'Thumbnail was not added to the media item.');
Chris@17:     // We expect the title not to be present on the Thumbnail.
Chris@17:     $this->assertEmpty($media->thumbnail->title);
Chris@17:     $this->assertSame('', $media->thumbnail->alt);
Chris@0: 
Chris@0:     // Now change the metadata attribute and make sure that the thumbnail stays
Chris@0:     // the same.
Chris@0:     \Drupal::state()->set('media_source_test_attributes', [
Chris@17:       'thumbnail_uri' => ['value' => 'public://thumbnail2.jpg'],
Chris@0:     ]);
Chris@17:     $this->assertSame('public://thumbnail2.jpg', $media_source->getMetadata($media, 'thumbnail_uri'), 'Value of the thumbnail metadata attribute is not correct.');
Chris@0:     $media->save();
Chris@17:     $this->assertSame('public://thumbnail1.jpg', $media->thumbnail->entity->getFileUri(), 'Thumbnail was not preserved.');
Chris@17:     $this->assertEmpty($media->thumbnail->title);
Chris@17:     $this->assertSame('', $media->thumbnail->alt);
Chris@0: 
Chris@0:     // Remove the thumbnail and make sure that it is auto-updated on save.
Chris@0:     $media->thumbnail->target_id = NULL;
Chris@17:     $this->assertSame('public://thumbnail2.jpg', $media_source->getMetadata($media, 'thumbnail_uri'), 'Value of the thumbnail metadata attribute is not correct.');
Chris@0:     $media->save();
Chris@17:     $this->assertSame('public://thumbnail2.jpg', $media->thumbnail->entity->getFileUri(), 'New thumbnail was not added to the media item.');
Chris@17:     $this->assertEmpty($media->thumbnail->title);
Chris@17:     $this->assertSame('', $media->thumbnail->alt);
Chris@0: 
Chris@0:     // Change the metadata attribute again, change the source field value too
Chris@0:     // and make sure that the thumbnail updates.
Chris@0:     \Drupal::state()->set('media_source_test_attributes', [
Chris@17:       'thumbnail_uri' => ['value' => 'public://thumbnail1.jpg'],
Chris@0:     ]);
Chris@0:     $media->field_media_test->value = 'some_new_value';
Chris@17:     $this->assertSame('public://thumbnail1.jpg', $media_source->getMetadata($media, 'thumbnail_uri'), 'Value of the thumbnail metadata attribute is not correct.');
Chris@0:     $media->save();
Chris@17:     $this->assertSame('public://thumbnail1.jpg', $media->thumbnail->entity->getFileUri(), 'New thumbnail was not added to the media item.');
Chris@17:     $this->assertEmpty($media->thumbnail->title);
Chris@17:     $this->assertSame('', $media->thumbnail->alt);
Chris@0: 
Chris@0:     // Change the thumbnail metadata attribute and make sure that the thumbnail
Chris@0:     // is set correctly.
Chris@0:     \Drupal::state()->set('media_source_test_attributes', [
Chris@17:       'thumbnail_uri' => ['value' => 'public://thumbnail1.jpg'],
Chris@17:       'alternative_thumbnail_uri' => ['value' => 'public://thumbnail2.jpg'],
Chris@0:     ]);
Chris@0:     \Drupal::state()->set('media_source_test_definition', ['thumbnail_uri_metadata_attribute' => 'alternative_thumbnail_uri']);
Chris@0:     $media = Media::create([
Chris@0:       'bundle' => $this->testMediaType->id(),
Chris@0:       'name' => 'Mr. Jones',
Chris@0:       'field_media_test' => 'some_value',
Chris@0:     ]);
Chris@0:     $media_source = $media->getSource();
Chris@17:     $this->assertSame('public://thumbnail1.jpg', $media_source->getMetadata($media, 'thumbnail_uri'), 'Value of the metadata attribute is not correct.');
Chris@17:     $this->assertSame('public://thumbnail2.jpg', $media_source->getMetadata($media, 'alternative_thumbnail_uri'), 'Value of the thumbnail metadata attribute is not correct.');
Chris@0:     $media->save();
Chris@17:     $this->assertSame('public://thumbnail2.jpg', $media->thumbnail->entity->getFileUri(), 'Correct metadata attribute was not used for the thumbnail.');
Chris@17:     $this->assertEmpty($media->thumbnail->title);
Chris@17:     $this->assertSame('', $media->thumbnail->alt);
Chris@0: 
Chris@0:     // Enable queued thumbnails and make sure that the entity gets the default
Chris@0:     // thumbnail initially.
Chris@0:     \Drupal::state()->set('media_source_test_definition', []);
Chris@0:     \Drupal::state()->set('media_source_test_attributes', [
Chris@17:       'thumbnail_uri' => ['value' => 'public://thumbnail1.jpg'],
Chris@0:     ]);
Chris@0:     $this->testMediaType->setQueueThumbnailDownloadsStatus(TRUE)->save();
Chris@0:     $media = Media::create([
Chris@0:       'bundle' => $this->testMediaType->id(),
Chris@0:       'name' => 'Mr. Jones',
Chris@0:       'field_media_test' => 'some_value',
Chris@0:     ]);
Chris@17:     $this->assertSame('public://thumbnail1.jpg', $media->getSource()->getMetadata($media, 'thumbnail_uri'), 'Value of the metadata attribute is not correct.');
Chris@0:     $media->save();
Chris@17:     $this->assertSame('public://media-icons/generic/generic.png', $media->thumbnail->entity->getFileUri(), 'Default thumbnail was not set initially.');
Chris@17:     $this->assertEmpty($media->thumbnail->title);
Chris@17:     $this->assertSame('', $media->thumbnail->alt);
Chris@0: 
Chris@0:     // Process the queue item and make sure that the thumbnail was updated too.
Chris@0:     $queue_name = 'media_entity_thumbnail';
Chris@0:     /** @var \Drupal\Core\Queue\QueueWorkerInterface $queue_worker */
Chris@0:     $queue_worker = \Drupal::service('plugin.manager.queue_worker')->createInstance($queue_name);
Chris@0:     $queue = \Drupal::queue($queue_name);
Chris@17:     $this->assertSame(1, $queue->numberOfItems(), 'Item was not added to the queue.');
Chris@0: 
Chris@0:     $item = $queue->claimItem();
Chris@17:     $this->assertSame($media->id(), $item->data['id'], 'Queue item that was created does not belong to the correct entity.');
Chris@0: 
Chris@0:     $queue_worker->processItem($item->data);
Chris@0:     $queue->deleteItem($item);
Chris@17:     $this->assertSame(0, $queue->numberOfItems(), 'Item was not removed from the queue.');
Chris@0: 
Chris@0:     $media = Media::load($media->id());
Chris@17:     $this->assertSame('public://thumbnail1.jpg', $media->thumbnail->entity->getFileUri(), 'Thumbnail was not updated by the queue.');
Chris@17:     $this->assertEmpty($media->thumbnail->title);
Chris@17:     $this->assertSame('', $media->thumbnail->alt);
Chris@0: 
Chris@17:     // Set the alt metadata attribute and make sure it's used for the thumbnail.
Chris@0:     \Drupal::state()->set('media_source_test_definition', [
Chris@0:       'thumbnail_alt_metadata_attribute' => 'alt',
Chris@0:     ]);
Chris@0:     \Drupal::state()->set('media_source_test_attributes', [
Chris@17:       'alt' => ['value' => 'This will be alt.'],
Chris@0:     ]);
Chris@0:     $media = Media::create([
Chris@0:       'bundle' => $this->testMediaType->id(),
Chris@0:       'name' => 'Boxer',
Chris@0:       'field_media_test' => 'some_value',
Chris@0:     ]);
Chris@0:     $media->save();
Chris@17:     $this->assertSame('Boxer', $media->getName(), 'Correct name was not set on the media item.');
Chris@17:     $this->assertEmpty($media->thumbnail->title);
Chris@17:     $this->assertSame('This will be alt.', $media->thumbnail->alt);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@14:    * Tests the media item constraints functionality.
Chris@0:    */
Chris@0:   public function testConstraints() {
Chris@0:     // Test entity constraints.
Chris@0:     \Drupal::state()->set('media_source_test_entity_constraints', [
Chris@0:       'MediaTestConstraint' => [],
Chris@0:     ]);
Chris@0: 
Chris@0:     // Create a media item media that uses a source plugin with constraints and
Chris@0:     // make sure the constraints works as expected when validating.
Chris@0:     /** @var \Drupal\media\MediaInterface $media */
Chris@0:     $media = Media::create([
Chris@0:       'bundle' => $this->testConstraintsMediaType->id(),
Chris@0:       'name' => 'I do not like Drupal',
Chris@0:       'field_media_test_constraints' => 'Not checked',
Chris@0:     ]);
Chris@0: 
Chris@0:     // Validate the entity and make sure violation is reported.
Chris@0:     /** @var \Drupal\Core\Entity\EntityConstraintViolationListInterface $violations */
Chris@0:     $violations = $media->validate();
Chris@0:     $this->assertCount(1, $violations, 'Expected number of validations not found.');
Chris@0:     $this->assertEquals('Inappropriate text.', $violations->get(0)->getMessage(), 'Incorrect constraint validation message found.');
Chris@0: 
Chris@0:     // Fix the violation and make sure it is not reported anymore.
Chris@0:     $media->setName('I love Drupal!');
Chris@0:     $violations = $media->validate();
Chris@0:     $this->assertCount(0, $violations, 'Expected number of validations not found.');
Chris@0: 
Chris@0:     // Save and make sure it succeeded.
Chris@0:     $this->assertEmpty($media->id(), 'Entity ID was found.');
Chris@0:     $media->save();
Chris@0:     $this->assertNotEmpty($media->id(), 'Entity ID was not found.');
Chris@0:     $this->assertSame($media->getName(), 'I love Drupal!');
Chris@0: 
Chris@0:     // Test source field constraints.
Chris@0:     \Drupal::state()->set('media_source_test_field_constraints', [
Chris@0:       'MediaTestConstraint' => [],
Chris@0:     ]);
Chris@0:     \Drupal::state()->set('media_source_test_entity_constraints', []);
Chris@0: 
Chris@0:     // Create media that uses source with constraints and make sure it can't
Chris@0:     // be saved without validating them.
Chris@0:     /** @var \Drupal\media\MediaInterface $media */
Chris@0:     $media = Media::create([
Chris@0:       'bundle' => $this->testConstraintsMediaType->id(),
Chris@0:       'name' => 'Not checked',
Chris@0:       'field_media_test_constraints' => 'I do not like Drupal',
Chris@0:     ]);
Chris@0: 
Chris@0:     // Validate the entity and make sure violation is reported.
Chris@0:     /** @var \Drupal\Core\Entity\EntityConstraintViolationListInterface $violations */
Chris@0:     $violations = $media->validate();
Chris@0:     $this->assertCount(1, $violations, 'Expected number of validations not found.');
Chris@0:     $this->assertEquals('Inappropriate text.', $violations->get(0)->getMessage(), 'Incorrect constraint validation message found.');
Chris@0: 
Chris@0:     // Fix the violation and make sure it is not reported anymore.
Chris@0:     $media->set('field_media_test_constraints', 'I love Drupal!');
Chris@0:     $violations = $media->validate();
Chris@0:     $this->assertCount(0, $violations, 'Expected number of validations not found.');
Chris@0: 
Chris@0:     // Save and make sure it succeeded.
Chris@0:     $this->assertEmpty($media->id(), 'Entity ID was found.');
Chris@0:     $media->save();
Chris@0:     $this->assertNotEmpty($media->id(), 'Entity ID was not found.');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests logic related to the automated source field creation.
Chris@0:    */
Chris@0:   public function testSourceFieldCreation() {
Chris@0:     /** @var \Drupal\media\MediaTypeInterface $type */
Chris@0:     $type = MediaType::create([
Chris@0:       'id' => 'test_type',
Chris@0:       'label' => 'Test type',
Chris@0:       'source' => 'test',
Chris@0:     ]);
Chris@0: 
Chris@0:     /** @var \Drupal\field\Entity\FieldConfig $field */
Chris@0:     $field = $type->getSource()->createSourceField($type);
Chris@0:     /** @var \Drupal\field\Entity\FieldStorageConfig $field_storage */
Chris@0:     $field_storage = $field->getFieldStorageDefinition();
Chris@0: 
Chris@0:     // Test field storage.
Chris@0:     $this->assertTrue($field_storage->isNew(), 'Field storage is saved automatically.');
Chris@0:     $this->assertFalse($field_storage->isLocked(), 'Field storage is not locked.');
Chris@17:     $this->assertSame('string', $field_storage->getType(), 'Field is not of correct type.');
Chris@17:     $this->assertSame('field_media_test_1', $field_storage->getName(), 'Incorrect field name is used.');
Chris@17:     $this->assertSame('media', $field_storage->getTargetEntityTypeId(), 'Field is not targeting media entities.');
Chris@0: 
Chris@0:     // Test field.
Chris@0:     $this->assertTrue($field->isNew(), 'Field is saved automatically.');
Chris@17:     $this->assertSame('field_media_test_1', $field->getName(), 'Incorrect field name is used.');
Chris@17:     $this->assertSame('string', $field->getType(), 'Field is of incorrect type.');
Chris@0:     $this->assertTrue($field->isRequired(), 'Field is not required.');
Chris@0:     $this->assertEquals('Test source', $field->label(), 'Incorrect label is used.');
Chris@17:     $this->assertSame('test_type', $field->getTargetBundle(), 'Field is not targeting correct bundle.');
Chris@0: 
Chris@0:     // Fields should be automatically saved only when creating the media type
Chris@0:     // using the media type creation form. Make sure that they are not saved
Chris@0:     // when creating a media type programmatically.
Chris@0:     // Drupal\Tests\media\FunctionalJavascript\MediaTypeCreationTest is testing
Chris@0:     // form part of the functionality.
Chris@0:     $type->save();
Chris@0:     $storage = FieldStorageConfig::load('media.field_media_test_1');
Chris@0:     $this->assertNull($storage, 'Field storage was not saved.');
Chris@0:     $field = FieldConfig::load('media.test_type.field_media_test_1');
Chris@0:     $this->assertNull($field, 'Field storage was not saved.');
Chris@0: 
Chris@0:     // Test the plugin with a different default source field type.
Chris@0:     $type = MediaType::create([
Chris@0:       'id' => 'test_constraints_type',
Chris@0:       'label' => 'Test type with constraints',
Chris@0:       'source' => 'test_constraints',
Chris@0:     ]);
Chris@0:     $field = $type->getSource()->createSourceField($type);
Chris@0:     $field_storage = $field->getFieldStorageDefinition();
Chris@0: 
Chris@0:     // Test field storage.
Chris@0:     $this->assertTrue($field_storage->isNew(), 'Field storage is saved automatically.');
Chris@0:     $this->assertFalse($field_storage->isLocked(), 'Field storage is not locked.');
Chris@17:     $this->assertSame('string_long', $field_storage->getType(), 'Field is of incorrect type.');
Chris@17:     $this->assertSame('field_media_test_constraints_1', $field_storage->getName(), 'Incorrect field name is used.');
Chris@17:     $this->assertSame('media', $field_storage->getTargetEntityTypeId(), 'Field is not targeting media entities.');
Chris@0: 
Chris@0:     // Test field.
Chris@0:     $this->assertTrue($field->isNew(), 'Field is saved automatically.');
Chris@17:     $this->assertSame('field_media_test_constraints_1', $field->getName(), 'Incorrect field name is used.');
Chris@17:     $this->assertSame('string_long', $field->getType(), 'Field is of incorrect type.');
Chris@0:     $this->assertTrue($field->isRequired(), 'Field is not required.');
Chris@0:     $this->assertEquals('Test source with constraints', $field->label(), 'Incorrect label is used.');
Chris@17:     $this->assertSame('test_constraints_type', $field->getTargetBundle(), 'Field is not targeting correct bundle.');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests configuration form submit handler on the base media source plugin.
Chris@0:    */
Chris@0:   public function testSourceConfigurationSubmit() {
Chris@0:     /** @var \Drupal\media\MediaSourceManager $manager */
Chris@0:     $manager = $this->container->get('plugin.manager.media.source');
Chris@0:     $form = [];
Chris@0:     $form_state = new FormState();
Chris@0:     $form_state->setValues(['test_config_value' => 'Somewhere over the rainbow.']);
Chris@0: 
Chris@0:     /** @var \Drupal\media\MediaSourceInterface $source */
Chris@0:     $source = $manager->createInstance('test', []);
Chris@0:     $source->submitConfigurationForm($form, $form_state);
Chris@17:     $expected = ['source_field' => 'field_media_test_1', 'test_config_value' => 'Somewhere over the rainbow.'];
Chris@17:     $this->assertSame($expected, $source->getConfiguration(), 'Submitted values were saved correctly.');
Chris@0: 
Chris@0:     // Try to save a NULL value.
Chris@0:     $form_state->setValue('test_config_value', NULL);
Chris@0:     $source->submitConfigurationForm($form, $form_state);
Chris@0:     $expected['test_config_value'] = NULL;
Chris@17:     $this->assertSame($expected, $source->getConfiguration(), 'Submitted values were saved correctly.');
Chris@0: 
Chris@0:     // Make sure that the config keys are determined correctly even if the
Chris@0:     // existing value is NULL.
Chris@0:     $form_state->setValue('test_config_value', 'Somewhere over the rainbow.');
Chris@0:     $source->submitConfigurationForm($form, $form_state);
Chris@0:     $expected['test_config_value'] = 'Somewhere over the rainbow.';
Chris@17:     $this->assertSame($expected, $source->getConfiguration(), 'Submitted values were saved correctly.');
Chris@0: 
Chris@0:     // Make sure that a non-relevant value will be skipped.
Chris@0:     $form_state->setValue('not_relevant', 'Should not be saved in the plugin.');
Chris@0:     $source->submitConfigurationForm($form, $form_state);
Chris@17:     $this->assertSame($expected, $source->getConfiguration(), 'Submitted values were saved correctly.');
Chris@0:   }
Chris@0: 
Chris@14:   /**
Chris@14:    * Tests different display options for the source field.
Chris@14:    */
Chris@14:   public function testDifferentSourceFieldDisplays() {
Chris@14:     $id = 'test_different_displays';
Chris@14:     $field_name = 'field_media_different_display';
Chris@14: 
Chris@14:     $this->createMediaTypeViaForm($id, $field_name);
Chris@14: 
Chris@14:     // Source field not in displays.
Chris@14:     $display = entity_get_display('media', $id, 'default');
Chris@14:     $components = $display->getComponents();
Chris@14:     $this->assertArrayHasKey($field_name, $components);
Chris@14:     $this->assertSame('entity_reference_entity_id', $components[$field_name]['type']);
Chris@14: 
Chris@14:     $display = entity_get_form_display('media', $id, 'default');
Chris@14:     $components = $display->getComponents();
Chris@14:     $this->assertArrayHasKey($field_name, $components);
Chris@14:     $this->assertSame('entity_reference_autocomplete_tags', $components[$field_name]['type']);
Chris@14:   }
Chris@14: 
Chris@14:   /**
Chris@14:    * Tests hidden source field in media type.
Chris@14:    */
Chris@14:   public function testHiddenSourceField() {
Chris@14:     $id = 'test_hidden_source_field';
Chris@14:     $field_name = 'field_media_hidden';
Chris@14: 
Chris@14:     $this->createMediaTypeViaForm($id, $field_name);
Chris@14: 
Chris@14:     // Source field not in displays.
Chris@14:     $display = entity_get_display('media', $id, 'default');
Chris@14:     $this->assertArrayNotHasKey($field_name, $display->getComponents());
Chris@14: 
Chris@14:     $display = entity_get_form_display('media', $id, 'default');
Chris@14:     $this->assertArrayNotHasKey($field_name, $display->getComponents());
Chris@14:   }
Chris@14: 
Chris@14:   /**
Chris@14:    * Creates a media type via form submit.
Chris@14:    *
Chris@14:    * @param string $source_plugin_id
Chris@14:    *   Source plugin ID.
Chris@14:    * @param string $field_name
Chris@14:    *   Source field name.
Chris@14:    */
Chris@14:   protected function createMediaTypeViaForm($source_plugin_id, $field_name) {
Chris@14:     /** @var \Drupal\media\MediaTypeInterface $type */
Chris@14:     $type = MediaType::create(['source' => $source_plugin_id]);
Chris@14: 
Chris@14:     $form = $this->container->get('entity_type.manager')
Chris@14:       ->getFormObject('media_type', 'add')
Chris@14:       ->setEntity($type);
Chris@14: 
Chris@14:     $form_state = new FormState();
Chris@14:     $form_state->setValues([
Chris@14:       'label' => 'Test type',
Chris@14:       'id' => $source_plugin_id,
Chris@14:       'op' => t('Save'),
Chris@14:     ]);
Chris@14: 
Chris@14:     /** @var \Drupal\Core\Entity\EntityFieldManagerInterface $field_manager */
Chris@14:     $field_manager = \Drupal::service('entity_field.manager');
Chris@14: 
Chris@14:     // Source field not created yet.
Chris@14:     $fields = $field_manager->getFieldDefinitions('media', $source_plugin_id);
Chris@14:     $this->assertArrayNotHasKey($field_name, $fields);
Chris@14: 
Chris@14:     \Drupal::formBuilder()->submitForm($form, $form_state);
Chris@14: 
Chris@14:     // Source field exists now.
Chris@14:     $fields = $field_manager->getFieldDefinitions('media', $source_plugin_id);
Chris@14:     $this->assertArrayHasKey($field_name, $fields);
Chris@14:   }
Chris@14: 
Chris@0: }