FilterCrudTest.php

<?php

/**
 * @file
 * Definition of Drupal\filter\Tests\FilterCrudTest.
 */
namespace Drupal\filter\Tests;

use Drupal\simpletest\DrupalUnitTestBase;

/**
 * Tests for text format and filter CRUD operations.
 */
class FilterCrudTest extends DrupalUnitTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'filter',
    'filter_test',
  );
  public static function getInfo() {
    return array(
      'name' => 'Filter CRUD operations',
      'description' => 'Test creation, loading, updating, deleting of text formats and filters.',
      'group' => 'Filter',
    );
  }

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

    // Add a text format with minimum data only.
    $format = entity_create('filter_format', array());
    $format->format = 'empty_format';
    $format->name = 'Empty format';
    $format
      ->save();
    $this
      ->verifyTextFormat($format);
    $this
      ->verifyFilters($format);

    // Add another text format specifying all possible properties.
    $format = entity_create('filter_format', array());
    $format->format = 'custom_format';
    $format->name = 'Custom format';
    $format
      ->setFilterConfig('filter_url', array(
      'status' => 1,
      'settings' => array(
        'filter_url_length' => 30,
      ),
    ));
    $format
      ->save();
    $this
      ->verifyTextFormat($format);
    $this
      ->verifyFilters($format);

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

    // Add a uncacheable filter and save again.
    $format
      ->setFilterConfig('filter_test_uncacheable', array(
      'status' => 1,
    ));
    $format
      ->save();
    $this
      ->verifyTextFormat($format);
    $this
      ->verifyFilters($format);

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

  /**
   * Verifies that a text format is properly stored.
   */
  function verifyTextFormat($format) {
    $t_args = array(
      '%format' => $format->name,
    );
    $default_langcode = language_default()->langcode;

    // Verify filter_format_load().
    $filter_format = filter_format_load($format->format);
    $this
      ->assertEqual($filter_format->format, $format->format, format_string('filter_format_load: Proper format id for text format %format.', $t_args));
    $this
      ->assertEqual($filter_format->name, $format->name, format_string('filter_format_load: Proper title for text format %format.', $t_args));
    $this
      ->assertEqual($filter_format->cache, $format->cache, format_string('filter_format_load: Proper cache indicator for text format %format.', $t_args));
    $this
      ->assertEqual($filter_format->weight, $format->weight, format_string('filter_format_load: Proper weight for text format %format.', $t_args));

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

    // Verify the 'cache' text format property according to enabled filters.
    $filters = filter_list_format($filter_format->format);
    $cacheable = TRUE;
    foreach ($filters as $name => $filter) {

      // If this filter is not cacheable, update $cacheable accordingly, so we
      // can verify $format->cache after iterating over all filters.
      if ($filter->status && !$filter->cache) {
        $cacheable = FALSE;
        break;
      }
    }
    $this
      ->assertEqual($filter_format->cache, $cacheable, 'Text format contains proper cache property.');
  }

  /**
   * Verifies that filters are properly stored for a text format.
   */
  function verifyFilters($format) {
    $filters = filter_list_format($format->format);
    $format_filters = $format
      ->filters();
    foreach ($filters as $name => $filter) {
      $t_args = array(
        '%format' => $format->name,
        '%filter' => $name,
      );

      // Verify that filter status is properly stored.
      $this
        ->assertEqual($filter->status, $format_filters
        ->get($name)->status, format_string('filter_list_format: Proper status for %filter in text format %format.', $t_args));

      // Verify that filter settings were properly stored.
      $this
        ->assertEqual($filter->settings, $format_filters
        ->get($name)->settings, format_string('filter_list_format: Proper filter settings for %filter in text format %format.', $t_args));

      // Verify that each filter has a module name assigned.
      $this
        ->assertTrue(!empty($filter->module), format_string('filter_list_format: Proper module name for %filter in text format %format.', $t_args));
    }
    $this
      ->assertEqual(count($filters), count($format_filters), 'filter_list_format: All filters for the format are present.');
  }

}