EditorFileUsageTest.php in Zircon Profile 8

Contains \Drupal\editor\Tests\EditorFileUsageTest.

Namespace

Drupal\editor\Tests

File

core/modules/editor/src/Tests/EditorFileUsageTest.php

<?php

/**
 * @file
 * Contains \Drupal\editor\Tests\EditorFileUsageTest.
 */
namespace Drupal\editor\Tests;

use Drupal\system\Tests\Entity\EntityUnitTestBase;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\Core\Field\FieldStorageDefinitionInterface;

/**
 * Tests tracking of file usage by the Text Editor module.
 *
 * @group editor
 */
class EditorFileUsageTest extends EntityUnitTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'editor',
    'editor_test',
    'node',
    'file',
  );
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('file');
    $this
      ->installSchema('node', array(
      'node_access',
    ));
    $this
      ->installSchema('file', array(
      'file_usage',
    ));
    $this
      ->installConfig([
      'node',
    ]);

    // Add text formats.
    $filtered_html_format = entity_create('filter_format', array(
      'format' => 'filtered_html',
      'name' => 'Filtered HTML',
      'weight' => 0,
      'filters' => array(),
    ));
    $filtered_html_format
      ->save();

    // Set cardinality for body field.
    FieldStorageConfig::loadByName('node', 'body')
      ->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED)
      ->save();

    // Set up text editor.
    $editor = entity_create('editor', array(
      'format' => 'filtered_html',
      'editor' => 'unicorn',
    ));
    $editor
      ->save();

    // Create a node type for testing.
    $type = entity_create('node_type', array(
      'type' => 'page',
      'name' => 'page',
    ));
    $type
      ->save();
    node_add_body_field($type);
  }

  /**
   * Tests the configurable text editor manager.
   */
  public function testEditorEntityHooks() {
    $image_paths = array(
      0 => 'core/misc/druplicon.png',
      1 => 'core/misc/tree.png',
      2 => 'core/misc/help.png',
    );
    $image_entities = array();
    foreach ($image_paths as $key => $image_path) {
      $image = entity_create('file');
      $image
        ->setFileUri($image_path);
      $image
        ->setFilename(drupal_basename($image
        ->getFileUri()));
      $image
        ->save();
      $file_usage = $this->container
        ->get('file.usage');
      $this
        ->assertIdentical(array(), $file_usage
        ->listUsage($image), 'The image ' . $image_paths[$key] . ' has zero usages.');
      $image_entities[] = $image;
    }
    $body = array();
    foreach ($image_entities as $key => $image_entity) {

      // Don't be rude, say hello.
      $body_value = '<p>Hello, world!</p>';

      // Test handling of a valid image entry.
      $body_value .= '<img src="awesome-llama-' . $key . '.jpg" data-entity-type="file" data-entity-uuid="' . $image_entity
        ->uuid() . '" />';

      // Test handling of an invalid data-entity-uuid attribute.
      $body_value .= '<img src="awesome-llama-' . $key . '.jpg" data-entity-type="file" data-entity-uuid="invalid-entity-uuid-value" />';

      // Test handling of an invalid data-entity-type attribute.
      $body_value .= '<img src="awesome-llama-' . $key . '.jpg" data-entity-type="invalid-entity-type-value" data-entity-uuid="' . $image_entity
        ->uuid() . '" />';

      // Test handling of a non-existing UUID.
      $body_value .= '<img src="awesome-llama-' . $key . '.jpg" data-entity-type="file" data-entity-uuid="30aac704-ba2c-40fc-b609-9ed121aa90f4" />';
      $body[] = array(
        'value' => $body_value,
        'format' => 'filtered_html',
      );
    }

    // Test editor_entity_insert(): increment.
    $this
      ->createUser();
    $node = entity_create('node', array(
      'type' => 'page',
      'title' => 'test',
      'body' => $body,
      'uid' => 1,
    ));
    $node
      ->save();
    foreach ($image_entities as $key => $image_entity) {
      $this
        ->assertIdentical(array(
        'editor' => array(
          'node' => array(
            1 => '1',
          ),
        ),
      ), $file_usage
        ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 1 usage.');
    }

    // Test editor_entity_update(): increment, twice, by creating new revisions.
    $node
      ->setNewRevision(TRUE);
    $node
      ->save();
    $second_revision_id = $node
      ->getRevisionId();
    $node
      ->setNewRevision(TRUE);
    $node
      ->save();
    foreach ($image_entities as $key => $image_entity) {
      $this
        ->assertIdentical(array(
        'editor' => array(
          'node' => array(
            1 => '3',
          ),
        ),
      ), $file_usage
        ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 3 usages.');
    }

    // Test hook_entity_update(): decrement, by modifying the last revision:
    // remove the data-entity-type attribute from the body field.
    $original_values = array();
    for ($i = 0; $i < count($image_entities); $i++) {
      $original_value = $node->body[$i]->value;
      $new_value = str_replace('data-entity-type', 'data-entity-type-modified', $original_value);
      $node->body[$i]->value = $new_value;
      $original_values[$i] = $original_value;
    }
    $node
      ->save();
    foreach ($image_entities as $key => $image_entity) {
      $this
        ->assertIdentical(array(
        'editor' => array(
          'node' => array(
            1 => '2',
          ),
        ),
      ), $file_usage
        ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 2 usages.');
    }

    // Test editor_entity_update(): increment again by creating a new revision:
    // read the data- attributes to the body field.
    $node
      ->setNewRevision(TRUE);
    foreach ($original_values as $key => $original_value) {
      $node->body[$key]->value = $original_value;
    }
    $node
      ->save();
    foreach ($image_entities as $key => $image_entity) {
      $this
        ->assertIdentical(array(
        'editor' => array(
          'node' => array(
            1 => '3',
          ),
        ),
      ), $file_usage
        ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 3 usages.');
    }

    // Test hook_entity_update(): decrement, by modifying the last revision:
    // remove the data-entity-uuid attribute from the body field.
    foreach ($original_values as $key => $original_value) {
      $original_value = $node->body[$key]->value;
      $new_value = str_replace('data-entity-type', 'data-entity-type-modified', $original_value);
      $node->body[$key]->value = $new_value;
    }
    $node
      ->save();
    foreach ($image_entities as $key => $image_entity) {
      $this
        ->assertIdentical(array(
        'editor' => array(
          'node' => array(
            1 => '2',
          ),
        ),
      ), $file_usage
        ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 2 usages.');
    }

    // Test hook_entity_update(): increment, by modifying the last revision:
    // read the data- attributes to the body field.
    foreach ($original_values as $key => $original_value) {
      $node->body[$key]->value = $original_value;
    }
    $node
      ->save();
    foreach ($image_entities as $key => $image_entity) {
      $this
        ->assertIdentical(array(
        'editor' => array(
          'node' => array(
            1 => '3',
          ),
        ),
      ), $file_usage
        ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 3 usages.');
    }

    // Test editor_entity_revision_delete(): decrement, by deleting a revision.
    entity_revision_delete('node', $second_revision_id);
    foreach ($image_entities as $key => $image_entity) {
      $this
        ->assertIdentical(array(
        'editor' => array(
          'node' => array(
            1 => '2',
          ),
        ),
      ), $file_usage
        ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 2 usages.');
    }

    // Test editor_entity_delete().
    $node
      ->delete();
    foreach ($image_entities as $key => $image_entity) {
      $this
        ->assertIdentical(array(), $file_usage
        ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has zero usages again.');
    }
  }

}

Classes

Name	Description
EditorFileUsageTest	Tests tracking of file usage by the Text Editor module.