Perform end-to-end tests of the upgrade path.
Expanded class hierarchy of UpgradePathTestBase
abstract class UpgradePathTestBase extends WebTestBase {
/**
* The file path(s) to the dumped database(s) to load into the child site.
*
* @var array
*/
var $databaseDumpFiles = array();
/**
* Flag that indicates whether the child site has been upgraded.
*/
var $upgradedSite = FALSE;
/**
* Array of errors triggered during the upgrade process.
*/
var $upgradeErrors = array();
/**
* Flag to indicate whether there are pending updates or not.
*/
var $pendingUpdates = TRUE;
/**
* Prepares the appropriate session for the release of Drupal being upgraded.
*/
protected function prepareD8Session() {
// Generate and set a D7-compatible session cookie.
$this
->curlInitialize();
$sid = drupal_hash_base64(uniqid(mt_rand(), TRUE) . drupal_random_bytes(55));
curl_setopt($this->curlHandle, CURLOPT_COOKIE, rawurlencode(session_name()) . '=' . rawurlencode($sid));
// Force our way into the session of the child site.
drupal_save_session(TRUE);
_drupal_session_write($sid, '');
drupal_save_session(FALSE);
}
/**
* Checks that zlib is enabled in order to run the upgrade tests.
*/
protected function checkRequirements() {
if (!function_exists('gzopen')) {
return array(
'Missing zlib requirement for upgrade tests.',
);
}
return parent::checkRequirements();
}
/**
* Overrides Drupal\simpletest\WebTestBase::setUp() for upgrade testing.
*
* @see Drupal\simpletest\WebTestBase::prepareDatabasePrefix()
* @see Drupal\simpletest\WebTestBase::changeDatabasePrefix()
* @see Drupal\simpletest\WebTestBase::prepareEnvironment()
*/
protected function setUp() {
global $user, $conf;
// Load the Update API.
require_once DRUPAL_ROOT . '/core/includes/update.inc';
// Reset flags.
$this->upgradedSite = FALSE;
$this->upgradeErrors = array();
// Create the database prefix for this test.
$this
->prepareDatabasePrefix();
// Prepare the environment for running tests.
$this
->prepareEnvironment();
if (!$this->setupEnvironment) {
return FALSE;
}
// Reset all statics and variables to perform tests in a clean environment.
$conf = array();
drupal_static_reset();
// Change the database prefix.
// All static variables need to be reset before the database prefix is
// changed, since Drupal\Core\Utility\CacheArray implementations attempt to
// write back to persistent caches when they are destructed.
$this
->changeDatabasePrefix();
if (!$this->setupDatabasePrefix) {
return FALSE;
}
// Load the database from the portable PHP dump.
// The files may be gzipped.
foreach ($this->databaseDumpFiles as $file) {
if (substr($file, -3) == '.gz') {
$file = "compress.zlib://{$file}";
}
require $file;
}
// Set path variables.
$this
->variable_set('file_public_path', $this->public_files_directory);
$this
->variable_set('file_private_path', $this->private_files_directory);
$this
->variable_set('file_temporary_path', $this->temp_files_directory);
$this
->pass('Finished loading the dump.');
// Ensure that the session is not written to the new environment and replace
// the global $user session with uid 1 from the new test site.
drupal_save_session(FALSE);
// Login as uid 1.
$user = db_query('SELECT * FROM {users} WHERE uid = :uid', array(
':uid' => 1,
))
->fetchObject();
// Generate and set a D8-compatible session cookie.
$this
->prepareD8Session();
// Restore necessary variables.
$this
->variable_set('site_mail', 'simpletest@example.com');
drupal_set_time_limit($this->timeLimit);
$this
->rebuildContainer();
$this->setup = TRUE;
}
/**
* Specialized variable_set() that works even if the child site is not upgraded.
*
* @param $name
* The name of the variable to set.
* @param $value
* The value to set. This can be any PHP data type; these functions take care
* of serialization as necessary.
*
* @todo Update for D8 configuration system.
*/
protected function variable_set($name, $value) {
db_delete('variable')
->condition('name', $name)
->execute();
db_insert('variable')
->fields(array(
'name' => $name,
'value' => serialize($value),
))
->execute();
try {
cache()
->delete('variables');
cache('bootstrap')
->delete('variables');
} catch (Exception $e) {
}
}
/**
* Specialized refreshVariables().
*/
protected function refreshVariables() {
// No operation if the child has not been upgraded yet.
if (!$this->upgradedSite) {
return parent::refreshVariables();
}
}
/**
* Perform the upgrade.
*
* @param $register_errors
* Register the errors during the upgrade process as failures.
* @return
* TRUE if the upgrade succeeded, FALSE otherwise.
*/
protected function performUpgrade($register_errors = TRUE) {
// Load the first update screen.
$this
->getUpdatePhp();
if (!$this
->assertResponse(200)) {
throw new Exception('Initial GET to update.php did not return HTTP 200 status.');
}
// Continue.
$this
->drupalPost(NULL, array(), t('Continue'));
if (!$this
->assertResponse(200)) {
throw new Exception('POST to continue update.php did not return HTTP 200 status.');
}
// The test should pass if there are no pending updates.
$content = $this
->drupalGetContent();
if (strpos($content, t('No pending updates.')) !== FALSE) {
$this
->pass('No pending updates and therefore no upgrade process to test.');
$this->pendingUpdates = FALSE;
return TRUE;
}
// Go!
$this
->drupalPost(NULL, array(), t('Apply pending updates'));
if (!$this
->assertResponse(200)) {
throw new Exception('POST to update.php to apply pending updates did not return HTTP 200 status.');
}
// Check for errors during the update process.
foreach ($this
->xpath('//li[@class=:class]', array(
':class' => 'failure',
)) as $element) {
$message = strip_tags($element
->asXML());
$this->upgradeErrors[] = $message;
if ($register_errors) {
$this
->fail($message);
}
}
if (!empty($this->upgradeErrors)) {
// Upgrade failed, the installation might be in an inconsistent state,
// don't process.
throw new Exception('Errors during update process.');
}
// Check if there still are pending updates.
$this
->getUpdatePhp();
$this
->drupalPost(NULL, array(), t('Continue'));
if (!$this
->assertText(t('No pending updates.'), 'No pending updates at the end of the update process.')) {
throw new Exception('update.php still shows pending updates after execution.');
}
// Upgrade succeed, rebuild the environment so that we can call the API
// of the child site directly from this request.
$this->upgradedSite = TRUE;
// Reload module list for modules that are enabled in the test database
// but not on the test client.
system_list_reset();
module_implements_reset();
module_load_all(FALSE, TRUE);
// Rebuild the container and all caches.
$this
->rebuildContainer();
$this
->resetAll();
return TRUE;
}
/**
* Gets update.php without calling url().
*
* Required since WebTestBase::drupalGet() calls t(), which calls into
* system_list(), from the parent site/test runner, before update.php is even
* executed.
*
* @see WebTestBase::drupalGet()
*/
protected function getUpdatePhp() {
$path = $GLOBALS['base_url'] . '/core/update.php';
$out = $this
->curlExec(array(
CURLOPT_HTTPGET => TRUE,
CURLOPT_URL => $path,
CURLOPT_NOBODY => FALSE,
));
// Ensure that any changes to variables in the other thread are picked up.
$this
->refreshVariables();
// Replace original page output with new output from redirected page(s).
if ($new = $this
->checkForMetaRefresh()) {
$out = $new;
}
$this
->verbose('GET request to: ' . $path . '<hr />Ending URL: ' . $this
->getUrl() . '<hr />' . $out);
return $out;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
UpgradePathTestBase:: |
protected | function | Prepares the appropriate session for the release of Drupal being upgraded. | |
UpgradePathTestBase:: |
protected | function |
Checks that zlib is enabled in order to run the upgrade tests. Overrides TestBase:: |
|
UpgradePathTestBase:: |
protected | function |
Overrides Drupal\simpletest\WebTestBase::setUp() for upgrade testing. Overrides WebTestBase:: |
13 |
UpgradePathTestBase:: |
protected | function | Specialized variable_set() that works even if the child site is not upgraded. | |
UpgradePathTestBase:: |
protected | function |
Specialized refreshVariables(). Overrides WebTestBase:: |
|
UpgradePathTestBase:: |
protected | function | Perform the upgrade. | |
UpgradePathTestBase:: |
protected | function | Gets update.php without calling url(). | |
WebTestBase:: |
function |
Constructor for Drupal\simpletest\WebTestBase. Overrides TestBase:: |
||
WebTestBase:: |
function | Get a node from the database based on its title. | ||
WebTestBase:: |
protected | function | Creates a node based on default settings. | |
WebTestBase:: |
protected | function | Creates a custom content type based on default settings. | |
WebTestBase:: |
protected | function | Get a list files that can be used in tests. | |
WebTestBase:: |
protected | function | Compare two files based on size and file name. | |
WebTestBase:: |
protected | function | Create a user with a given set of permissions. | |
WebTestBase:: |
protected | function | Internal helper function; Create a role with specified permissions. | |
WebTestBase:: |
protected | function | Check to make sure that the array of permissions are valid. | |
WebTestBase:: |
protected | function | Log in a user with the internal browser. | |
WebTestBase:: |
protected | function | Generate a token for the currently logged in user. | |
WebTestBase:: |
protected | function | ||
WebTestBase:: |
protected | function | Reset all data structures after having enabled new modules. | |
WebTestBase:: |
protected | function |
Delete created files and temporary files directory, delete the tables created by setUp(),
and reset the database prefix. Overrides TestBase:: |
6 |
WebTestBase:: |
protected | function | Initializes the cURL connection. | |
WebTestBase:: |
protected | function | Initializes and executes a cURL request. | |
WebTestBase:: |
protected | function | Reads headers and registers errors received from the tested site. | |
WebTestBase:: |
protected | function | Close the cURL handler and unset the handler. | |
WebTestBase:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
WebTestBase:: |
protected | function | Retrieves a Drupal path or an absolute path. | |
WebTestBase:: |
protected | function | Retrieve a Drupal path or an absolute path and JSON decode the result. | |
WebTestBase:: |
protected | function | Execute a POST request on a Drupal page. It will be done as usual POST request with SimpleBrowser. | |
WebTestBase:: |
protected | function | Execute an Ajax submission. | |
WebTestBase:: |
protected | function | Runs cron in the Drupal installed by Simpletest. | |
WebTestBase:: |
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. | |
WebTestBase:: |
protected | function | Retrieves only the headers for a Drupal path or an absolute path. | |
WebTestBase:: |
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. | |
WebTestBase:: |
protected | function | Builds an XPath query. | |
WebTestBase:: |
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. | |
WebTestBase:: |
protected | function | Get all option elements, including nested options, in a select. | |
WebTestBase:: |
protected | function | Pass if a link with the specified label is found, and optional with the specified index. | |
WebTestBase:: |
protected | function | Pass if a link with the specified label is not found. | |
WebTestBase:: |
protected | function | Pass if a link containing a given href (part) is found. | |
WebTestBase:: |
protected | function | Pass if a link containing a given href (part) is not found. | |
WebTestBase:: |
protected | function | Follows a link by name. | |
WebTestBase:: |
protected | function | Takes a path and returns an absolute path. | |
WebTestBase:: |
protected | function | Get the current URL from the cURL handler. | |
WebTestBase:: |
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… | |
WebTestBase:: |
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… | |
WebTestBase:: |
protected | function | Gets the current raw HTML of requested page. | |
WebTestBase:: |
protected | function | Gets the value of the Drupal.settings JavaScript variable for the currently loaded page. | |
WebTestBase:: |
protected | function | Gets an array containing all e-mails sent during this test case. | |
WebTestBase:: |
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. | |
WebTestBase:: |
protected | function | Sets the value of the Drupal.settings JavaScript variable for the currently loaded page. | |
WebTestBase:: |
protected | function | Creates a typed data object and executes some basic assertions. | |
WebTestBase:: |
protected | function | Pass if the internal browser's URL matches the given path. | |
WebTestBase:: |
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. | |
WebTestBase:: |
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. | |
WebTestBase:: |
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. | |
WebTestBase:: |
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. | |
WebTestBase:: |
protected | function | Helper for assertText and assertNoText. | |
WebTestBase:: |
protected | function | Pass if the text is found ONLY ONCE on the text version of the page. | |
WebTestBase:: |
protected | function | Pass if the text is found MORE THAN ONCE on the text version of the page. | |
WebTestBase:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
WebTestBase:: |
protected | function | Will trigger a pass if the Perl regex pattern is found in the raw content. | |
WebTestBase:: |
protected | function | Will trigger a pass if the perl regex pattern is not present in raw content. | |
WebTestBase:: |
protected | function | Pass if the page title is the given string. | |
WebTestBase:: |
protected | function | Pass if the page title is not the given string. | |
WebTestBase:: |
protected | function | Asserts themed output. | |
WebTestBase:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
WebTestBase:: |
protected | function | Get the selected value from a select field. | |
WebTestBase:: |
protected | function | Asserts that a field does not exist in the current page by the given XPath. | |
WebTestBase:: |
protected | function | Asserts that a field exists in the current page with the given name and value. | |
WebTestBase:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
WebTestBase:: |
protected | function | Asserts that a field exists in the current page with the given id and value. | |
WebTestBase:: |
protected | function | Asserts that a field does not exist with the given id and value. | |
WebTestBase:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
WebTestBase:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
WebTestBase:: |
protected | function | Asserts that a select option in the current page exists. | |
WebTestBase:: |
protected | function | Asserts that a select option in the current page does not exist. | |
WebTestBase:: |
protected | function | Asserts that a select option in the current page is checked. | |
WebTestBase:: |
protected | function | Asserts that a select option in the current page is not checked. | |
WebTestBase:: |
protected | function | Asserts that a field exists with the given name or id. | |
WebTestBase:: |
protected | function | Asserts that a field does not exist with the given name or id. | |
WebTestBase:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
WebTestBase:: |
protected | function | Helper function: construct an XPath for the given set of attributes and value. | |
WebTestBase:: |
protected | function | Asserts the page responds with the specified response code. | |
WebTestBase:: |
protected | function | Asserts the page did not return the specified response code. | |
WebTestBase:: |
protected | function | Asserts that the most recently sent e-mail message has the given value. | |
WebTestBase:: |
protected | function | Asserts that the most recently sent e-mail message has the string in it. | |
WebTestBase:: |
protected | function | Asserts that the most recently sent e-mail message has the pattern in it. | |
WebTestBase:: |
protected | function | Outputs to verbose the most recent $count emails sent. | |
TestBase:: |
protected | function | Internal helper: stores the assert. | |
TestBase:: |
public static | function | Store an assertion from outside the testing context. | |
TestBase:: |
public static | function | Delete an assertion record by message ID. | |
TestBase:: |
public static | function | Returns the database connection to the site running Simpletest. | |
TestBase:: |
protected | function | Cycles through backtrace until the first non-assertion method is found. | |
TestBase:: |
protected | function | Check to see if a value is not false (not an empty string, 0, NULL, or FALSE). | |
TestBase:: |
protected | function | Check to see if a value is false (an empty string, 0, NULL, or FALSE). | |
TestBase:: |
protected | function | Check to see if a value is NULL. | |
TestBase:: |
protected | function | Check to see if a value is not NULL. | |
TestBase:: |
protected | function | Check to see if two values are equal. | |
TestBase:: |
protected | function | Check to see if two values are not equal. | |
TestBase:: |
protected | function | Check to see if two values are identical. | |
TestBase:: |
protected | function | Check to see if two values are not identical. | |
TestBase:: |
protected | function | Checks to see if two objects are identical. | |
TestBase:: |
protected | function | Fire an assertion that is always positive. | |
TestBase:: |
protected | function | Fire an assertion that is always negative. | |
TestBase:: |
protected | function | Fire an error assertion. | 1 |
TestBase:: |
protected | function | Logs verbose message in a text file. | |
TestBase:: |
public | function | Run all tests in this class. | |
TestBase:: |
protected | function | Generates a database prefix for running tests. | |
TestBase:: |
protected | function | Changes the database connection to the prefixed one. | |
TestBase:: |
protected | function | Prepares the current environment for running the test. | |
TestBase:: |
protected | function | Rebuild drupal_container(). | |
TestBase:: |
public | function | Handle errors during test runs. | |
TestBase:: |
protected | function | Handle exceptions. | |
TestBase:: |
public static | function | Generates a random string of ASCII characters of codes 32 to 126. | |
TestBase:: |
public static | function | Generates a random string containing letters and numbers. | |
TestBase:: |
public static | function | Generates a random PHP object. | |
TestBase:: |
public static | function | Converts a list of possible parameters into a stack of permutations. | |
TestBase:: |
public static | function | Ensures test files are deletable within file_unmanaged_delete_recursive(). | |
UpgradePathTestBase:: |
property | The file path(s) to the dumped database(s) to load into the child site. | ||
UpgradePathTestBase:: |
property | Flag that indicates whether the child site has been upgraded. | ||
UpgradePathTestBase:: |
property | Array of errors triggered during the upgrade process. | ||
UpgradePathTestBase:: |
property | Flag to indicate whether there are pending updates or not. | ||
WebTestBase:: |
protected | property | The profile to install as a basis for testing. | 35 |
WebTestBase:: |
protected | property | The URL currently loaded in the internal browser. | |
WebTestBase:: |
protected | property | The handle of the current cURL connection. | |
WebTestBase:: |
protected | property | The headers of the page currently loaded in the internal browser. | |
WebTestBase:: |
protected | property | The content of the page currently loaded in the internal browser. | |
WebTestBase:: |
protected | property | The content of the page currently loaded in the internal browser (plain text version). | |
WebTestBase:: |
protected | property | The value of the Drupal.settings JavaScript variable for the page currently loaded in the internal browser. | |
WebTestBase:: |
protected | property | The parsed version of the page. | 1 |
WebTestBase:: |
protected | property | The current user logged in using the internal browser. | |
WebTestBase:: |
protected | property | The current cookie file used by cURL. | |
WebTestBase:: |
protected | property | Additional cURL options. | |
WebTestBase:: |
protected | property | The original user, before it was changed to a clean uid = 1 for testing purposes. | |
WebTestBase:: |
protected | property | The original shutdown handlers array, before it was cleaned for testing purposes. | |
WebTestBase:: |
protected | property | HTTP authentication method | |
WebTestBase:: |
protected | property | HTTP authentication credentials (<username>:<password>). | |
WebTestBase:: |
protected | property | The current session name, if available. | |
WebTestBase:: |
protected | property | The current session ID, if available. | |
WebTestBase:: |
protected | property | Whether the files were copied to the test files directory. | |
WebTestBase:: |
protected | property | The maximum number of redirects to follow when handling responses. | |
WebTestBase:: |
protected | property | The number of redirects followed during the handling of a request. | |
WebTestBase:: |
protected | property | The kernel used in this test. | |
TestBase:: |
protected | property | The test run ID. | |
TestBase:: |
protected | property | The database prefix of this test run. | |
TestBase:: |
protected | property | The original file directory, before it was changed for testing purposes. | |
TestBase:: |
protected | property | Time limit for the test. | |
TestBase:: |
public | property | Current results of this test case. | |
TestBase:: |
protected | property | Assertions thrown in that test case. | |
TestBase:: |
protected | property | This class is skipped when looking for the source of an assertion. | |
TestBase:: |
protected | property | Flag to indicate whether the test has been set up. | |
TestBase:: |
protected | property | ||
TestBase:: |
protected | property | ||
TestBase:: |
protected | property | TRUE if verbose debugging is enabled. | |
TestBase:: |
protected | property | Incrementing identifier for verbose output filenames. | |
TestBase:: |
protected | property | Safe class name for use in verbose output filenames. | |
TestBase:: |
protected | property | Directory where verbose output files are put. | |
TestBase:: |
protected | property | The original database prefix when running inside Simpletest. | |
TestBase:: |
protected | property | URL to the verbose output file directory. |