You are here

Home » API reference » Devel 8 » DevelSwitchUserTest.php

class DevelSwitchUserTest in Devel 8

Same name and namespace in other branches
  1. 8.3 tests/src/Functional/DevelSwitchUserTest.php \Drupal\Tests\devel\Functional\DevelSwitchUserTest
  2. 8.2 tests/src/Functional/DevelSwitchUserTest.php \Drupal\Tests\devel\Functional\DevelSwitchUserTest
  3. 4.x tests/src/Functional/DevelSwitchUserTest.php \Drupal\Tests\devel\Functional\DevelSwitchUserTest

Tests switch user.

@group devel

Hierarchy

Expanded class hierarchy of DevelSwitchUserTest

File

tests/src/Functional/DevelSwitchUserTest.php, line 13

Namespace

Drupal\Tests\devel\Functional
View source 
class DevelSwitchUserTest extends BrowserTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'devel',
    'block',
  ];

  /**
   * The block used by this test.
   *
   * @var \Drupal\block\BlockInterface
   */
  protected $block;

  /**
   * The devel user.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $develUser;

  /**
   * The switch user.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $switchUser;

  /**
   * The web user.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $webUser;

  /**
   * Set up test.
   */
  protected function setUp() {
    parent::setUp();
    $this->block = $this
      ->drupalPlaceBlock('devel_switch_user', [
      'id' => 'switch-user',
    ]);
    $this->develUser = $this
      ->drupalCreateUser([
      'access devel information',
      'switch users',
    ]);
    $this->switchUser = $this
      ->drupalCreateUser([
      'switch users',
    ]);
    $this->webUser = $this
      ->drupalCreateUser();
  }

  /**
   * Tests switch user.
   */
  public function testSwitchUser() {
    $this
      ->drupalLogin($this->webUser);
    $this
      ->drupalGet('');
    $this
      ->assertNoText($this->block
      ->label(), 'Block title was not found.');

    // Ensure that a token is required to switch user.
    $this
      ->drupalGet('/devel/switch/' . $this->webUser
      ->getDisplayName());
    $this
      ->assertResponse(403);
    $this
      ->drupalLogin($this->develUser);
    $this
      ->drupalGet('');
    $this
      ->assertText($this->block
      ->label(), 'Block title was found.');

    // Ensure that if name in not passed the controller returns access denied.
    $this
      ->drupalGet('/devel/switch');
    $this
      ->assertResponse(403);

    // Ensure that a token is required to switch user.
    $this
      ->drupalGet('/devel/switch/' . $this->switchUser
      ->getDisplayName());
    $this
      ->assertResponse(403);

    // Switch to another user account.
    $this
      ->drupalGet('/user/' . $this->switchUser
      ->id());
    $this
      ->clickLink($this->switchUser
      ->getDisplayName());
    $this
      ->assertSessionByUid($this->switchUser
      ->id());
    $this
      ->assertNoSessionByUid($this->develUser
      ->id());

    // Switch back to initial account.
    $this
      ->clickLink($this->develUser
      ->getDisplayName());
    $this
      ->assertNoSessionByUid($this->switchUser
      ->id());
    $this
      ->assertSessionByUid($this->develUser
      ->id());

    // Use the search form to switch to another account.
    $edit = [
      'userid' => $this->switchUser
        ->getDisplayName(),
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Switch'));
    $this
      ->assertSessionByUid($this->switchUser
      ->id());
    $this
      ->assertNoSessionByUid($this->develUser
      ->id());
  }

  /**
   * Tests the switch user block configuration.
   */
  public function testSwitchUserBlockConfiguration() {
    $anonymous = \Drupal::config('user.settings')
      ->get('anonymous');

    // Create some users for the test.
    for ($i = 0; $i < 12; $i++) {
      $this
        ->drupalCreateUser();
    }
    $this
      ->drupalLogin($this->develUser);
    $this
      ->drupalGet('');
    $this
      ->assertText($this->block
      ->label(), 'Block title was found.');

    // Ensure that block default configuration is effectively used. The block
    // default configuration is the following:
    // - list_size : 12
    // - include_anon : FALSE
    // - show_form : TRUE
    $this
      ->assertSwitchUserSearchForm();
    $this
      ->assertSwitchUserListCount(12);
    $this
      ->assertSwitchUserListNoContainsUser($anonymous);

    // Ensure that changing the list_size configuration property the number of
    // user displayed in the list change.
    $this
      ->setBlockConfiguration('list_size', 4);
    $this
      ->drupalGet('');
    $this
      ->assertSwitchUserListCount(4);

    // Ensure that changing the include_anon configuration property the
    // anonymous user is displayed in the list.
    $this
      ->setBlockConfiguration('include_anon', TRUE);
    $this
      ->drupalGet('');
    $this
      ->assertSwitchUserListContainsUser($anonymous);

    // Ensure that changing the show_form configuration property the
    // form is not displayed.
    $this
      ->setBlockConfiguration('show_form', FALSE);
    $this
      ->drupalGet('');
    $this
      ->assertSwitchUserNoSearchForm();
  }

  /**
   * Test the user list items.
   */
  public function testSwitchUserListItems() {
    $anonymous = \Drupal::config('user.settings')
      ->get('anonymous');
    $this
      ->setBlockConfiguration('list_size', 2);

    // Login as web user so we are sure that this account is prioritized
    // in the list if not enougth user with 'switch users' permission are
    // present.
    $this
      ->drupalLogin($this->webUser);
    $this
      ->drupalLogin($this->develUser);
    $this
      ->drupalGet('');

    // Ensure that user with 'switch users' permission are prioritized.
    $this
      ->assertSwitchUserListCount(2);
    $this
      ->assertSwitchUserListContainsUser($this->develUser
      ->getDisplayName());
    $this
      ->assertSwitchUserListContainsUser($this->switchUser
      ->getDisplayName());

    // Ensure that blocked users are not shown in the list.
    $this->switchUser
      ->set('status', 0)
      ->save();
    $this
      ->drupalGet('');
    $this
      ->assertSwitchUserListCount(2);
    $this
      ->assertSwitchUserListContainsUser($this->develUser
      ->getDisplayName());
    $this
      ->assertSwitchUserListContainsUser($this->webUser
      ->getDisplayName());
    $this
      ->assertSwitchUserListNoContainsUser($this->switchUser
      ->getDisplayName());

    // Ensure that anonymous user are prioritized if include_anon is set to true.
    $this
      ->setBlockConfiguration('include_anon', TRUE);
    $this
      ->drupalGet('');
    $this
      ->assertSwitchUserListCount(2);
    $this
      ->assertSwitchUserListContainsUser($this->develUser
      ->getDisplayName());
    $this
      ->assertSwitchUserListContainsUser($anonymous);

    // Ensure that the switch user block works properly even if no prioritized
    // users are found (special handling for user 1).
    $this
      ->drupalLogout();
    $this->develUser
      ->delete();
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->drupalGet('');
    $this
      ->assertSwitchUserListCount(2);
    $this
      ->assertSwitchUserListContainsUser($this->rootUser
      ->getDisplayName());
    $this
      ->assertSwitchUserListContainsUser($anonymous);

    // Ensure that the switch user block works properly even if no roles have
    // the 'switch users' permission associated (special handling for user 1).
    $roles = user_roles(TRUE, 'switch users');
    \Drupal::entityTypeManager()
      ->getStorage('user_role')
      ->delete($roles);
    $this
      ->drupalGet('');
    $this
      ->assertSwitchUserListCount(2);
    $this
      ->assertSwitchUserListContainsUser($this->rootUser
      ->getDisplayName());
    $this
      ->assertSwitchUserListContainsUser($anonymous);
  }

  /**
   * Helper function for verify the number of items shown in the user list.
   *
   * @param int $number
   *   The expected numer of items.
   */
  public function assertSwitchUserListCount($number) {
    $result = $this
      ->xpath('//div[@id=:block]//ul/li/a', [
      ':block' => 'block-switch-user',
    ]);
    $this
      ->assert(count($result) == $number, 'The number of users shown in switch user is correct.');
  }

  /**
   * Helper function for verify if the user list contains a username.
   *
   * @param string $username
   *   The username to check.
   */
  public function assertSwitchUserListContainsUser($username) {
    $result = $this
      ->xpath('//div[@id=:block]//ul/li/a[normalize-space()=:user]', [
      ':block' => 'block-switch-user',
      ':user' => $username,
    ]);
    $this
      ->assert(count($result) > 0, new FormattableMarkup('User "%user" is included in the switch user list.', [
      '%user' => $username,
    ]));
  }

  /**
   * Helper function for verify if the user list not contains a username.
   *
   * @param string $username
   *   The username to check.
   */
  public function assertSwitchUserListNoContainsUser($username) {
    $result = $this
      ->xpath('//div[@id=:block]//ul/li/a[normalize-space()=:user]', [
      ':block' => 'block-switch-user',
      ':user' => $username,
    ]);
    $this
      ->assert(count($result) == 0, new FormattableMarkup('User "%user" is not included in the switch user list.', [
      '%user' => $username,
    ]));
  }

  /**
   * Helper function for verify if the search form is shown.
   */
  public function assertSwitchUserSearchForm() {
    $result = $this
      ->xpath('//div[@id=:block]//form[contains(@class, :form)]', [
      ':block' => 'block-switch-user',
      ':form' => 'devel-switchuser-form',
    ]);
    $this
      ->assert(count($result) > 0, 'The search form is shown.');
  }

  /**
   * Helper function for verify if the search form is not shown.
   */
  public function assertSwitchUserNoSearchForm() {
    $result = $this
      ->xpath('//div[@id=:block]//form[contains(@class, :form)]', [
      ':block' => 'block-switch-user',
      ':form' => 'devel-switchuser-form',
    ]);
    $this
      ->assert(count($result) == 0, 'The search form is not shown.');
  }

  /**
   * Protected helper method to set the test block's configuration.
   */
  protected function setBlockConfiguration($key, $value) {
    $block = $this->block
      ->getPlugin();
    $block
      ->setConfigurationValue($key, $value);
    $this->block
      ->save();
  }

  /**
   * Asserts that there is a session for a given user ID.
   *
   * Based off masquarade module.
   *
   * @param int $uid
   *   The user ID for which to find a session record.
   *
   * TODO find a cleaner way to do this check.
   */
  protected function assertSessionByUid($uid) {
    $query = \Drupal::database()
      ->select('sessions');
    $query
      ->fields('sessions', [
      'uid',
    ]);
    $query
      ->condition('uid', $uid);
    $result = $query
      ->execute()
      ->fetchAll();
    if (empty($result)) {
      $this
        ->fail(new FormattableMarkup('No session found for uid @uid', [
        '@uid' => $uid,
      ]));
    }
    elseif (count($result) > 1) {

      // If there is more than one session, then that must be unexpected.
      $this
        ->fail("Found more than 1 session for uid {$uid}.");
    }
    else {
      $this
        ->pass("Found session for uid {$uid}.");
    }
  }

  /**
   * Asserts that no session exists for a given uid.
   *
   * Based off masquarade module.
   *
   * @param int $uid
   *   The user ID to assert.
   *
   * TODO find a cleaner way to do this check.
   */
  protected function assertNoSessionByUid($uid) {
    $query = \Drupal::database()
      ->select('sessions');
    $query
      ->fields('sessions', [
      'uid',
    ]);
    $query
      ->condition('uid', $uid);
    $result = $query
      ->execute()
      ->fetchAll();
    $this
      ->assert(empty($result), "No session for uid {$uid} found.");
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
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::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$defaultTheme protected property The theme to install as the default for testing. 1,597
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
DevelSwitchUserTest::$block protected property The block used by this test.
DevelSwitchUserTest::$develUser protected property The devel user.
DevelSwitchUserTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
DevelSwitchUserTest::$switchUser protected property The switch user.
DevelSwitchUserTest::$webUser protected property The web user.
DevelSwitchUserTest::assertNoSessionByUid protected function Asserts that no session exists for a given uid.
DevelSwitchUserTest::assertSessionByUid protected function Asserts that there is a session for a given user ID.
DevelSwitchUserTest::assertSwitchUserListContainsUser public function Helper function for verify if the user list contains a username.
DevelSwitchUserTest::assertSwitchUserListCount public function Helper function for verify the number of items shown in the user list.
DevelSwitchUserTest::assertSwitchUserListNoContainsUser public function Helper function for verify if the user list not contains a username.
DevelSwitchUserTest::assertSwitchUserNoSearchForm public function Helper function for verify if the search form is not shown.
DevelSwitchUserTest::assertSwitchUserSearchForm public function Helper function for verify if the search form is shown.
DevelSwitchUserTest::setBlockConfiguration protected function Protected helper method to set the test block's configuration.
DevelSwitchUserTest::setUp protected function Set up test. Overrides BrowserTestBase::setUp
DevelSwitchUserTest::testSwitchUser public function Tests switch user.
DevelSwitchUserTest::testSwitchUserBlockConfiguration public function Tests the switch user block configuration.
DevelSwitchUserTest::testSwitchUserListItems public function Test the user list items.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
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.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
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. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
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.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.