class SimpleTestExampleTestCase
Same name in other branches
- 6.x-1.x simpletest_example/simpletest_example.test \SimpleTestExampleTestCase
The SimpleTestExampleTestCase is a functional test case, meaning that it actually exercises a particular sequence of actions through the web UI. The majority of core test cases are done this way, but the SimpleTest suite also provides unit tests as demonstrated in the unit test case example later in this file.
Functional test cases are far slower to execute than unit test cases because they require a complete Drupal install to be done for each test.
Hierarchy
- class \DrupalTestCase
- class \DrupalWebTestCase extends \DrupalTestCase
- class \SimpleTestExampleTestCase extends \DrupalWebTestCase
- class \DrupalWebTestCase extends \DrupalTestCase
Expanded class hierarchy of SimpleTestExampleTestCase
See also
SimpleTestUnitTestExampleTestCase
Related topics
File
-
simpletest_example/
simpletest_example.test, line 24
View source
class SimpleTestExampleTestCase extends DrupalWebTestCase {
protected $privilegedUser;
/**
* Give display information to the SimpleTest system.
*
* getInfo() returns a keyed array of information for SimpleTest to show.
*
* It's a good idea to organize your tests consistently using the 'group'
* key.
*/
public static function getInfo() {
return array(
'name' => 'SimpleTest Example',
'description' => 'Ensure that the simpletest_example content type provided functions properly.',
'group' => 'Examples',
);
}
/**
* Set up the test environment.
*
* This method is called once per test method, before the test is executed.
* It gives you a chance to control the setup of the test environment.
*
* If you need a different test environment, then you should create another
* test class which overloads DrupalWebTestCase::setUp() differently.
*
* @see DrupalWebTestCase::setUp()
*/
public function setUp() {
// We call parent::setUp() with the list of modules we want to enable.
// This can be an array or just a list of arguments.
parent::setUp('simpletest_example');
// Create and log in our user. The user has the arbitrary privilege
// 'extra special edit any simpletest_example' which is provided by
// our module to grant access.
$this->privilegedUser = $this->drupalCreateUser(array(
'create simpletest_example content',
'extra special edit any simpletest_example',
));
$this->drupalLogin($this->privilegedUser);
}
/**
* Create a simpletest_example node using the node form.
*/
public function testSimpleTestExampleCreate() {
// Create node to edit.
$edit = array();
$edit['title'] = $this->randomName(8);
$edit["body[und][0][value]"] = $this->randomName(16);
$this->drupalPost('node/add/simpletest-example', $edit, t('Save'));
$this->assertText(t('SimpleTest Example Node Type @title has been created.', array(
'@title' => $edit['title'],
)));
}
/**
* Create a simpletest_example node and then see if our user can edit it.
*/
public function testSimpleTestExampleEdit() {
$settings = array(
'type' => 'simpletest_example',
'title' => $this->randomName(32),
'body' => array(
LANGUAGE_NONE => array(
array(
$this->randomName(64),
),
),
),
);
$node = $this->drupalCreateNode($settings);
// For debugging, we might output the node structure with $this->verbose()
// It would only be output if the testing settings had 'verbose' set.
$this->verbose('Node created: ' . var_export($node, TRUE));
// We'll run this test normally, but not on the testbot, as it would
// indicate that the examples module was failing tests.
if (!$this->runningOnTestbot()) {
// The debug() statement will output information into the test results.
// It can also be used in Drupal 7 anywhere in code and will come out
// as a drupal_set_message().
debug('We are not running on the PIFR testing server, so will go ahead and catch the failure.');
$this->drupalGet("node/{$node->nid}/edit");
// Make sure we don't get a 401 unauthorized response:
$this->assertResponse(200, 'User is allowed to edit the content.');
// Looking for title text in the page to determine whether we were
// successful opening edit form.
$this->assertText(t("@title", array(
'@title' => $settings['title'],
)), "Found title in edit form");
}
}
/**
* Detect if we're running on PIFR testbot.
*
* Skip intentional failure in that case. It happens that on the testbot the
* site under test is in a directory named 'checkout' or 'site_under_test'.
*
* @return bool
* TRUE if running on testbot.
*/
public function runningOnTestbot() {
// @todo: Add this line back once the testbot variable is available.
// https://www.drupal.org/node/2565181
// return env('DRUPALCI');
return TRUE;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DrupalTestCase::$assertions | protected | property | Assertions thrown in that test case. | ||
DrupalTestCase::$databasePrefix | protected | property | The database prefix of this test run. | ||
DrupalTestCase::$originalFileDirectory | protected | property | The original file directory, before it was changed for testing purposes. | ||
DrupalTestCase::$originalLanguage | protected | property | The original language. | ||
DrupalTestCase::$originalLanguageDefault | protected | property | The original default language. | ||
DrupalTestCase::$originalTheme | protected | property | The original theme. | ||
DrupalTestCase::$originalThemeKey | protected | property | The original theme key. | ||
DrupalTestCase::$originalThemePath | protected | property | The original theme path. | ||
DrupalTestCase::$results | public | property | Current results of this test case. | ||
DrupalTestCase::$setup | protected | property | Flag to indicate whether the test has been set up. | ||
DrupalTestCase::$setupDatabasePrefix | protected | property | |||
DrupalTestCase::$setupEnvironment | protected | property | |||
DrupalTestCase::$skipClasses | protected | property | This class is skipped when looking for the source of an assertion. | ||
DrupalTestCase::$testId | protected | property | The test run ID. | ||
DrupalTestCase::$timeLimit | protected | property | Time limit for the test. | ||
DrupalTestCase::$useSetupInstallationCache | public | property | Whether to cache the installation part of the setUp() method. | ||
DrupalTestCase::$useSetupModulesCache | public | property | Whether to cache the modules installation part of the setUp() method. | ||
DrupalTestCase::$verboseDirectoryUrl | protected | property | URL to the verbose output file directory. | ||
DrupalTestCase::assert | protected | function | Internal helper: stores the assert. | ||
DrupalTestCase::assertEqual | protected | function | Check to see if two values are equal. | ||
DrupalTestCase::assertFalse | protected | function | Check to see if a value is false (an empty string, 0, NULL, or FALSE). | ||
DrupalTestCase::assertIdentical | protected | function | Check to see if two values are identical. | ||
DrupalTestCase::assertNotEqual | protected | function | Check to see if two values are not equal. | ||
DrupalTestCase::assertNotIdentical | protected | function | Check to see if two values are not identical. | ||
DrupalTestCase::assertNotNull | protected | function | Check to see if a value is not NULL. | ||
DrupalTestCase::assertNull | protected | function | Check to see if a value is NULL. | ||
DrupalTestCase::assertTrue | protected | function | Check to see if a value is not false (not an empty string, 0, NULL, or FALSE). | ||
DrupalTestCase::deleteAssert | public static | function | Delete an assertion record by message ID. | ||
DrupalTestCase::error | protected | function | Fire an error assertion. | 1 | |
DrupalTestCase::errorHandler | public | function | Handle errors during test runs. | 1 | |
DrupalTestCase::exceptionHandler | protected | function | Handle exceptions. | ||
DrupalTestCase::fail | protected | function | Fire an assertion that is always negative. | ||
DrupalTestCase::generatePermutations | public static | function | Converts a list of possible parameters into a stack of permutations. | ||
DrupalTestCase::getAssertionCall | protected | function | Cycles through backtrace until the first non-assertion method is found. | ||
DrupalTestCase::getDatabaseConnection | public static | function | Returns the database connection to the site running Simpletest. | ||
DrupalTestCase::insertAssert | public static | function | Store an assertion from outside the testing context. | ||
DrupalTestCase::pass | protected | function | Fire an assertion that is always positive. | ||
DrupalTestCase::randomName | public static | function | Generates a random string containing letters and numbers. | ||
DrupalTestCase::randomString | public static | function | Generates a random string of ASCII characters of codes 32 to 126. | ||
DrupalTestCase::run | public | function | Run all tests in this class. | ||
DrupalTestCase::verbose | protected | function | Logs a verbose message in a text file. | ||
DrupalWebTestCase::$additionalCurlOptions | protected | property | Additional cURL options. | ||
DrupalWebTestCase::$content | protected | property | The content of the page currently loaded in the internal browser. | ||
DrupalWebTestCase::$cookieFile | protected | property | The current cookie file used by cURL. | ||
DrupalWebTestCase::$cookies | protected | property | The cookies of the page currently loaded in the internal browser. | ||
DrupalWebTestCase::$curlHandle | protected | property | The handle of the current cURL connection. | ||
DrupalWebTestCase::$drupalSettings | protected | property | The value of the Drupal.settings JavaScript variable for the page currently loaded in the internal browser. | ||
DrupalWebTestCase::$elements | protected | property | The parsed version of the page. | ||
DrupalWebTestCase::$generatedTestFiles | protected | property | Whether the files were copied to the test files directory. | ||
DrupalWebTestCase::$headers | protected | property | The headers of the page currently loaded in the internal browser. | ||
DrupalWebTestCase::$httpauth_credentials | protected | property | HTTP authentication credentials (<username>:<password>). | ||
DrupalWebTestCase::$httpauth_method | protected | property | HTTP authentication method | ||
DrupalWebTestCase::$loggedInUser | protected | property | The current user logged in using the internal browser. | ||
DrupalWebTestCase::$originalCleanUrl | protected | property | The original clean_url variable value. | ||
DrupalWebTestCase::$originalLanguageUrl | protected | property | The original language URL. | ||
DrupalWebTestCase::$originalProfile | protected | property | The original active installation profile. | ||
DrupalWebTestCase::$originalShutdownCallbacks | protected | property | The original shutdown handlers array, before it was cleaned for testing purposes. | ||
DrupalWebTestCase::$originalUser | protected | property | The original user, before it was changed to a clean uid = 1 for testing purposes. | ||
DrupalWebTestCase::$plainTextContent | protected | property | The content of the page currently loaded in the internal browser (plain text version). | ||
DrupalWebTestCase::$private_files_directory | protected | property | The private files directory created for testing purposes. | ||
DrupalWebTestCase::$profile | protected | property | The profile to install as a basis for testing. | 20 | |
DrupalWebTestCase::$public_files_directory | protected | property | The public files directory created for testing purposes. | ||
DrupalWebTestCase::$redirect_count | protected | property | The number of redirects followed during the handling of a request. | ||
DrupalWebTestCase::$session_id | protected | property | The current session ID, if available. | ||
DrupalWebTestCase::$session_name | protected | property | The current session name, if available. | ||
DrupalWebTestCase::$temp_files_directory | protected | property | The temporary files directory created for testing purposes. | ||
DrupalWebTestCase::$url | protected | property | The URL currently loaded in the internal browser. | ||
DrupalWebTestCase::assertField | protected | function | Asserts that a field exists with the given name or ID. | ||
DrupalWebTestCase::assertFieldById | protected | function | Asserts that a field exists in the current page with the given ID and value. | ||
DrupalWebTestCase::assertFieldByName | protected | function | Asserts that a field exists in the current page with the given name and value. | ||
DrupalWebTestCase::assertFieldByXPath | protected | function | Asserts that a field exists in the current page by the given XPath. | ||
DrupalWebTestCase::assertFieldChecked | protected | function | Asserts that a checkbox field in the current page is checked. | ||
DrupalWebTestCase::assertLink | protected | function | Pass if a link with the specified label is found, and optional with the specified index. |
||
DrupalWebTestCase::assertLinkByHref | protected | function | Pass if a link containing a given href (part) is found. | ||
DrupalWebTestCase::assertMail | protected | function | Asserts that the most recently sent e-mail message has the given value. | ||
DrupalWebTestCase::assertMailPattern | protected | function | Asserts that the most recently sent e-mail message has the pattern in it. | ||
DrupalWebTestCase::assertMailString | protected | function | Asserts that the most recently sent e-mail message has the string in it. | ||
DrupalWebTestCase::assertNoDuplicateIds | protected | function | Asserts that each HTML ID is used for just a single element. | ||
DrupalWebTestCase::assertNoField | protected | function | Asserts that a field does not exist with the given name or ID. | ||
DrupalWebTestCase::assertNoFieldById | protected | function | Asserts that a field does not exist with the given ID and value. | ||
DrupalWebTestCase::assertNoFieldByName | protected | function | Asserts that a field does not exist with the given name and value. | ||
DrupalWebTestCase::assertNoFieldByXPath | protected | function | Asserts that a field doesn't exist or its value doesn't match, by XPath. | ||
DrupalWebTestCase::assertNoFieldChecked | protected | function | Asserts that a checkbox field in the current page is not checked. | ||
DrupalWebTestCase::assertNoLink | protected | function | Pass if a link with the specified label is not found. | ||
DrupalWebTestCase::assertNoLinkByHref | protected | function | Pass if a link containing a given href (part) is not found. | ||
DrupalWebTestCase::assertNoOptionSelected | protected | function | Asserts that a select option in the current page is not checked. | ||
DrupalWebTestCase::assertNoPattern | protected | function | Will trigger a pass if the perl regex pattern is not present in raw content. | ||
DrupalWebTestCase::assertNoRaw | 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::assertNoResponse | protected | function | Asserts the page did not return the specified response code. | ||
DrupalWebTestCase::assertNoText | 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::assertNoTitle | protected | function | Pass if the page title is not the given string. | ||
DrupalWebTestCase::assertNoUniqueText | protected | function | Pass if the text is found MORE THAN ONCE on the text version of the page. | ||
DrupalWebTestCase::assertOptionSelected | protected | function | Asserts that a select option in the current page is checked. | ||
DrupalWebTestCase::assertPattern | protected | function | Will trigger a pass if the Perl regex pattern is found in the raw content. | ||
DrupalWebTestCase::assertRaw | 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::assertResponse | protected | function | Asserts the page responds with the specified response code. | ||
DrupalWebTestCase::assertText | 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::assertTextHelper | protected | function | Helper for assertText and assertNoText. | ||
DrupalWebTestCase::assertThemeOutput | protected | function | Asserts themed output. | ||
DrupalWebTestCase::assertTitle | protected | function | Pass if the page title is the given string. | ||
DrupalWebTestCase::assertUniqueText | protected | function | Pass if the text is found ONLY ONCE on the text version of the page. | ||
DrupalWebTestCase::assertUniqueTextHelper | protected | function | Helper for assertUniqueText and assertNoUniqueText. | ||
DrupalWebTestCase::assertUrl | protected | function | Pass if the internal browser's URL matches the given path. | ||
DrupalWebTestCase::buildXPathQuery | protected | function | Builds an XPath query. | ||
DrupalWebTestCase::changeDatabasePrefix | protected | function | Changes the database connection to the prefixed one. | ||
DrupalWebTestCase::checkForMetaRefresh | 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::checkPermissions | protected | function | Check to make sure that the array of permissions are valid. | ||
DrupalWebTestCase::clickLink | protected | function | Follows a link by name. | ||
DrupalWebTestCase::constructFieldXpath | protected | function | Helper function: construct an XPath for the given set of attributes and value. | ||
DrupalWebTestCase::copySetupCache | protected | function | Copy the setup cache from/to another table and files directory. | ||
DrupalWebTestCase::cronRun | protected | function | Runs cron in the Drupal installed by Simpletest. | ||
DrupalWebTestCase::curlClose | protected | function | Close the cURL handler and unset the handler. | ||
DrupalWebTestCase::curlExec | protected | function | Initializes and executes a cURL request. | ||
DrupalWebTestCase::curlHeaderCallback | protected | function | Reads headers and registers errors received from the tested site. | ||
DrupalWebTestCase::curlInitialize | protected | function | Initializes the cURL connection. | ||
DrupalWebTestCase::drupalCompareFiles | protected | function | Compare two files based on size and file name. | ||
DrupalWebTestCase::drupalCreateContentType | protected | function | Creates a custom content type based on default settings. | ||
DrupalWebTestCase::drupalCreateNode | protected | function | Creates a node based on default settings. | ||
DrupalWebTestCase::drupalCreateRole | protected | function | Creates a role with specified permissions. | ||
DrupalWebTestCase::drupalCreateUser | protected | function | Create a user with a given set of permissions. | ||
DrupalWebTestCase::drupalGet | protected | function | Retrieves a Drupal path or an absolute path. | ||
DrupalWebTestCase::drupalGetAJAX | protected | function | Retrieve a Drupal path or an absolute path and JSON decode the result. | ||
DrupalWebTestCase::drupalGetContent | protected | function | Gets the current raw HTML of requested page. | ||
DrupalWebTestCase::drupalGetHeader | 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::drupalGetHeaders | 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::drupalGetMails | protected | function | Gets an array containing all e-mails sent during this test case. | ||
DrupalWebTestCase::drupalGetNodeByTitle | function | Get a node from the database based on its title. | |||
DrupalWebTestCase::drupalGetSettings | protected | function | Gets the value of the Drupal.settings JavaScript variable for the currently loaded page. | ||
DrupalWebTestCase::drupalGetTestFiles | protected | function | Get a list files that can be used in tests. | ||
DrupalWebTestCase::drupalGetToken | protected | function | Generate a token for the currently logged in user. | ||
DrupalWebTestCase::drupalHead | protected | function | Retrieves only the headers for a Drupal path or an absolute path. | ||
DrupalWebTestCase::drupalLogin | protected | function | Log in a user with the internal browser. | ||
DrupalWebTestCase::drupalLogout | protected | function | |||
DrupalWebTestCase::drupalPost | protected | function | Execute a POST request on a Drupal page. It will be done as usual POST request with SimpleBrowser. |
||
DrupalWebTestCase::drupalPostAJAX | protected | function | Execute an Ajax submission. | ||
DrupalWebTestCase::drupalSetContent | 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::drupalSetSettings | protected | function | Sets the value of the Drupal.settings JavaScript variable for the currently loaded page. | ||
DrupalWebTestCase::getAbsoluteUrl | protected | function | Takes a path and returns an absolute path. | ||
DrupalWebTestCase::getAllOptions | protected | function | Get all option elements, including nested options, in a select. | ||
DrupalWebTestCase::getSelectedItem | protected | function | Get the selected value from a select field. | ||
DrupalWebTestCase::getSetupCacheKey | protected | function | Returns the cache key used for the setup caching. | ||
DrupalWebTestCase::getUrl | protected | function | Get the current URL from the cURL handler. | ||
DrupalWebTestCase::handleForm | 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::loadSetupCache | protected | function | Copies the cached tables and files for a cached installation setup. | ||
DrupalWebTestCase::parse | protected | function | Parse content returned from curlExec using DOM and SimpleXML. | ||
DrupalWebTestCase::preloadRegistry | protected | function | Preload the registry from the testing site. | ||
DrupalWebTestCase::prepareDatabasePrefix | protected | function | Generates a database prefix for running tests. | ||
DrupalWebTestCase::prepareEnvironment | protected | function | Prepares the current environment for running the test. | ||
DrupalWebTestCase::recursiveDirectoryCopy | protected | function | Recursively copy one directory to another. | ||
DrupalWebTestCase::refreshVariables | 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::resetAll | protected | function | Reset all data structures after having enabled new modules. | ||
DrupalWebTestCase::storeSetupCache | protected | function | Store the installation setup to a cache. | ||
DrupalWebTestCase::tearDown | protected | function | Delete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix. |
7 | |
DrupalWebTestCase::verboseEmail | protected | function | Outputs to verbose the most recent $count emails sent. | ||
DrupalWebTestCase::xpath | 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::__construct | function | Constructor for DrupalWebTestCase. | Overrides DrupalTestCase::__construct | 1 | |
SimpleTestExampleTestCase::$privilegedUser | protected | property | |||
SimpleTestExampleTestCase::getInfo | public static | function | Give display information to the SimpleTest system. | ||
SimpleTestExampleTestCase::runningOnTestbot | public | function | Detect if we're running on PIFR testbot. | ||
SimpleTestExampleTestCase::setUp | public | function | Set up the test environment. | Overrides DrupalWebTestCase::setUp | |
SimpleTestExampleTestCase::testSimpleTestExampleCreate | public | function | Create a simpletest_example node using the node form. | ||
SimpleTestExampleTestCase::testSimpleTestExampleEdit | public | function | Create a simpletest_example node and then see if our user can edit it. |