class FileFieldPathTest in Drupal 10

Tests that files are uploaded to proper locations.

@group file

Hierarchy

• class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
  • class \Drupal\Tests\file\Functional\FileFieldTestBase uses FileFieldCreationTrait, TestFileCreationTrait
    • class \Drupal\Tests\file\Functional\FileFieldPathTest

File

core/modules/file/tests/src/Functional/FileFieldPathTest.php, line 13

Namespace

Drupal\Tests\file\Functional

class FileFieldPathTest extends FileFieldTestBase {

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * Tests the normal formatter display on node display.
   */
  public function testUploadPath() {

    /** @var \Drupal\node\NodeStorageInterface $node_storage */
    $node_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('node');
    $field_name = strtolower($this
      ->randomMachineName());
    $type_name = 'article';
    $this
      ->createFileField($field_name, 'node', $type_name);

    /** @var \Drupal\file\FileInterface $test_file */
    $test_file = $this
      ->getTestFile('text');

    // Create a new node.
    $nid = $this
      ->uploadNodeFile($test_file, $field_name, $type_name);

    // Check that the file was uploaded to the correct location.
    $node_storage
      ->resetCache([
      $nid,
    ]);
    $node = $node_storage
      ->load($nid);

    /** @var \Drupal\file\FileInterface $node_file */
    $node_file = $node->{$field_name}->entity;
    $date_formatter = $this->container
      ->get('date.formatter');
    $expected_filename = 'public://' . $date_formatter
      ->format(REQUEST_TIME, 'custom', 'Y') . '-' . $date_formatter
      ->format(REQUEST_TIME, 'custom', 'm') . '/' . $test_file
      ->getFilename();
    $this
      ->assertPathMatch($expected_filename, $node_file
      ->getFileUri(), new FormattableMarkup('The file %file was uploaded to the correct path.', [
      '%file' => $node_file
        ->getFileUri(),
    ]));

    // Change the path to contain multiple subdirectories.
    $this
      ->updateFileField($field_name, $type_name, [
      'file_directory' => 'foo/bar/baz',
    ]);

    // Upload a new file into the subdirectories.
    $nid = $this
      ->uploadNodeFile($test_file, $field_name, $type_name);

    // Check that the file was uploaded into the subdirectory.
    $node_storage
      ->resetCache([
      $nid,
    ]);
    $node = $node_storage
      ->load($nid);
    $node_file = File::load($node->{$field_name}->target_id);
    $this
      ->assertPathMatch('public://foo/bar/baz/' . $test_file
      ->getFilename(), $node_file
      ->getFileUri(), new FormattableMarkup('The file %file was uploaded to the correct path.', [
      '%file' => $node_file
        ->getFileUri(),
    ]));

    // Check the path when used with tokens.
    // Change the path to contain multiple token directories.
    $this
      ->updateFileField($field_name, $type_name, [
      'file_directory' => '[current-user:uid]/[current-user:name]',
    ]);

    // Upload a new file into the token subdirectories.
    $nid = $this
      ->uploadNodeFile($test_file, $field_name, $type_name);

    // Check that the file was uploaded into the subdirectory.
    $node_storage
      ->resetCache([
      $nid,
    ]);
    $node = $node_storage
      ->load($nid);
    $node_file = File::load($node->{$field_name}->target_id);

    // Do token replacement using the same user which uploaded the file, not
    // the user running the test case.
    $data = [
      'user' => $this->adminUser,
    ];
    $subdirectory = \Drupal::token()
      ->replace('[user:uid]/[user:name]', $data);
    $this
      ->assertPathMatch('public://' . $subdirectory . '/' . $test_file
      ->getFilename(), $node_file
      ->getFileUri(), new FormattableMarkup('The file %file was uploaded to the correct path with token replacements.', [
      '%file' => $node_file
        ->getFileUri(),
    ]));
  }

  /**
   * Asserts that a file is uploaded to the right location.
   *
   * @param string $expected_path
   *   The location where the file is expected to be uploaded. Duplicate file
   *   names to not need to be taken into account.
   * @param string $actual_path
   *   Where the file was actually uploaded.
   * @param string $message
   *   The message to display with this assertion.
   *
   * @internal
   */
  public function assertPathMatch(string $expected_path, string $actual_path, string $message) : void {

    // Strip off the extension of the expected path to allow for _0, _1, etc.
    // suffixes when the file hits a duplicate name.
    $pos = strrpos($expected_path, '.');
    $base_path = substr($expected_path, 0, $pos);
    $extension = substr($expected_path, $pos + 1);
    $result = (bool) preg_match('/' . preg_quote($base_path, '/') . '(_[0-9]+)?\\.' . preg_quote($extension, '/') . '/', $actual_path);
    $this
      ->assertTrue($result, $message);
  }

}