EWPP-253: Move media creation into trait.

composer.json

@@ -20,7 +20,7 @@
         "drupal-composer/drupal-scaffold": "~2.5.2",
         "guzzlehttp/guzzle": "~6.3",
         "openeuropa/behat-transformation-context": "~0.1",
-        "openeuropa/code-review": "~1.0.0-beta2",
+        "openeuropa/code-review": "~1.5",
         "openeuropa/drupal-core-require-dev": "^8.7",
         "openeuropa/task-runner": "~1.0@beta",
         "openeuropa/oe_link_lists": "dev-master",

modules/oe_media_avportal/src/Plugin/EntityBrowser/Widget/AVPortalSearch.php

@@ -56,7 +56,7 @@ protected function prepareEntities(array $form, FormStateInterface $form_state)
    * @return \Drupal\media\MediaInterface|null
    *   The media entity.
    */
-  protected function getMediaEntityFromRef(string $ref): MediaInterface {
+  protected function getMediaEntityFromRef(string $ref): ?MediaInterface {
     $bundle = NULL;
     $field = NULL;
 

tests/Behat/MediaContext.php

@@ -11,12 +11,15 @@
 use Drupal\DrupalExtension\Context\RawDrupalContext;
 use Drupal\file\FileInterface;
 use Drupal\media\MediaInterface;
+use Drupal\Tests\oe_media\Traits\MediaCreationTrait;
 
 /**
  * Context to related to media testing.
  */
 class MediaContext extends RawDrupalContext {
 
+  use MediaCreationTrait;
+
   /**
    * Keep track of medias so they can be cleaned up.
    *
@@ -120,16 +123,10 @@ public function createMediaDocuments(TableNode $table): void {
     $files = $table->getColumnsHash();
     foreach ($files as $properties) {
       $file = $this->createFileEntity($properties['file']);
-      $media = \Drupal::entityTypeManager()
-        ->getStorage('media')->create([
-          'bundle' => 'document',
-          'name' => $properties['name'],
-          'oe_media_file' => [
-            'target_id' => (int) $file->id(),
-          ],
-          'status' => 1,
-        ]);
-      $media->save();
+      $media = $this->createMediaDocument($file, [
+        'name' => $properties['name'],
+        'file_id' => $file->id(),
+      ]);
 
       // Store for cleanup.
       $this->media[] = $media;
@@ -156,18 +153,11 @@ public function createMediaImages(TableNode $table): void {
     $files = $table->getColumnsHash();
     foreach ($files as $properties) {
       $file = $this->createFileEntity($properties['file']);
-      $media = \Drupal::entityTypeManager()
-        ->getStorage('media')->create([
-          'bundle' => 'image',
-          'name' => $properties['name'],
-          'oe_media_image' => [
-            'target_id' => (int) $file->id(),
-            'alt' => $properties['alt'] ?? $properties['name'],
-            'title' => $properties['title'] ?? $properties['name'],
-          ],
-          'status' => 1,
-        ]);
-      $media->save();
+      $media = $this->createMediaImage($file, [
+        'name' => $properties['name'],
+        'alt' => $properties['alt'] ?? $properties['name'],
+        'title' => $properties['title'] ?? $properties['name'],
+      ]);
 
       // Store for cleanup.
       $this->media[] = $media;
@@ -195,13 +185,9 @@ public function createMediaAvPortalPhotos(TableNode $table): void {
 
     // Retrieve the url table from the test scenario.
     foreach ($table->getColumnsHash() as $hash) {
-      $media = \Drupal::entityTypeManager()
-        ->getStorage('media')->create([
-          'bundle' => 'av_portal_photo',
-          'oe_media_avportal_photo' => $media_source->transformUrlToReference($hash['url']),
-          'status' => 1,
-        ]);
-      $media->save();
+      $media = $this->createMediaAvPortalPhoto($media_source, [
+        'url' => $hash['url'],
+      ]);
 
       // Store for cleanup.
       $this->media[] = $media;
@@ -222,13 +208,9 @@ public function createMediaAvPortalPhotos(TableNode $table): void {
    */
   public function createMediaRemoteVideo(TableNode $table): void {
     foreach ($table->getColumnsHash() as $hash) {
-      $media = \Drupal::entityTypeManager()
-        ->getStorage('media')->create([
-          'bundle' => 'remote_video',
-          'oe_media_oembed_video' => $hash['url'],
-          'status' => 1,
-        ]);
-      $media->save();
+      $media = $this->createMediaRemoteVideo([
+        'url' => $hash['url'],
+      ]);
 
       // Store for cleanup.
       $this->media[] = $media;
@@ -296,9 +278,8 @@ protected function getConfigContext(): ConfigContext {
    *   File entity object.
    */
   protected function createFileEntity(string $file_name): FileInterface {
-    $file = file_save_data(file_get_contents($this->getMinkParameter('files_path') . $file_name), 'public://' . basename($file_name));
-    $file->setPermanent();
-    $file->save();
+    $filepah = $this->getMinkParameter('files_path') . $file_name;
+    $file = $this->createFile($filepah);
 
     // Store for cleanup.
     $this->files[] = $file;

tests/Traits/MediaCreationTrait.php

@@ -0,0 +1,215 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\Tests\oe_media\Traits;
+
+use Drupal\file\FileInterface;
+use Drupal\media_avportal\Plugin\media\Source\MediaAvPortalSourceInterface;
+use Drupal\media\MediaInterface;
+use Drupal\Component\Utility\Html;
+
+/**
+ * Helper methods to deal with media creation.
+ */
+trait MediaCreationTrait {
+
+  /**
+   * Create a file entity from the given file path.
+   *
+   * @param string $filepath
+   *   Path to the file location.
+   *
+   * @return \Drupal\file\FileInterface
+   *   File entity object.
+   */
+  protected function createFile(string $filepath): FileInterface {
+    $file = file_save_data(file_get_contents($filepath), 'public://' . basename($filepath));
+    $file->setPermanent();
+    $file->save();
+
+    return $file;
+  }
+
+  /**
+   * Suggest a safe file name using the file uri.
+   *
+   * @param \Drupal\file\FileInterface $file
+   *   The file entity.
+   *
+   * @return string
+   *   The suggested name for the file entity.
+   */
+  protected function getFileNameSuggestion(FileInterface $file): string {
+    return Html::cleanCssIdentifier($file->getFileUri());
+  }
+
+  /**
+   * Create a media entity of image bundle.
+   *
+   * @param \Drupal\file\FileInterface $file
+   *   The file entity.
+   * @param array $settings
+   *   An associative array of settings for the media entity.
+   *
+   * @return \Drupal\media\MediaInterface
+   *   The media object.
+   */
+  protected function createMediaDocument(FileInterface $file, array $settings = []): MediaInterface {
+    $settings += [
+      'name' => $this->getFileNameSuggestion($file),
+      'status' => 1,
+      'uid' => 0,
+    ];
+
+    $values = [
+      'bundle' => 'document',
+      'name' => $settings['name'],
+      'oe_media_file' => [
+        'target_id' => (int) $file->id(),
+      ],
+      'status' => $settings['status'],
+      'uid' => $settings['uid'],
+    ];
+
+    foreach (['name', 'status', 'uid'] as $key) {
+      if (isset($settings[$key])) {
+        // Remove already used values.
+        unset($settings[$key]);
+      }
+    }
+
+    $values += $settings;
+    $media = \Drupal::entityTypeManager()
+      ->getStorage('media')->create($values);
+    $media->save();
+
+    return $media;
+  }
+
+  /**
+   * Create a media entity of image bundle.
+   *
+   * @param \Drupal\file\FileInterface $file
+   *   The file entity.
+   * @param array $settings
+   *   An associative array of settings for the media entity.
+   *
+   * @return \Drupal\media\MediaInterface
+   *   The media object.
+   */
+  protected function createMediaImage(FileInterface $file, array $settings = []): MediaInterface {
+    $filename_suggestion = $this->getFileNameSuggestion($file);
+    $settings += [
+      'name' => $filename_suggestion,
+      'file_id' => FALSE,
+      'alt' => $filename_suggestion,
+      'title' => $filename_suggestion,
+      'status' => 1,
+      'uid' => 0,
+    ];
+
+    $values = [
+      'bundle' => 'image',
+      'name' => $settings['name'],
+      'oe_media_image' => [
+        'target_id' => (int) $file->id(),
+        'alt' => $settings['alt'],
+        'title' => $settings['title'],
+      ],
+      'status' => $settings['status'],
+      'uid' => $settings['uid'],
+    ];
+
+    foreach (['name', 'alt', 'title', 'status', 'uid'] as $key) {
+      if (isset($settings[$key])) {
+        // Remove already used values.
+        unset($settings[$key]);
+      }
+    }
+
+    $values += $settings;
+    $media = \Drupal::entityTypeManager()
+      ->getStorage('media')->create($values);
+    $media->save();
+
+    return $media;
+  }
+
+  /**
+   * Create a media entity of av_portal_photo bundle.
+   *
+   * @param Drupal\media_avportal\Plugin\media\Source\MediaAvPortalSourceInterface $media_source
+   *   The av_portal_photo media source.
+   * @param array $settings
+   *   An associative array of settings for the media entity.
+   *
+   * @return \Drupal\media\MediaInterface
+   *   The media object.
+   */
+  protected function createMediaAvPortalPhoto(MediaAvPortalSourceInterface $media_source, array $settings = []): MediaInterface {
+    $settings += [
+      'status' => 1,
+      'uid' => 0,
+    ];
+
+    $values = [
+      'bundle' => 'av_portal_photo',
+      'oe_media_avportal_photo' => $media_source->transformUrlToReference($settings['url']),
+      'status' => $settings['status'],
+      'uid' => $settings['uid'],
+    ];
+
+    foreach (['url', 'status', 'uid'] as $key) {
+      if (isset($settings[$key])) {
+        // Remove already used values.
+        unset($settings[$key]);
+      }
+    }
+
+    $values += $settings;
+    $media = \Drupal::entityTypeManager()
+      ->getStorage('media')->create($values);
+    $media->save();
+
+    return $media;
+  }
+
+  /**
+   * Create a media entity of remote_video bundle.
+   *
+   * @param array $settings
+   *   An associative array of settings for the media entity.
+   *
+   * @return \Drupal\media\MediaInterface
+   *   The media object.
+   */
+  protected function createMediaRemoteVideo(array $settings = []): MediaInterface {
+    $settings += [
+      'status' => 1,
+      'uid' => 0,
+    ];
+
+    $values = [
+      'bundle' => 'remote_video',
+      'oe_media_oembed_video' => $settings['url'],
+      'status' => $settings['status'],
+      'uid' => $settings['uid'],
+    ];
+
+    foreach (['url', 'status', 'uid'] as $key) {
+      if (isset($settings[$key])) {
+        // Remove already used values.
+        unset($settings[$key]);
+      }
+    }
+
+    $values += $settings;
+    $media = \Drupal::entityTypeManager()
+      ->getStorage('media')->create($values);
+    $media->save();
+
+    return $media;
+  }
+
+}