class SecurepagesTest in Secure Pages 8

Test Secure Pages redirects.

@group securepages

Hierarchy

• class \Drupal\simpletest\TestBase uses TestSetupTrait, AssertHelperTrait, ConfigTestTrait, RandomGeneratorTrait, GeneratePermutationsTrait
  • class \Drupal\simpletest\WebTestBase uses AssertMailTrait, FunctionalTestSetupTrait, AssertContentTrait, AssertPageCacheContextsAndTagsTrait, BlockCreationTrait, EntityViewTrait, ContentTypeCreationTrait, NodeCreationTrait, TestFileCreationTrait, CronRunTrait, UserCreationTrait, XdebugRequestTrait
    • class \Drupal\securepages\Tests\SecurepagesTest uses CommentTestTrait

File

src/Tests/SecurepagesTest.php, line 23

Contains \Drupal\securepages\Tests\SecurepagesTest.

Namespace

Drupal\securepages\Tests

class SecurepagesTest extends WebTestBase {
  use CommentTestTrait;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'securepages',
    'node',
    'comment',
    'locale',
    'path',
  ];

  /**
   * List of default pages protected.
   *
   * @var array
   *   List of strings.
   */
  protected $pages_default = [
    '/node/add*',
    '/node/*/edit',
    '/node/*/delete',
    '/user',
    '/user/*',
    '/admin',
    '/admin/*',
  ];
  public function setUp() {
    parent::setUp();
    $this
      ->drupalCreateContentType([
      'type' => 'article',
    ]);
    $this
      ->addDefaultCommentField('node', 'article');
  }

  /**
   * Runs all the tests in a sequence to avoid multiple re-installs.
   */
  function testSecurePages() {
    $this
      ->_testSettingsForm();
    $this
      ->_testMatch();
    $this
      ->_testLocale();
    $this
      ->_testAnonymous();
    $this
      ->_testFormAlter();
    $this
      ->_testCachedResponse();
    $this
      ->_testPathAlias();

    // @todo given no GET q in Drupal 8 and otherwise the format tested not
    // being a valid URL, not sure how would securepages be used for open
    // redirection.
    // $this->_testOpenRedirect();
    $this
      ->_testXHR();
    $this
      ->_testRoles();
    $this
      ->_testPathNorms();
  }

  /**
   * Test submitting the settings form.
   */
  function _testSettingsForm() {
    $this
      ->drupalLoginHttps($this
      ->drupalCreateUser([
      'administer site configuration',
    ]));
    $this
      ->drupalPostForm(Securepages::getUrl('securepages.admin_settings'), [
      'enable' => 1,
    ], t('Save configuration'));
    $this
      ->assertRaw(t('The configuration options have been saved.'));

    // Clean up.
    $this
      ->drupalLogoutHttps();
  }

  /**
   * Tests the securepages_match() function.
   */
  function _testMatch() {
    \Drupal::configFactory()
      ->getEditable('securepages.settings')
      ->set('ignore', [
      '*/autocomplete/*',
    ])
      ->save();
    $request = \Drupal::requestStack()
      ->getCurrentRequest();
    $test_request_is_https = $request
      ->isSecure();
    $this
      ->assertEqual(Securepages::matchPath('/user'), !$test_request_is_https, 'user matches.');
    $this
      ->assertEqual(Securepages::matchPath('/user/login'), !$test_request_is_https, 'user/login matches.');
    $this
      ->assertEqual(Securepages::matchPath('/admin/modules'), !$test_request_is_https, 'path admin/modules matches.');
    $this
      ->assertEqual(Securepages::matchPath('/node'), $test_request_is_https, 'path node does not match.');
    $request = \Drupal::requestStack()
      ->getCurrentRequest();
    $this
      ->assertEqual(Securepages::matchPath('/user/autocomplete/alice'), $test_request_is_https, 'autocomplete path is ignored.');

    // Clean up.
    \Drupal::configFactory()
      ->getEditable('securepages.settings')
      ->set('ignore', [])
      ->save();
  }

  /**
   * Tests correct operation with locale module.
   */
  function _testLocale() {
    $french = ConfigurableLanguage::createFromLangcode('fr');
    $french
      ->save();
    $this
      ->drupalGet('fr/user');
    $this
      ->assertResponse(200);
    $this
      ->assertUrl(Url::fromRoute('<front>', [], [
      'https' => TRUE,
      'absolute' => TRUE,
    ])
      ->toString() . 'fr/user/login');
    $this
      ->assertTrue(strstr($this->url, 'fr/user'), t('URL contains language prefix.'));
  }

  /**
   * Tests for anonymous browsing with securepages.
   */
  function _testAnonymous() {

    // Visit the home page (same as user page) with plain HTTP.
    $this
      ->drupalGet('', [
      'https' => FALSE,
    ]);
    $this
      ->assertResponse(302);
    $this
      ->assertUrl(Url::fromRoute('user.login', [], [
      'https' => TRUE,
      'absolute' => TRUE,
    ]));

    // Visit the login page (same as front page in tests) with plain HTTP.
    $this
      ->drupalGet('user/login', [
      'https' => FALSE,
    ]);
    $this
      ->assertResponse(302);
    $this
      ->assertUrl(Url::fromRoute('user.login', [], [
      'https' => TRUE,
      'absolute' => TRUE,
    ]));

    // Visit the home page and login with HTTPS.
    $this
      ->drupalGet('', [
      'https' => TRUE,
    ]);
    $this
      ->assertResponse(302);
    $this
      ->assertUrl(Url::fromRoute('user.login', [], [
      'https' => TRUE,
      'absolute' => TRUE,
    ]));
    $this
      ->drupalGet('user/login', [
      'https' => TRUE,
    ]);
    $this
      ->assertResponse(200);
    $this
      ->assertUrl(Url::fromRoute('user.login', [], [
      'https' => TRUE,
      'absolute' => TRUE,
    ]));

    // Enable "Switch back to http pages when there are no matches".
    \Drupal::configFactory()
      ->getEditable('securepages.settings')
      ->set('switch', TRUE)
      ->save();

    // Visit the home page and user with HTTPS and confirm the switch-back.
    $this
      ->drupalGet('', [
      'https' => TRUE,
    ]);
    $this
      ->assertResponse(302);
    $this
      ->assertUrl(Url::fromRoute('user.login', [], [
      'https' => FALSE,
      'absolute' => TRUE,
    ]));
    $this
      ->drupalGet('user/login', [
      'https' => TRUE,
    ]);
    $this
      ->assertResponse(302);
    $this
      ->assertUrl(Url::fromRoute('user.login', [], [
      'https' => FALSE,
      'absolute' => TRUE,
    ]));

    // Clean up.
    \Drupal::configFactory()
      ->getEditable('securepages.settings')
      ->set('switch', FALSE)
      ->save();
  }

  /**
   * Tests the ability to alter form actions.
   *
   * Uses the comment form, since it has an #action set.
   */
  function _testFormAlter() {
    $config = \Drupal::configFactory()
      ->getEditable('securepages.settings');
    $config
      ->set('switch', TRUE)
      ->save();

    // Enable anonymous user comments.
    user_role_change_permissions(AccountInterface::ANONYMOUS_ROLE, [
      'access comments' => TRUE,
      'post comments' => TRUE,
      'skip comment approval' => TRUE,
    ]);
    $account = $this
      ->drupalCreateUser([
      'access content',
      'access comments',
      'post comments',
      'skip comment approval',
    ]);
    $node = $this
      ->drupalCreateNode([
      'type' => 'article',
      'promote' => 1,
    ]);
    foreach (array(
      'anonymous',
      'authenticated',
    ) as $mode) {
      if ($mode == 'authenticated') {
        $this
          ->drupalLogin($account);
      }

      // Test plain HTTP posting to HTTPS.
      $config
        ->set('pages', [
        '/comment/reply/*',
        '/user*',
      ])
        ->save();
      $this
        ->drupalGet('node/' . $node
        ->id(), [
        'https' => FALSE,
      ]);
      $this
        ->assertFieldByXPath('//form[@class="comment-form" and starts-with(@action, "https:")]', NULL, "The {$mode} comment form action is https.");
      $this
        ->drupalPostForm(NULL, [
        'comment_body[0][value]' => 'test comment',
      ], t('Save'));
      $this
        ->assertRaw(t('Your comment has been posted.'));

      // Test HTTPS posting to plain HTTP.
      $config
        ->set('pages', [
        '/node/*',
        '/user*',
      ])
        ->save();
      $this
        ->drupalGet('node/' . $node
        ->id(), [
        'https' => TRUE,
      ]);
      $this
        ->assertUrl(Url::fromRoute('entity.node.canonical', [
        'node' => $node
          ->id(),
      ], [
        'https' => TRUE,
        'absolute' => TRUE,
      ]));
      $this
        ->assertFieldByXPath('//form[@class="comment-form" and starts-with(@action, "http:")]', NULL, "The {$mode} comment form action is http.");
      $this
        ->drupalPostForm(NULL, [
        'comment_body[0][value]' => 'test',
      ], t('Save'));
      $this
        ->assertRaw(t('Your comment has been posted.'));
    }
    $this
      ->drupalLogout();

    // Test the user login block.
    $this
      ->drupalGet('');
    $edit = [
      'name' => $account
        ->getAccountName(),
      'pass' => $account->pass_raw,
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Log in'));
    $this
      ->drupalGet('user/' . $account
      ->id() . '/edit');
    $this
      ->assertResponse(200);

    // Clean up.
    $this
      ->drupalLogout();
    $config
      ->set('switch', FALSE)
      ->set('pages', $this->pages_default)
      ->save();
  }
  function _testCachedResponse() {

    // Enable the page cache and fetch the login page.
    $this
      ->installModule('page_cache');
    $url = Url::fromRoute('user.login', [], [
      'absolute' => TRUE,
      'https' => FALSE,
    ]);
    $this
      ->drupalGet($url);

    // Short-circuit redirects within the simpletest browser.
    $maximum_redirects = $this->maximumRedirects;
    $this->maximumRedirects = 0;
    $this
      ->drupalGet($url);
    $this
      ->assertResponse(302);
    $this
      ->assertEqual($this
      ->drupalGetHeader('Location'), Url::fromRoute('user.login', [], [
      'https' => TRUE,
      'absolute' => TRUE,
    ])
      ->toString());
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'HIT', 'Page was cached.');

    // Clean up.
    $this->maximumRedirects = $maximum_redirects;
    $this
      ->uninstallModule('page_cache');
  }

  /**
   * Test redirection on aliased paths.
   */
  function _testPathAlias() {
    $config = \Drupal::configFactory()
      ->getEditable('securepages.settings');
    $config
      ->set('pages', [
      '/node/*',
      '/user*',
    ])
      ->save();

    // Create test user and login.
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'administer url aliases',
      'create url aliases',
    ]));

    // Create test node.
    $node = $this
      ->drupalCreateNode();

    // Create alias.
    $edit = [];
    $edit['source'] = 'node/' . $node
      ->id();
    $edit['alias'] = $this
      ->randomMachineName();
    $this
      ->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));

    // Short-circuit redirects within the simpletest browser.
    $maximum_redirects = $this->maximumRedirects;
    $this->maximumRedirects = 0;
    $this
      ->drupalGet($edit['alias'], [
      'absolute' => TRUE,
      'https' => FALSE,
    ]);
    $this
      ->assertResponse(302);
    $this
      ->assertEqual($this
      ->drupalGetHeader('Location'), Url::fromRoute('<front>', [], [
      'https' => TRUE,
      'absolute' => TRUE,
    ])
      ->toString() . $edit['alias']);

    // Clean up.
    $this->maximumRedirects = $maximum_redirects;
    $this
      ->drupalLogout();
    $config
      ->set('pages', $this->pages_default)
      ->save();
  }

  /**
   * Verifies that securepages is not an open redirect.
   */
  function _testOpenRedirect() {

    // Short-circuit redirects within the simpletest browser.
    variable_set('simpletest_maximum_redirects', 0);
    variable_set('securepages_switch', TRUE);
    global $base_url, $base_path;
    $secure_base_url = str_replace('http', 'https', $base_url);
    $this
      ->drupalGet($secure_base_url . $base_path . '?q=http://example.com/', array(
      'external' => TRUE,
    ));
    $this
      ->assertResponse(302);
    $this
      ->assertTrue(strstr($this
      ->drupalGetHeader('Location'), $base_url), t('Open redirect test passed.'));
    $this
      ->drupalGet($secure_base_url . $base_path . '?q=' . urlencode('http://example.com/'), array(
      'external' => TRUE,
    ));
    $this
      ->assertResponse(302);
    $this
      ->assertTrue(strstr($this
      ->drupalGetHeader('Location'), $base_url), t('Open redirect test passed.'));

    // Clean up
    variable_del('simpletest_maximum_redirects');
    variable_del('securepages_switch');
  }

  /**
   * Test detection of XHR requests.
   */
  function _testXHR() {

    // Without XHR header.
    $this
      ->drupalGet('user', [
      'https' => FALSE,
    ]);
    $this
      ->assertResponse(200);
    $this
      ->assertUrl(Url::fromRoute('user.login', [], [
      'https' => TRUE,
      'absolute' => TRUE,
    ]));

    // With XHR header.
    $this
      ->drupalGet('user', [
      'https' => FALSE,
    ], [
      'X-Requested-With: XMLHttpRequest',
    ]);
    $this
      ->assertResponse(200);
    $this
      ->assertUrl(Url::fromRoute('user.login', [], [
      'https' => FALSE,
      'absolute' => TRUE,
    ]));
  }

  /**
   * Test role-based switching.
   */
  function _testRoles() {
    $account = $this
      ->drupalCreateUser([
      'access content',
    ]);
    $role = current($account
      ->getRoles(TRUE));
    $this
      ->drupalLoginHttps($account);
    $config = \Drupal::configFactory()
      ->getEditable('securepages.settings');
    $config
      ->set('switch', TRUE)
      ->set('roles', [
      $role,
    ])
      ->set('pages', [
      '/admin*',
    ])
      ->save();

    // Visit the home page and /user with HTTPS and confirm that redirection happens.
    $this
      ->drupalGet('', [
      'https' => FALSE,
    ]);
    $this
      ->assertResponse(200);
    $this
      ->assertUrl(Url::fromRoute('<front>', [], [
      'https' => TRUE,
      'absolute' => TRUE,
    ]));
    $this
      ->drupalGet('user', [
      'https' => FALSE,
    ]);
    $this
      ->assertResponse(200);
    $this
      ->assertUrl(Url::fromRoute('user.page', [], [
      'https' => TRUE,
      'absolute' => TRUE,
    ]));

    // Test that forms actions aren't switched back to http.
    $node = $this
      ->drupalCreateNode([
      'type' => 'article',
      'promote' => 1,
    ]);
    $this
      ->drupalGet('node/' . $node
      ->id(), [
      'https' => TRUE,
    ]);
    $this
      ->assertFieldByXPath('//form[@class="comment-form" and starts-with(@action, "/")]', NULL, "The comment form action is https.");

    // Clean up.
    $config
      ->set('switch', FALSE)
      ->set('roles', [])
      ->set('pages', $this->pages_default)
      ->save();
    $this
      ->drupalLogout();
  }

  /**
   * Test path normalization checks.
   */
  function _testPathNorms() {
    $config = \Drupal::configFactory()
      ->getEditable('securepages.settings');
    $config
      ->set('switch', TRUE)
      ->set('pages', [
      '/user',
    ])
      ->save();

    // Test mixed-case path.
    $this
      ->drupalGet('UsEr');
    $this
      ->assertUrl('UsEr', [
      'https' => TRUE,
      'absolute' => TRUE,
    ]);
    $this
      ->assertFieldByXPath('//form[@id="user-login" and starts-with(@action, "/")]', NULL, 'The user login form action is https.');

    // Test that a trailing slash will not force a protected form's action to
    // http. A http based 'user/' path will become 'user' when doing the
    // redirect, so best to ensure that the test gets the right conditions the
    // path should be https based.
    $this
      ->drupalGet('user/', [
      'https' => TRUE,
      'absolute' => TRUE,
    ]);
    $this
      ->assertUrl('user/', [
      'https' => TRUE,
      'absolute' => TRUE,
    ]);
    $this
      ->assertFieldByXPath('//form[@id="user-login" and starts-with(@action, "/")]', NULL, 'The user login form action is https.');

    // Clean up.
    $config
      ->set('switch', FALSe)
      ->set('pages', $this->pages_default)
      ->save();
  }

  /**
   * Log in a user with the internal browser using HTTPS.
   *
   * @see \Drupal\simpletest\WebTestBase::drupalLogin().
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   User object representing the user to log in.
   */
  function drupalLoginHttps($account) {
    if ($this->loggedInUser) {
      $this
        ->drupalLogout();
    }
    $edit = array(
      'name' => $account
        ->getAccountName(),
      'pass' => $account->pass_raw,
    );
    $this
      ->drupalPostForm(Securepages::getUrl('user.login'), $edit, t('Log in'));

    // @see WebTestBase::drupalUserIsLoggedIn()
    if (isset($this->sessionId)) {
      $account->session_id = $this->sessionId;
    }
    $pass = $this
      ->assertRaw('>' . $account
      ->getAccountName() . '<', t('User %name successfully logged in.', array(
      '%name' => $account
        ->getAccountName(),
    )), 'User login');
    if ($pass) {
      $this->loggedInUser = $account;
      $this->container
        ->get('current_user')
        ->setAccount($account);
    }
  }

  /**
   * Logs a user out of the internal browser and confirms.
   *
   * Confirms logout by checking the login page.
   */
  protected function drupalLogoutHttps() {

    // Make a request to the logout page, and redirect to the user page, the
    // idea being if you were properly logged out you should be seeing a login
    // screen.
    $this
      ->drupalGet(Securepages::getUrl('user.logout', array(
      'query' => array(
        'destination' => 'user/login',
      ),
    )));
    $this
      ->assertResponse(200, 'User was logged out.');
    $pass = $this
      ->assertField('name', 'Username field found.', 'Logout');
    $pass = $pass && $this
      ->assertField('pass', 'Password field found.', 'Logout');
    if ($pass) {

      // @see WebTestBase::drupalUserIsLoggedIn()
      unset($this->loggedInUser->session_id);
      $this->loggedInUser = FALSE;
      $this->container
        ->get('current_user')
        ->setAccount(new AnonymousUserSession());
    }
  }

  /**
   * Installs a module.
   *
   * @param string $module
   *   The module name.
   */
  protected function installModule($module) {
    $this->container
      ->get('module_installer')
      ->install(array(
      $module,
    ));
    $this->container = \Drupal::getContainer();
  }

  /**
   * Uninstalls a module.
   *
   * @param string $module
   *   The module name.
   */
  protected function uninstallModule($module) {
    $this->container
      ->get('module_installer')
      ->uninstall(array(
      $module,
    ));
    $this->container = \Drupal::getContainer();
  }

}

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.
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. Aliased as: drupalGetMails
AssertMailTrait::verboseEmail	protected	function	Outputs to verbose the most recent $count emails sent.
AssertPageCacheContextsAndTagsTrait::assertCacheContext	protected	function	Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts	protected	function	Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge	protected	function	Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags	protected	function	Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext	protected	function	Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags	protected	function	Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::debugCacheTags	protected	function	Provides debug information for cache tags.
AssertPageCacheContextsAndTagsTrait::enablePageCaching	protected	function	Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues	protected	function	Gets a specific header value as array.
BlockCreationTrait::placeBlock	protected	function	Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
CommentTestTrait::addDefaultCommentField	public	function	Adds the default comment field to an entity.
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
CronRunTrait::cronRun	protected	function	Runs cron on the test site.
EntityViewTrait::buildEntityView	protected	function	Builds the renderable view of an entity. Aliased as: drupalBuildEntityView
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.
GeneratePermutationsTrait::generatePermutations	public static	function	Converts a list of possible parameters into a stack of permutations.
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
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
SecurepagesTest::$modules	public static	property	Modules to enable.
SecurepagesTest::$pages_default	protected	property	List of default pages protected.
SecurepagesTest::drupalLoginHttps		function	Log in a user with the internal browser using HTTPS.
SecurepagesTest::drupalLogoutHttps	protected	function	Logs a user out of the internal browser and confirms.
SecurepagesTest::installModule	protected	function	Installs a module.
SecurepagesTest::setUp	public	function	Sets up a Drupal site for running functional and integration tests. Overrides WebTestBase::setUp
SecurepagesTest::testSecurePages		function	Runs all the tests in a sequence to avoid multiple re-installs.
SecurepagesTest::uninstallModule	protected	function	Uninstalls a module.
SecurepagesTest::_testAnonymous		function	Tests for anonymous browsing with securepages.
SecurepagesTest::_testCachedResponse		function
SecurepagesTest::_testFormAlter		function	Tests the ability to alter form actions.
SecurepagesTest::_testLocale		function	Tests correct operation with locale module.
SecurepagesTest::_testMatch		function	Tests the securepages_match() function.
SecurepagesTest::_testOpenRedirect		function	Verifies that securepages is not an open redirect.
SecurepagesTest::_testPathAlias		function	Test redirection on aliased paths.
SecurepagesTest::_testPathNorms		function	Test path normalization checks.
SecurepagesTest::_testRoles		function	Test role-based switching.
SecurepagesTest::_testSettingsForm		function	Test submitting the settings form.
SecurepagesTest::_testXHR		function	Test detection of XHR requests.
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.
TestBase::$assertions	protected	property	Assertions thrown in that test case.
TestBase::$configImporter	protected	property	The config importer that can used in a test.
TestBase::$databasePrefix	protected	property	The database prefix of this test run.
TestBase::$dieOnFail	public	property	Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials	protected	property	HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod	protected	property	HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$originalConf	protected	property	The original configuration (variables), if available.
TestBase::$originalConfig	protected	property	The original configuration (variables).
TestBase::$originalConfigDirectories	protected	property	The original configuration directories.
TestBase::$originalContainer	protected	property	The original container.
TestBase::$originalFileDirectory	protected	property	The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage	protected	property	The original language.
TestBase::$originalPrefix	protected	property	The original database prefix when running inside Simpletest.
TestBase::$originalSessionName	protected	property	The name of the session cookie of the test-runner.
TestBase::$originalSettings	protected	property	The settings array.
TestBase::$results	public	property	Current results of this test case.
TestBase::$skipClasses	protected	property	This class is skipped when looking for the source of an assertion.
TestBase::$timeLimit	protected	property	Time limit for the test.
TestBase::$translationFilesDirectory	protected	property	The translation file directory for the test environment.
TestBase::$verbose	public	property	TRUE if verbose debugging is enabled.
TestBase::$verboseClassName	protected	property	Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory	protected	property	Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl	protected	property	URL to the verbose output file directory.
TestBase::$verboseId	protected	property	Incrementing identifier for verbose output filenames.
TestBase::assert	protected	function	Internal helper: stores the assert.
TestBase::assertEqual	protected	function	Check to see if two values are equal.
TestBase::assertErrorLogged	protected	function	Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse	protected	function	Check to see if a value is false.
TestBase::assertIdentical	protected	function	Check to see if two values are identical.
TestBase::assertIdenticalObject	protected	function	Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged	protected	function	Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual	protected	function	Check to see if two values are not equal.
TestBase::assertNotIdentical	protected	function	Check to see if two values are not identical.
TestBase::assertNotNull	protected	function	Check to see if a value is not NULL.
TestBase::assertNull	protected	function	Check to see if a value is NULL.
TestBase::assertTrue	protected	function	Check to see if a value is not false.
TestBase::beforePrepareEnvironment	protected	function	Act on global state information before the environment is altered for a test.	1
TestBase::checkRequirements	protected	function	Checks the matching requirements for Test.	1
TestBase::checkTestHierarchyMismatch	public	function	Fail the test if it belongs to a PHPUnit-based framework.
TestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
TestBase::deleteAssert	public static	function	Delete an assertion record by message ID.
TestBase::error	protected	function	Fire an error assertion.	1
TestBase::errorHandler	public	function	Handle errors during test runs.
TestBase::exceptionHandler	protected	function	Handle exceptions.
TestBase::fail	protected	function	Fire an assertion that is always negative.
TestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable.
TestBase::getAssertionCall	protected	function	Cycles through backtrace until the first non-assertion method is found.
TestBase::getDatabasePrefix	public	function	Gets the database prefix.
TestBase::getTempFilesDirectory	public	function	Gets the temporary files directory.
TestBase::insertAssert Deprecated	public static	function	Store an assertion from outside the testing context.	1
TestBase::pass	protected	function	Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix	private	function	Generates a database prefix for running tests. Overrides TestSetupTrait::prepareDatabasePrefix
TestBase::restoreEnvironment	private	function	Cleans up the test environment and restores the original environment.
TestBase::run	public	function	Run all tests in this class.	2
TestBase::settingsSet	protected	function	Changes in memory settings.
TestBase::storeAssertion	protected	function	Helper method to store an assertion record in the configured database.	1
TestBase::verbose	protected	function	Logs a verbose message in a text file.
TestFileCreationTrait::$generatedTestFiles	protected	property	Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles	protected	function	Compares two files based on size and file name. Aliased as: drupalCompareFiles
TestFileCreationTrait::generateFile	public static	function	Generates a test file.
TestFileCreationTrait::getTestFiles	protected	function	Gets a list of files that can be used in tests. Aliased as: drupalGetTestFiles
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.
UserCreationTrait::checkPermissions	protected	function	Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole	protected	function	Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole	protected	function	Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser	protected	function	Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions	protected	function	Grant permissions to a user role.
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.
WebTestBase::$additionalCurlOptions	protected	property	Additional cURL options.
WebTestBase::$assertAjaxHeader	protected	property	Whether or not to assert the presence of the X-Drupal-Ajax-Token.
WebTestBase::$cookieFile	protected	property	The current cookie file used by cURL.
WebTestBase::$cookies	protected	property	The cookies of the page currently loaded in the internal browser.
WebTestBase::$curlCookies	protected	property	Cookies to set on curl requests.
WebTestBase::$curlHandle	protected	property	The handle of the current cURL connection.
WebTestBase::$customTranslations	protected	property	An array of custom translations suitable for drupal_rewrite_settings().
WebTestBase::$dumpHeaders	protected	property	Indicates that headers should be dumped if verbose output is enabled.	1
WebTestBase::$headers	protected	property	The headers of the page currently loaded in the internal browser.
WebTestBase::$loggedInUser	protected	property	The current user logged in using the internal browser.
WebTestBase::$maximumMetaRefreshCount	protected	property	The number of meta refresh redirects to follow, or NULL if unlimited.
WebTestBase::$maximumRedirects	protected	property	The maximum number of redirects to follow when handling responses.
WebTestBase::$metaRefreshCount	protected	property	The number of meta refresh redirects followed during ::drupalGet().
WebTestBase::$originalBatch	protected	property	The original batch, before it was changed for testing purposes.
WebTestBase::$originalShutdownCallbacks	protected	property	The original shutdown handlers array, before it was cleaned for testing. Overrides TestBase::$originalShutdownCallbacks
WebTestBase::$originalUser	protected	property	The original user, before it was changed to a clean uid = 1 for testing. Overrides TestBase::$originalUser
WebTestBase::$profile	protected	property	The profile to install as a basis for testing.	2
WebTestBase::$redirectCount	protected	property	The number of redirects followed during the handling of a request.
WebTestBase::$sessionId	protected	property	The current session ID, if available.
WebTestBase::$url	protected	property	The URL currently loaded in the internal browser.
WebTestBase::addCustomTranslations	protected	function	Queues custom translations to be written to settings.php.
WebTestBase::assertBlockAppears	protected	function	Checks to see whether a block appears on the page.
WebTestBase::assertCacheTag	protected	function	Asserts whether an expected cache tag was present in the last response.
WebTestBase::assertHeader	protected	function	Check if a HTTP response header exists and has the expected value.
WebTestBase::assertNoBlockAppears	protected	function	Checks to see whether a block does not appears on the page.
WebTestBase::assertNoCacheTag	protected	function	Asserts whether an expected cache tag was absent in the last response.
WebTestBase::assertNoResponse	protected	function	Asserts the page did not return the specified response code.
WebTestBase::assertResponse	protected	function	Asserts the page responds with the specified response code.	1
WebTestBase::assertUrl	protected	function	Passes if the internal browser's URL matches the given path.
WebTestBase::buildUrl	protected	function	Builds an a absolute URL from a system path or a URL object.
WebTestBase::checkForMetaRefresh	protected	function	Checks for meta refresh tag and if found call drupalGet() recursively.
WebTestBase::clickLink	protected	function	Follows a link by complete name.
WebTestBase::clickLinkHelper	protected	function	Provides a helper for ::clickLink() and ::clickLinkPartialName().
WebTestBase::clickLinkPartialName	protected	function	Follows a link by partial name.
WebTestBase::curlClose	protected	function	Close the cURL handler and unset the handler.
WebTestBase::curlExec	protected	function	Initializes and executes a cURL request.	1
WebTestBase::curlHeaderCallback	protected	function	Reads headers and registers errors received from the tested site.
WebTestBase::curlInitialize	protected	function	Initializes the cURL connection.
WebTestBase::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	1
WebTestBase::drupalGetAjax	protected	function	Requests a path or URL in drupal_ajax format and JSON-decodes the response.
WebTestBase::drupalGetHeader	protected	function	Gets the value of an HTTP response header.	1
WebTestBase::drupalGetHeaders	protected	function	Gets the HTTP response headers of the requested page.	1
WebTestBase::drupalGetJSON	protected	function	Retrieves a Drupal path or an absolute path and JSON decodes the result.
WebTestBase::drupalGetWithFormat	protected	function	Retrieves a Drupal path or an absolute path for a given format.
WebTestBase::drupalGetXHR	protected	function	Requests a Drupal path or an absolute path as if it is a XMLHttpRequest.
WebTestBase::drupalHead	protected	function	Retrieves only the headers for a Drupal path or an absolute path.
WebTestBase::drupalLogin	protected	function	Log in a user with the internal browser.
WebTestBase::drupalLogout	protected	function	Logs a user out of the internal browser and confirms.
WebTestBase::drupalPost	protected	function	Perform a POST HTTP request.
WebTestBase::drupalPostAjaxForm	protected	function	Executes an Ajax form submission.
WebTestBase::drupalPostForm	protected	function	Executes a form submission.
WebTestBase::drupalPostWithFormat	protected	function	Performs a POST HTTP request with a specific format.
WebTestBase::drupalProcessAjaxResponse	protected	function	Processes an AJAX response into current content.
WebTestBase::drupalUserIsLoggedIn	protected	function	Returns whether a given user account is logged in.
WebTestBase::findBlockInstance	protected	function	Find a block instance on the page.
WebTestBase::getAbsoluteUrl	protected	function	Takes a path and returns an absolute path.
WebTestBase::getAjaxPageStatePostData	protected	function	Get the Ajax page state from drupalSettings and prepare it for POSTing.
WebTestBase::handleForm	protected	function	Handles form input related to drupalPostForm().
WebTestBase::isInChildSite	protected	function	Returns whether the test is being executed from within a test site.
WebTestBase::restoreBatch	protected	function	Restore the original batch.
WebTestBase::serializePostValues	protected	function	Serialize POST HTTP request values.
WebTestBase::setBatch	protected	function	Preserve the original batch, and instantiate the test batch.
WebTestBase::setHttpResponseDebugCacheabilityHeaders	protected	function	Enables/disables the cacheability headers.
WebTestBase::tearDown	protected	function	Cleans up after testing. Overrides TestBase::tearDown	1
WebTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm().
WebTestBase::writeCustomTranslations	protected	function	Writes custom translations to the test site's settings.php.
WebTestBase::__construct	public	function	Constructor for \Drupal\simpletest\WebTestBase. Overrides TestBase::__construct	1
XdebugRequestTrait::extractCookiesFromRequest	protected	function	Adds xdebug cookies, from request setup.