FileEntityFormatterTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\file\Kernel\Formatter;

use Drupal\Core\Entity\Entity\EntityViewDisplay;
use Drupal\file\Entity\File;
use Drupal\KernelTests\KernelTestBase;

/**
 * Tests the default file formatter.
 *
 * @group field
 */
class FileEntityFormatterTest extends KernelTestBase {
  
  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'file',
    'user',
    'file_test',
  ];
  
  /**
   * The files.
   *
   * @var array
   */
  protected $files;
  
  /**
   * The file URL generator.
   *
   * @var \Drupal\Core\File\FileUrlGeneratorInterface
   */
  protected $fileUrlGenerator;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->fileUrlGenerator = $this->container
      ->get('file_url_generator');
    $this->installEntitySchema('file');
    $this->files = [];
    file_put_contents('public://file.png', str_repeat('t', 10));
    $file = File::create([
      'uri' => 'public://file.png',
      'filename' => 'file.png',
    ]);
    $file->save();
    $this->files[] = $file;
    file_put_contents('public://file.tar', str_repeat('t', 200));
    $file = File::create([
      'uri' => 'public://file.tar',
      'filename' => 'file.tar',
    ]);
    $file->save();
    $this->files[] = $file;
    file_put_contents('public://file.tar.gz', str_repeat('t', 40000));
    $file = File::create([
      'uri' => 'public://file.tar.gz',
      'filename' => 'file.tar.gz',
    ]);
    $file->save();
    $this->files[] = $file;
    file_put_contents('public://file', str_repeat('t', 8000000));
    $file = File::create([
      'uri' => 'public://file',
      'filename' => 'file',
    ]);
    $file->save();
    $this->files[] = $file;
  }
  
  /**
   * Tests the file_link field formatter.
   */
  public function testFormatterFileLink() : void {
    $entity_display = EntityViewDisplay::create([
      'targetEntityType' => 'file',
      'bundle' => 'file',
    ]);
    $entity_display->setComponent('filename', [
      'type' => 'file_link',
    ]);
    $build = $entity_display->buildMultiple($this->files)[0]['filename'][0];
    $this->assertEquals('file.png', $build['#title']);
    $this->assertEquals($this->fileUrlGenerator
      ->generate('public://file.png'), $build['#url']);
  }
  
  /**
   * Tests the file_link field formatter.
   */
  public function testFormatterFileUri() : void {
    $entity_display = EntityViewDisplay::create([
      'targetEntityType' => 'file',
      'bundle' => 'file',
    ]);
    $entity_display->setComponent('uri', [
      'type' => 'file_uri',
    ]);
    $build = $entity_display->buildMultiple($this->files)[0]['uri'][0];
    $this->assertEquals('public://file.png', $build['#markup']);
    $entity_display->setComponent('uri', [
      'type' => 'file_uri',
      'settings' => [
        'file_download_path' => TRUE,
      ],
    ]);
    $build = $entity_display->buildMultiple($this->files)[0]['uri'][0];
    $this->assertEquals($this->fileUrlGenerator
      ->generateString('public://file.png'), $build['#markup']);
    $entity_display->setComponent('uri', [
      'type' => 'file_uri',
      'settings' => [
        'file_download_path' => TRUE,
        'link_to_file' => TRUE,
      ],
    ]);
    $build = $entity_display->buildMultiple($this->files)[0]['uri'][0];
    $this->assertEquals($this->fileUrlGenerator
      ->generateString('public://file.png'), $build['#title']);
    $this->assertEquals($this->fileUrlGenerator
      ->generate('public://file.png'), $build['#url']);
  }
  
  /**
   * Tests the file_extension field formatter.
   */
  public function testFormatterFileExtension() : void {
    $entity_display = EntityViewDisplay::create([
      'targetEntityType' => 'file',
      'bundle' => 'file',
    ]);
    $entity_display->setComponent('filename', [
      'type' => 'file_extension',
    ]);
    $expected = [
      'png',
      'tar',
      'gz',
      '',
    ];
    foreach (array_values($this->files) as $i => $file) {
      $build = $entity_display->build($file);
      $this->assertEquals($expected[$i], $build['filename'][0]['#markup']);
    }
    $entity_display->setComponent('filename', [
      'type' => 'file_extension',
      'settings' => [
        'extension_detect_tar' => TRUE,
      ],
    ]);
    $expected = [
      'png',
      'tar',
      'tar.gz',
      '',
    ];
    foreach (array_values($this->files) as $i => $file) {
      $build = $entity_display->build($file);
      $this->assertEquals($expected[$i], $build['filename'][0]['#markup']);
    }
  }
  
  /**
   * Tests the file_extension field formatter.
   */
  public function testFormatterFileMime() : void {
    $entity_display = EntityViewDisplay::create([
      'targetEntityType' => 'file',
      'bundle' => 'file',
    ]);
    $entity_display->setComponent('filemime', [
      'type' => 'file_filemime',
      'settings' => [
        'filemime_image' => TRUE,
      ],
    ]);
    foreach (array_values($this->files) as $i => $file) {
      $build = $entity_display->build($file);
      $this->assertEquals('image__file_icon', $build['filemime'][0]['#theme']);
      $this->assertEquals(spl_object_hash($file), spl_object_hash($build['filemime'][0]['#file']));
    }
  }
  
  /**
   * Tests the file_size field formatter.
   */
  public function testFormatterFileSize() : void {
    $entity_display = EntityViewDisplay::create([
      'targetEntityType' => 'file',
      'bundle' => 'file',
    ]);
    $entity_display->setComponent('filesize', [
      'type' => 'file_size',
    ]);
    $expected = [
      '10 bytes',
      '200 bytes',
      '39.06 KB',
      '7.63 MB',
    ];
    foreach (array_values($this->files) as $i => $file) {
      $build = $entity_display->build($file);
      $this->assertEquals($expected[$i], $build['filesize'][0]['#markup']);
    }
  }
  
  /**
   * Tests the file_link field formatter using a query string.
   */
  public function testFormatterFileLinkWithQueryString() : void {
    $file = File::create([
      'uri' => 'dummy-external-readonly://file-query-string?foo=bar',
      'filename' => 'file-query-string',
    ]);
    $file->save();
    $file_link = [
      '#theme' => 'file_link',
      '#file' => $file,
    ];
    $output = (string) \Drupal::service('renderer')->renderRoot($file_link);
    $this->assertStringContainsString($this->fileUrlGenerator
      ->generate('dummy-external-readonly://file-query-string?foo=bar')
      ->toUriString(), $output);
  }

}