SimpleTestExampleMockModuleTestCase allows us to demonstrate how you can use a mock module to aid in functional testing in Backdrop.

If you have some functionality that's not intrinsic to the code under test, you can add a special mock module that only gets installed during test time. This allows you to implement APIs created by your module, or otherwise exercise the code in question.

This test case class is very similar to SimpleTestExampleTestCase. The main difference is that we enable the simpletest_example_test module in the setUp() method. Then we can test for behaviors provided by that module.

Hierarchy

Expanded class hierarchy of SimpleTestExampleMockModuleTestCase

See also

SimpleTestExampleTestCase

Related topics

File

modules/examples/simpletest_example/simpletest_example.test, line 181
An example of simpletest tests to accompany the tutorial at http://DOCUMENTATION_PENDING/node/890654.

Members

Contains filters are case sensitive
Namesort ascending Modifiers Type Description
SimpleTestExampleMockModuleTestCase::testSimpleTestExampleMockModule public function Test modifications made by our mock module.
SimpleTestExampleMockModuleTestCase::setUp public function Set up the test environment. Overrides BackdropWebTestCase::setUp
BackdropWebTestCase::__construct function Constructor for BackdropWebTestCase. Overrides BackdropTestCase::__construct
BackdropWebTestCase::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.
BackdropWebTestCase::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
BackdropWebTestCase::useCache protected function Copies the cached tables and config for a profile if one is available.
BackdropWebTestCase::tearDown protected function Delete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix. Overrides BackdropTestCase::tearDown
BackdropWebTestCase::resetAll protected function Reset all data structures after having enabled new modules.
BackdropWebTestCase::refreshVariables protected function Refresh the in-memory set of variables and state values. Useful after a page request is made that changes a variable in a different thread.
BackdropWebTestCase::recursiveCopy private function Recursively copy one directory to another.
BackdropWebTestCase::prepareEnvironment protected function Prepares the current environment for running the test.
BackdropWebTestCase::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
BackdropWebTestCase::handleForm protected function Handle form input related to backdropPost(). Ensure that the specified fields exist and attempt to create POST data in the correct manner for the particular field type.
BackdropWebTestCase::getUrl protected function Get the current URL from the cURL handler.
BackdropWebTestCase::getSelectedItem protected function Get the selected value from a select field.
BackdropWebTestCase::getAllOptions protected function Get all option elements, including nested options, in a select.
BackdropWebTestCase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
BackdropWebTestCase::curlInitialize protected function Initializes the cURL connection.
BackdropWebTestCase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
BackdropWebTestCase::curlExec protected function Initializes and executes a cURL request.
BackdropWebTestCase::curlClose protected function Close the cURL handler and unset the handler.
BackdropWebTestCase::cronRun protected function Runs cron in the Backdrop installed by SimpleTest.
BackdropWebTestCase::constructFieldXpath protected function Helper function: construct an XPath for the given set of attributes and value.
BackdropWebTestCase::clickLink protected function Follows a link by name.
BackdropWebTestCase::checkPermissions protected function Check to make sure that the array of permissions are valid.
BackdropWebTestCase::checkForMetaRefresh protected function Check for meta refresh tag and if found call backdropGet() recursively. This function looks for the http-equiv attribute to be set to "Refresh" and is case-sensitive.
BackdropWebTestCase::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
BackdropWebTestCase::buildXPathQuery protected function Builds an XPath query.
BackdropWebTestCase::backdropSetSettings protected function Sets the value of the Backdrop.settings JavaScript variable for the currently loaded page.
BackdropWebTestCase::backdropSetContent 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.
BackdropWebTestCase::backdropPostAJAX protected function Execute an Ajax submission.
BackdropWebTestCase::backdropPost protected function Execute a POST request on a Backdrop page. It will be done as usual POST request with SimpleBrowser.
BackdropWebTestCase::backdropLogout protected function
BackdropWebTestCase::backdropLogin protected function Log in a user with the internal browser.
BackdropWebTestCase::backdropHead protected function Retrieves only the headers for a Backdrop path or an absolute path.
BackdropWebTestCase::backdropGetToken protected function Generate a token for the currently logged in user.
BackdropWebTestCase::backdropGetTestFiles protected function Get a list files that can be used in tests.
BackdropWebTestCase::backdropGetSettings protected function Gets the value of the Backdrop.settings JavaScript variable for the currently loaded page.
BackdropWebTestCase::backdropGetNodeByTitle function Get a node from the database based on its title.
BackdropWebTestCase::backdropGetMails protected function Gets an array containing all e-mails sent during this test case.
BackdropWebTestCase::backdropGetHeaders 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…
BackdropWebTestCase::backdropGetHeader 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…
BackdropWebTestCase::backdropGetContent protected function Gets the current raw HTML of requested page.
BackdropWebTestCase::backdropGetAJAX protected function Retrieve a Backdrop path or an absolute path and JSON decode the result.
BackdropWebTestCase::backdropGet protected function Retrieves a Backdrop path or an absolute path.
BackdropWebTestCase::backdropCreateUser protected function Create a user with a given set of permissions.
BackdropWebTestCase::backdropCreateRole protected function Creates a role with specified permissions.
BackdropWebTestCase::backdropCreateNode protected function Creates a node based on default settings.
BackdropWebTestCase::backdropCreateContentType protected function Creates a custom content type based on default settings.
BackdropWebTestCase::backdropCompareFiles protected function Compare two files based on size and file name.
BackdropWebTestCase::assertUrl protected function Pass if the internal browser's URL matches the given path.
BackdropWebTestCase::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
BackdropWebTestCase::assertUniqueText protected function Pass if the text is found ONLY ONCE on the text version of the page.
BackdropWebTestCase::assertTitle protected function Pass if the page title is the given string.
BackdropWebTestCase::assertThemeOutput protected function Asserts themed output.
BackdropWebTestCase::assertTextHelper protected function Helper for assertText and assertNoText.
BackdropWebTestCase::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.
BackdropWebTestCase::assertResponse protected function Asserts the page responds with the specified response code.
BackdropWebTestCase::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.
BackdropWebTestCase::assertPattern protected function Will trigger a pass if the Perl regex pattern is found in the raw content.
BackdropWebTestCase::assertOptionSelected protected function Asserts that a select option in the current page is checked.
BackdropWebTestCase::assertOption protected function Asserts that a select option in the current page exists.
BackdropWebTestCase::assertNoUniqueText protected function Pass if the text is found MORE THAN ONCE on the text version of the page.
BackdropWebTestCase::assertNoTitle protected function Pass if the page title is not the given string.
BackdropWebTestCase::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.
BackdropWebTestCase::assertNoResponse protected function Asserts the page did not return the specified response code.
BackdropWebTestCase::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.
BackdropWebTestCase::assertNoPattern protected function Will trigger a pass if the perl regex pattern is not present in raw content.
BackdropWebTestCase::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
BackdropWebTestCase::assertNoOption protected function Asserts that a select option in the current page does not exist.
BackdropWebTestCase::assertNoLinkByHref protected function Pass if a link containing a given href (part) is not found.
BackdropWebTestCase::assertNoLink protected function Pass if a link with the specified label is not found.
BackdropWebTestCase::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
BackdropWebTestCase::assertNoFieldByXPath protected function Asserts that a field does not exist in the current page by the given XPath.
BackdropWebTestCase::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
BackdropWebTestCase::assertNoFieldById protected function Asserts that a field does not exist with the given id and value.
BackdropWebTestCase::assertNoField protected function Asserts that a field does not exist with the given name or id.
BackdropWebTestCase::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
BackdropWebTestCase::assertMailString protected function Asserts that the most recently sent e-mail message has the string in it.
BackdropWebTestCase::assertMailPattern protected function Asserts that the most recently sent e-mail message has the pattern in it.
BackdropWebTestCase::assertMail protected function Asserts that the most recently sent e-mail message has the given value.
BackdropWebTestCase::assertLinkByHref protected function Pass if a link containing a given href (part) is found.
BackdropWebTestCase::assertLink protected function Pass if a link with the specified label is found, and optional with the specified index.
BackdropWebTestCase::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
BackdropWebTestCase::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
BackdropWebTestCase::assertFieldByName protected function Asserts that a field exists in the current page with the given name and value.
BackdropWebTestCase::assertFieldById protected function Asserts that a field exists in the current page with the given id and value.
BackdropWebTestCase::assertField protected function Asserts that a field exists with the given name or id.
BackdropWebTestCase::$url protected property The URL currently loaded in the internal browser.
BackdropWebTestCase::$temp_files_directory public property
BackdropWebTestCase::$session_name protected property The current session name, if available.
BackdropWebTestCase::$session_id protected property The current session ID, if available.
BackdropWebTestCase::$redirect_count protected property The number of redirects followed during the handling of a request.
BackdropWebTestCase::$public_files_directory public property
BackdropWebTestCase::$profile protected property The profile to install as a basis for testing.
BackdropWebTestCase::$private_files_directory public property
BackdropWebTestCase::$plainTextContent protected property The content of the page currently loaded in the internal browser (plain text version).
BackdropWebTestCase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing purposes.
BackdropWebTestCase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing purposes.
BackdropWebTestCase::$originalSettings protected property The original settings as provided in settings.php.
BackdropWebTestCase::$originalProfile protected property The original installation profile, before changing for testing purposes.
BackdropWebTestCase::$originalCleanUrl protected property The original clean URL setting, before changing for testing purposes.
BackdropWebTestCase::$maximumRedirects protected property The maximum number of redirects to follow when handling responses.
BackdropWebTestCase::$loggedInUser protected property The current user logged in using the internal browser.
BackdropWebTestCase::$headers protected property The headers of the page currently loaded in the internal browser.
BackdropWebTestCase::$generatedTestFiles protected property Whether the files were copied to the test files directory.
BackdropWebTestCase::$elements protected property The parsed version of the page.
BackdropWebTestCase::$curlHandle protected property The handle of the current cURL connection.
BackdropWebTestCase::$cookies protected property An array of cookies set in the most recent cURL request.
BackdropWebTestCase::$cookieFile protected property The current cookie file used by cURL.
BackdropWebTestCase::$content protected property The content of the page currently loaded in the internal browser.
BackdropWebTestCase::$backdropSettings protected property The value of the Backdrop.settings JavaScript variable for the page currently loaded in the internal browser.
BackdropWebTestCase::$additionalCurlOptions protected property Additional cURL options.
BackdropTestCase::verbose protected function Logs a verbose message in a text file.
BackdropTestCase::run public function Run all tests in this class.
BackdropTestCase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
BackdropTestCase::randomName public static function Generates a random string containing letters and numbers.
BackdropTestCase::prepareDatabasePrefix protected function Generates a database prefix for running tests.
BackdropTestCase::pass protected function Fire an assertion that is always positive.
BackdropTestCase::insertAssert public static function Store an assertion from outside the testing context.
BackdropTestCase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
BackdropTestCase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
BackdropTestCase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
BackdropTestCase::fail protected function Fire an assertion that is always negative.
BackdropTestCase::exceptionHandler protected function Handle exceptions.
BackdropTestCase::errorHandler public function Handle errors during test runs.
BackdropTestCase::error protected function Fire an error assertion.
BackdropTestCase::deleteAssert public static function Delete an assertion record by message ID.
BackdropTestCase::checkRequirements protected function Checks the matching requirements for BackdropTestCase.
BackdropTestCase::assertTrue protected function Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
BackdropTestCase::assertNull protected function Check to see if a value is NULL.
BackdropTestCase::assertNotNull protected function Check to see if a value is not NULL.
BackdropTestCase::assertNotIdentical protected function Check to see if two values are not identical.
BackdropTestCase::assertNotEqual protected function Check to see if two values are not equal.
BackdropTestCase::assertIdentical protected function Check to see if two values are identical.
BackdropTestCase::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or FALSE).
BackdropTestCase::assertEqual protected function Check to see if two values are equal.
BackdropTestCase::assert protected function Internal helper: stores the assert.
BackdropTestCase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
BackdropTestCase::$timeLimit protected property Time limit for the test.
BackdropTestCase::$testId protected property The test run ID.
BackdropTestCase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
BackdropTestCase::$setupEnvironment protected property
BackdropTestCase::$setupDatabasePrefix protected property
BackdropTestCase::$setup protected property Flag to indicate whether the test has been set up.
BackdropTestCase::$results public property Current results of this test case.
BackdropTestCase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
BackdropTestCase::$originalConfigDirectories protected property The original config directory array, before changing for testing purposes.
BackdropTestCase::$httpauth_method protected property HTTP authentication method
BackdropTestCase::$httpauth_credentials protected property HTTP authentication credentials (<username>:<password>).
BackdropTestCase::$fileDirectoryName protected property The file directory for this test's files. Usually matches $databasePrefix.
BackdropTestCase::$databasePrefix protected property The database prefix of this test run.
BackdropTestCase::$assertions protected property Assertions thrown in that test case.