You are here

Home » API reference » Field Formatter Filter 8 » FieldApiTest.php

class FieldApiTest in Field Formatter Filter 8

Same name and namespace in other branches
  1. 2.0.x tests/src/Kernel/FieldApiTest.php \Drupal\Tests\field_formatter_filter\Kernel\FieldApiTest

Tests applying the filter formatter to a node.

As this is done through the non-bootstrapped mocked up back end, I have to manually add a lot more specific dependencies than I'd like.

@group field_formatter_filter

Hierarchy

Expanded class hierarchy of FieldApiTest

File

tests/src/Kernel/FieldApiTest.php, line 19

Namespace

Drupal\Tests\field_formatter_filter\Kernel
View source 
class FieldApiTest extends EntityKernelTestBase {
  use \Drupal\simpletest\ContentTypeCreationTrait {
    createContentType as drupalCreateContentType;
  }

  /**
   * Modules to install.
   *
   * @var string[]
   */
  public static $modules = [
    'node',
    'system',
    'user',
    'text',
    'field_ui',
    'field',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();

    // Need some normal expectations to be present.
    // We require 'node' in order to run NodeType::create()
    $this
      ->installEntitySchema('node');

    // Presumably 'user' is assumed a lot.
    $this
      ->installEntitySchema('user');

    // 'system' provide a date_format that we need when rendering later.
    $this
      ->installConfig([
      'system',
      'field',
      'node',
      'user',
    ]);

    // Need to mock more bootstrap stuff.
    $this
      ->createTextFormats();
  }

  /**
   * Tests creating and configuring a bundle.
   */
  public function testCreateContentType() {
    $this
      ->createContentType([
      'type' => 'fff_article',
    ]);
  }

  /**
   * Test enabling the filter formatter. Check before, during and after.
   */
  public function testTeaserFilter() {
    $entity_type = 'node';
    $bundle = 'fff_article';
    $view_mode = 'teaser';
    $this
      ->createContentType([
      'type' => $bundle,
    ]);
    $node = $this
      ->createTestNode($bundle);

    // Verify that rendering the teaser normally shows unwanted text.
    $build = $this->container
      ->get('entity.manager')
      ->getViewBuilder($entity_type)
      ->view($node, $view_mode);
    $output = \Drupal::service('renderer')
      ->renderRoot($build);
    $this
      ->assertTrue((bool) preg_match("/the real content of the body text/", $output), 'Teaser view of node contains expected markup');
    $this
      ->assertTrue((bool) preg_match("/<img/", $output), 'Teaser view of node contains messy markup');

    // Now enable the module.
    $this->container
      ->get('module_installer')
      ->install([
      'field_formatter_filter',
    ], TRUE);

    // Re-check that all is well, issue #2868519 implies it may damage normal
    // display.
    $build = $this->container
      ->get('entity.manager')
      ->getViewBuilder($entity_type)
      ->view($node, $view_mode);
    $output = \Drupal::service('renderer')
      ->renderRoot($build);
    $this
      ->assertTrue((bool) preg_match("/the real content of the body text/", $output), 'Teaser view of node contains expected markup');

    // Now edit the teaser view mode settings to use our safe markup filter.

    /** @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display */
    $display = \Drupal::entityTypeManager()
      ->getStorage('entity_view_display')
      ->load("{$entity_type}.{$bundle}.{$view_mode}");
    $component = $display
      ->getComponent('body');

    // Adjust the body field formatter component and save the display.

    /*
    $component = [
      'type' => 'text_summary_or_trimmed',
      'label' => 'hidden',
      'weight' => 10,
      'settings' => [
        'trim_length' => 600,
      ],
      'third_party_settings' => [
        'field_formatter_filter' => [
          'format' => 'teaser_safe_text',
        ],
      ],
    ];
    */
    $component['third_party_settings']['field_formatter_filter']['format'] = 'teaser_safe_text';
    $display
      ->setComponent('body', $component)
      ->save();

    // Now re-render the teaser, and assert that the text has been sanitised.
    // display.
    $build = $this->container
      ->get('entity.manager')
      ->getViewBuilder($entity_type)
      ->view($node, $view_mode);
    $output = \Drupal::service('renderer')
      ->renderRoot($build);
    $this
      ->assertTrue((bool) preg_match("/the real content of the body text/", $output), 'Teaser view of node contains expected markup');
    $this
      ->assertFalse((bool) preg_match("/<img/", $output), 'Teaser view of node does not contain messy markup');

    // Normal mode of operations successfully tested.
    // Now try to break it...
    // Assign an invalid value to the formatter.
    // As if the text format was deleted?
    // May trigger "Error: Call to a member function filters() on null".
    $component['third_party_settings']['field_formatter_filter']['format'] = 'invalid_text_format';
    $display
      ->setComponent('body', $component)
      ->save();
    $build = $this->container
      ->get('entity.manager')
      ->getViewBuilder($entity_type)
      ->view($node, $view_mode);
    $output = \Drupal::service('renderer')
      ->renderRoot($build);
    $this
      ->assertTrue((bool) preg_match("/the real content of the body text/", $output), 'Teaser view of node contains expected markup');
    $this
      ->assertFalse((bool) preg_match("/<img/", $output), 'Teaser view of node does not contain messy markup');
  }

  /**
   * Create our test content type.
   *
   * Extend ContentTypeCreationTrait.
   * I'm not sure, but it seems this is not expected to be a thing we use
   * in Kernel tests - is it  based around assuming a simpletest environment?
   *
   * @inheritdoc
   */
  public function createContentType(array $values = []) {

    // From ContentTypeCreationTrait.
    $content_type = $this
      ->drupalCreateContentType($values);

    // To avoid too many dependencies,
    // -- just toggle off the 'display user' for view modes.
    $content_type
      ->set('display_submitted', FALSE);
    $content_type
      ->save();
  }

  /**
   * Create our test content type.
   *
   * This operates completely through the API operations available for
   * configuring views modes and widget settings.
   *
   * @param string $bundle
   *
   * @see \Drupal\Tests\field_ui\Kernel\EntityDisplayTest
   */
  public function xcreateContentType(array $values = []) {
    $bundle = $values['type'];

    // Create a node bundle.
    $entity_type = 'node';
    $type = NodeType::create([
      'type' => $bundle,
    ]);

    // To avoid too many dependencies,
    // -- just toggle off the 'display user' for view modes.
    $type
      ->set('display_submitted', FALSE);
    $type
      ->save();
    node_add_body_field($type);

    // Presave its view modes - the default display and form display.
    // I think this helps ensure defaults are in place.
    //
    // Deprecated: entity_get_display($entity_type, $bundle, 'default')->save();
    \Drupal::entityTypeManager()
      ->getStorage('entity_view_display')
      ->load("{$entity_type}.{$bundle}.default")
      ->save();

    // Deprecated: entity_get_form_display($entity_type, $bundle, 'default')->save();
    \Drupal::entityTypeManager()
      ->getStorage('entity_form_display')
      ->load("{$entity_type}.{$bundle}.default")
      ->save();

    // Pre-save its teaser view mode. Same as above, but uses a static call?
    EntityViewDisplay::load("{$entity_type}.{$bundle}.teaser")
      ->save();
  }

  /**
   * Create a node with sample content.
   *
   * @param $bundle
   * @return \Drupal\Core\Entity\EntityInterface
   */
  private function createTestNode($bundle) {

    // Sample markup is in an external file - just to keep HTML out of code.
    $path = __DIR__ . '/../..';
    $body = file_get_contents($path . '/sample-markup.txt');
    $node = Node::create([
      'type' => $bundle,
      'title' => 'Test this is filtered',
      'uid' => 1,
      'body' => [
        'value' => $body,
        'format' => 'full_html',
      ],
    ]);
    $validated = $node
      ->validate();
    $saved = $node
      ->save();

    // It's now populated with expected values like date and nid, so should be
    // ready to render.
    return $node;
  }

  /**
   * We need to set up two text formats.
   */
  private function createTextFormats() {

    // Add a text format with minimum data only.
    $format = FilterFormat::create([
      'format' => 'full_html',
      'name' => 'Full HTML',
    ]);
    $format
      ->save();

    // Add another text format specifying all possible properties.
    $format = FilterFormat::create([
      'format' => 'teaser_safe_text',
      'name' => 'Teaser safe text',
    ]);
    $format
      ->setFilterConfig('filter_html', [
      'status' => 1,
      'settings' => [
        'allowed_html' => '<p> <br> <a href hreflang> <em> <strong>',
      ],
    ]);
    $format
      ->save();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
EntityKernelTestBase::$deprecatedProperties protected property The list of deprecated services.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
FieldApiTest::$modules public static property Modules to install. Overrides EntityKernelTestBase::$modules
FieldApiTest::createContentType public function Create our test content type.
FieldApiTest::createTestNode private function Create a node with sample content.
FieldApiTest::createTextFormats private function We need to set up two text formats.
FieldApiTest::setUp protected function Overrides EntityKernelTestBase::setUp
FieldApiTest::testCreateContentType public function Tests creating and configuring a bundle.
FieldApiTest::testTeaserFilter public function Test enabling the filter formatter. Check before, during and after.
FieldApiTest::xcreateContentType public function Create our test content type.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser