WebformElementMediaFileTest.php in Webform 6.x

Namespace

Drupal\Tests\webform\Functional\Element

File

tests/src/Functional/Element/WebformElementMediaFileTest.php

<?php

namespace Drupal\Tests\webform\Functional\Element;

use Drupal\file\Entity\File;
use Drupal\webform\Entity\WebformSubmission;

/**
 * Test for webform element managed file handling.
 *
 * @group webform
 */
class WebformElementMediaFileTest extends WebformElementManagedFileTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'file',
    'image',
    'webform',
  ];

  /**
   * Webforms to load.
   *
   * @var array
   */
  protected static $testWebforms = [
    'test_element_media_file',
  ];

  /**
   * Test media file upload elements.
   */
  public function testMediaFileUpload() {

    /* Element render */

    // Get test webform.
    $this
      ->drupalGet('/webform/test_element_media_file');

    // Check document file.
    $this
      ->assertRaw('<input data-drupal-selector="edit-document-file-upload" type="file" id="edit-document-file-upload" name="files[document_file]" size="22" class="js-form-file form-file" />');

    // Check audio file.
    $this
      ->assertRaw('<input data-drupal-selector="edit-audio-file-upload" accept="audio/*" type="file" id="edit-audio-file-upload" name="files[audio_file]" size="22" class="js-form-file form-file" />');

    // Check image file.
    $this
      ->assertRaw('<input data-drupal-selector="edit-image-file-upload" accept="image/*" type="file" id="edit-image-file-upload" name="files[image_file]" size="22" class="js-form-file form-file" />');

    // Check video file.
    $this
      ->assertRaw('<input data-drupal-selector="edit-video-file-upload" accept="video/mp4,video/x-m4v,video/*" type="file" id="edit-video-file-upload" name="files[video_file]" size="22" class="js-form-file form-file" />');

    /* Element processing */

    // Get test webform preview with test values.
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->drupalPostForm('/webform/test_element_media_file/test', [], 'Preview');

    // Check audio file preview.
    $this
      ->assertRaw('<source src="' . $this
      ->getAbsoluteUrl('/system/files/webform/test_element_media_file/_sid_/audio_file_mp3.mp3') . '" type="audio/mpeg">');

    // Check image file preview.
    $this
      ->assertRaw('<img class="webform-image-file" alt="image_file_jpg.jpg" title="image_file_jpg.jpg" src="' . $this
      ->getAbsoluteUrl('/system/files/webform/test_element_media_file/_sid_/image_file_jpg.jpg') . '" />');

    // Check image file link to modal.
    $this
      ->assertRaw('/system/files/webform/test_element_media_file/_sid_/image_file_jpg_modal.jpg" class="js-webform-image-file-modal webform-image-file-modal">');
    $this
      ->assertRaw('/system/files/styles/thumbnail/private/webform/test_element_media_file/_sid_/image_file_jpg_modal.jpg?itok=');

    // Check video file preview.
    $this
      ->assertRaw('<source src="' . $this
      ->getAbsoluteUrl('/system/files/webform/test_element_media_file/_sid_/video_file_mp4.mp4') . '" type="video/mp4">');
  }

  /****************************************************************************/

  // Helper functions. From: \Drupal\file\Tests\FileFieldTestBase::getTestFile

  /****************************************************************************/

  /**
   * Check file upload.
   *
   * @param string $type
   *   The type of file upload which can be either single or multiple.
   * @param object $first_file
   *   The first file to be uploaded.
   * @param object $second_file
   *   The second file that replaces the first file.
   */
  protected function checkFileUpload($type, $first_file, $second_file) {
    $key = 'managed_file_' . $type;
    $parameter_name = $type === 'multiple' ? "files[{$key}][]" : "files[{$key}]";
    $edit = [
      $parameter_name => \Drupal::service('file_system')
        ->realpath($first_file->uri),
    ];
    $sid = $this
      ->postSubmission($this->webform, $edit);

    /** @var \Drupal\webform\WebformSubmissionInterface $submission */
    $submission = WebformSubmission::load($sid);

    /** @var \Drupal\file\Entity\File $file */
    $fid = $this
      ->getLastFileId();
    $file = File::load($fid);

    // Check that test file was uploaded to the current submission.
    $second = $type === 'multiple' ? [
      $fid,
    ] : $fid;
    $this
      ->assertEqual($submission
      ->getElementData($key), $second, 'Test file was upload to the current submission');

    // Check test file file usage.
    $this
      ->assertIdentical([
      'webform' => [
        'webform_submission' => [
          $sid => '1',
        ],
      ],
    ], $this->fileUsage
      ->listUsage($file), 'The file has 1 usage.');

    // Check test file uploaded file path.
    $this
      ->assertEqual($file
      ->getFileUri(), 'private://webform/test_element_managed_file/' . $sid . '/' . $first_file->filename);

    // Check that test file exists.
    $this
      ->assertFileExists($file
      ->getFileUri());

    // Login admin user.
    $this
      ->drupalLogin($this->adminSubmissionUser);

    // Check managed file formatting.
    $this
      ->drupalGet('/admin/structure/webform/manage/test_element_managed_file/submission/' . $sid);
    if ($type === 'multiple') {
      $this
        ->assertRaw('<label>managed_file_multiple</label>');
      $this
        ->assertRaw('<div class="item-list">');
    }
    $this
      ->assertRaw('<span class="file file--mime-text-plain file--text"> <a href="' . file_create_url($file
      ->getFileUri()) . '" type="text/plain; length=' . $file
      ->getSize() . '">' . $file
      ->getFilename() . '</a></span>');

    // Remove the uploaded file.
    if ($type === 'multiple') {
      $edit = [
        'managed_file_multiple[file_' . $fid . '][selected]' => TRUE,
      ];
      $submit = 'Remove selected';
    }
    else {
      $edit = [];
      $submit = 'Remove';
    }
    $this
      ->drupalPostForm('/admin/structure/webform/manage/test_element_managed_file/submission/' . $sid . '/edit', $edit, $submit);

    // Upload new file.
    $edit = [
      $parameter_name => \Drupal::service('file_system')
        ->realpath($second_file->uri),
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Upload');

    // Submit the new file.
    $this
      ->drupalPostForm(NULL, [], 'Save');

    /** @var \Drupal\file\Entity\File $test_file_0 */
    $new_fid = $this
      ->getLastFileId();
    $new_file = File::load($new_fid);
    \Drupal::entityTypeManager()
      ->getStorage('webform_submission')
      ->resetCache();
    $submission = WebformSubmission::load($sid);

    // Check that test new file was uploaded to the current submission.
    $second = $type === 'multiple' ? [
      $new_fid,
    ] : $new_fid;
    $this
      ->assertEqual($submission
      ->getElementData($key), $second, 'Test new file was upload to the current submission');

    // Check that test file was deleted from the disk and database.
    $this
      ->assertFileNotExists($file
      ->getFileUri(), 'Test file deleted from disk');
    $this
      ->assertEqual(0, \Drupal::database()
      ->query('SELECT COUNT(fid) AS total FROM {file_managed} WHERE fid = :fid', [
      ':fid' => $fid,
    ])
      ->fetchField(), 'Test file 0 deleted from database');
    $this
      ->assertEqual(0, \Drupal::database()
      ->query('SELECT COUNT(fid) AS total FROM {file_usage} WHERE fid = :fid', [
      ':fid' => $fid,
    ])
      ->fetchField(), 'Test file 0 deleted from database');

    // Check test file 1 file usage.
    $this
      ->assertIdentical([
      'webform' => [
        'webform_submission' => [
          $sid => '1',
        ],
      ],
    ], $this->fileUsage
      ->listUsage($new_file), 'The new file has 1 usage.');

    // Delete the submission.
    $submission
      ->delete();

    // Check that test file 1 was deleted from the disk and database.
    $this
      ->assertFileNotExists($new_file
      ->getFileUri(), 'Test new file deleted from disk');
    $this
      ->assertEqual(0, \Drupal::database()
      ->query('SELECT COUNT(fid) AS total FROM {file_managed} WHERE fid = :fid', [
      ':fid' => $new_fid,
    ])
      ->fetchField(), 'Test new file deleted from database');
  }

}

Classes

Name	Description
WebformElementMediaFileTest	Test for webform element managed file handling.