You are here

Home » API reference » SimpleTest 7.2 » drupal_web_test_case.php

class DrupalRemoteTestCase in SimpleTest 7.2

Base class used for writing atomic remote tests.

The test cases are written in such a way that they can be run against a staging or live environment and will clean up after themselves by reverting all peformed actions. The tests should be performed through a set of actions defined in the test method. For example: <code> protected function testFoo() { $this->actions[] = 'login'; }

protected function performLogin(); protected function revertLogin(); </code>

The setUp() and tearDown() methods will not create an environment, but instead direct the internal browser to the remote URL, 'simpletest_remote_url'. The tests will be run against the specified URL instead of the local machine.

The test can also be run against the local development environment by leaving the variable blank. If not specified the remote URL will be filled with the local environment's URL.

Hierarchy

Expanded class hierarchy of DrupalRemoteTestCase

File

./drupal_web_test_case.php, line 3519
Provides DrupalTestCase, DrupalUnitTestCase, and DrupalWebTestCase classes.

View source 
class DrupalRemoteTestCase extends DrupalWebTestCase {

  /**
   * URL variables that need to be changed when running against remote server.
   *
   * @var array
   */
  protected static $URL_VARIABLES = array(
    'base_url',
    'base_secure_url',
    'base_insecure_url',
  );

  /**
   * Prefix to be added to all random strings.
   */
  protected static $REMOTE_PREFIX;

  /**
   * URL of the remote server.
   *
   * @var string
   */
  protected $remoteUrl;

  /**
   * Associative array of original values for the URL variables.
   *
   * @var array
   */
  protected $originalUrls = array();

  /**
   * List of actions to perform.
   *
   * @var array
   */
  protected $actions = array();

  /**
   * Determine when to run against remote environment.
   */
  protected function setUp() {

    //     // BEGIN: Excerpt from DrupalUnitTestCase.
    //     global $conf;
    //
    // Set to that verbose mode works properly.
    $this->originalFileDirectory = variable_get('file_public_path', conf_path() . '/files');

    //
    //     spl_autoload_register('db_autoload');
    //
    //     // Reset all statics so that test is performed with a clean environment.
    //     drupal_static_reset();
    //
    //     // Generate temporary prefixed database to ensure that tests have a clean starting point.
    //     $this->databasePrefix = Database::getConnection()->prefixTables('{simpletest' . mt_rand(1000, 1000000) . '}');
    //     $conf['file_public_path'] = $this->originalFileDirectory . '/' . $this->databasePrefix;
    //
    // Clone the current connection and replace the current prefix.
    $connection_info = Database::getConnectionInfo('default');
    Database::renameConnection('default', 'simpletest_original_default');
    foreach ($connection_info as $target => $value) {
      $connection_info[$target]['prefix'] = array(
        'default' => $value['prefix']['default'] . $this->databasePrefix,
      );
    }
    Database::addConnectionInfo('default', 'default', $connection_info['default']);

    //
    //     // Set user agent to be consistent with web test case.
    //     $_SERVER['HTTP_USER_AGENT'] = $this->databasePrefix;
    //
    //     // If locale is enabled then t() will try to access the database and
    //     // subsequently will fail as the database is not accessible.
    //     $module_list = module_list();
    //     if (isset($module_list['locale'])) {
    //       $this->originalModuleList = $module_list;
    //       unset($module_list['locale']);
    //       module_list(TRUE, FALSE, FALSE, $module_list);
    //     }
    //     // END: Excerpt from DrupalUnitTestCase.
    if (!$this->remoteUrl && !($this->remoteUrl = variable_get('simpletest_remote_url', FALSE))) {
      $this->remoteUrl = url('', array(
        'absolute' => TRUE,
      ));
    }

    // Point the internal browser to the staging site.
    foreach (self::$URL_VARIABLES as $variable) {
      $this->originalUrls[$variable] = $GLOBALS[$variable];
      $GLOBALS[$variable] = $this->remoteUrl;
    }
    $GLOBALS['base_secure_url'] = str_replace('http://', 'https://', $GLOBALS['base_secure_url']);

    // Generate unique remote prefix.
    self::$REMOTE_PREFIX = 'test' . mt_rand(100, 100000);

    // Set the time-limit for the test case.
    drupal_set_time_limit($this->timeLimit);
  }

  /**
   * Perform and revert actions, then tear down based on what setUp() did.
   */
  protected function tearDown() {

    // Perform all actions as part of the test and revert them.
    $this
      ->performActions();
    $this
      ->revertActions();

    // Revert all URL variables to their original values.
    foreach (self::$URL_VARIABLES as $variable) {
      $GLOBALS[$variable] = $this->originalUrls[$variable];
    }

    // BEGIN: Excerpt from DrupalUnitTestCase.
    global $conf;

    // Get back to the original connection.
    Database::removeConnection('default');
    Database::renameConnection('simpletest_original_default', 'default');
    $conf['file_public_path'] = $this->originalFileDirectory;

    //     // Restore modules if necessary.
    //     if (isset($this->originalModuleList)) {
    //       module_list(TRUE, FALSE, FALSE, $this->originalModuleList);
    //     }
    //     // END: Excerpt from DrupalUnitTestCase.
  }

  /**
   * Perform all actions listed in the $actions array.
   */
  protected function performActions() {
    foreach ($this->actions as $action) {
      call_user_func(array(
        $this,
        'perform' . ucfirst($action),
      ));
    }
  }

  /**
   * Revert all actions listed in the $actions array.
   */
  protected function revertActions() {
    foreach ($this->actions as $action) {
      if (method_exists($this, 'revert' . ucfirst($action))) {
        call_user_func(array(
          $this,
          'revert' . ucfirst($action),
        ));
      }
    }
  }

  /**
   * Set the user agent to Drupal.
   */
  protected function curlInitialize() {
    parent::curlInitialize();
    curl_setopt($this->curlHandle, CURLOPT_USERAGENT, 'Drupal (+http://drupal.org/)');
  }

  /**
   * Set the remote URL base.
   *
   * @param $url
   *   Base of the remote URL, for example: http://example.com
   */
  protected function setUrl($url) {
    $prefix = self::$REMOTE_PREFIX;
    $this
      ->tearDown();
    $this->remoteUrl = $url;
    $this
      ->setUp();
    self::$REMOTE_PREFIX = $prefix;
  }

  /**
   * Reset the remote URL base to the value in 'simpletest_remote_url'.
   */
  protected function resetUrl() {
    $this
      ->setUrl(variable_get('simpletest_remote_url', FALSE));
  }

  //  /**
  //   * Set url() option 'alias' to TRUE to ensure no path lookup.
  //   */
  //  protected function drupalGet($path, array $options = array(), array $headers = array()) {
  //    $options['alias'] = TRUE;
  //    return parent::drupalGet($path, $options, $headers);
  //  }
  //
  //  /**
  //   * Set url() option 'alias' to TRUE to ensure no path lookup.
  //   */
  //  protected function drupalPost($path, $edit, $submit, array $options = array(), array $headers = array(), $form_html_id = NULL) {
  //    $options['alias'] = TRUE;
  //    return parent::drupalPost($path, $edit, $submit, $options, $headers, $form_html_id);
  //  }
  //
  //  /**
  //   * Set url() option 'alias' to TRUE to ensure no path lookup.
  //   */
  //  protected function drupalPostAJAX($path, $edit, $triggering_element, $ajax_path = 'system/ajax', array $options = array(), array $headers = array(), $form_html_id = NULL, $ajax_settings = array()) {
  //    $options['alias'] = TRUE;
  //    parent::drupalPostAJAX($path, $edit, $triggering_element, $ajax_path, $options, $headers, $form_html_id, $ajax_settings);
  //  }

  /**
   * Override to ensure not database activity.
   */
  protected function refreshVariables() {

    // Do nothing.
  }

  /**
   * Add remote prefix.
   */
  public static function randomName($length = 8) {
    return self::$REMOTE_PREFIX . parent::randomName($length);
  }

  /**
   * Add remote prefix.
   */
  public static function randomString($length = 8) {
    return self::$REMOTE_PREFIX . parent::randomString($length);
  }

  /**
   * Temporarily revert the global URL variables so verbose links will print.
   */
  protected function verbose($message) {
    if ($this->remoteUrl) {
      foreach (self::$URL_VARIABLES as $variable) {
        $GLOBALS[$variable] = $this->originalUrls[$variable];
      }
    }
    parent::verbose($message);
    if ($this->remoteUrl) {
      foreach (self::$URL_VARIABLES as $variable) {
        $GLOBALS[$variable] = $this->remoteUrl;
      }
      $GLOBALS['base_secure_url'] = str_replace('http://', 'https://', $GLOBALS['base_secure_url']);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DrupalRemoteTestCase::$actions protected property List of actions to perform.
DrupalRemoteTestCase::$originalUrls protected property Associative array of original values for the URL variables.
DrupalRemoteTestCase::$remoteUrl protected property URL of the remote server.
DrupalRemoteTestCase::$REMOTE_PREFIX protected static property Prefix to be added to all random strings.
DrupalRemoteTestCase::$URL_VARIABLES protected static property URL variables that need to be changed when running against remote server.
DrupalRemoteTestCase::curlInitialize protected function Set the user agent to Drupal. Overrides DrupalWebTestCase::curlInitialize
DrupalRemoteTestCase::performActions protected function Perform all actions listed in the $actions array.
DrupalRemoteTestCase::randomName public static function Add remote prefix. Overrides DrupalTestCase::randomName
DrupalRemoteTestCase::randomString public static function Add remote prefix. Overrides DrupalTestCase::randomString
DrupalRemoteTestCase::refreshVariables protected function Override to ensure not database activity. Overrides DrupalWebTestCase::refreshVariables
DrupalRemoteTestCase::resetUrl protected function Reset the remote URL base to the value in 'simpletest_remote_url'.
DrupalRemoteTestCase::revertActions protected function Revert all actions listed in the $actions array.
DrupalRemoteTestCase::setUp protected function Determine when to run against remote environment. Overrides DrupalWebTestCase::setUp
DrupalRemoteTestCase::setUrl protected function Set the remote URL base.
DrupalRemoteTestCase::tearDown protected function Perform and revert actions, then tear down based on what setUp() did. Overrides DrupalWebTestCase::tearDown
DrupalRemoteTestCase::verbose protected function Temporarily revert the global URL variables so verbose links will print. Overrides DrupalTestCase::verbose
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::$results public property Current results of this test case.
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::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.
DrupalTestCase::errorHandler public function Handle errors during test runs.
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::insertAssert public static function Store an assertion from outside the testing context.
DrupalTestCase::pass protected function Fire an assertion that is always positive.
DrupalTestCase::run public function Run all tests in this class.
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::$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::$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::$profile protected property The profile to install as a basis for testing.
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::$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 does not exist in the current page by the given 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::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::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::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::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 Internal helper function; Create a role with specified permissions.
DrupalWebTestCase::drupalCreateUser protected function Create a user with a given set of permissions. The permissions correspond to the names given on the privileges page.
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::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::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
DrupalWebTestCase::preloadRegistry protected function Preload the registry from the testing site.
DrupalWebTestCase::resetAll protected function Reset all data structures after having enabled new modules.
DrupalWebTestCase::setUpInstall protected function Perform Drupal installation. 1
DrupalWebTestCase::setUpVariables protected function Set post-installation variables. 1
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