You are here

Home » API reference » SpamSpan filter 8 » FilterSpamspanUnitTest.php

class FilterSpamspanUnitTest in SpamSpan filter 8

Same name and namespace in other branches
  1. 8.2 tests/src/Kernel/FilterSpamspanUnitTest.php \Drupal\Tests\spamspan\Kernel\FilterSpamspanUnitTest

Tests spamspan filter.

@group spamspan

Hierarchy

Expanded class hierarchy of FilterSpamspanUnitTest

File

tests/src/Kernel/FilterSpamspanUnitTest.php, line 13

Namespace

Drupal\Tests\spamspan\Kernel
View source 
class FilterSpamspanUnitTest extends KernelTestBase {

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

  /**
   * Default spamspan filter.
   *
   * @var \Drupal\spamspan\Plugin\Filter\FilterSpamspan
   */
  protected $spamspanFilter;

  /**
   * Default spamspan filter with spamspan_use_form = 1.
   *
   * @var \Drupal\spamspan\Plugin\Filter\FilterSpamspan
   */
  protected $spamspanFilterForm;

  /**
   * Default spamspan filter with custom at and dot.
   *
   * @var \Drupal\spamspan\Plugin\Filter\FilterSpamspan
   */
  protected $spamspanFilterAtDot;

  /**
   * Test inline image.
   *
   * @var string
   */
  protected $base64Image;

  /**
   * Use DOM flag.
   *
   * @var int
   */
  protected $withDom = 0;

  /**
   * {@inheritDoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->installConfig([
      'system',
    ]);
    $manager = $this->container
      ->get('plugin.manager.filter');
    $bag = new FilterPluginCollection($manager, []);
    $filters = $bag
      ->getAll();
    $this->spamspanFilter = $filters['filter_spamspan'];
    $configuration = $this->spamspanFilter
      ->getConfiguration();
    $configuration['settings'] = [
      'spamspan_parse_dom' => $this->withDom,
    ] + $configuration['settings'];
    $this->spamspanFilter
      ->setConfiguration($configuration);

    // Spamspan filter that is set to use contact form.
    $configuration['settings'] = [
      'spamspan_use_form' => 1,
    ] + $configuration['settings'];
    $this->spamspanFilterForm = $manager
      ->createInstance('filter_spamspan', $configuration);

    // Spamspan filter that is set to use graphic at and dot enabled.
    $configuration['settings'] = [
      'spamspan_use_form' => 0,
      'spamspan_use_graphic' => 1,
      'spamspan_dot_enable' => 1,
    ] + $configuration['settings'];
    $this->spamspanFilterAtDot = $manager
      ->createInstance('filter_spamspan', $configuration);

    // Read the test image from the file provided.
    $this->base64Image = file_get_contents(drupal_get_path('module', 'spamspan') . '/tests/src/Kernel/base64image.txt');
  }

  /**
   * Wrapper function.
   *
   * Conveniently wraps some text around main test subject and then asserts.
   */
  protected function wrappedAssert($filter, $input, $shouldbe, $prefix = '', $suffix = '', $message = '') {
    $output = $filter
      ->process($prefix . $input . $suffix, 'und')
      ->getProcessedText();
    if (empty($message)) {
      $this
        ->assertSame($output, $prefix . $shouldbe . $suffix);
    }
    else {
      $this
        ->assertSame($output, $prefix . $shouldbe . $suffix, $message);
    }
  }

  /**
   * Helper function to assert variations.
   */
  protected function variatedAssert($filter, $input, $shouldbe) {

    // Test for bare email;.
    $this
      ->wrappedAssert($filter, $input, $shouldbe);

    // Test for email with text at the start.
    $this
      ->wrappedAssert($filter, $input, $shouldbe, 'some text at the start ');

    // Test for email with text at the end.
    $this
      ->wrappedAssert($filter, $input, $shouldbe, '', ' some text at the end');

    // Test for email with text at the start and end.
    $this
      ->wrappedAssert($filter, $input, $shouldbe, 'some text at the start ', ' some text at the end');

    // Test for email with tags at the start and end.
    $this
      ->wrappedAssert($filter, $input, $shouldbe, '<p>', '</p>');

    // Test for email with trailing commas.
    $this
      ->wrappedAssert($filter, $input, $shouldbe, 'some text at the start ', ', next clause.');

    // Test for email with trailing full stop.
    $this
      ->wrappedAssert($filter, $input, $shouldbe, 'some text at the start ', '. next sentence.');

    // Test for email with preceding tag, and no closing tag.
    $this
      ->wrappedAssert($filter, $input, $this->withDom ? $shouldbe . '</dt>' : $shouldbe, '<dt>');

    // Test for brackets.
    $this
      ->wrappedAssert($filter, $input, $shouldbe, '(', ')');

    // Test for newlines.
    $this
      ->wrappedAssert($filter, $input, $shouldbe, PHP_EOL, PHP_EOL);

    // Test for spaces.
    $this
      ->wrappedAssert($filter, $input, $shouldbe, ' ', ' ');

    // Test base64image.
    $this
      ->wrappedAssert($filter, $input, $shouldbe, $this->base64Image, $this->base64Image);
    if (!$this->withDom) {

      // Test for angular brackets.
      $this
        ->wrappedAssert($filter, $input, $shouldbe, '<', '>');
    }
  }

  /**
   * Tests the align filter.
   */
  public function testSpamSpanFilter() {

    // Test that strings without emails a passed unchanged.
    $noemails = [
      'no email here',
      'oneword',
      '',
      'notan@email',
      'notan@email either',
      'some text and notan.email@something here',
    ];
    if ($this->withDom) {
      $noemails[] = '<a href="http://test.test/@user.me">contact</a>';
      $noemails[] = '<drupal-entity data-settings="mailto: user@example.com"></drupal-entity>';
    }
    foreach ($noemails as $input) {
      $this
        ->variatedAssert($this->spamspanFilter, $input, $input);
    }

    // A list of addresses, together with what they should look like.
    $emails = [
      'user@example.com' => '<span class="spamspan"><span class="u">user</span> [at] <span class="d">example.com</span></span>',
      'user@example.co.uk' => '<span class="spamspan"><span class="u">user</span> [at] <span class="d">example.co.uk</span></span>',
      'user@example.somenewlongtld' => '<span class="spamspan"><span class="u">user</span> [at] <span class="d">example.somenewlongtld</span></span>',
      'user.user@example.com' => '<span class="spamspan"><span class="u">user.user</span> [at] <span class="d">example.com</span></span>',
      'user\'user@example.com' => '<span class="spamspan"><span class="u">user\'user</span> [at] <span class="d">example.com</span></span>',
      'user-user@example.com' => '<span class="spamspan"><span class="u">user-user</span> [at] <span class="d">example.com</span></span>',
      'user_user@example.com' => '<span class="spamspan"><span class="u">user_user</span> [at] <span class="d">example.com</span></span>',
      'user+user@example.com' => '<span class="spamspan"><span class="u">user+user</span> [at] <span class="d">example.com</span></span>',
      '!#$%&\'*+-/=?^_`{|}~.@example.com' => $this->withDom ? '<span class="spamspan"><span class="u">!#$%&amp;\'*+-/=?^_`{|}~.</span> [at] <span class="d">example.com</span></span>' : '<span class="spamspan"><span class="u">!#$%&\'*+-/=?^_`{|}~.</span> [at] <span class="d">example.com</span></span>',
      '<a href="mailto:email@example.com"></a>' => '<span class="spamspan"><span class="u">email</span> [at] <span class="d">example.com</span></span>',
      '<a href=" mailto:email@example.com ">email@example.com</a>' => '<span class="spamspan"><span class="u">email</span> [at] <span class="d">example.com</span></span>',
      '<a href="mailto:email@example.com"><img src="/core/misc/favicon.ico"></a>' => '<span class="spamspan"><span class="u">email</span> [at] <span class="d">example.com</span><span class="t"> (<img src="/core/misc/favicon.ico">)</span></span>',
      '<a href="mailto:email@example.com?subject=Hi there!&body=Dear Sir">some text</a>' => '<span class="spamspan"><span class="u">email</span> [at] <span class="d">example.com</span><span class="h"> (subject: Hi%20there%21, body: Dear%20Sir) </span><span class="t"> (some text)</span></span>',
      '<a href="mailto:email@example.com">The email@example.com should not show and neither email2@example.me</a>' => '<span class="spamspan"><span class="u">email</span> [at] <span class="d">example.com</span><span class="t"> (The  should not show and neither )</span></span>',
      '<a class="someclass" data-before="before" href="mailto:email@example.com" id="someid" data-after="after"></a>' => '<span class="spamspan"><span class="u">email</span> [at] <span class="d">example.com</span><span class="e">class="someclass" data-before="before" id="someid" data-after="after"</span></span>',
      '<a href="mailto:email@example.com?subject=Message%20Subject%2C%20nasty%20%22%20%3Cchars%3F%3E&body=%22This%20is%20a%20message%20body%21%20%3C%20%3E%20%22%3F%0A%0A%21%22%C2%A3%24%25%5E%26%2A%28%29%3A%40~%3B%23%3C%3E%3F%2C.%2F%20%5B%5D%20%7B%7D%20-%3D%20_%2B">some text</a>' => '<span class="spamspan"><span class="u">email</span> [at] <span class="d">example.com</span><span class="h"> (subject: Message%20Subject%2C%20nasty%20%22%20%3Cchars%3F%3E, body: %22This%20is%20a%20message%20body%21%20%3C%20%3E%20%22%3F%0A%0A%21%22%C2%A3%24%25%5E%26%2A%28%29%3A%40~%3B%23%3C%3E%3F%2C.%2F%20%5B%5D%20%7B%7D%20-%3D%20_%2B) </span><span class="t"> (some text)</span></span>',
      '<a href="mailto:email@example.com?subject=Hi there!&body=Dear\'Sir">some text</a>' => '<span class="spamspan"><span class="u">email</span> [at] <span class="d">example.com</span><span class="h"> (subject: Hi%20there%21, body: Dear%27Sir) </span><span class="t"> (some text)</span></span>',
    ];
    foreach ($emails as $input => $shouldbe) {
      $this
        ->variatedAssert($this->spamspanFilter, $input, $shouldbe);
    }
    $basepath = base_path();

    // Use form tests.
    $emails = [
      'user@example.com' => '<a href="' . $basepath . 'contact?goto=dXNlckBleGFtcGxlLmNvbQ%3D%3D">contact form</a>',
      '<a href="mailto:user@example.com">tag contents will be replaced</a>' => '<a href="' . $basepath . 'contact?goto=dXNlckBleGFtcGxlLmNvbQ%3D%3D">contact form</a>',
      'user@example.co.uk[mycontactform]' => '<a href="' . $basepath . 'mycontactform?goto=dXNlckBleGFtcGxlLmNvLnVr">contact form</a>',
      'user@example.com[http://google.com]' => '<a href="http://google.com?goto=dXNlckBleGFtcGxlLmNvbQ%3D%3D">contact form</a>',
      'user@example.museum[mycontactform|Contact me using this form]' => '<a href="' . $basepath . 'mycontactform?goto=dXNlckBleGFtcGxlLm11c2V1bQ%3D%3D">Contact me using this form</a>',
    ];
    foreach ($emails as $input => $shouldbe) {
      $this
        ->variatedAssert($this->spamspanFilterForm, $input, $shouldbe);
    }

    // Graphical at and [dot].
    $emails = [
      'user@example.com' => $this->withDom ? '<span class="spamspan"><span class="u">user</span><img class="spamspan-image" alt="at" src="' . base_path() . drupal_get_path('module', 'spamspan') . '/image.gif"><span class="d">example<span class="o"> [dot] </span>com</span></span>' : '<span class="spamspan"><span class="u">user</span><img class="spamspan-image" alt="at" src="' . base_path() . drupal_get_path('module', 'spamspan') . '/image.gif" /><span class="d">example<span class="o"> [dot] </span>com</span></span>',
    ];
    foreach ($emails as $input => $shouldbe) {
      $this
        ->variatedAssert($this->spamspanFilterAtDot, $input, $shouldbe);
    }

    // Test the spamspan.js being attached.
    $attached_library = [
      'library' => [
        'spamspan/obfuscate',
      ],
    ];
    $output = $this->spamspanFilter
      ->process('email@example.com', 'und');
    $this
      ->assertSame($attached_library, $output
      ->getAttachments());
  }

}

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.
FilterSpamspanUnitTest::$base64Image protected property Test inline image.
FilterSpamspanUnitTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
FilterSpamspanUnitTest::$spamspanFilter protected property Default spamspan filter.
FilterSpamspanUnitTest::$spamspanFilterAtDot protected property Default spamspan filter with custom at and dot.
FilterSpamspanUnitTest::$spamspanFilterForm protected property Default spamspan filter with spamspan_use_form = 1.
FilterSpamspanUnitTest::$withDom protected property Use DOM flag.
FilterSpamspanUnitTest::setUp protected function Overrides KernelTestBase::setUp
FilterSpamspanUnitTest::testSpamSpanFilter public function Tests the align filter.
FilterSpamspanUnitTest::variatedAssert protected function Helper function to assert variations.
FilterSpamspanUnitTest::wrappedAssert protected function Wrapper function.
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::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
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.