You are here

Home » API reference » Message Subscribe 8 » SubscribersTest.php

class SubscribersTest in Message Subscribe 8

Same name in this branch
  1. 8 tests/src/Unit/SubscribersTest.php \Drupal\Tests\message_subscribe\Unit\SubscribersTest
  2. 8 tests/src/Kernel/SubscribersTest.php \Drupal\Tests\message_subscribe\Kernel\SubscribersTest

Test getting subscribes from context.

@group message_subscribe

@coversDefaultClass \Drupal\message_subscribe\Subscribers

Hierarchy

Expanded class hierarchy of SubscribersTest

File

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

Namespace

Drupal\Tests\message_subscribe\Kernel
View source 
class SubscribersTest extends MessageSubscribeTestBase {
  use AssertMailTrait;

  /**
   * Flag service.
   *
   * @var \Drupal\flag\FlagServiceInterface
   */
  protected $flagService;

  /**
   * The message subscription service.
   *
   * @var \Drupal\message_subscribe\SubscribersInterface
   */
  protected $messageSubscribers;

  /**
   * Nodes to test with.
   *
   * @var \Drupal\node\NodeInterface[]
   */
  protected $nodes;

  /**
   * Users to test with.
   *
   * @var \Drupal\user\UserInterface[]
   */
  protected $users;

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

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this
      ->installSchema('node', [
      'node_access',
    ]);
    $this->flagService = $this->container
      ->get('flag');
    $this->messageSubscribers = $this->container
      ->get('message_subscribe.subscribers');

    // Create node-type.
    $node_type = 'article';
    $flags = $this->flagService
      ->getAllFlags();
    $flag = $flags['subscribe_node'];
    $flag
      ->set('bundles', [
      $node_type,
    ]);
    $flag
      ->enable();
    $flag
      ->save();
    $flag = $flags['subscribe_user'];
    $flag
      ->enable();
    $flag
      ->save();
    $this->users[1] = $this
      ->createUser([
      'flag subscribe_node',
      'unflag subscribe_node',
      'flag subscribe_user',
      'unflag subscribe_user',
    ]);
    $this->users[2] = $this
      ->createUser([
      'flag subscribe_node',
      'unflag subscribe_node',
      'flag subscribe_user',
      'unflag subscribe_user',
    ]);

    // User 3 is blocked.
    $this->users[3] = $this
      ->createUser([
      'flag subscribe_node',
      'unflag subscribe_node',
      'flag subscribe_user',
      'unflag subscribe_user',
    ]);
    $this->users[3]
      ->block();
    $this->users[3]
      ->save();

    // Create node.
    $settings = [];
    $settings['type'] = $node_type;
    $settings['uid'] = $this->users[1];
    $this->nodes[0] = $this
      ->createNode($settings);
    $settings['uid'] = $this->users[2];
    $this->nodes[1] = $this
      ->createNode($settings);

    // User1, User2 and user_blocked flag node1.
    $this->flagService
      ->flag($flags['subscribe_node'], $this->nodes[0], $this->users[1]);
    $this->flagService
      ->flag($flags['subscribe_node'], $this->nodes[0], $this->users[2]);
    $this->flagService
      ->flag($flags['subscribe_node'], $this->nodes[0], $this->users[3]);
    $this->flagService
      ->flag($flags['subscribe_node'], $this->nodes[1], $this->users[3]);

    // User2 flags User1.
    $this->flagService
      ->flag($flags['subscribe_user'], $this->users[1], $this->users[2]);

    // Override default notifiers.
    \Drupal::configFactory()
      ->getEditable('message_subscribe.settings')
      ->set('default_notifiers', [])
      ->save();
  }

  /**
   * Test getting the subscribers list.
   */
  public function testGetSubscribers() {
    $message = Message::create([
      'template' => $this->template
        ->id(),
      'uid' => $this->users[1],
    ]);
    $node = $this->nodes[0];
    $user2 = $this->users[2];
    $user_blocked = $this->users[3];
    $uids = $this->messageSubscribers
      ->getSubscribers($node, $message);

    // Assert subscribers data.
    $expected_uids = [
      $user2
        ->id() => new DeliveryCandidate([
        'subscribe_node',
        'subscribe_user',
      ], [], $user2
        ->id()),
    ];
    $this
      ->assertEquals($uids, $expected_uids, 'All expected subscribers were fetched.');

    // Test none of users will get message if only blocked user is subscribed.
    $message = Message::create([
      'template' => $this->template
        ->id(),
      'uid' => $this->users[1],
    ]);
    $node1 = $this->nodes[1];
    $uids = $this->messageSubscribers
      ->getSubscribers($node1, $message);

    // Assert subscribers data.
    $expected_uids = [];
    $this
      ->assertEquals($uids, $expected_uids, 'All expected subscribers were fetched.');

    // Test notifying all users, including those who are blocked.
    $subscribe_options['notify blocked users'] = TRUE;
    $uids = $this->messageSubscribers
      ->getSubscribers($node, $message, $subscribe_options);
    $expected_uids = [
      $user2
        ->id() => new DeliveryCandidate([
        'subscribe_node',
        'subscribe_user',
      ], [], $user2
        ->id()),
      $user_blocked
        ->id() => new DeliveryCandidate([
        'subscribe_node',
      ], [], $user_blocked
        ->id()),
    ];
    $this
      ->assertEquals($uids, $expected_uids, 'All expected subscribers were fetched, including blocked users.');
    $user3 = $this
      ->createUser([
      'flag subscribe_node',
      'unflag subscribe_node',
      'flag subscribe_user',
      'unflag subscribe_user',
    ]);
    $user4 = $this
      ->createUser([
      'flag subscribe_node',
      'unflag subscribe_node',
      'flag subscribe_user',
      'unflag subscribe_user',
    ]);
    $flags = $this->flagService
      ->getAllFlags();
    $this->flagService
      ->flag($flags['subscribe_node'], $node, $user3);
    $this->flagService
      ->flag($flags['subscribe_node'], $node, $user4);

    // Get subscribers from a given "last uid".
    $subscribe_options = [
      'last uid' => $user2
        ->id(),
    ];
    $uids = $this->messageSubscribers
      ->getSubscribers($node, $message, $subscribe_options);
    $this
      ->assertEquals(array_keys($uids), [
      $user3
        ->id(),
      $user4
        ->id(),
    ], 'All subscribers from "last uid" were fetched.');

    // Get a range of subscribers.
    $subscribe_options['range'] = 1;
    $uids = $this->messageSubscribers
      ->getSubscribers($node, $message, $subscribe_options);
    $this
      ->assertEquals(array_keys($uids), [
      $user3
        ->id(),
    ], 'All subscribers from "last uid" and "range" were fetched.');
  }

  /**
   * Testing the exclusion of the entity author from the subscribers lists.
   */
  public function testGetSubscribersExcludeSelf() {

    // Test the affect of the variable when set to FALSE (do not notify self).
    \Drupal::configFactory()
      ->getEditable('message_subscribe.settings')
      ->set('notify_own_actions', FALSE)
      ->save();
    $message = Message::create([
      'template' => $this->template
        ->id(),
      'uid' => $this->users[1],
    ]);
    $node = $this->nodes[0];
    $user1 = $this->users[1];
    $user2 = $this->users[2];
    $uids = $this->messageSubscribers
      ->getSubscribers($node, $message);

    // Assert subscribers data.
    $expected_uids = [
      $this->users[2]
        ->id() => new DeliveryCandidate([
        'subscribe_node',
        'subscribe_user',
      ], [], $this->users[2]
        ->id()),
    ];
    $this
      ->assertEquals($uids, $expected_uids, 'All subscribers except for the triggering user were fetched.');

    // Test the affect of the variable when set to TRUE (Notify self).
    \Drupal::configFactory()
      ->getEditable('message_subscribe.settings')
      ->set('notify_own_actions', TRUE)
      ->save();
    $uids = $this->messageSubscribers
      ->getSubscribers($node, $message);

    // Assert subscribers data.
    $expected_uids = [
      $this->users[1]
        ->id() => new DeliveryCandidate([
        'subscribe_node',
      ], [], $this->users[1]
        ->id()),
      $this->users[2]
        ->id() => new DeliveryCandidate([
        'subscribe_node',
        'subscribe_user',
      ], [], $this->users[2]
        ->id()),
    ];
    $this
      ->assertEquals($uids, $expected_uids, 'All subscribers including the triggering user were fetched.');
  }

  /**
   * Assert subscribers list is entity-access aware.
   */
  public function testEntityAccess() {

    // Make sure we are notifying ourselves for this test.
    \Drupal::configFactory()
      ->getEditable('message_subscribe.settings')
      ->set('notify_own_actions', TRUE)
      ->save();
    $message = Message::create([
      'template' => $this->template
        ->id(),
    ]);
    $node = $this->nodes[0];
    $node
      ->setUnpublished();
    $node
      ->save();

    // Add permission to view own unpublished content.
    user_role_change_permissions(AccountInterface::AUTHENTICATED_ROLE, [
      'view own unpublished content' => TRUE,
    ]);

    // Set the node to be unpublished.
    $user1 = $this->users[1];
    $user2 = $this->users[2];
    $subscribe_options['entity access'] = TRUE;
    $uids = $this->messageSubscribers
      ->getSubscribers($node, $message, $subscribe_options);
    $this
      ->assertEquals(array_keys($uids), [
      $user1
        ->id(),
    ], 'Only user with access to node returned for subscribers list.');
    $subscribe_options['entity access'] = FALSE;
    $uids = $this->messageSubscribers
      ->getSubscribers($node, $message, $subscribe_options);
    $this
      ->assertEquals(array_keys($uids), [
      $user1
        ->id(),
      $user2
        ->id(),
    ], 'All users (even without access) returned for subscribers list.');
  }

  /**
   * Ensure hooks are firing correctly.
   */
  public function testHooks() {
    $this
      ->enableModules([
      'message_subscribe_test',
    ]);
    $message = Message::create([
      'template' => $this->template
        ->id(),
      'uid' => $this->users[1],
    ]);

    // Create a 4th user that the test module will add.
    $this->users[4] = $this
      ->createUser();
    $node = $this->nodes[0];
    $uids = $this->messageSubscribers
      ->getSubscribers($node, $message);

    // @see message_subscribe_test.module
    $this
      ->assertTrue(\Drupal::state('message_subscribe_test')
      ->get('hook_called'));
    $this
      ->assertTrue(\Drupal::state('message_subscribe_test')
      ->get('alter_hook_called'));
    $this
      ->assertEquals([
      4 => new DeliveryCandidate([
        'foo_flag',
      ], [
        'email',
      ], 4),
      10001 => new DeliveryCandidate([
        'bar_flag',
      ], [
        'email',
      ], 10001),
    ], $uids);

    // Disable the test module from adding a fake user.
    \Drupal::state('message_subscribe_test')
      ->set('disable_subscribers_alter', TRUE);

    // Send a message and verify the message alter hook is called (should be
    // called once for each subscriber, so 2 times).
    $this->messageSubscribers
      ->sendMessage($node, $message, [], [
      'entity access' => FALSE,
    ]);
    $this
      ->assertEquals(2, \Drupal::state('message_subscribe_test')
      ->get('message_alter_hook_called', FALSE));
  }

  /**
   * Tests sendMessage method.
   *
   * @covers ::sendMessage
   */
  public function testSendMessage() {

    // Enable a notifier.
    $this
      ->config('message_subscribe.settings')
      ->set('default_notifiers', [
      'email',
    ])
      ->save();

    // Add a few more users.
    $flags = $this->flagService
      ->getAllFlags();
    foreach (range(4, 10) as $i) {
      $this->users[$i] = $this
        ->createUser([
        'access content',
        'flag subscribe_node',
        'unflag subscribe_node',
        'flag subscribe_user',
        'unflag subscribe_user',
      ]);
      $this->flagService
        ->flag($flags['subscribe_node'], $this->nodes[0], $this->users[$i]);
    }

    // Send notifications for node 1.
    // Pass in the save message argument to the notifier.
    $notify_options = [
      'email' => [
        'save on fail' => TRUE,
        'save on success' => TRUE,
      ],
    ];
    $subscribe_options = [
      'notify message owner' => TRUE,
    ];
    $message = Message::create([
      'template' => $this->template
        ->id(),
    ]);
    $this->messageSubscribers
      ->sendMessage($this->nodes[0], $message, $notify_options, $subscribe_options);

    // Verify that each of the users has a copy of the message.
    $mails = $this
      ->getMails();
    $no_message_count = $message_count = 0;
    foreach ($this->users as $account) {

      /** @var \Drupal\Core\Entity\Query\QueryInterface $query */
      $query = $this->container
        ->get('entity_type.manager')
        ->getStorage('message')
        ->getQuery();
      $query
        ->condition('uid', $account
        ->id());
      $result = $query
        ->execute();

      // Users 2 through 3 won't have access.
      if (!$account
        ->hasPermission('access content') || $account
        ->isBlocked()) {
        $this
          ->assertEmpty($result);
        $no_message_count++;
      }
      else {
        $this
          ->assertEquals(1, count($result), '1 message was saved for user ' . $account
          ->id());
        $message_count++;
      }
    }
    $this
      ->assertEquals(2, $no_message_count);
    $this
      ->assertEquals(8, $message_count);
    $this
      ->assertEquals(count($mails), $message_count);
  }

  /**
   * Tests entity owner sending specific to node entites.
   *
   * @covers ::getSubscribers
   */
  public function testNotifyEntityOwner() {

    // Unblock user 3.
    $this->users[3]
      ->activate();
    $this->users[3]
      ->save();

    // Setup a node owned by user 2, but *edited* by user 3.
    $this->nodes[0]
      ->setOwner($this->users[2]);
    $this->nodes[0]
      ->setRevisionUser($this->users[3]);
    $this->nodes[0]
      ->save();

    // Ensure owners are not setup to be notified.
    $this
      ->config('message_subscribe.settings')
      ->set('notify_own_actions', FALSE)
      ->save();

    // User 3, also subscribed, should not be notified. User 2 *should* be
    // notified (they are subscribed in ::setUp) because user 3 edited the node.
    $message = Message::create([
      'template' => $this->template
        ->id(),
    ]);
    $subscribers = $this->messageSubscribers
      ->getSubscribers($this->nodes[0], $message);
    $expected = [
      $this->users[1]
        ->id() => new DeliveryCandidate([
        'subscribe_node',
      ], [], $this->users[1]
        ->id()),
      $this->users[2]
        ->id() => new DeliveryCandidate([
        'subscribe_node',
      ], [], $this->users[2]
        ->id()),
    ];
    $this
      ->assertEquals($expected, $subscribers);

    // Edit the node by user 2, and user 3 should now be notified.
    $this->nodes[0]
      ->setRevisionUser($this->users[2]);
    $this->nodes[0]
      ->save();
    $subscribers = $this->messageSubscribers
      ->getSubscribers($this->nodes[0], $message);
    $expected = [
      $this->users[1]
        ->id() => new DeliveryCandidate([
        'subscribe_node',
      ], [], $this->users[1]
        ->id()),
      $this->users[3]
        ->id() => new DeliveryCandidate([
        'subscribe_node',
      ], [], $this->users[3]
        ->id()),
    ];
    $this
      ->assertEquals($expected, $subscribers);
  }

  /**
   * Tests message bundles with fields are properly cloned.
   *
   * @covers ::sendMessage
   */
  public function testFieldedMessageBundles() {
    $field_name = mb_strtolower($this
      ->randomMachineName());
    $field_storage = FieldStorageConfig::create([
      'field_name' => $field_name,
      'entity_type' => 'message',
      'type' => 'text',
    ]);
    $field_storage
      ->save();
    $field_config = FieldConfig::create([
      'field_storage' => $field_storage,
      'bundle' => $this->template
        ->id(),
    ]);
    $field_config
      ->save();

    // Enable the email notifier.
    \Drupal::configFactory()
      ->getEditable('message_subscribe.settings')
      ->set('default_notifiers', [
      'email',
    ])
      ->save();
    $message = Message::create([
      'template' => $this->template
        ->id(),
      'uid' => $this->users[1],
      $field_name => $this
        ->randomString(),
    ]);

    // Save and reload to mimic queue behavior.
    $message
      ->save();
    $message = $message
      ->load($message
      ->id());

    // Send message set to save the cloned message.
    $node = $this->nodes[0];
    $this->messageSubscribers
      ->sendMessage($node, $message, [
      'email' => [
        'save on success' => TRUE,
      ],
    ], [
      'entity access' => FALSE,
    ]);
    $cloned_message = \Drupal::entityTypeManager()
      ->getStorage('message')
      ->load($message
      ->id() + 1);
    $this
      ->assertEquals($message->{$field_name}->value, $cloned_message->{$field_name}->value);
  }

}

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
AssertMailTrait::assertMail protected function Asserts that the most recently sent email message has the given value.
AssertMailTrait::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
AssertMailTrait::assertMailString protected function Asserts that the most recently sent email message has the string in it.
AssertMailTrait::getMails protected function Gets an array containing all emails sent during this test case.
AssertMailTrait::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
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. 1
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.
MessageSubscribeTestBase::$template protected property Message template.
MessageTemplateCreateTrait::createMessageTemplate protected function Helper function to create and save a message template entity.
NodeCreationTrait::createNode protected function Creates a node based on default settings.
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title.
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.
SubscribersTest::$flagService protected property Flag service.
SubscribersTest::$messageSubscribers protected property The message subscription service. Overrides MessageSubscribeTestBase::$messageSubscribers
SubscribersTest::$modules public static property Modules to enable. Overrides MessageSubscribeTestBase::$modules
SubscribersTest::$nodes protected property Nodes to test with.
SubscribersTest::$users protected property Users to test with.
SubscribersTest::setUp public function Overrides MessageSubscribeTestBase::setUp
SubscribersTest::testEntityAccess public function Assert subscribers list is entity-access aware.
SubscribersTest::testFieldedMessageBundles public function Tests message bundles with fields are properly cloned.
SubscribersTest::testGetSubscribers public function Test getting the subscribers list.
SubscribersTest::testGetSubscribersExcludeSelf public function Testing the exclusion of the entity author from the subscribers lists.
SubscribersTest::testHooks public function Ensure hooks are firing correctly.
SubscribersTest::testNotifyEntityOwner public function Tests entity owner sending specific to node entites.
SubscribersTest::testSendMessage public function Tests sendMessage method.
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.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions.
UserCreationTrait::createUser protected function Create a user with a given set of permissions.
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.