session.test in SimpleTest 7

Provides SimpleTests for core session handling functionality.

File

tests/session.test

<?php

/**
 * @file
 * Provides SimpleTests for core session handling functionality.
 */
class SessionTestCase extends DrupalWebTestCase {
  public static function getInfo() {
    return array(
      'name' => 'Session tests',
      'description' => 'Drupal session handling tests.',
      'group' => 'Session',
    );
  }
  function setUp() {
    parent::setUp('session_test');
  }

  /**
   * Tests for drupal_save_session() and drupal_session_regenerate().
   */
  function testSessionSaveRegenerate() {
    $this
      ->assertFalse(drupal_save_session(), t('drupal_save_session() correctly returns FALSE (inside of testing framework) when initially called with no arguments.'), t('Session'));
    $this
      ->assertFalse(drupal_save_session(FALSE), t('drupal_save_session() correctly returns FALSE when called with FALSE.'), t('Session'));
    $this
      ->assertFalse(drupal_save_session(), t('drupal_save_session() correctly returns FALSE when saving has been disabled.'), t('Session'));
    $this
      ->assertTrue(drupal_save_session(TRUE), t('drupal_save_session() correctly returns TRUE when called with TRUE.'), t('Session'));
    $this
      ->assertTrue(drupal_save_session(), t('drupal_save_session() correctly returns TRUE when saving has been enabled.'), t('Session'));

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

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

    // Make sure the session cookie is set as HttpOnly.
    $this
      ->drupalLogin($user);
    $this
      ->assertTrue(preg_match('/HttpOnly/i', $this
      ->drupalGetHeader('Set-Cookie', TRUE)), t('Session cookie is set as HttpOnly.'));
    $this
      ->drupalLogout();

    // Verify that the session is regenerated if a module calls exit
    // in hook_user_login().
    user_save($user, array(
      'name' => 'session_test_user',
    ));
    $user->name = 'session_test_user';
    $this
      ->drupalGet('session-test/id');
    $matches = array();
    preg_match('/\\s*session_id:(.*)\\n/', $this
      ->drupalGetContent(), $matches);
    $this
      ->assertTrue(!empty($matches[1]), t('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 = array(
      'name' => $user->name,
      'pass' => $user->pass_raw,
    );
    $this
      ->drupalPost('user', $edit, t('Log in'));
    $this
      ->drupalGet('user');
    $pass = $this
      ->assertText($user->name, t('Found name: %name', array(
      '%name' => $user->name,
    )), t('User login'));
    $this->_logged_in = $pass;
    $this
      ->drupalGet('session-test/id');
    $matches = array();
    preg_match('/\\s*session_id:(.*)\\n/', $this
      ->drupalGetContent(), $matches);
    $this
      ->assertTrue(!empty($matches[1]), t('Found session ID after logging in.'));
    $this
      ->assertTrue($matches[1] != $original_session, t('Session ID changed after login.'));
  }

  /**
   * Test data persistence via the session_test module callbacks. Also tests
   * drupal_session_count() since session data is already generated here.
   */
  function testDataPersistence() {

    // At the very start, we have no session.
    $expected_anonymous = 0;
    $expected_authenticated = 0;
    $user = $this
      ->drupalCreateUser(array(
      'access content',
    ));

    // Enable sessions.
    $this
      ->sessionReset($user->uid);
    $this
      ->drupalLogin($user);
    $expected_authenticated++;
    $value_1 = $this
      ->randomName();
    $this
      ->drupalGet('session-test/set/' . $value_1);
    $this
      ->assertText($value_1, t('The session value was stored.'), t('Session'));
    $this
      ->drupalGet('session-test/get');
    $this
      ->assertText($value_1, t('Session correctly returned the stored data for an authenticated user.'), t('Session'));

    // Attempt to write over val_1. If drupal_save_session(FALSE) is working.
    // properly, val_1 will still be set.
    $value_2 = $this
      ->randomName();
    $this
      ->drupalGet('session-test/no-set/' . $value_2);
    $this
      ->assertText($value_2, t('The session value was correctly passed to session-test/no-set.'), t('Session'));
    $this
      ->drupalGet('session-test/get');
    $this
      ->assertText($value_1, t('Session data is not saved for drupal_save_session(FALSE).'), t('Session'));

    // Switch browser cookie to anonymous user, then back to user 1.
    $this
      ->sessionReset();
    $this
      ->sessionReset($user->uid);
    $this
      ->assertText($value_1, t('Session data persists through browser close.'), t('Session'));

    // Logout the user and make sure the stored value no longer persists.
    $this
      ->drupalLogout();
    $expected_authenticated--;
    $this
      ->sessionReset();
    $this
      ->drupalGet('session-test/get');
    $this
      ->assertNoText($value_1, t("After logout, previous user's session data is not available."), t('Session'));

    // Now try to store some data as an anonymous user.
    $value_3 = $this
      ->randomName();
    $this
      ->drupalGet('session-test/set/' . $value_3);
    $this
      ->assertText($value_3, t('Session data stored for anonymous user.'), t('Session'));
    $this
      ->drupalGet('session-test/get');
    $this
      ->assertText($value_3, t('Session correctly returned the stored data for an anonymous user.'), t('Session'));

    // Session count should go up since we have started an anonymous session now.
    $expected_anonymous++;

    // Try to store data when drupal_save_session(FALSE).
    $value_4 = $this
      ->randomName();
    $this
      ->drupalGet('session-test/no-set/' . $value_4);
    $this
      ->assertText($value_4, t('The session value was correctly passed to session-test/no-set.'), t('Session'));
    $this
      ->drupalGet('session-test/get');
    $this
      ->assertText($value_3, t('Session data is not saved for drupal_save_session(FALSE).'), t('Session'));

    // Login, the data should persist.
    $this
      ->drupalLogin($user);
    $expected_anonymous--;
    $expected_authenticated++;
    $this
      ->sessionReset($user->uid);
    $this
      ->drupalGet('session-test/get');
    $this
      ->assertNoText($value_1, t('Session has persisted for an authenticated user after logging out and then back in.'), t('Session'));

    // Change session and create another user.
    $user2 = $this
      ->drupalCreateUser(array(
      'access content',
    ));
    $this
      ->sessionReset($user2->uid);
    $this
      ->drupalLogin($user2);
    $expected_authenticated++;

    // Perform drupal_session_count tests here in order to use the session data already generated.
    // Test absolute count.
    $anonymous = drupal_session_count(0, TRUE);
    $authenticated = drupal_session_count(0, FALSE);
    $this
      ->assertEqual($anonymous + $authenticated, $expected_anonymous + $expected_authenticated, t('@count total sessions (expected @expected).', array(
      '@count' => $anonymous + $authenticated,
      '@expected' => $expected_anonymous + $expected_authenticated,
    )), t('Session'));

    // Test anonymous count.
    $this
      ->assertEqual($anonymous, $expected_anonymous, t('@count anonymous sessions (expected @expected).', array(
      '@count' => $anonymous,
      '@expected' => $expected_anonymous,
    )), t('Session'));

    // Test authenticated count.
    $this
      ->assertEqual($authenticated, $expected_authenticated, t('@count authenticated sessions (expected @expected).', array(
      '@count' => $authenticated,
      '@expected' => $expected_authenticated,
    )), t('Session'));

    // Should return 0 sessions from 1 second from now.
    $this
      ->assertEqual(drupal_session_count(time() + 1), 0, t('0 sessions newer than the current time.'), t('Session'));
  }

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

    // Verify that no session is automatically created for anonymous user.
    $this
      ->drupalGet('');
    $this
      ->assertSessionCookie(FALSE);
    $this
      ->assertSessionEmpty(TRUE);

    // The same behavior is expected when caching is enabled.
    variable_set('cache', CACHE_NORMAL);
    $this
      ->drupalGet('');
    $this
      ->assertSessionCookie(FALSE);
    $this
      ->assertSessionEmpty(TRUE);
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'MISS', t('Page was not cached.'));

    // Start a new session by setting a message.
    $this
      ->drupalGet('session-test/set-message');
    $this
      ->assertSessionCookie(TRUE);
    $this
      ->assertTrue($this
      ->drupalGetHeader('Set-Cookie'), t('New session was started.'));

    // 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);
    $this
      ->assertFalse($this
      ->drupalGetHeader('X-Drupal-Cache'), t('Caching was bypassed.'));
    $this
      ->assertText(t('This is a dummy message.'), t('Message was displayed.'));
    $this
      ->assertTrue(preg_match('/SESS\\w+=deleted/', $this
      ->drupalGetHeader('Set-Cookie')), t('Session cookie was deleted.'));

    // Verify that session was destroyed.
    $this
      ->drupalGet('');
    $this
      ->assertSessionCookie(FALSE);
    $this
      ->assertSessionEmpty(TRUE);
    $this
      ->assertNoText(t('This is a dummy message.'), t('Message was not cached.'));
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'HIT', t('Page was cached.'));
    $this
      ->assertFalse($this
      ->drupalGetHeader('Set-Cookie'), t('New session was not started.'));

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

    // Verify that no message is displayed.
    $this
      ->drupalGet('');
    $this
      ->assertSessionCookie(FALSE);
    $this
      ->assertSessionEmpty(TRUE);
    $this
      ->assertNoText(t('This is a dummy message.'), t('The message was not saved.'));
  }

  /**
   * Reset the cookie file so that it refers to the specified user.
   *
   * @param $uid User id to set as the active session.
   */
  function sessionReset($uid = 0) {

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

    // Change cookie file for user.
    $this->cookieFile = file_directory_path('temporary') . '/cookie.' . $uid . '.txt';
    $this->additionalCurlOptions[CURLOPT_COOKIEFILE] = $this->cookieFile;
    $this->additionalCurlOptions[CURLOPT_COOKIESESSION] = TRUE;
    $this
      ->drupalGet('session-test/get');
    $this
      ->assertResponse(200, t('Session test module is correctly enabled.'), t('Session'));
  }

  /**
   * Assert whether the SimpleTest browser sent a session cookie.
   */
  function assertSessionCookie($sent) {
    if ($sent) {
      $this
        ->assertNotNull($this->session_id, t('Session cookie was sent.'));
    }
    else {
      $this
        ->assertNull($this->session_id, t('Session cookie was not sent.'));
    }
  }

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

}

/**
 * Ensure that when running under https two session cookies are generated.
 */
class SessionHttpsTestCase extends DrupalWebTestCase {
  public static function getInfo() {
    return array(
      'name' => 'Session https handling',
      'description' => 'Ensure that when running under https two session cookies are generated.',
      'group' => 'Session',
    );
  }
  public function setUp() {
    parent::setUp('session_test');
  }
  protected function testHttpsSession() {
    global $is_https;
    if ($is_https) {

      // The functionality does not make sense when running on https.
      return;
    }
    $insecure_session_name = session_name();
    $secure_session_name = "S{$insecure_session_name}";

    // Enable secure pages.
    variable_set('https', TRUE);
    $user = $this
      ->drupalCreateUser(array(
      'access administration pages',
    ));
    $this
      ->curlClose();
    $this
      ->drupalGet('session-test/set/1');

    // Check secure cookie on insecure page.
    $this
      ->assertFalse(isset($this->cookies[$secure_session_name]), 'The secure cookie is not sent on insecure pages.');

    // Check insecure cookie on insecure page.
    $this
      ->assertFalse($this->cookies[$insecure_session_name]['secure'], 'The insecure cookie does not have the secure attribute');

    // Check that password request form action is not secure.
    $this
      ->drupalGet('user/password');
    $form = $this
      ->xpath('//form[@id="user-pass"]');
    $this
      ->assertNotEqual(substr($form[0]['action'], 0, 6), 'https:', 'Password request form action is not secure');
    $form[0]['action'] = $this
      ->httpsUrl('user');

    // Check that user login form action is secure.
    $this
      ->drupalGet('user');
    $form =& $this
      ->xpath('//form[@id="user-login"]');
    $this
      ->assertEqual(substr($form[0]['action'], 0, 6), 'https:', 'Login form action is secure');
    $form[0]['action'] = $this
      ->httpsUrl('user');
    $edit = array(
      'name' => $user->name,
      'pass' => $user->pass_raw,
    );
    $this
      ->drupalPost(NULL, $edit, t('Log in'));

    // Check secure cookie on secure page.
    $this
      ->assertTrue($this->cookies[$secure_session_name]['secure'], 'The secure cookie has the secure attribute');

    // Check insecure cookie on secure page.
    $this
      ->assertFalse($this->cookies[$insecure_session_name]['secure'], 'The insecure cookie does not have the secure attribute');
    $args = array(
      ':sid' => $this->cookies[$insecure_session_name]['value'],
      ':ssid' => $this->cookies[$secure_session_name]['value'],
    );
    $this
      ->assertTrue(db_query('SELECT sid FROM {sessions} WHERE sid = :sid AND ssid = :ssid', $args)
      ->fetchField(), 'Session has both SIDs');
    $cookies = array(
      $insecure_session_name . '=' . $args[':sid'],
      $secure_session_name . '=' . $args[':ssid'],
    );
    foreach ($cookies as $cookie_key => $cookie) {
      foreach (array(
        'admin',
        $this
          ->httpsUrl('admin'),
      ) as $url_key => $url) {
        $this
          ->curlClose();
        $this
          ->drupalGet($url, array(), array(
          'Cookie: ' . $cookie,
        ));
        if ($cookie_key == $url_key) {
          $this
            ->assertText(t('Administer'));
        }
        else {
          $this
            ->assertNoText(t('Administer'));
        }
      }
    }
  }
  protected function httpsUrl($url) {
    global $base_url;
    return $base_url . '/modules/simpletest/tests/https.php?q=' . $url;
  }

}

Classes

Name	Description
SessionHttpsTestCase	Ensure that when running under https two session cookies are generated.
SessionTestCase	@file Provides SimpleTests for core session handling functionality.