class SessionTest in Drupal 9

Same name in this branch

9 core/tests/Drupal/FunctionalJavascriptTests/Core/Session/SessionTest.php \Drupal\FunctionalJavascriptTests\Core\Session\SessionTest
9 core/modules/system/tests/src/Functional/Session/SessionTest.php \Drupal\Tests\system\Functional\Session\SessionTest

Same name and namespace in other branches

8 core/modules/system/tests/src/Functional/Session/SessionTest.php \Drupal\Tests\system\Functional\Session\SessionTest

Drupal session handling tests.

@group Session

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\system\Functional\Session\SessionTest

Expanded class hierarchy of SessionTest

File

core/modules/system/tests/src/Functional/Session/SessionTest.php, line 13

Namespace

Drupal\Tests\system\Functional\Session

View source

class SessionTest extends BrowserTestBase {

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

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';
  protected $dumpHeaders = TRUE;

  /**
   * Tests for \Drupal\Core\Session\WriteSafeSessionHandler::setSessionWritable()
   * ::isSessionWritable and \Drupal\Core\Session\SessionManager::regenerate().
   */
  public function testSessionSaveRegenerate() {
    $session_handler = $this->container
      ->get('session_handler.write_safe');
    $this
      ->assertTrue($session_handler
      ->isSessionWritable(), 'session_handler->isSessionWritable() initially returns TRUE.');
    $session_handler
      ->setSessionWritable(FALSE);
    $this
      ->assertFalse($session_handler
      ->isSessionWritable(), '$session_handler->isSessionWritable() returns FALSE after disabling.');
    $session_handler
      ->setSessionWritable(TRUE);
    $this
      ->assertTrue($session_handler
      ->isSessionWritable(), '$session_handler->isSessionWritable() returns TRUE after enabling.');

    // Test session hardening code from SA-2008-044.
    $user = $this
      ->drupalCreateUser();

    // Enable sessions.
    $this
      ->sessionReset();

    // Make sure the session cookie is set as HttpOnly. We can only test this in
    // the header, with the test setup
    // \GuzzleHttp\Cookie\SetCookie::getHttpOnly() always returns FALSE.
    // Start a new session by setting a message.
    $this
      ->drupalGet('session-test/set-message');
    $this
      ->assertSessionCookie(TRUE);

    // Verify that the session cookie is set as HttpOnly.
    $this
      ->assertSession()
      ->responseHeaderMatches('Set-Cookie', '/HttpOnly/i');

    // Verify that the session is regenerated if a module calls exit
    // in hook_user_login().
    $user->name = 'session_test_user';
    $user
      ->save();
    $this
      ->drupalGet('session-test/id');
    $matches = [];
    preg_match('/\\s*session_id:(.*)\\n/', $this
      ->getSession()
      ->getPage()
      ->getContent(), $matches);
    $this
      ->assertTrue(!empty($matches[1]), 'Found session ID before logging in.');
    $original_session = $matches[1];

    // We cannot use $this->drupalLogin($user); because we exit in
    // session_test_user_login() which breaks a normal assertion.
    $edit = [
      'name' => $user
        ->getAccountName(),
      'pass' => $user->passRaw,
    ];
    $this
      ->drupalGet('user/login');
    $this
      ->submitForm($edit, 'Log in');
    $this
      ->drupalGet('user');
    $this
      ->assertSession()
      ->pageTextContains($user
      ->getAccountName());
    $this
      ->drupalGet('session-test/id');
    $matches = [];
    preg_match('/\\s*session_id:(.*)\\n/', $this
      ->getSession()
      ->getPage()
      ->getContent(), $matches);
    $this
      ->assertTrue(!empty($matches[1]), 'Found session ID after logging in.');
    $this
      ->assertNotSame($original_session, $matches[1], 'Session ID changed after login.');
  }

  /**
   * Tests data persistence via the session_test module callbacks.
   */
  public function testDataPersistence() {
    $user = $this
      ->drupalCreateUser([]);

    // Enable sessions.
    $this
      ->sessionReset($user
      ->id());
    $this
      ->drupalLogin($user);
    $value_1 = $this
      ->randomMachineName();

    // Verify that the session value is stored.
    $this
      ->drupalGet('session-test/set/' . $value_1);
    $this
      ->assertSession()
      ->pageTextContains($value_1);

    // Verify that the session correctly returned the stored data for an
    // authenticated user.
    $this
      ->drupalGet('session-test/get');
    $this
      ->assertSession()
      ->pageTextContains($value_1);

    // Attempt to write over val_1. If drupal_save_session(FALSE) is working.
    // properly, val_1 will still be set.
    $value_2 = $this
      ->randomMachineName();

    // Verify that the session value is correctly passed to
    // session-test/no-set.
    $this
      ->drupalGet('session-test/no-set/' . $value_2);
    $session = $this
      ->getSession();
    $this
      ->assertSession()
      ->pageTextContains($value_2);

    // Verify that the session data is not saved for drupal_save_session(FALSE).
    $this
      ->drupalGet('session-test/get');
    $this
      ->assertSession()
      ->pageTextContains($value_1);

    // Switch browser cookie to anonymous user, then back to user 1.
    $session_cookie_name = $this
      ->getSessionName();
    $session_cookie_value = $session
      ->getCookie($session_cookie_name);
    $session
      ->restart();
    $this
      ->initFrontPage();

    // Session restart always resets all the cookies by design, so we need to
    // add the old session cookie again.
    $session
      ->setCookie($session_cookie_name, $session_cookie_value);

    // Verify that the session data persists through browser close.
    $this
      ->drupalGet('session-test/get');
    $this
      ->assertSession()
      ->pageTextContains($value_1);
    $this->mink
      ->setDefaultSessionName('default');

    // Logout the user and make sure the stored value no longer persists.
    $this
      ->drupalLogout();
    $this
      ->sessionReset();

    // Verify that after logout, previous user's session data is not available.
    $this
      ->drupalGet('session-test/get');
    $this
      ->assertSession()
      ->pageTextNotContains($value_1);

    // Now try to store some data as an anonymous user.
    $value_3 = $this
      ->randomMachineName();

    // Verify that session data is stored for anonymous user.
    $this
      ->drupalGet('session-test/set/' . $value_3);
    $this
      ->assertSession()
      ->pageTextContains($value_3);

    // Verify that session correctly returns the stored data for an anonymous
    // user.
    $this
      ->drupalGet('session-test/get');
    $this
      ->assertSession()
      ->pageTextContains($value_3);

    // Try to store data when drupal_save_session(FALSE).
    $value_4 = $this
      ->randomMachineName();

    // Verify that the session value is correctly passed to session-test/no-set.
    $this
      ->drupalGet('session-test/no-set/' . $value_4);
    $this
      ->assertSession()
      ->pageTextContains($value_4);

    // Verify that the session data is not saved for drupal_save_session(FALSE).
    $this
      ->drupalGet('session-test/get');
    $this
      ->assertSession()
      ->pageTextContains($value_3);

    // Login, the data should persist.
    $this
      ->drupalLogin($user);
    $this
      ->sessionReset($user
      ->id());

    // Verify that the session persists for an authenticated user after
    // logging out and then back in.
    $this
      ->drupalGet('session-test/get');
    $this
      ->assertSession()
      ->pageTextNotContains($value_1);

    // Change session and create another user.
    $user2 = $this
      ->drupalCreateUser([]);
    $this
      ->sessionReset($user2
      ->id());
    $this
      ->drupalLogin($user2);
  }

  /**
   * Tests storing data in Session() object.
   */
  public function testSessionPersistenceOnLogin() {

    // Store information via hook_user_login().
    $user = $this
      ->drupalCreateUser();
    $this
      ->drupalLogin($user);

    // Test property added to session object form hook_user_login().
    $this
      ->drupalGet('session-test/get-from-session-object');
    $this
      ->assertSession()
      ->pageTextContains('foobar');
  }

  /**
   * Tests that empty anonymous sessions are destroyed.
   */
  public function testEmptyAnonymousSession() {

    // Disable the dynamic_page_cache module; it'd cause session_test's debug
    // output (that is added in
    // SessionTestSubscriber::onKernelResponseSessionTest()) to not be added.
    $this->container
      ->get('module_installer')
      ->uninstall([
      'dynamic_page_cache',
    ]);

    // Verify that no session is automatically created for anonymous user when
    // page caching is disabled.
    $this->container
      ->get('module_installer')
      ->uninstall([
      'page_cache',
    ]);
    $this
      ->drupalGet('');
    $this
      ->assertSessionCookie(FALSE);
    $this
      ->assertSessionEmpty(TRUE);

    // The same behavior is expected when caching is enabled.
    $this->container
      ->get('module_installer')
      ->install([
      'page_cache',
    ]);
    $config = $this
      ->config('system.performance');
    $config
      ->set('cache.page.max_age', 300);
    $config
      ->save();
    $this
      ->drupalGet('');
    $this
      ->assertSessionCookie(FALSE);

    // @todo Reinstate when REQUEST and RESPONSE events fire for cached pages.
    // $this->assertSessionEmpty(TRUE);
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');

    // Start a new session by setting a message.
    $this
      ->drupalGet('session-test/set-message');
    $this
      ->assertSessionCookie(TRUE);
    $this
      ->assertNotNull($this
      ->getSession()
      ->getResponseHeader('Set-Cookie'));

    // Display the message, during the same request the session is destroyed
    // and the session cookie is unset.
    $this
      ->drupalGet('');
    $this
      ->assertSessionCookie(FALSE);
    $this
      ->assertSessionEmpty(FALSE);

    // Verify that caching was bypassed.
    $this
      ->assertSession()
      ->responseHeaderDoesNotExist('X-Drupal-Cache');
    $this
      ->assertSession()
      ->pageTextContains('This is a dummy message.');

    // Verify that session cookie was deleted.
    $this
      ->assertSession()
      ->responseHeaderMatches('Set-Cookie', '/SESS\\w+=deleted/');

    // Verify that session was destroyed.
    $this
      ->drupalGet('');
    $this
      ->assertSessionCookie(FALSE);

    // @todo Reinstate when REQUEST and RESPONSE events fire for cached pages.
    // $this->assertSessionEmpty(TRUE);
    $this
      ->assertSession()
      ->pageTextNotContains('This is a dummy message.');
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
    $this
      ->assertSession()
      ->responseHeaderDoesNotExist('Set-Cookie');

    // Verify that no session is created if drupal_save_session(FALSE) is called.
    $this
      ->drupalGet('session-test/set-message-but-do-not-save');
    $this
      ->assertSessionCookie(FALSE);
    $this
      ->assertSessionEmpty(TRUE);

    // Verify that no message is displayed.
    $this
      ->drupalGet('');
    $this
      ->assertSessionCookie(FALSE);

    // @todo Reinstate when REQUEST and RESPONSE events fire for cached pages.
    // $this->assertSessionEmpty(TRUE);
    $this
      ->assertSession()
      ->pageTextNotContains('This is a dummy message.');
  }

  /**
   * Tests that sessions are only saved when necessary.
   */
  public function testSessionWrite() {
    $user = $this
      ->drupalCreateUser([]);
    $this
      ->drupalLogin($user);
    $connection = Database::getConnection();
    $query = $connection
      ->select('users_field_data', 'u');
    $query
      ->innerJoin('sessions', 's', '[u].[uid] = [s].[uid]');
    $query
      ->fields('u', [
      'access',
    ])
      ->fields('s', [
      'timestamp',
    ])
      ->condition('u.uid', $user
      ->id());
    $times1 = $query
      ->execute()
      ->fetchObject();

    // Before every request we sleep one second to make sure that if the session
    // is saved, its timestamp will change.
    // Modify the session.
    sleep(1);
    $this
      ->drupalGet('session-test/set/foo');
    $times2 = $query
      ->execute()
      ->fetchObject();
    $this
      ->assertEquals($times1->access, $times2->access, 'Users table was not updated.');
    $this
      ->assertNotEquals($times1->timestamp, $times2->timestamp, 'Sessions table was updated.');

    // Write the same value again, i.e. do not modify the session.
    sleep(1);
    $this
      ->drupalGet('session-test/set/foo');
    $times3 = $query
      ->execute()
      ->fetchObject();
    $this
      ->assertEquals($times1->access, $times3->access, 'Users table was not updated.');
    $this
      ->assertEquals($times2->timestamp, $times3->timestamp, 'Sessions table was not updated.');

    // Do not change the session.
    sleep(1);
    $this
      ->drupalGet('');
    $times4 = $query
      ->execute()
      ->fetchObject();
    $this
      ->assertEquals($times3->access, $times4->access, 'Users table was not updated.');
    $this
      ->assertEquals($times3->timestamp, $times4->timestamp, 'Sessions table was not updated.');

    // Force updating of users and sessions table once per second.
    $settings['settings']['session_write_interval'] = (object) [
      'value' => 0,
      'required' => TRUE,
    ];
    $this
      ->writeSettings($settings);
    $this
      ->drupalGet('');
    $times5 = $query
      ->execute()
      ->fetchObject();
    $this
      ->assertNotEquals($times4->access, $times5->access, 'Users table was updated.');
    $this
      ->assertNotEquals($times4->timestamp, $times5->timestamp, 'Sessions table was updated.');
  }

  /**
   * Tests that empty session IDs are not allowed.
   */
  public function testEmptySessionID() {
    $user = $this
      ->drupalCreateUser([]);
    $this
      ->drupalLogin($user);
    $this
      ->drupalGet('session-test/is-logged-in');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Reset the sid in {sessions} to a blank string. This may exist in the
    // wild in some cases, although we normally prevent it from happening.
    Database::getConnection()
      ->update('sessions')
      ->fields([
      'sid' => '',
    ])
      ->condition('uid', $user
      ->id())
      ->execute();

    // Send a blank sid in the session cookie, and the session should no longer
    // be valid. Closing the curl handler will stop the previous session ID
    // from persisting.
    $this->mink
      ->resetSessions();
    $this
      ->drupalGet('session-test/id-from-cookie');

    // Verify that session ID is blank as sent from cookie header.
    $this
      ->assertSession()
      ->responseContains("session_id:\n");

    // Assert that we have an anonymous session now.
    $this
      ->drupalGet('session-test/is-logged-in');
    $this
      ->assertSession()
      ->statusCodeEquals(403);
  }

  /**
   * Tests session bag.
   */
  public function testSessionBag() {

    // Ensure the flag is absent to start with.
    $this
      ->drupalGet('/session-test/has-bag-flag');
    $this
      ->assertSessionCookie(FALSE);
    $this
      ->assertSessionEmpty(TRUE);
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Set the flag.
    $this
      ->drupalGet('/session-test/set-bag-flag');
    $this
      ->assertSessionCookie(TRUE);
    $this
      ->assertSessionEmpty(TRUE);
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Ensure the flag is set.
    $this
      ->drupalGet('/session-test/has-bag-flag');
    $this
      ->assertSessionCookie(TRUE);
    $this
      ->assertSessionEmpty(FALSE);
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Clear the flag.
    $this
      ->drupalGet('/session-test/clear-bag-flag');
    $this
      ->assertSessionCookie(FALSE);
    $this
      ->assertSessionEmpty(FALSE);
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Ensure the flag is absent again.
    $this
      ->drupalGet('/session-test/has-bag-flag');
    $this
      ->assertSessionCookie(FALSE);
    $this
      ->assertSessionEmpty(TRUE);
    $this
      ->assertSession()
      ->statusCodeEquals(200);
  }

  /**
   * Reset the cookie file so that it refers to the specified user.
   */
  public function sessionReset() {

    // Close the internal browser.
    $this->mink
      ->resetSessions();
    $this->loggedInUser = FALSE;

    // Change cookie file for user.
    $this
      ->drupalGet('session-test/get');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
  }

  /**
   * Assert whether the SimpleTest browser sent a session cookie.
   */
  public function assertSessionCookie($sent) {
    if ($sent) {
      $this
        ->assertNotEmpty($this
        ->getSessionCookies()
        ->count(), 'Session cookie was sent.');
    }
    else {
      $this
        ->assertEmpty($this
        ->getSessionCookies()
        ->count(), 'Session cookie was not sent.');
    }
  }

  /**
   * Assert whether $_SESSION is empty at the beginning of the request.
   */
  public function assertSessionEmpty($empty) {
    if ($empty) {
      $this
        ->assertSession()
        ->responseHeaderEquals('X-Session-Empty', '1');
    }
    else {
      $this
        ->assertSession()
        ->responseHeaderEquals('X-Session-Empty', '0');
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertEscaped Deprecated	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated	protected	function	Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertLink Deprecated	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNoText Deprecated	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::assertNoUniqueText Deprecated	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated	protected	function	Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated	protected	function	Gets the current raw content.
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	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::getResponseLogHandler	protected	function	Provides a Guzzle middleware handler to log every response received.
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::$mink	protected	property	Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs	protected	property	Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass	protected	property	Mink class for the default driver to use.	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::drupalGetHeader Deprecated	protected	function	Gets the value of an HTTP response header.
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::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::setUp	protected	function		486
BrowserTestBase::setUpAppRoot	protected	function	Sets up the root application path.
BrowserTestBase::setUpBeforeClass	public static	function		1
BrowserTestBase::tearDown	protected	function		3
BrowserTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
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
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
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::$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.	1
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.	20
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.	1
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
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.	1
SessionTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
SessionTest::$dumpHeaders	protected	property
SessionTest::$modules	protected static	property	Modules to enable. Overrides BrowserTestBase::$modules
SessionTest::assertSessionCookie	public	function	Assert whether the SimpleTest browser sent a session cookie.
SessionTest::assertSessionEmpty	public	function	Assert whether $_SESSION is empty at the beginning of the request.
SessionTest::sessionReset	public	function	Reset the cookie file so that it refers to the specified user.
SessionTest::testDataPersistence	public	function	Tests data persistence via the session_test module callbacks.
SessionTest::testEmptyAnonymousSession	public	function	Tests that empty anonymous sessions are destroyed.
SessionTest::testEmptySessionID	public	function	Tests that empty session IDs are not allowed.
SessionTest::testSessionBag	public	function	Tests session bag.
SessionTest::testSessionPersistenceOnLogin	public	function	Tests storing data in Session() object.
SessionTest::testSessionSaveRegenerate	public	function	Tests for \Drupal\Core\Session\WriteSafeSessionHandler::setSessionWritable() ::isSessionWritable and \Drupal\Core\Session\SessionManager::regenerate().
SessionTest::testSessionWrite	public	function	Tests that sessions are only saved when necessary.
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.	1
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.	1
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 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::cssSelectToXpath	protected	function	Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	2
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 Deprecated	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::isTestUsingGuzzleClient	protected	function	Determines if test is using DrupalTestBrowser.
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.

You are here

class SessionTest in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation