Skip navigation
Help

FormsFormStorageTestCase

  1. drupal
    1. 7 drupal/modules/simpletest/tests/form.test

Test the form storage on a multistep form.

The tested form puts data into the storage during the initial form construction. These tests verify that there are no duplicate form constructions, with and without manual form caching activiated. Furthermore when a validation error occurs, it makes sure that changed form element values aren't lost due to a wrong form rebuild.

Hierarchy

Properties

NameDescription
DrupalTestCase::$assertionsAssertions thrown in that test case.
DrupalTestCase::$databasePrefixThe database prefix of this test run.
DrupalTestCase::$originalFileDirectoryThe original file directory, before it was changed for testing purposes.
DrupalTestCase::$resultsCurrent results of this test case.
DrupalTestCase::$skipClassesThis class is skipped when looking for the source of an assertion.
DrupalTestCase::$testIdThe test run ID.
DrupalTestCase::$timeLimitTime limit for the test.
DrupalWebTestCase::$additionalCurlOptionsAdditional cURL options.
DrupalWebTestCase::$contentThe content of the page currently loaded in the internal browser.
DrupalWebTestCase::$cookieFileThe current cookie file used by cURL.
DrupalWebTestCase::$curlHandleThe handle of the current cURL connection.
DrupalWebTestCase::$drupalSettingsThe value of the Drupal.settings JavaScript variable for the page currently loaded in the internal browser.
DrupalWebTestCase::$elementsThe parsed version of the page.
DrupalWebTestCase::$generatedTestFilesWhether the files were copied to the test files directory.
DrupalWebTestCase::$headersThe headers of the page currently loaded in the internal browser.
DrupalWebTestCase::$httpauth_credentialsHTTP authentication credentials (<username>:<password>).
DrupalWebTestCase::$httpauth_methodHTTP authentication method
DrupalWebTestCase::$loggedInUserThe current user logged in using the internal browser.
DrupalWebTestCase::$originalShutdownCallbacksThe original shutdown handlers array, before it was cleaned for testing purposes.
DrupalWebTestCase::$originalUserThe original user, before it was changed to a clean uid = 1 for testing purposes.
DrupalWebTestCase::$plainTextContentThe content of the page currently loaded in the internal browser (plain text version).
DrupalWebTestCase::$profileThe profile to install as a basis for testing.
DrupalWebTestCase::$redirect_countThe number of redirects followed during the handling of a request.
DrupalWebTestCase::$session_idThe current session ID, if available.
DrupalWebTestCase::$session_nameThe current session name, if available.
DrupalWebTestCase::$urlThe URL currently loaded in the internal browser.

Functions & methods

NameDescription
DrupalTestCase::assertInternal helper: stores the assert.
DrupalTestCase::assertEqualCheck to see if two values are equal.
DrupalTestCase::assertFalseCheck to see if a value is false (an empty string, 0, NULL, or FALSE).
DrupalTestCase::assertIdenticalCheck to see if two values are identical.
DrupalTestCase::assertNotEqualCheck to see if two values are not equal.
DrupalTestCase::assertNotIdenticalCheck to see if two values are not identical.
DrupalTestCase::assertNotNullCheck to see if a value is not NULL.
DrupalTestCase::assertNullCheck to see if a value is NULL.
DrupalTestCase::assertTrueCheck to see if a value is not false (not an empty string, 0, NULL, or FALSE).
DrupalTestCase::deleteAssertDelete an assertion record by message ID.
DrupalTestCase::errorFire an error assertion.
DrupalTestCase::errorHandlerHandle errors during test runs.
DrupalTestCase::exceptionHandlerHandle exceptions.
DrupalTestCase::failFire an assertion that is always negative.
DrupalTestCase::generatePermutationsConverts a list of possible parameters into a stack of permutations.
DrupalTestCase::getAssertionCallCycles through backtrace until the first non-assertion method is found.
DrupalTestCase::insertAssertStore an assertion from outside the testing context.
DrupalTestCase::passFire an assertion that is always positive.
DrupalTestCase::randomNameGenerates a random string containing letters and numbers.
DrupalTestCase::randomStringGenerates a random string of ASCII characters of codes 32 to 126.
DrupalTestCase::runRun all tests in this class.
DrupalTestCase::verboseLogs verbose message in a text file.
DrupalWebTestCase::assertFieldAsserts that a field exists with the given name or id.
DrupalWebTestCase::assertFieldByIdAsserts that a field exists in the current page with the given id and value.
DrupalWebTestCase::assertFieldByNameAsserts that a field exists in the current page with the given name and value.
DrupalWebTestCase::assertFieldByXPathAsserts that a field exists in the current page by the given XPath.
DrupalWebTestCase::assertFieldCheckedAsserts that a checkbox field in the current page is checked.
DrupalWebTestCase::assertLinkPass if a link with the specified label is found, and optional with the specified index.
DrupalWebTestCase::assertLinkByHrefPass if a link containing a given href (part) is found.
DrupalWebTestCase::assertMailAsserts that the most recently sent e-mail message has the given value.
DrupalWebTestCase::assertMailPatternAsserts that the most recently sent e-mail message has the pattern in it.
DrupalWebTestCase::assertMailStringAsserts that the most recently sent e-mail message has the string in it.
DrupalWebTestCase::assertNoDuplicateIdsAsserts that each HTML ID is used for just a single element.
DrupalWebTestCase::assertNoFieldAsserts that a field does not exist with the given name or id.
DrupalWebTestCase::assertNoFieldByIdAsserts that a field does not exist with the given id and value.
DrupalWebTestCase::assertNoFieldByNameAsserts that a field does not exist with the given name and value.
DrupalWebTestCase::assertNoFieldByXPathAsserts that a field does not exist in the current page by the given XPath.
DrupalWebTestCase::assertNoFieldCheckedAsserts that a checkbox field in the current page is not checked.
DrupalWebTestCase::assertNoLinkPass if a link with the specified label is not found.
DrupalWebTestCase::assertNoLinkByHrefPass if a link containing a given href (part) is not found.
DrupalWebTestCase::assertNoOptionSelectedAsserts that a select option in the current page is not checked.
DrupalWebTestCase::assertNoPatternWill trigger a pass if the perl regex pattern is not present in raw content.
DrupalWebTestCase::assertNoRawPass 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::assertNoResponseAsserts the page did not return the specified response code.
DrupalWebTestCase::assertNoTextPass 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::assertNoTitlePass if the page title is not the given string.
DrupalWebTestCase::assertNoUniqueTextPass if the text is found MORE THAN ONCE on the text version of the page.
DrupalWebTestCase::assertOptionSelectedAsserts that a select option in the current page is checked.
DrupalWebTestCase::assertPatternWill trigger a pass if the Perl regex pattern is found in the raw content.
DrupalWebTestCase::assertRawPass if the raw text IS found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated.
DrupalWebTestCase::assertResponseAsserts the page responds with the specified response code.
DrupalWebTestCase::assertTextPass 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::assertTextHelperHelper for assertText and assertNoText.
DrupalWebTestCase::assertTitlePass if the page title is the given string.
DrupalWebTestCase::assertUniqueTextPass if the text is found ONLY ONCE on the text version of the page.
DrupalWebTestCase::assertUniqueTextHelperHelper for assertUniqueText and assertNoUniqueText.
DrupalWebTestCase::assertUrlPass if the internal browser's URL matches the given path.
DrupalWebTestCase::buildXPathQueryBuilds an XPath query.
DrupalWebTestCase::checkForMetaRefreshCheck 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::checkPermissionsCheck to make sure that the array of permissions are valid.
DrupalWebTestCase::clickLinkFollows a link by name.
DrupalWebTestCase::constructFieldXpathHelper function: construct an XPath for the given set of attributes and value.
DrupalWebTestCase::cronRunRuns cron in the Drupal installed by Simpletest.
DrupalWebTestCase::curlCloseClose the cURL handler and unset the handler.
DrupalWebTestCase::curlExecInitializes and executes a cURL request.
DrupalWebTestCase::curlHeaderCallbackReads headers and registers errors received from the tested site.
DrupalWebTestCase::curlInitializeInitializes the cURL connection.
DrupalWebTestCase::drupalCompareFilesCompare two files based on size and file name.
DrupalWebTestCase::drupalCreateContentTypeCreates a custom content type based on default settings.
DrupalWebTestCase::drupalCreateNodeCreates a node based on default settings.
DrupalWebTestCase::drupalCreateRoleInternal helper function; Create a role with specified permissions.
DrupalWebTestCase::drupalCreateUserCreate a user with a given set of permissions. The permissions correspond to the names given on the privileges page.
DrupalWebTestCase::drupalGetRetrieves a Drupal path or an absolute path.
DrupalWebTestCase::drupalGetAJAXRetrieve a Drupal path or an absolute path and JSON decode the result.
DrupalWebTestCase::drupalGetContentGets the current raw HTML of requested page.
DrupalWebTestCase::drupalGetHeaderGets 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::drupalGetHeadersGets 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::drupalGetMailsGets an array containing all e-mails sent during this test case.
DrupalWebTestCase::drupalGetNodeByTitleGet a node from the database based on its title.
DrupalWebTestCase::drupalGetSettingsGets the value of the Drupal.settings JavaScript variable for the currently loaded page.
DrupalWebTestCase::drupalGetTestFilesGet a list files that can be used in tests.
DrupalWebTestCase::drupalGetTokenGenerate a token for the currently logged in user.
DrupalWebTestCase::drupalHeadRetrieves only the headers for a Drupal path or an absolute path.
DrupalWebTestCase::drupalLoginLog in a user with the internal browser.
DrupalWebTestCase::drupalLogout
DrupalWebTestCase::drupalPostExecute a POST request on a Drupal page. It will be done as usual POST request with SimpleBrowser.
DrupalWebTestCase::drupalPostAJAXExecute an Ajax submission.
DrupalWebTestCase::drupalSetContentSets 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::drupalSetSettingsSets the value of the Drupal.settings JavaScript variable for the currently loaded page.
DrupalWebTestCase::getAbsoluteUrlTakes a path and returns an absolute path.
DrupalWebTestCase::getAllOptionsGet all option elements, including nested options, in a select.
DrupalWebTestCase::getSelectedItemGet the selected value from a select field.
DrupalWebTestCase::getUrlGet the current url from the cURL handler.
DrupalWebTestCase::handleFormHandle 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::parseParse content returned from curlExec using DOM and SimpleXML.
DrupalWebTestCase::preloadRegistryPreload the registry from the testing site.
DrupalWebTestCase::refreshVariablesRefresh the in-memory set of variables. Useful after a page request is made that changes a variable in a different thread.
DrupalWebTestCase::resetAllReset all data structures after having enabled new modules.
DrupalWebTestCase::tearDownDelete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix.
DrupalWebTestCase::verboseEmailOutputs to verbose the most recent $count emails sent.
DrupalWebTestCase::xpathPerform 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::__constructConstructor for DrupalWebTestCase. Overrides DrupalTestCase::__construct
FormsFormStorageTestCase::getInfo
FormsFormStorageTestCase::setUpGenerates a random database prefix, runs the install scripts on the prefixed database and enable the specified modules. After installation many caches are flushed and the internal browser is setup so that the page requests will run on the new prefix.… Overrides DrupalWebTestCase::setUp
FormsFormStorageTestCase::testCachedFormStorageValidationTests updating cached form storage during form validation.
FormsFormStorageTestCase::testFormTests using the form in a usual way.
FormsFormStorageTestCase::testFormCachedTests using the form with an activated $form_state['cache'] property.
FormsFormStorageTestCase::testFormStatePersistTests a form using form state without using 'storage' to pass data from the constructor to a submit handler. The data has to persist even when caching gets activated, what may happen when a modules alter the form and adds #ajax properties.
FormsFormStorageTestCase::testValidationTests validation when form storage is used.

File

drupal/modules/simpletest/tests/form.test, line 875
Unit tests for the Drupal Form API.

View source
class FormsFormStorageTestCase extends DrupalWebTestCase {

  public static function getInfo() {
    return array(
      'name' => 'Multistep form using form storage', 
      'description' => 'Tests a multistep form using form storage and makes sure validation and caching works right.', 
      'group' => 'Form API',
    );
  }

  function setUp() {
    parent::setUp('form_test');

    $this->web_user = $this->drupalCreateUser(array('access content'));
    $this->drupalLogin($this->web_user);
  }

  /**
   * Tests using the form in a usual way.
   */
  function testForm() {
    $this->drupalGet('form_test/form-storage');
    $this->assertText('Form constructions: 1');

    $edit = array(
      'title' => 'new',
      'value' => 'value_is_set',
    );

    // Use form rebuilding triggered by a submit button.
    $this->drupalPost(NULL, $edit, 'Continue submit');
    $this->assertText('Form constructions: 2');
    $this->assertText('Form constructions: 3');

    // Reset the form to the values of the storage, using a form rebuild
    // triggered by button of type button.
    $this->drupalPost(NULL, array('title' => 'changed'), 'Reset');
    $this->assertFieldByName('title', 'new', 'Values have been resetted.');
    // After rebuilding, the form has been cached.
    $this->assertText('Form constructions: 4');

    $this->drupalPost(NULL, $edit, 'Save');
    $this->assertText('Form constructions: 4');
    $this->assertText('Title: new', t('The form storage has stored the values.'));
  }

  /**
   * Tests using the form with an activated $form_state['cache'] property.
   */
  function testFormCached() {
    $this->drupalGet('form_test/form-storage', array('query' => array('cache' => 1)));
    $this->assertText('Form constructions: 1');

    $edit = array(
      'title' => 'new',
      'value' => 'value_is_set',
    );

    // Use form rebuilding triggered by a submit button.
    $this->drupalPost(NULL, $edit, 'Continue submit');
    $this->assertText('Form constructions: 2');

    // Reset the form to the values of the storage, using a form rebuild
    // triggered by button of type button.
    $this->drupalPost(NULL, array('title' => 'changed'), 'Reset');
    $this->assertFieldByName('title', 'new', 'Values have been resetted.');
    $this->assertText('Form constructions: 3');

    $this->drupalPost(NULL, $edit, 'Save');
    $this->assertText('Form constructions: 3');
    $this->assertText('Title: new', t('The form storage has stored the values.'));
  }

  /**
   * Tests validation when form storage is used.
   */
  function testValidation() {
    $this->drupalPost('form_test/form-storage', array('title' => '', 'value' => 'value_is_set'), 'Continue submit');
    $this->assertPattern('/value_is_set/', t('The input values have been kept.'));
  }

  /**
   * Tests updating cached form storage during form validation.
   *
   * If form caching is enabled and a form stores data in the form storage, then
   * the form storage also has to be updated in case of a validation error in
   * the form. This test re-uses the existing form for multi-step tests, but
   * triggers a special #element_validate handler to update the form storage
   * during form validation, while another, required element in the form
   * triggers a form validation error.
   */
  function testCachedFormStorageValidation() {
    // Request the form with 'cache' query parameter to enable form caching.
    $this->drupalGet('form_test/form-storage', array('query' => array('cache' => 1)));

    // Skip step 1 of the multi-step form, since the first step copies over
    // 'title' into form storage, but we want to verify that changes in the form
    // storage are updated in the cache during form validation.
    $edit = array('title' => 'foo');
    $this->drupalPost(NULL, $edit, 'Continue submit');

    // In step 2, trigger a validation error for the required 'title' field, and
    // post the special 'change_title' value for the 'value' field, which
    // conditionally invokes the #element_validate handler to update the form
    // storage.
    $edit = array(
      'title' => '',
      'value' => 'change_title',
    );
    $this->drupalPost(NULL, $edit, 'Save');

    // At this point, the form storage should contain updated values, but we do
    // not see them, because the form has not been rebuilt yet due to the
    // validation error. Post again and verify that the rebuilt form contains
    // the values of the updated form storage.
    $this->drupalPost(NULL, array('title' => 'foo', 'value' => 'bar'), 'Save');
    $this->assertText("The thing has been changed.", 'The altered form storage value was updated in cache and taken over.');
  }

  /**
   * Tests a form using form state without using 'storage' to pass data from the
   * constructor to a submit handler. The data has to persist even when caching
   * gets activated, what may happen when a modules alter the form and adds
   * #ajax properties.
   */
  function testFormStatePersist() {
    // Test the form one time with caching activated and one time without.
    $run_options = array(
      array(),
      array('query' => array('cache' => 1)),
    );
    foreach ($run_options as $options) {
      $this->drupalPost('form-test/state-persist', array(), t('Submit'), $options);
      // The submit handler outputs the value in $form_state, assert it's there.
      $this->assertText('State persisted.');

      // Test it again, but first trigger a validation error, then test.
      $this->drupalPost('form-test/state-persist', array('title' => ''), t('Submit'), $options);
      $this->assertText(t('!name field is required.', array('!name' => 'title')));
      // Submit the form again triggering no validation error.
      $this->drupalPost(NULL, array('title' => 'foo'), t('Submit'), $options);
      $this->assertText('State persisted.');

      // Now post to the rebuilt form and verify it's still there afterwards.
      $this->drupalPost(NULL, array('title' => 'bar'), t('Submit'), $options);
      $this->assertText('State persisted.');
    }
  }
}