Base class for file tests that adds some additional file specific assertions and helper functions.
Expanded class hierarchy of FileTestBase
abstract class FileTestBase extends WebTestBase {
function setUp() {
parent::setUp();
// Make sure that custom stream wrappers are registered.
// @todo This has the potential to be a major bug deeply buried in File API;
// file_unmanaged_*() API functions and test functions are invoking native
// PHP functions directly, whereas Drupal's custom stream wrappers are not
// registered yet.
file_get_stream_wrappers();
}
/**
* Check that two files have the same values for all fields other than the
* timestamp.
*
* @param $before
* File object to compare.
* @param $after
* File object to compare.
*/
function assertFileUnchanged($before, $after) {
$this
->assertEqual($before->fid, $after->fid, t('File id is the same: %file1 == %file2.', array(
'%file1' => $before->fid,
'%file2' => $after->fid,
)), 'File unchanged');
$this
->assertEqual($before->uid, $after->uid, t('File owner is the same: %file1 == %file2.', array(
'%file1' => $before->uid,
'%file2' => $after->uid,
)), 'File unchanged');
$this
->assertEqual($before->filename, $after->filename, t('File name is the same: %file1 == %file2.', array(
'%file1' => $before->filename,
'%file2' => $after->filename,
)), 'File unchanged');
$this
->assertEqual($before->uri, $after->uri, t('File path is the same: %file1 == %file2.', array(
'%file1' => $before->uri,
'%file2' => $after->uri,
)), 'File unchanged');
$this
->assertEqual($before->filemime, $after->filemime, t('File MIME type is the same: %file1 == %file2.', array(
'%file1' => $before->filemime,
'%file2' => $after->filemime,
)), 'File unchanged');
$this
->assertEqual($before->filesize, $after->filesize, t('File size is the same: %file1 == %file2.', array(
'%file1' => $before->filesize,
'%file2' => $after->filesize,
)), 'File unchanged');
$this
->assertEqual($before->status, $after->status, t('File status is the same: %file1 == %file2.', array(
'%file1' => $before->status,
'%file2' => $after->status,
)), 'File unchanged');
}
/**
* Check that two files are not the same by comparing the fid and filepath.
*
* @param $file1
* File object to compare.
* @param $file2
* File object to compare.
*/
function assertDifferentFile($file1, $file2) {
$this
->assertNotEqual($file1->fid, $file2->fid, t('Files have different ids: %file1 != %file2.', array(
'%file1' => $file1->fid,
'%file2' => $file2->fid,
)), 'Different file');
$this
->assertNotEqual($file1->uri, $file2->uri, t('Files have different paths: %file1 != %file2.', array(
'%file1' => $file1->uri,
'%file2' => $file2->uri,
)), 'Different file');
}
/**
* Check that two files are the same by comparing the fid and filepath.
*
* @param $file1
* File object to compare.
* @param $file2
* File object to compare.
*/
function assertSameFile($file1, $file2) {
$this
->assertEqual($file1->fid, $file2->fid, t('Files have the same ids: %file1 == %file2.', array(
'%file1' => $file1->fid,
'%file2-fid' => $file2->fid,
)), 'Same file');
$this
->assertEqual($file1->uri, $file2->uri, t('Files have the same path: %file1 == %file2.', array(
'%file1' => $file1->uri,
'%file2' => $file2->uri,
)), 'Same file');
}
/**
* Helper function to test the permissions of a file.
*
* @param $filepath
* String file path.
* @param $expected_mode
* Octal integer like 0664 or 0777.
* @param $message
* Optional message.
*/
function assertFilePermissions($filepath, $expected_mode, $message = NULL) {
// Clear out PHP's file stat cache to be sure we see the current value.
clearstatcache(TRUE, $filepath);
// Mask out all but the last three octets.
$actual_mode = fileperms($filepath) & 0777;
// PHP on Windows has limited support for file permissions. Usually each of
// "user", "group" and "other" use one octal digit (3 bits) to represent the
// read/write/execute bits. On Windows, chmod() ignores the "group" and
// "other" bits, and fileperms() returns the "user" bits in all three
// positions. $expected_mode is updated to reflect this.
if (substr(PHP_OS, 0, 3) == 'WIN') {
// Reset the "group" and "other" bits.
$expected_mode = $expected_mode & 0700;
// Shift the "user" bits to the "group" and "other" positions also.
$expected_mode = $expected_mode | $expected_mode >> 3 | $expected_mode >> 6;
}
if (!isset($message)) {
$message = t('Expected file permission to be %expected, actually were %actual.', array(
'%actual' => decoct($actual_mode),
'%expected' => decoct($expected_mode),
));
}
$this
->assertEqual($actual_mode, $expected_mode, $message);
}
/**
* Helper function to test the permissions of a directory.
*
* @param $directory
* String directory path.
* @param $expected_mode
* Octal integer like 0664 or 0777.
* @param $message
* Optional message.
*/
function assertDirectoryPermissions($directory, $expected_mode, $message = NULL) {
// Clear out PHP's file stat cache to be sure we see the current value.
clearstatcache(TRUE, $directory);
// Mask out all but the last three octets.
$actual_mode = fileperms($directory) & 0777;
// PHP on Windows has limited support for file permissions. Usually each of
// "user", "group" and "other" use one octal digit (3 bits) to represent the
// read/write/execute bits. On Windows, chmod() ignores the "group" and
// "other" bits, and fileperms() returns the "user" bits in all three
// positions. $expected_mode is updated to reflect this.
if (substr(PHP_OS, 0, 3) == 'WIN') {
// Reset the "group" and "other" bits.
$expected_mode = $expected_mode & 0700;
// Shift the "user" bits to the "group" and "other" positions also.
$expected_mode = $expected_mode | $expected_mode >> 3 | $expected_mode >> 6;
}
if (!isset($message)) {
$message = t('Expected directory permission to be %expected, actually were %actual.', array(
'%actual' => decoct($actual_mode),
'%expected' => decoct($expected_mode),
));
}
$this
->assertEqual($actual_mode, $expected_mode, $message);
}
/**
* Create a directory and assert it exists.
*
* @param $path
* Optional string with a directory path. If none is provided, a random
* name in the site's files directory will be used.
* @return
* The path to the directory.
*/
function createDirectory($path = NULL) {
// A directory to operate on.
if (!isset($path)) {
$path = file_default_scheme() . '://' . $this
->randomName();
}
$this
->assertTrue(drupal_mkdir($path) && is_dir($path), 'Directory was created successfully.');
return $path;
}
/**
* Create a file and return the URI of it.
*
* @param $filepath
* Optional string specifying the file path. If none is provided then a
* randomly named file will be created in the site's files directory.
* @param $contents
* Optional contents to save into the file. If a NULL value is provided an
* arbitrary string will be used.
* @param $scheme
* Optional string indicating the stream scheme to use. Drupal core includes
* public, private, and temporary. The public wrapper is the default.
* @return
* File URI.
*/
function createUri($filepath = NULL, $contents = NULL, $scheme = NULL) {
if (!isset($filepath)) {
// Prefix with non-latin characters to ensure that all file-related
// tests work with international filenames.
$filepath = 'Файл для тестирования ' . $this
->randomName();
}
if (!isset($scheme)) {
$scheme = file_default_scheme();
}
$filepath = $scheme . '://' . $filepath;
if (!isset($contents)) {
$contents = "file_put_contents() doesn't seem to appreciate empty strings so let's put in some data.";
}
file_put_contents($filepath, $contents);
$this
->assertTrue(is_file($filepath), t('The test file exists on the disk.'), 'Create test file');
return $filepath;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
WebTestBase:: |
protected | property | The profile to install as a basis for testing. | 35 |
FileTestBase:: |
function |
Sets up a Drupal site for running functional and integration tests. Overrides WebTestBase:: |
9 | |
WebTestBase:: |
protected | function |
Delete created files and temporary files directory, delete the tables created by setUp(),
and reset the database prefix. Overrides TestBase:: |
6 |
TestBase:: |
protected | function | Checks the matching requirements for Test. | 3 |
WebTestBase:: |
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 |
TestBase:: |
protected | function | Fire an error assertion. | 1 |
WebTestBase:: |
protected | property | The parsed version of the page. | 1 |
FileTestBase:: |
function | Check that two files have the same values for all fields other than the timestamp. | ||
FileTestBase:: |
function | Check that two files are not the same by comparing the fid and filepath. | ||
FileTestBase:: |
function | Check that two files are the same by comparing the fid and filepath. | ||
FileTestBase:: |
function | Helper function to test the permissions of a file. | ||
FileTestBase:: |
function | Helper function to test the permissions of a directory. | ||
FileTestBase:: |
function | Create a directory and assert it exists. | ||
FileTestBase:: |
function | Create a file and return the URI of it. | ||
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 | 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 | 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(). | |
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 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. |