FilterCrudTest.php in Drupal 8

Namespace

Drupal\Tests\filter\Kernel

File

core/modules/filter/tests/src/Kernel/FilterCrudTest.php

<?php

namespace Drupal\Tests\filter\Kernel;

use Drupal\Component\Render\FormattableMarkup;
use Drupal\filter\Entity\FilterFormat;
use Drupal\KernelTests\KernelTestBase;

/**
 * Tests creation, loading, updating, deleting of text formats and filters.
 *
 * @group filter
 */
class FilterCrudTest extends KernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'filter',
    'filter_test',
    'system',
    'user',
  ];

  /**
   * Tests CRUD operations for text formats and filters.
   */
  public function testTextFormatCrud() {

    // Add a text format with minimum data only.
    $format = FilterFormat::create([
      'format' => 'empty_format',
      'name' => 'Empty format',
    ]);
    $format
      ->save();
    $this
      ->verifyTextFormat($format);

    // Add another text format specifying all possible properties.
    $format = FilterFormat::create([
      'format' => 'custom_format',
      'name' => 'Custom format',
    ]);
    $format
      ->setFilterConfig('filter_url', [
      'status' => 1,
      'settings' => [
        'filter_url_length' => 30,
      ],
    ]);
    $format
      ->save();
    $this
      ->verifyTextFormat($format);

    // Alter some text format properties and save again.
    $format
      ->set('name', 'Altered format');
    $format
      ->setFilterConfig('filter_url', [
      'status' => 0,
    ]);
    $format
      ->setFilterConfig('filter_autop', [
      'status' => 1,
    ]);
    $format
      ->save();
    $this
      ->verifyTextFormat($format);

    // Add a filter_test_replace  filter and save again.
    $format
      ->setFilterConfig('filter_test_replace', [
      'status' => 1,
    ]);
    $format
      ->save();
    $this
      ->verifyTextFormat($format);

    // Disable the text format.
    $format
      ->disable()
      ->save();
    $formats = filter_formats();
    $this
      ->assertTrue(!isset($formats[$format
      ->id()]), 'filter_formats: Disabled text format no longer exists.');
  }

  /**
   * Tests disabling the fallback text format.
   */
  public function testDisableFallbackFormat() {
    $this
      ->installConfig([
      'filter',
    ]);
    $message = '\\LogicException with message "The fallback text format \'plain_text\' cannot be disabled." was thrown.';
    try {
      FilterFormat::load('plain_text')
        ->disable();
      $this
        ->fail($message);
    } catch (\LogicException $e) {
      $this
        ->assertIdentical($e
        ->getMessage(), "The fallback text format 'plain_text' cannot be disabled.", $message);
    }
  }

  /**
   * Verifies that a text format is properly stored.
   */
  public function verifyTextFormat($format) {
    $t_args = [
      '%format' => $format
        ->label(),
    ];
    $default_langcode = \Drupal::languageManager()
      ->getDefaultLanguage()
      ->getId();

    // Verify the loaded filter has all properties.
    $filter_format = FilterFormat::load($format
      ->id());
    $this
      ->assertEqual($filter_format
      ->id(), $format
      ->id(), new FormattableMarkup('filter_format_load: Proper format id for text format %format.', $t_args));
    $this
      ->assertEqual($filter_format
      ->label(), $format
      ->label(), new FormattableMarkup('filter_format_load: Proper title for text format %format.', $t_args));
    $this
      ->assertEqual($filter_format
      ->get('weight'), $format
      ->get('weight'), new FormattableMarkup('filter_format_load: Proper weight for text format %format.', $t_args));

    // Check that the filter was created in site default language.
    $this
      ->assertEqual($format
      ->language()
      ->getId(), $default_langcode, new FormattableMarkup('filter_format_load: Proper language code for text format %format.', $t_args));
  }

}

Classes

Name	Description
FilterCrudTest	Tests creation, loading, updating, deleting of text formats and filters.