abstract class PluginTestBase in Purge 8.3

Same name in this branch

8.3 tests/src/Kernel/Queue/PluginTestBase.php \Drupal\Tests\purge\Kernel\Queue\PluginTestBase
8.3 tests/src/Kernel/Invalidation/PluginTestBase.php \Drupal\Tests\purge\Kernel\Invalidation\PluginTestBase

Provides an abstract test class to thoroughly test invalidation types.

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\purge\Kernel\KernelTestBase uses TestTrait
  - class \Drupal\Tests\purge\Kernel\Invalidation\PluginTestBase

Expanded class hierarchy of PluginTestBase

File

tests/src/Kernel/Invalidation/PluginTestBase.php, line 22

Namespace

Drupal\Tests\purge\Kernel\Invalidation

View source

abstract class PluginTestBase extends KernelTestBase {

  /**
   * The plugin ID of the invalidation type being tested.
   *
   * @var string
   */
  protected $pluginId;

  /**
   * String expressions valid to the invalidation type being tested.
   *
   * @var null|mixed[]
   */
  protected $expressions = NULL;

  /**
   * String expressions invalid to the invalidation type being tested.
   *
   * @var null|mixed[]
   */
  protected $expressionsInvalid;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'purge_purger_test',
  ];

  /**
   * Set up the test.
   */
  public function setUp($switch_to_memory_queue = TRUE) : void {
    parent::setUp($switch_to_memory_queue);
    $this
      ->initializePurgersService([
      'good',
    ]);
    $this
      ->initializeInvalidationFactoryService();
  }

  /**
   * Retrieve a invalidation object provided by the plugin.
   */
  public function getInstance() : InvalidationInterface {
    return $this
      ->getInvalidations(1, $this->pluginId, $this->expressions[0]);
  }

  /**
   * Retrieve a immutable invalidation object, which wraps the plugin.
   */
  public function getImmutableInstance() : ImmutableInvalidationInterface {
    return $this->purgeInvalidationFactory
      ->getImmutable($this->pluginId, $this->expressions[0]);
  }

  /**
   * Tests the code contract strictly enforced on invalidation type plugins.
   */
  public function testCodeContract() : void {
    $this
      ->assertTrue($this
      ->getInstance() instanceof ImmutableInvalidationInterface);
    $this
      ->assertTrue($this
      ->getInstance() instanceof InvalidationInterface);
    $this
      ->assertTrue($this
      ->getInstance() instanceof ImmutableInvalidationBase);
    $this
      ->assertTrue($this
      ->getInstance() instanceof InvalidationBase);
    $this
      ->assertTrue($this
      ->getImmutableInstance() instanceof ImmutableInvalidationInterface);
    $this
      ->assertFalse($this
      ->getImmutableInstance() instanceof InvalidationInterface);
    $this
      ->assertTrue($this
      ->getImmutableInstance() instanceof ImmutableInvalidationBase);
    $this
      ->assertFalse($this
      ->getImmutableInstance() instanceof InvalidationBase);
  }

  /**
   * Tests TypeUnsupportedException.
   */
  public function testTypeUnsupportedException() : void {
    $this
      ->initializePurgersService([], TRUE);
    $this
      ->expectException(TypeUnsupportedException::class);
    $this
      ->getInvalidations(1, $this->pluginId, $this->expressions[0], FALSE);
    $this
      ->getInstance(FALSE);
  }

  /**
   * Tests \Drupal\purge\Plugin\Purge\Invalidation\ImmutableInvalidation.
   */
  public function testImmutable() : void {
    $immutable = $this
      ->getImmutableInstance();
    $mutable = $this
      ->getInstance();
    $this
      ->assertEquals($immutable
      ->__toString(), $mutable
      ->__toString());
    $this
      ->assertEquals($immutable
      ->getExpression(), $mutable
      ->getExpression());
    $this
      ->assertEquals($immutable
      ->getState(), $mutable
      ->getState());
    $this
      ->assertEquals($immutable
      ->getStateString(), $mutable
      ->getStateString());
    $this
      ->assertEquals($immutable
      ->getType(), $mutable
      ->getType());
  }

  /**
   * Test that instances initialize with no properties.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\ImmutableInvalidationInterface::getProperties
   */
  public function testPropertiesInitializeEmpty() : void {
    $i = $this
      ->getInstance();
    $this
      ->assertSame([], $i
      ->getProperties());
  }

  /**
   * Test deleting a property.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::deleteProperty
   */
  public function testDeleteProperty() : void {
    $i = $this
      ->getInstance();
    $i
      ->setStateContext('purger_a');
    $i
      ->setProperty('myprop', 1234);
    $i
      ->deleteProperty('myprop');
    $this
      ->assertSame(NULL, $i
      ->getProperty('myprop'));
  }

  /**
   * Test retrieving a property.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\ImmutableInvalidationInterface::getProperty
   */
  public function testGetProperty() : void {
    $i = $this
      ->getInstance();
    $i
      ->setStateContext('purger_b');
    $i
      ->setProperty('my_book', 'Nineteen Eighty-Four');
    $this
      ->assertSame('Nineteen Eighty-Four', $i
      ->getProperty('my_book'));
    $this
      ->assertSame(NULL, $i
      ->getProperty('my_film'));

    // Test again within a different context.
    $i
      ->setState(InvalidationInterface::FAILED);
    $i
      ->setStateContext('purger_b2');
    $this
      ->assertSame(NULL, $i
      ->getProperty('my_book'));
  }

  /**
   * Test setting a property.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::setProperty
   */
  public function testSetProperty() : void {
    $i = $this
      ->getInstance();
    $i
      ->setStateContext('purger_d');
    $this
      ->assertSame(NULL, $i
      ->setProperty('my_film', 'Pulp Fiction'));
    $this
      ->assertSame('Pulp Fiction', $i
      ->getProperty('my_film'));
  }

  /**
   * Test that properties are stored by context.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\ImmutableInvalidationInterface::getProperties
   * @see \Drupal\purge\Plugin\Purge\Invalidation\ImmutableInvalidationInterface::getProperty
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::deleteProperty
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::setProperty
   */
  public function testPropertyStorageModel() : void {
    $i = $this
      ->getInstance();

    // Verify retrieving and setting properties.
    $i
      ->setStateContext('purger1');
    $this
      ->assertSame(NULL, $i
      ->getProperty('doesntexist'));
    $this
      ->assertSame(NULL, $i
      ->setProperty('key1', 'foobar'));
    $this
      ->assertSame('foobar', $i
      ->getProperty('key1'));
    $this
      ->assertSame(NULL, $i
      ->deleteProperty('key1'));
    $this
      ->assertSame(NULL, $i
      ->getProperty('key1'));
    $this
      ->assertSame(NULL, $i
      ->setProperty('key1', 'foobar2'));
    $this
      ->assertSame('foobar2', $i
      ->getProperty('key1'));

    // Switch state to add some more properties.
    $i
      ->setState(InvalidationInterface::FAILED);
    $i
      ->setStateContext('purger2');
    $i
      ->setProperty('key2', 'baz');
    $i
      ->setState(InvalidationInterface::FAILED);
    $i
      ->setStateContext(NULL);

    // Verify that every property is stored by context.
    $p = $i
      ->getProperties();
    $this
      ->assertSame(2, count($p));
    $this
      ->assertSame(TRUE, isset($p['purger1']['key1']));
    $this
      ->assertSame('foobar2', $p['purger1']['key1']);
    $this
      ->assertSame(TRUE, isset($p['purger2']['key2']));
    $this
      ->assertSame('baz', $p['purger2']['key2']);
  }

  /**
   * Test that you can't delete a property without specifying the state context.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::deleteProperty
   */
  public function testStateContextExceptionDeleteProperty() : void {
    $i = $this
      ->getInstance();
    $this
      ->expectException(\LogicException::class);
    $this
      ->expectExceptionMessage('Call ::setStateContext() before deleting properties!');
    $i
      ->deleteProperty('my_setting');
  }

  /**
   * Test that you can't fetch a property without specifying the state context.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\ImmutableInvalidationInterface::getProperty
   */
  public function testStateContextExceptionGetProperty() : void {
    $i = $this
      ->getInstance();
    $this
      ->expectException(\LogicException::class);
    $this
      ->expectExceptionMessage('Call ::setStateContext() before retrieving properties!');
    $i
      ->getProperty('my_setting');
  }

  /**
   * Test that you can't set a property without specifying the state context.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::setProperty
   */
  public function testStateContextExceptionSetProperty() : void {
    $i = $this
      ->getInstance();
    $this
      ->expectException(\LogicException::class);
    $this
      ->expectExceptionMessage('Call ::setStateContext() before setting properties!');
    $i
      ->setProperty('my_setting', FALSE);
  }

  /**
   * Test the initial state of the invalidation object.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::getState
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::getStateString
   */
  public function testStateInitial() : void {
    $i = $this
      ->getInstance();
    $this
      ->assertEquals($i
      ->getState(), InvalidationInterface::FRESH);
    $this
      ->assertEquals($i
      ->getStateString(), 'FRESH');
  }

  /**
   * Test switching away from the acceptable states.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::setStateContext
   */
  public function testStateSwitchGoodBehavior() : void {
    $i = $this
      ->getInstance();
    $i
      ->setStateContext('failingpurger');
    $i
      ->setState(InvalidationInterface::NOT_SUPPORTED);
    $i
      ->setStateContext(NULL);
    $i
      ->setStateContext('failingpurger');
    $i
      ->setState(InvalidationInterface::PROCESSING);
    $i
      ->setStateContext(NULL);
    $i
      ->setStateContext('failingpurger');
    $i
      ->setState(InvalidationInterface::SUCCEEDED);
    $i
      ->setStateContext(NULL);
    $i
      ->setStateContext('failingpurger');
    $i
      ->setState(InvalidationInterface::FAILED);
    $i
      ->setStateContext(NULL);
    $this
      ->assertSame([
      'failingpurger',
    ], $i
      ->getStateContexts());
  }

  /**
   * Test exception when switching away from the 'FRESH' state.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::setStateContext
   */
  public function testStateSwitchBadBehavior() : void {
    $i = $this
      ->getInstance();
    $i
      ->setStateContext('test');
    $this
      ->expectException(BadPluginBehaviorException::class);
    $this
      ->expectExceptionMessage('Only NOT_SUPPORTED, PROCESSING, SUCCEEDED and FAILED are valid outbound states.');
    $i
      ->setStateContext(NULL);
  }

  /**
   * Test exception when setting state in NULL context.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::setState
   */
  public function testStateSetInGeneralContext() : void {
    $i = $this
      ->getInstance();
    $this
      ->expectException(\LogicException::class);
    $this
      ->expectExceptionMessage('State cannot be set in NULL context!');
    $i
      ->setState(InvalidationInterface::FAILED);
  }

  /**
   * Test exceptions when setting invalid states.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::setState
   */
  public function testStateSetInvalidStateA() : void {
    $i = $this
      ->getInstance();
    $this
      ->expectException(InvalidStateException::class);
    $this
      ->expectExceptionMessage('$state not an integer!');
    $i
      ->setState('2');
  }

  /**
   * Test exceptions when setting invalid states.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::setState
   */
  public function testStateSetInvalidStateB() : void {
    $i = $this
      ->getInstance();
    $this
      ->expectException(InvalidStateException::class);
    $this
      ->expectExceptionMessage('$state not an integer!');
    $i
      ->setState('FRESH');
  }

  /**
   * Test exceptions when setting invalid states.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::setState
   */
  public function testStateSetInvalidStateC() : void {
    $i = $this
      ->getInstance();
    $this
      ->expectException(InvalidStateException::class);
    $this
      ->expectExceptionMessage('$state is out of range!');
    $i
      ->setState(-1);
  }

  /**
   * Test exceptions when setting invalid states.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::setState
   */
  public function testStateSetInvalidStateD() : void {
    $i = $this
      ->getInstance();
    $this
      ->expectException(InvalidStateException::class);
    $this
      ->expectExceptionMessage('$state is out of range!');
    $i
      ->setState(5);
  }

  /**
   * Test exceptions when setting invalid states.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::setState
   */
  public function testStateSetInvalidStateE() : void {
    $i = $this
      ->getInstance();
    $this
      ->expectException(InvalidStateException::class);
    $this
      ->expectExceptionMessage('$state is out of range!');
    $i
      ->setState(100);
  }

  /**
   * Test overal state storage and retrieval.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::setState
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::setStateContext
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::getState
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::getStateString
   */
  public function testStateStorageAndRetrieval() : void {
    $i = $this
      ->getInstance();

    // Test setting normal states results in the same return state.
    $test_states = [
      InvalidationInterface::PROCESSING => 'PROCESSING',
      InvalidationInterface::SUCCEEDED => 'SUCCEEDED',
      InvalidationInterface::FAILED => 'FAILED',
      InvalidationInterface::NOT_SUPPORTED => 'NOT_SUPPORTED',
    ];
    $context = 0;
    $i
      ->setStateContext((string) $context);
    foreach ($test_states as $state => $string) {
      $this
        ->assertNull($i
        ->setStateContext((string) $context++));
      $this
        ->assertNull($i
        ->setState($state));
      $this
        ->assertEquals($i
        ->getState(), $state);
      $this
        ->assertEquals($i
        ->getStateString(), $string);
    }
    $i
      ->setStateContext(NULL);
  }

  /**
   * Test if typecasting invalidation objects to strings gets us a string.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::__toString
   */
  public function testStringExpression() : void {
    $this
      ->assertEquals((string) $this
      ->getInstance(), $this->expressions[0], 'The __toString method returns $expression.');
  }

  /**
   * Test if all valid string expressions properly instantiate the object.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::__construct
   */
  public function testValidExpressions() : void {
    if (is_null($this->expressions)) {
      $this
        ->assertInstanceOf(InvalidationInterface::class, $this->purgeInvalidationFactory
        ->get($this->pluginId));
    }
    else {
      foreach ($this->expressions as $e) {
        $this
          ->assertInstanceOf(InvalidationInterface::class, $this->purgeInvalidationFactory
          ->get($this->pluginId, $e));
      }
    }
  }

  /**
   * Test if all invalid string expressions fail to instantiate the object.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::__construct
   */
  public function testInvalidExpressions() : void {
    foreach ($this->expressionsInvalid as $exp) {
      $thrown = FALSE;
      try {
        $this->purgeInvalidationFactory
          ->get($this->pluginId, $exp);
      } catch (\Exception $e) {
        $thrown = $e;
      }
      if (is_null($exp)) {
        $this
          ->assertInstanceOf(MissingExpressionException::class, $thrown);
      }
      else {
        $this
          ->assertInstanceOf(InvalidExpressionException::class, $thrown);
      }
    }
  }

  /**
   * Test retrieving the plugin ID and definition.
   *
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::getPluginId
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::getType
   * @see \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface::getPluginDefinition
   */
  public function testPluginIdAndDefinition() : void {

    // Test mutable objects.
    $mutable = $this
      ->getInstance();
    $this
      ->assertEquals($this->pluginId, $mutable
      ->getPluginId());
    $this
      ->assertEquals($this->pluginId, $mutable
      ->getType());
    $d = $mutable
      ->getPluginDefinition();
    $this
      ->assertTrue(is_array($d));
    $this
      ->assertTrue(is_array($d['examples']));
    $this
      ->assertTrue($d['label'] instanceof TranslatableMarkup);
    $this
      ->assertFalse(empty((string) $d['label']));
    $this
      ->assertTrue($d['description'] instanceof TranslatableMarkup);
    $this
      ->assertFalse(empty((string) $d['description']));
    $this
      ->assertTrue(isset($d['expression_required']));
    $this
      ->assertTrue(isset($d['expression_can_be_empty']));
    $this
      ->assertTrue(isset($d['expression_must_be_string']));
    if (!$d["expression_required"]) {
      $this
        ->assertFalse($d["expression_can_be_empty"]);
    }

    // Test the immutable objects.
    $immutable = $this
      ->getImmutableInstance();
    $this
      ->assertEquals($this->pluginId, $immutable
      ->getPluginId());
    $this
      ->assertEquals($this->pluginId, $immutable
      ->getType());
    $d = $immutable
      ->getPluginDefinition();
    $this
      ->assertTrue(is_array($d));
    $this
      ->assertTrue(is_array($d['examples']));
    $this
      ->assertTrue($d['label'] instanceof TranslatableMarkup);
    $this
      ->assertFalse(empty((string) $d['label']));
    $this
      ->assertTrue($d['description'] instanceof TranslatableMarkup);
    $this
      ->assertFalse(empty((string) $d['description']));
    $this
      ->assertTrue(isset($d['expression_required']));
    $this
      ->assertTrue(isset($d['expression_can_be_empty']));
    $this
      ->assertTrue(isset($d['expression_must_be_string']));
    if (!$d["expression_required"]) {
      $this
        ->assertFalse($d["expression_can_be_empty"]);
    }
  }

}

Members

Name	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.
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.
PluginTestBase::$expressions	protected	property	String expressions valid to the invalidation type being tested.	8
PluginTestBase::$expressionsInvalid	protected	property	String expressions invalid to the invalidation type being tested.	8
PluginTestBase::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules
PluginTestBase::$pluginId	protected	property	The plugin ID of the invalidation type being tested.
PluginTestBase::getImmutableInstance	public	function	Retrieve a immutable invalidation object, which wraps the plugin.
PluginTestBase::getInstance	public	function	Retrieve a invalidation object provided by the plugin.
PluginTestBase::setUp	public	function	Set up the test. Overrides KernelTestBase::setUp
PluginTestBase::testCodeContract	public	function	Tests the code contract strictly enforced on invalidation type plugins.
PluginTestBase::testDeleteProperty	public	function	Test deleting a property.
PluginTestBase::testGetProperty	public	function	Test retrieving a property.
PluginTestBase::testImmutable	public	function	Tests \Drupal\purge\Plugin\Purge\Invalidation\ImmutableInvalidation.
PluginTestBase::testInvalidExpressions	public	function	Test if all invalid string expressions fail to instantiate the object.
PluginTestBase::testPluginIdAndDefinition	public	function	Test retrieving the plugin ID and definition.
PluginTestBase::testPropertiesInitializeEmpty	public	function	Test that instances initialize with no properties.
PluginTestBase::testPropertyStorageModel	public	function	Test that properties are stored by context.
PluginTestBase::testSetProperty	public	function	Test setting a property.
PluginTestBase::testStateContextExceptionDeleteProperty	public	function	Test that you can't delete a property without specifying the state context.
PluginTestBase::testStateContextExceptionGetProperty	public	function	Test that you can't fetch a property without specifying the state context.
PluginTestBase::testStateContextExceptionSetProperty	public	function	Test that you can't set a property without specifying the state context.
PluginTestBase::testStateInitial	public	function	Test the initial state of the invalidation object.
PluginTestBase::testStateSetInGeneralContext	public	function	Test exception when setting state in NULL context.
PluginTestBase::testStateSetInvalidStateA	public	function	Test exceptions when setting invalid states.
PluginTestBase::testStateSetInvalidStateB	public	function	Test exceptions when setting invalid states.
PluginTestBase::testStateSetInvalidStateC	public	function	Test exceptions when setting invalid states.
PluginTestBase::testStateSetInvalidStateD	public	function	Test exceptions when setting invalid states.
PluginTestBase::testStateSetInvalidStateE	public	function	Test exceptions when setting invalid states.
PluginTestBase::testStateStorageAndRetrieval	public	function	Test overal state storage and retrieval.
PluginTestBase::testStateSwitchBadBehavior	public	function	Test exception when switching away from the 'FRESH' state.
PluginTestBase::testStateSwitchGoodBehavior	public	function	Test switching away from the acceptable states.
PluginTestBase::testStringExpression	public	function	Test if typecasting invalidation objects to strings gets us a string.
PluginTestBase::testTypeUnsupportedException	public	function	Tests TypeUnsupportedException.
PluginTestBase::testValidExpressions	public	function	Test if all valid string expressions properly instantiate the object.
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.
TestTrait::$configFactory	protected	property	The factory for configuration objects.
TestTrait::$purgeDiagnostics	protected	property	The 'purge.diagnostics' service.
TestTrait::$purgeInvalidationFactory	protected	property	The 'purge.invalidation.factory' service.
TestTrait::$purgeLogger	protected	property	The 'purge.logger' service.
TestTrait::$purgeProcessors	protected	property	The 'purge.processors' service.
TestTrait::$purgePurgers	protected	property	The 'purge.purgers' service.
TestTrait::$purgeQueue	protected	property	The 'purge.queue' service.
TestTrait::$purgeQueuers	protected	property	The 'purge.queuers' service.
TestTrait::$purgeQueueStats	protected	property	The 'purge.queue.stats' service.
TestTrait::$purgeQueueTxbuffer	protected	property	The 'purge.queue.txbuffer' service.
TestTrait::$purgeTagsHeaders	protected	property	The 'purge.tagsheaders' service.
TestTrait::getInvalidations	public	function	Create $amount requested invalidation objects.
TestTrait::initializeDiagnosticsService	protected	function	Make $this->purgeDiagnostics available.
TestTrait::initializeInvalidationFactoryService	protected	function	Make $this->purgeInvalidationFactory available.
TestTrait::initializeLoggerService	protected	function	Make $this->purgeLogger available.
TestTrait::initializeProcessorsService	protected	function	Make $this->purgeProcessors available.
TestTrait::initializePurgersService	protected	function	Make $this->purgePurgers available.
TestTrait::initializeQueuersService	protected	function	Make $this->purgeQueuers available.
TestTrait::initializeQueueService	protected	function	Make $this->purgeQueue available.
TestTrait::initializeTagsHeadersService	protected	function	Make $this->purgeTagsheaders available.
TestTrait::setMemoryQueue	public	function	Switch to the memory queue backend.

You are here

abstract class PluginTestBase in Purge 8.3

Hierarchy

See also

File

Namespace

Members

API Navigation