class SessionLimitBaseTestCase in Session Limit 7.2
Same name and namespace in other branches
- 8 tests/session_limit.test \SessionLimitBaseTestCase
- 6.2 tests/session_limit.test \SessionLimitBaseTestCase
- 2.x tests/session_limit.test \SessionLimitBaseTestCase
Base test for session limits.
This contains a collection of helper functions and session_limit assertions.
Hierarchy
- class \DrupalTestCase
- class \DrupalWebTestCase
- class \SessionLimitBaseTestCase
- class \DrupalWebTestCase
Expanded class hierarchy of SessionLimitBaseTestCase
File
- tests/
session_limit.test, line 14 - Simpletest tests for session_limit.
View source
class SessionLimitBaseTestCase extends DrupalWebTestCase {
/**
* A store references to different sessions.
*/
protected $curlHandles = array();
protected $loggedInUsers = array();
/**
* Session limit helper function to create 3 roles.
*
* @param stdClass $user
* (optional) If provided the user will be added to
* the three roles.
*
* @return array
* An array of the three roles.
*/
public function sessionLimitMakeRoles($user = NULL) {
// Create roles.
$roles = array();
$roles[] = (object) array(
'name' => 'role1',
);
$roles[] = (object) array(
'name' => 'role2',
);
$roles[] = (object) array(
'name' => 'role3',
);
user_role_save($roles[0]);
user_role_save($roles[1]);
user_role_save($roles[2]);
if (!empty($user)) {
$user->roles[$roles[0]->rid] = $roles[0]->name;
$user->roles[$roles[1]->rid] = $roles[1]->name;
$user->roles[$roles[2]->rid] = $roles[2]->name;
user_save($user);
}
return $roles;
}
/**
* Test that an individual user can have up to a specifed number of sessions.
*
* Once the maximum is reached, the oldest session is logged out.
*
* @param int $session_limit
* The max number of sessions the specified user should be able to access.
* @param stdClass $user
* (optional) The user to test this with. Leave blank to create a user.
*/
public function assertSessionLogout($session_limit, stdClass $user = NULL) {
// Set the session limit behaviour to log out of old sessions.
variable_set('session_limit_behaviour', 1);
variable_set('session_limit_logged_out_message', 'Reached limit @number.');
// Create the user to test with.
$user = empty($user) ? $this
->drupalCreateUser(array(
'access content',
)) : $user;
$sessions = array();
for ($session_number = 1; $session_number <= $session_limit; $session_number++) {
// Log user into each session.
$this
->drupalLogin($user);
$this
->drupalGet('user');
$this
->assertText(t('Log out'), t('User is logged in under session @no.', array(
'@no' => $session_number,
)));
$this
->assertText($user->name, t('User is logged in under session @no.', array(
'@no' => $session_number,
)));
// Backup session.
$sessions[$session_number] = $this
->stashSession();
// Wait briefly to prevent race conditions.
sleep(1);
}
// Check all allowed sessions are currently accessible.
foreach ($sessions as $session_number => $session_id) {
$this
->restoreSession($session_id);
$this
->drupalGet('user');
$this
->assertText(t('Log out'), t('User is logged in under session @no.', array(
'@no' => $session_number,
)));
$this
->assertText($user->name, t('User is logged in under session @no.', array(
'@no' => $session_number,
)));
}
// Create a further session.
$extra_session_number = $session_limit + 1;
$this
->stashSession();
$this
->drupalLogin($user);
$this
->drupalGet('user');
$this
->assertText(t('Log out'), t('User is logged in under session @no.', array(
'@no' => $extra_session_number,
)));
$this
->assertText($user->name, t('User is logged in under session @no.', array(
'@no' => $extra_session_number,
)));
// Check user 1 is no longer logged in on session 1.
$sessions[$extra_session_number] = $this
->stashSession();
$this
->restoreSession($sessions[1]);
$this
->drupalGet('node');
$this
->assertNoText(t('Log out'), t('User 1 is not logged in under session 1.'));
$this
->assertText(t('Reached limit @number.', array(
'@number' => $session_limit,
)), t('User was shown session limit message.'));
// Check user 1 is logged in on all other sessions.
foreach ($sessions as $session_number => $session_id) {
if ($session_number == 1) {
// We know they have been logged out of session 1.
continue;
}
$this
->restoreSession($session_id);
$this
->drupalGet('user');
$this
->assertText(t('Log out'), t('User is logged in under session @no.', array(
'@no' => $session_number,
)));
$this
->assertText($user->name, t('User is logged in under session @no.', array(
'@no' => $session_number,
)));
}
}
/**
* Test that new sessions cannot be created past a maximum.
*
* This tests the session_limit 'prevent new sessions' behaviour once
* the maximum is reached.
*
* @param int $session_limit
* The maximum number of allowed sessions.
*/
public function assertSessionPrevent($session_limit) {
// Set the session limit behaviour to prevent new sessions.
variable_set('session_limit_behaviour', 2);
// Set the default session limit to 1.
variable_set('session_limit_max', $session_limit);
// Create the user to test with.
$user = $this
->drupalCreateUser(array(
'access content',
));
$sessions = array();
for ($session_number = 1; $session_number <= $session_limit; $session_number++) {
// Log user into each session.
$this
->drupalLogin($user);
$this
->drupalGet('user');
$this
->assertText(t('Log out'), t('User is logged in under session @no.', array(
'@no' => $session_number,
)));
$this
->assertText($user->name, t('User is logged in under session @no.', array(
'@no' => $session_number,
)));
// Backup session.
$sessions[$session_number] = $this
->stashSession();
}
// Check all allowed sessions are currently accessible.
foreach ($sessions as $session_number => $session_id) {
$this
->restoreSession($session_id);
$this
->drupalGet('user');
$this
->assertText(t('Log out'), t('User is logged in under session @no.', array(
'@no' => $session_number,
)));
$this
->assertText($user->name, t('User is logged in under session @no.', array(
'@no' => $session_number,
)));
}
// Try to login on a further session.
$this
->stashSession();
$this
->drupalLoginExpectFail($user);
$this
->assertText(t('The maximum number of simultaneous sessions (@session_limit) for your account has been reached. You did not log off from a previous session or someone else is logged on to your account. This may indicate that your account has been compromised or that account sharing is limited on this site. Please contact the site administrator if you suspect your account has been compromised.', array(
'@session_limit' => $session_limit,
)), t('User sees the session limit login prevention message.'));
// Switch back to session 1 and logout.
$extra_session_number = $session_limit + 1;
$sessions[$extra_session_number] = $this
->stashSession();
$this
->restoreSession($sessions[1]);
$this
->drupalLogout($user);
$this
->drupalGet('node');
$this
->assertNoText(t('Log out'), t('User has logged out of session 1.'));
// Switch back to extra session and check they can now login.
$this
->restoreSession($sessions[$extra_session_number]);
$this
->drupalLogin($user);
$this
->drupalGet('node');
$this
->assertText(t('Log out'), t('User has logged into the extra session now they have logged out of session 1.'));
}
/**
* Initialise a new unique session.
*
* @return string
* Unique identifier for the session just stored.
* It is the cookiefile name.
*/
public function stashSession() {
if (empty($this->cookieFile)) {
// No session to stash.
return;
}
// The session_id is the current cookieFile.
$session_id = $this->cookieFile;
$this->curlHandles[$session_id] = $this->curlHandle;
$this->loggedInUsers[$session_id] = $this->loggedInUser;
// Reset Curl.
unset($this->curlHandle);
$this->loggedInUser = FALSE;
// Set a new unique cookie filename.
do {
$this->cookieFile = $this->public_files_directory . '/' . $this
->randomName() . '.jar';
} while (isset($this->curlHandles[$this->cookieFile]));
return $session_id;
}
/**
* Restore a previously stashed session.
*
* @param string $session_id
* The session to restore as returned by stashSession();
* This is also the path to the cookie file.
*
* @return string
* The old session id that was replaced.
*/
public function restoreSession($session_id) {
$old_session_id = NULL;
if (isset($this->curlHandle)) {
$old_session_id = $this
->stashSession();
}
// Restore the specified session.
$this->curlHandle = $this->curlHandles[$session_id];
$this->cookieFile = $session_id;
$this->loggedInUser = $this->loggedInUsers[$session_id];
return $old_session_id;
}
/**
* Close all stashed sessions and the current session.
*/
public function closeAllSessions() {
foreach ($this->curlHandles as $cookie_file => $curl_handle) {
if (isset($curl_handle)) {
curl_close($curl_handle);
}
}
// Make the server forget all sessions.
db_truncate('sessions')
->execute();
$this->curlHandles = array();
$this->loggedInUsers = array();
$this->loggedInUser = FALSE;
$this->cookieFile = $this->public_files_directory . '/' . $this
->randomName() . '.jar';
unset($this->curlHandle);
}
/**
* Log in a user with the internal browser but expect this to fail.
*
* This works as drupalLogin but instead of checking if the login succeeded,
* it instead checks for not being logged in and fails if it has managed
* to login successfully.
*
* @param $account
* User object representing the user to log in.
*
* @see drupalCreateUser()
*/
protected function drupalLoginExpectFail(stdClass $account) {
if ($this->loggedInUser) {
$this
->drupalLogout();
}
$edit = array(
'name' => $account->name,
'pass' => $account->pass_raw,
);
$this
->drupalPost('user', $edit, t('Log in'));
// Check that login was unsuccessful by ensuring there is no log out link.
$pass = $this
->assertNoLink(t('Log out'), 0, t('User %name did not log in.', array(
'%name' => $account->name,
)), t('User login'));
if (!$pass) {
$this->loggedInUser = $account;
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DrupalTestCase:: |
protected | property | Assertions thrown in that test case. | |
DrupalTestCase:: |
protected | property | The database prefix of this test run. | |
DrupalTestCase:: |
protected | property | The original file directory, before it was changed for testing purposes. | |
DrupalTestCase:: |
public | property | Current results of this test case. | |
DrupalTestCase:: |
protected | property | Flag to indicate whether the test has been set up. | |
DrupalTestCase:: |
protected | property | ||
DrupalTestCase:: |
protected | property | ||
DrupalTestCase:: |
protected | property | This class is skipped when looking for the source of an assertion. | |
DrupalTestCase:: |
protected | property | The test run ID. | |
DrupalTestCase:: |
protected | property | Time limit for the test. | |
DrupalTestCase:: |
public | property | Whether to cache the installation part of the setUp() method. | |
DrupalTestCase:: |
public | property | Whether to cache the modules installation part of the setUp() method. | |
DrupalTestCase:: |
protected | property | URL to the verbose output file directory. | |
DrupalTestCase:: |
protected | function | Internal helper: stores the assert. | |
DrupalTestCase:: |
protected | function | Check to see if two values are equal. | |
DrupalTestCase:: |
protected | function | Check to see if a value is false (an empty string, 0, NULL, or FALSE). | |
DrupalTestCase:: |
protected | function | Check to see if two values are identical. | |
DrupalTestCase:: |
protected | function | Check to see if two values are not equal. | |
DrupalTestCase:: |
protected | function | Check to see if two values are not identical. | |
DrupalTestCase:: |
protected | function | Check to see if a value is not NULL. | |
DrupalTestCase:: |
protected | function | Check to see if a value is NULL. | |
DrupalTestCase:: |
protected | function | Check to see if a value is not false (not an empty string, 0, NULL, or FALSE). | |
DrupalTestCase:: |
public static | function | Delete an assertion record by message ID. | |
DrupalTestCase:: |
protected | function | Fire an error assertion. | 1 |
DrupalTestCase:: |
public | function | Handle errors during test runs. | 1 |
DrupalTestCase:: |
protected | function | Handle exceptions. | |
DrupalTestCase:: |
protected | function | Fire an assertion that is always negative. | |
DrupalTestCase:: |
public static | function | Converts a list of possible parameters into a stack of permutations. | |
DrupalTestCase:: |
protected | function | Cycles through backtrace until the first non-assertion method is found. | |
DrupalTestCase:: |
public static | function | Returns the database connection to the site running Simpletest. | |
DrupalTestCase:: |
public static | function | Store an assertion from outside the testing context. | |
DrupalTestCase:: |
protected | function | Fire an assertion that is always positive. | |
DrupalTestCase:: |
public static | function | Generates a random string containing letters and numbers. | |
DrupalTestCase:: |
public static | function | Generates a random string of ASCII characters of codes 32 to 126. | |
DrupalTestCase:: |
public | function | Run all tests in this class. | |
DrupalTestCase:: |
protected | function | Logs a verbose message in a text file. | |
DrupalWebTestCase:: |
protected | property | Additional cURL options. | |
DrupalWebTestCase:: |
protected | property | The content of the page currently loaded in the internal browser. | |
DrupalWebTestCase:: |
protected | property | The current cookie file used by cURL. | |
DrupalWebTestCase:: |
protected | property | The cookies of the page currently loaded in the internal browser. | |
DrupalWebTestCase:: |
protected | property | The handle of the current cURL connection. | |
DrupalWebTestCase:: |
protected | property | The value of the Drupal.settings JavaScript variable for the page currently loaded in the internal browser. | |
DrupalWebTestCase:: |
protected | property | The parsed version of the page. | |
DrupalWebTestCase:: |
protected | property | Whether the files were copied to the test files directory. | |
DrupalWebTestCase:: |
protected | property | The headers of the page currently loaded in the internal browser. | |
DrupalWebTestCase:: |
protected | property | HTTP authentication credentials (<username>:<password>). | |
DrupalWebTestCase:: |
protected | property | HTTP authentication method | |
DrupalWebTestCase:: |
protected | property | The current user logged in using the internal browser. | |
DrupalWebTestCase:: |
protected | property | The original shutdown handlers array, before it was cleaned for testing purposes. | |
DrupalWebTestCase:: |
protected | property | The original user, before it was changed to a clean uid = 1 for testing purposes. | |
DrupalWebTestCase:: |
protected | property | The content of the page currently loaded in the internal browser (plain text version). | |
DrupalWebTestCase:: |
protected | property | The profile to install as a basis for testing. | 20 |
DrupalWebTestCase:: |
protected | property | The number of redirects followed during the handling of a request. | |
DrupalWebTestCase:: |
protected | property | The current session ID, if available. | |
DrupalWebTestCase:: |
protected | property | The current session name, if available. | |
DrupalWebTestCase:: |
protected | property | The URL currently loaded in the internal browser. | |
DrupalWebTestCase:: |
protected | function | Asserts that a field exists with the given name or ID. | |
DrupalWebTestCase:: |
protected | function | Asserts that a field exists in the current page with the given ID and value. | |
DrupalWebTestCase:: |
protected | function | Asserts that a field exists in the current page with the given name and value. | |
DrupalWebTestCase:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
DrupalWebTestCase:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
DrupalWebTestCase:: |
protected | function | Pass if a link with the specified label is found, and optional with the specified index. | |
DrupalWebTestCase:: |
protected | function | Pass if a link containing a given href (part) is found. | |
DrupalWebTestCase:: |
protected | function | Asserts that the most recently sent e-mail message has the given value. | |
DrupalWebTestCase:: |
protected | function | Asserts that the most recently sent e-mail message has the pattern in it. | |
DrupalWebTestCase:: |
protected | function | Asserts that the most recently sent e-mail message has the string in it. | |
DrupalWebTestCase:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
DrupalWebTestCase:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
DrupalWebTestCase:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
DrupalWebTestCase:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
DrupalWebTestCase:: |
protected | function | Asserts that a field doesn't exist or its value doesn't match, by XPath. | |
DrupalWebTestCase:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
DrupalWebTestCase:: |
protected | function | Pass if a link with the specified label is not found. | |
DrupalWebTestCase:: |
protected | function | Pass if a link containing a given href (part) is not found. | |
DrupalWebTestCase:: |
protected | function | Asserts that a select option in the current page is not checked. | |
DrupalWebTestCase:: |
protected | function | Will trigger a pass if the perl regex pattern is not present in raw content. | |
DrupalWebTestCase:: |
protected | function | Pass if the raw text is NOT found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated. | |
DrupalWebTestCase:: |
protected | function | Asserts the page did not return the specified response code. | |
DrupalWebTestCase:: |
protected | function | Pass if the text is NOT found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents. | |
DrupalWebTestCase:: |
protected | function | Pass if the page title is not the given string. | |
DrupalWebTestCase:: |
protected | function | Pass if the text is found MORE THAN ONCE on the text version of the page. | |
DrupalWebTestCase:: |
protected | function | Asserts that a select option in the current page is checked. | |
DrupalWebTestCase:: |
protected | function | Will trigger a pass if the Perl regex pattern is found in the raw content. | |
DrupalWebTestCase:: |
protected | function | Pass if the raw text IS found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated. | |
DrupalWebTestCase:: |
protected | function | Asserts the page responds with the specified response code. | |
DrupalWebTestCase:: |
protected | function | Pass if the text IS found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents. | |
DrupalWebTestCase:: |
protected | function | Helper for assertText and assertNoText. | |
DrupalWebTestCase:: |
protected | function | Asserts themed output. | |
DrupalWebTestCase:: |
protected | function | Pass if the page title is the given string. | |
DrupalWebTestCase:: |
protected | function | Pass if the text is found ONLY ONCE on the text version of the page. | |
DrupalWebTestCase:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
DrupalWebTestCase:: |
protected | function | Pass if the internal browser's URL matches the given path. | |
DrupalWebTestCase:: |
protected | function | Builds an XPath query. | |
DrupalWebTestCase:: |
protected | function | Changes the database connection to the prefixed one. | |
DrupalWebTestCase:: |
protected | function | Check for meta refresh tag and if found call drupalGet() recursively. This function looks for the http-equiv attribute to be set to "Refresh" and is case-sensitive. | |
DrupalWebTestCase:: |
protected | function | Check to make sure that the array of permissions are valid. | |
DrupalWebTestCase:: |
protected | function | Follows a link by name. | |
DrupalWebTestCase:: |
protected | function | Helper function: construct an XPath for the given set of attributes and value. | |
DrupalWebTestCase:: |
protected | function | Copy the setup cache from/to another table and files directory. | |
DrupalWebTestCase:: |
protected | function | Runs cron in the Drupal installed by Simpletest. | |
DrupalWebTestCase:: |
protected | function | Close the cURL handler and unset the handler. | |
DrupalWebTestCase:: |
protected | function | Initializes and executes a cURL request. | |
DrupalWebTestCase:: |
protected | function | Reads headers and registers errors received from the tested site. | |
DrupalWebTestCase:: |
protected | function | Initializes the cURL connection. | |
DrupalWebTestCase:: |
protected | function | Compare two files based on size and file name. | |
DrupalWebTestCase:: |
protected | function | Creates a custom content type based on default settings. | |
DrupalWebTestCase:: |
protected | function | Creates a node based on default settings. | |
DrupalWebTestCase:: |
protected | function | Creates a role with specified permissions. | |
DrupalWebTestCase:: |
protected | function | Create a user with a given set of permissions. | |
DrupalWebTestCase:: |
protected | function | Retrieves a Drupal path or an absolute path. | |
DrupalWebTestCase:: |
protected | function | Retrieve a Drupal path or an absolute path and JSON decode the result. | |
DrupalWebTestCase:: |
protected | function | Gets the current raw HTML of requested page. | |
DrupalWebTestCase:: |
protected | function | Gets the value of an HTTP response header. If multiple requests were required to retrieve the page, only the headers from the last request will be checked by default. However, if TRUE is passed as the second argument, all requests will be processed… | |
DrupalWebTestCase:: |
protected | function | Gets the HTTP response headers of the requested page. Normally we are only interested in the headers returned by the last request. However, if a page is redirected or HTTP authentication is in use, multiple requests will be required to retrieve the… | |
DrupalWebTestCase:: |
protected | function | Gets an array containing all e-mails sent during this test case. | |
DrupalWebTestCase:: |
function | Get a node from the database based on its title. | ||
DrupalWebTestCase:: |
protected | function | Gets the value of the Drupal.settings JavaScript variable for the currently loaded page. | |
DrupalWebTestCase:: |
protected | function | Get a list files that can be used in tests. | |
DrupalWebTestCase:: |
protected | function | Generate a token for the currently logged in user. | |
DrupalWebTestCase:: |
protected | function | Retrieves only the headers for a Drupal path or an absolute path. | |
DrupalWebTestCase:: |
protected | function | Log in a user with the internal browser. | |
DrupalWebTestCase:: |
protected | function | ||
DrupalWebTestCase:: |
protected | function | Execute a POST request on a Drupal page. It will be done as usual POST request with SimpleBrowser. | |
DrupalWebTestCase:: |
protected | function | Execute an Ajax submission. | |
DrupalWebTestCase:: |
protected | function | Sets the raw HTML content. This can be useful when a page has been fetched outside of the internal browser and assertions need to be made on the returned page. | |
DrupalWebTestCase:: |
protected | function | Sets the value of the Drupal.settings JavaScript variable for the currently loaded page. | |
DrupalWebTestCase:: |
protected | function | Takes a path and returns an absolute path. | |
DrupalWebTestCase:: |
protected | function | Get all option elements, including nested options, in a select. | |
DrupalWebTestCase:: |
protected | function | Get the selected value from a select field. | |
DrupalWebTestCase:: |
protected | function | Returns the cache key used for the setup caching. | |
DrupalWebTestCase:: |
protected | function | Get the current URL from the cURL handler. | |
DrupalWebTestCase:: |
protected | function | Handle form input related to drupalPost(). Ensure that the specified fields exist and attempt to create POST data in the correct manner for the particular field type. | |
DrupalWebTestCase:: |
protected | function | Copies the cached tables and files for a cached installation setup. | |
DrupalWebTestCase:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
DrupalWebTestCase:: |
protected | function | Preload the registry from the testing site. | |
DrupalWebTestCase:: |
protected | function | Generates a database prefix for running tests. | |
DrupalWebTestCase:: |
protected | function | Prepares the current environment for running the test. | |
DrupalWebTestCase:: |
protected | function | Recursively copy one directory to another. | |
DrupalWebTestCase:: |
protected | function | Refresh the in-memory set of variables. Useful after a page request is made that changes a variable in a different thread. | 1 |
DrupalWebTestCase:: |
protected | function | Reset all data structures after having enabled new modules. | |
DrupalWebTestCase:: |
protected | function | Sets up a Drupal site for running functional and integration tests. | 303 |
DrupalWebTestCase:: |
protected | function | Store the installation setup to a cache. | |
DrupalWebTestCase:: |
protected | function | Delete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix. | 6 |
DrupalWebTestCase:: |
protected | function | Outputs to verbose the most recent $count emails sent. | |
DrupalWebTestCase:: |
protected | function | Perform an xpath search on the contents of the internal browser. The search is relative to the root element (HTML tag normally) of the page. | |
DrupalWebTestCase:: |
function |
Constructor for DrupalWebTestCase. Overrides DrupalTestCase:: |
1 | |
SessionLimitBaseTestCase:: |
protected | property | A store references to different sessions. | |
SessionLimitBaseTestCase:: |
protected | property | ||
SessionLimitBaseTestCase:: |
public | function | Test that an individual user can have up to a specifed number of sessions. | |
SessionLimitBaseTestCase:: |
public | function | Test that new sessions cannot be created past a maximum. | |
SessionLimitBaseTestCase:: |
public | function | Close all stashed sessions and the current session. | |
SessionLimitBaseTestCase:: |
protected | function | Log in a user with the internal browser but expect this to fail. | |
SessionLimitBaseTestCase:: |
public | function | Restore a previously stashed session. | |
SessionLimitBaseTestCase:: |
public | function | Session limit helper function to create 3 roles. | |
SessionLimitBaseTestCase:: |
public | function | Initialise a new unique session. |