Chris@18: <?php
Chris@18: 
Chris@18: namespace Drupal\Tests\jsonapi\Functional;
Chris@18: 
Chris@18: use Drupal\Core\Entity\EntityInterface;
Chris@18: use Drupal\Core\Url;
Chris@18: use Drupal\file\Entity\File;
Chris@18: use Drupal\media\Entity\Media;
Chris@18: use Drupal\media\Entity\MediaType;
Chris@18: use Drupal\Tests\jsonapi\Traits\CommonCollectionFilterAccessTestPatternsTrait;
Chris@18: use Drupal\user\Entity\User;
Chris@18: 
Chris@18: /**
Chris@18:  * JSON:API integration test for the "Media" content entity type.
Chris@18:  *
Chris@18:  * @group jsonapi
Chris@18:  */
Chris@18: class MediaTest extends ResourceTestBase {
Chris@18: 
Chris@18:   use CommonCollectionFilterAccessTestPatternsTrait;
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public static $modules = ['media'];
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected static $entityTypeId = 'media';
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected static $resourceTypeName = 'media--camelids';
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected static $resourceTypeIsVersionable = TRUE;
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    *
Chris@18:    * @var \Drupal\media\MediaInterface
Chris@18:    */
Chris@18:   protected $entity;
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected static $patchProtectedFieldNames = [
Chris@18:     'changed' => NULL,
Chris@18:   ];
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function setUpAuthorization($method) {
Chris@18:     switch ($method) {
Chris@18:       case 'GET':
Chris@18:         $this->grantPermissionsToTestedRole(['view media']);
Chris@18:         break;
Chris@18: 
Chris@18:       case 'POST':
Chris@18:         $this->grantPermissionsToTestedRole(['create camelids media', 'access content']);
Chris@18:         break;
Chris@18: 
Chris@18:       case 'PATCH':
Chris@18:         $this->grantPermissionsToTestedRole(['edit any camelids media']);
Chris@18:         // @todo Remove this in https://www.drupal.org/node/2824851.
Chris@18:         $this->grantPermissionsToTestedRole(['access content']);
Chris@18:         break;
Chris@18: 
Chris@18:       case 'DELETE':
Chris@18:         $this->grantPermissionsToTestedRole(['delete any camelids media']);
Chris@18:         break;
Chris@18:     }
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function setUpRevisionAuthorization($method) {
Chris@18:     parent::setUpRevisionAuthorization($method);
Chris@18:     $this->grantPermissionsToTestedRole(['view all media revisions']);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function createEntity() {
Chris@18:     if (!MediaType::load('camelids')) {
Chris@18:       // Create a "Camelids" media type.
Chris@18:       $media_type = MediaType::create([
Chris@18:         'name' => 'Camelids',
Chris@18:         'id' => 'camelids',
Chris@18:         'description' => 'Camelids are large, strictly herbivorous animals with slender necks and long legs.',
Chris@18:         'source' => 'file',
Chris@18:       ]);
Chris@18:       $media_type->save();
Chris@18:       // Create the source field.
Chris@18:       $source_field = $media_type->getSource()->createSourceField($media_type);
Chris@18:       $source_field->getFieldStorageDefinition()->save();
Chris@18:       $source_field->save();
Chris@18:       $media_type
Chris@18:         ->set('source_configuration', [
Chris@18:           'source_field' => $source_field->getName(),
Chris@18:         ])
Chris@18:         ->save();
Chris@18:     }
Chris@18: 
Chris@18:     // Create a file to upload.
Chris@18:     $file = File::create([
Chris@18:       'uri' => 'public://llama.txt',
Chris@18:     ]);
Chris@18:     $file->setPermanent();
Chris@18:     $file->save();
Chris@18: 
Chris@18:     // @see \Drupal\Tests\jsonapi\Functional\MediaTest::testPostIndividual()
Chris@18:     $post_file = File::create([
Chris@18:       'uri' => 'public://llama2.txt',
Chris@18:     ]);
Chris@18:     $post_file->setPermanent();
Chris@18:     $post_file->save();
Chris@18: 
Chris@18:     // Create a "Llama" media item.
Chris@18:     $media = Media::create([
Chris@18:       'bundle' => 'camelids',
Chris@18:       'field_media_file' => [
Chris@18:         'target_id' => $file->id(),
Chris@18:       ],
Chris@18:     ]);
Chris@18:     $media
Chris@18:       ->setName('Llama')
Chris@18:       ->setPublished()
Chris@18:       ->setCreatedTime(123456789)
Chris@18:       ->setOwnerId($this->account->id())
Chris@18:       ->setRevisionUserId($this->account->id())
Chris@18:       ->save();
Chris@18: 
Chris@18:     return $media;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function getExpectedDocument() {
Chris@18:     $file = File::load(1);
Chris@18:     $thumbnail = File::load(3);
Chris@18:     $author = User::load($this->entity->getOwnerId());
Chris@18:     $base_url = Url::fromUri('base:/jsonapi/media/camelids/' . $this->entity->uuid())->setAbsolute();
Chris@18:     $self_url = clone $base_url;
Chris@18:     $version_identifier = 'id:' . $this->entity->getRevisionId();
Chris@18:     $self_url = $self_url->setOption('query', ['resourceVersion' => $version_identifier]);
Chris@18:     $version_query_string = '?resourceVersion=' . urlencode($version_identifier);
Chris@18:     return [
Chris@18:       'jsonapi' => [
Chris@18:         'meta' => [
Chris@18:           'links' => [
Chris@18:             'self' => ['href' => 'http://jsonapi.org/format/1.0/'],
Chris@18:           ],
Chris@18:         ],
Chris@18:         'version' => '1.0',
Chris@18:       ],
Chris@18:       'links' => [
Chris@18:         'self' => ['href' => $base_url->toString()],
Chris@18:       ],
Chris@18:       'data' => [
Chris@18:         'id' => $this->entity->uuid(),
Chris@18:         'type' => 'media--camelids',
Chris@18:         'links' => [
Chris@18:           'self' => ['href' => $self_url->toString()],
Chris@18:         ],
Chris@18:         'attributes' => [
Chris@18:           'langcode' => 'en',
Chris@18:           'name' => 'Llama',
Chris@18:           'status' => TRUE,
Chris@18:           'created' => '1973-11-29T21:33:09+00:00',
Chris@18:           'changed' => (new \DateTime())->setTimestamp($this->entity->getChangedTime())->setTimezone(new \DateTimeZone('UTC'))->format(\DateTime::RFC3339),
Chris@18:           'revision_created' => (new \DateTime())->setTimestamp($this->entity->getRevisionCreationTime())->setTimezone(new \DateTimeZone('UTC'))->format(\DateTime::RFC3339),
Chris@18:           'default_langcode' => TRUE,
Chris@18:           'revision_log_message' => NULL,
Chris@18:           // @todo Attempt to remove this in https://www.drupal.org/project/drupal/issues/2933518.
Chris@18:           'revision_translation_affected' => TRUE,
Chris@18:           'drupal_internal__mid' => 1,
Chris@18:           'drupal_internal__vid' => 1,
Chris@18:         ],
Chris@18:         'relationships' => [
Chris@18:           'field_media_file' => [
Chris@18:             'data' => [
Chris@18:               'id' => $file->uuid(),
Chris@18:               'meta' => [
Chris@18:                 'description' => NULL,
Chris@18:                 'display' => NULL,
Chris@18:               ],
Chris@18:               'type' => 'file--file',
Chris@18:             ],
Chris@18:             'links' => [
Chris@18:               'related' => [
Chris@18:                 'href' => $base_url->toString() . '/field_media_file' . $version_query_string,
Chris@18:               ],
Chris@18:               'self' => [
Chris@18:                 'href' => $base_url->toString() . '/relationships/field_media_file' . $version_query_string,
Chris@18:               ],
Chris@18:             ],
Chris@18:           ],
Chris@18:           'thumbnail' => [
Chris@18:             'data' => [
Chris@18:               'id' => $thumbnail->uuid(),
Chris@18:               'meta' => [
Chris@18:                 'alt' => '',
Chris@18:                 'width' => 180,
Chris@18:                 'height' => 180,
Chris@18:                 'title' => NULL,
Chris@18:               ],
Chris@18:               'type' => 'file--file',
Chris@18:             ],
Chris@18:             'links' => [
Chris@18:               'related' => [
Chris@18:                 'href' => $base_url->toString() . '/thumbnail' . $version_query_string,
Chris@18:               ],
Chris@18:               'self' => [
Chris@18:                 'href' => $base_url->toString() . '/relationships/thumbnail' . $version_query_string,
Chris@18:               ],
Chris@18:             ],
Chris@18:           ],
Chris@18:           'bundle' => [
Chris@18:             'data' => [
Chris@18:               'id' => MediaType::load('camelids')->uuid(),
Chris@18:               'type' => 'media_type--media_type',
Chris@18:             ],
Chris@18:             'links' => [
Chris@18:               'related' => [
Chris@18:                 'href' => $base_url->toString() . '/bundle' . $version_query_string,
Chris@18:               ],
Chris@18:               'self' => [
Chris@18:                 'href' => $base_url->toString() . '/relationships/bundle' . $version_query_string,
Chris@18:               ],
Chris@18:             ],
Chris@18:           ],
Chris@18:           'uid' => [
Chris@18:             'data' => [
Chris@18:               'id' => $author->uuid(),
Chris@18:               'type' => 'user--user',
Chris@18:             ],
Chris@18:             'links' => [
Chris@18:               'related' => [
Chris@18:                 'href' => $base_url->toString() . '/uid' . $version_query_string,
Chris@18:               ],
Chris@18:               'self' => [
Chris@18:                 'href' => $base_url->toString() . '/relationships/uid' . $version_query_string,
Chris@18:               ],
Chris@18:             ],
Chris@18:           ],
Chris@18:           'revision_user' => [
Chris@18:             'data' => [
Chris@18:               'id' => $author->uuid(),
Chris@18:               'type' => 'user--user',
Chris@18:             ],
Chris@18:             'links' => [
Chris@18:               'related' => [
Chris@18:                 'href' => $base_url->toString() . '/revision_user' . $version_query_string,
Chris@18:               ],
Chris@18:               'self' => [
Chris@18:                 'href' => $base_url->toString() . '/relationships/revision_user' . $version_query_string,
Chris@18:               ],
Chris@18:             ],
Chris@18:           ],
Chris@18:         ],
Chris@18:       ],
Chris@18:     ];
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function getPostDocument() {
Chris@18:     $file = File::load(2);
Chris@18:     return [
Chris@18:       'data' => [
Chris@18:         'type' => 'media--camelids',
Chris@18:         'attributes' => [
Chris@18:           'name' => 'Dramallama',
Chris@18:         ],
Chris@18:         'relationships' => [
Chris@18:           'field_media_file' => [
Chris@18:             'data' => [
Chris@18:               'id' => $file->uuid(),
Chris@18:               'meta' => [
Chris@18:                 'description' => 'This file is better!',
Chris@18:                 'display' => NULL,
Chris@18:               ],
Chris@18:               'type' => 'file--file',
Chris@18:             ],
Chris@18:           ],
Chris@18:         ],
Chris@18:       ],
Chris@18:     ];
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function getExpectedUnauthorizedAccessMessage($method) {
Chris@18:     switch ($method) {
Chris@18:       case 'GET';
Chris@18:         return "The 'view media' permission is required when the media item is published.";
Chris@18: 
Chris@18:       case 'POST':
Chris@18:         return "The following permissions are required: 'administer media' OR 'create media' OR 'create camelids media'.";
Chris@18: 
Chris@18:       case 'PATCH':
Chris@18:         return "The following permissions are required: 'update any media' OR 'update own media' OR 'camelids: edit any media' OR 'camelids: edit own media'.";
Chris@18: 
Chris@18:       case 'DELETE':
Chris@18:         return "The following permissions are required: 'delete any media' OR 'delete own media' OR 'camelids: delete any media' OR 'camelids: delete own media'.";
Chris@18: 
Chris@18:       default:
Chris@18:         return '';
Chris@18:     }
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function getEditorialPermissions() {
Chris@18:     return array_merge(parent::getEditorialPermissions(), ['view any unpublished content']);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function getExpectedUnauthorizedAccessCacheability() {
Chris@18:     // @see \Drupal\media\MediaAccessControlHandler::checkAccess()
Chris@18:     return parent::getExpectedUnauthorizedAccessCacheability()
Chris@18:       ->addCacheTags(['media:1']);
Chris@18:   }
Chris@18: 
Chris@18:   // @codingStandardsIgnoreStart
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function testPostIndividual() {
Chris@18:     // @todo Mimic \Drupal\Tests\rest\Functional\EntityResource\Media\MediaResourceTestBase::testPost()
Chris@18:     // @todo Later, use https://www.drupal.org/project/jsonapi/issues/2958554 to upload files rather than the REST module.
Chris@18:     parent::testPostIndividual();
Chris@18:   }
Chris@18:   // @codingStandardsIgnoreEnd
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    *
Chris@18:    * @todo Determine if this override should be removed in https://www.drupal.org/project/jsonapi/issues/2952522
Chris@18:    */
Chris@18:   protected function getExpectedGetRelationshipDocumentData($relationship_field_name, EntityInterface $entity = NULL) {
Chris@18:     $data = parent::getExpectedGetRelationshipDocumentData($relationship_field_name, $entity);
Chris@18:     switch ($relationship_field_name) {
Chris@18:       case 'thumbnail':
Chris@18:         $data['meta'] = [
Chris@18:           'alt' => '',
Chris@18:           'width' => 180,
Chris@18:           'height' => 180,
Chris@18:           'title' => NULL,
Chris@18:         ];
Chris@18:         return $data;
Chris@18: 
Chris@18:       case 'field_media_file':
Chris@18:         $data['meta'] = [
Chris@18:           'description' => NULL,
Chris@18:           'display' => NULL,
Chris@18:         ];
Chris@18:         return $data;
Chris@18: 
Chris@18:       default:
Chris@18:         return $data;
Chris@18:     }
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    *
Chris@18:    * @todo Remove this in https://www.drupal.org/node/2824851.
Chris@18:    */
Chris@18:   protected function doTestRelationshipMutation(array $request_options) {
Chris@18:     $this->grantPermissionsToTestedRole(['access content']);
Chris@18:     parent::doTestRelationshipMutation($request_options);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function testCollectionFilterAccess() {
Chris@18:     $this->doTestCollectionFilterAccessForPublishableEntities('name', 'view media', 'administer media');
Chris@18:   }
Chris@18: 
Chris@18: }