FileFieldFormatterTest.php in Entity Embed 8

Namespace

Drupal\Tests\entity_embed\Functional

File

tests/src/Functional/FileFieldFormatterTest.php

<?php

namespace Drupal\Tests\entity_embed\Functional;

use Drupal\Component\Serialization\Json;
use Drupal\Core\Form\FormState;

/**
 * Tests the file field formatter provided by entity_embed.
 *
 * @group entity_embed
 */
class FileFieldFormatterTest extends EntityEmbedTestBase {

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

  /**
   * Created file entity.
   *
   * @var \Drupal\file\FileInterface
   */
  protected $file;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->file = $this
      ->getTestFile('text');
  }

  /**
   * Tests file field formatter Entity Embed Display plugins.
   */
  public function testFileFieldFormatter() {

    // Ensure that file field formatters are available as plugins.
    $this
      ->assertAvailableDisplayPlugins($this->file, [
      'entity_reference:entity_reference_label',
      'entity_reference:entity_reference_entity_id',
      'file:file_default',
      'file:file_table',
      'file:file_url_plain',
    ]);

    // Ensure that correct form attributes are returned for the file field
    // formatter plugins.
    $form = [];
    $form_state = new FormState();
    $plugins = [
      'file:file_table',
      'file:file_default',
      'file:file_url_plain',
    ];

    // Ensure that description field is available for all the 'file' plugins.
    foreach ($plugins as $plugin) {
      $display = $this->container
        ->get('plugin.manager.entity_embed.display')
        ->createInstance($plugin, []);
      $display
        ->setContextValue('entity', $this->file);
      $conf_form = $display
        ->buildConfigurationForm($form, $form_state);
      $this
        ->assertArrayHasKey('description', $conf_form);
      $this
        ->assertSame('textfield', $conf_form['description']['#type']);
      $this
        ->assertSame('Description', (string) $conf_form['description']['#title']);
    }

    // Test entity embed using 'Generic file' Entity Embed Display plugin.
    $embed_settings = [
      'description' => 'This is sample description',
    ];
    $content = '<drupal-entity data-entity-type="file" data-entity-uuid="' . $this->file
      ->uuid() . '" data-entity-embed-display="file:file_default" data-entity-embed-display-settings=\'' . Json::encode($embed_settings) . '\'>This placeholder should not be rendered.</drupal-entity>';
    $settings = [];
    $settings['type'] = 'page';
    $settings['title'] = 'Test entity embed with file:file_default';
    $settings['body'] = [
      [
        'value' => $content,
        'format' => 'custom_format',
      ],
    ];
    $node = $this
      ->drupalCreateNode($settings);
    $this
      ->drupalGet('node/' . $node
      ->id());

    // Verify description of the embedded file exists in page.
    $this
      ->assertSession()
      ->responseContains($embed_settings['description']);
    $this
      ->assertSession()
      ->responseNotContains('This placeholder should not be rendered.');
    $this
      ->assertSession()
      ->linkByHrefExists(file_create_url($this->file
      ->getFileUri()), 0, 'Link to the embedded file exists.');
  }

}

Classes

Name	Description
FileFieldFormatterTest	Tests the file field formatter provided by entity_embed.