You are here

class EntityMetadataTestCase in Entity API 7

Tests metadata wrappers.

Hierarchy

Expanded class hierarchy of EntityMetadataTestCase

File

./entity.test, line 698
Entity CRUD API tests.

View source
class EntityMetadataTestCase extends EntityWebTestCase {
  public static function getInfo() {
    return array(
      'name' => 'Metadata Wrapper',
      'description' => 'Makes sure metadata wrapper are working right.',
      'group' => 'Entity API',
    );
  }
  protected function setUp() {
    parent::setUp('entity', 'entity_test', 'locale');

    // Create a field having 4 values for testing multiple value support.
    $this->field_name = drupal_strtolower($this
      ->randomName() . '_field_name');
    $this->field = array(
      'field_name' => $this->field_name,
      'type' => 'text',
      'cardinality' => 4,
    );
    $this->field = field_create_field($this->field);
    $this->field_id = $this->field['id'];
    $this->instance = array(
      'field_name' => $this->field_name,
      'entity_type' => 'node',
      'bundle' => 'page',
      'label' => $this
        ->randomName() . '_label',
      'description' => $this
        ->randomName() . '_description',
      'weight' => mt_rand(0, 127),
      'settings' => array(
        'text_processing' => FALSE,
      ),
      'widget' => array(
        'type' => 'text_textfield',
        'label' => 'Test Field',
        'settings' => array(
          'size' => 64,
        ),
      ),
    );
    field_create_instance($this->instance);

    // Make the body field and the node type 'page' translatable.
    $field = field_info_field('body');
    $field['translatable'] = TRUE;
    field_update_field($field);
    variable_set('language_content_type_page', 1);
  }

  /**
   * Creates a user and a node, then tests getting the properties.
   */
  public function testEntityMetadataWrapper() {
    $account = $this
      ->drupalCreateUser();

    // For testing sanitizing give the user a malicious user name.
    $account = user_save($account, array(
      'name' => '<b>BadName</b>',
    ));
    $title = '<b>Is it bold?<b>';
    $body[LANGUAGE_NONE][0] = array(
      'value' => '<b>The body & nothing.</b>',
      'summary' => '<b>The body.</b>',
    );
    $node = $this
      ->drupalCreateNode(array(
      'uid' => $account->uid,
      'name' => $account->name,
      'body' => $body,
      'title' => $title,
      'summary' => '',
      'type' => 'page',
    ));

    // First test without sanitizing.
    $wrapper = entity_metadata_wrapper('node', $node);
    $this
      ->assertEqual('<b>Is it bold?<b>', $wrapper->title
      ->value(), 'Getting a field value.');
    $this
      ->assertEqual($node->title, $wrapper->title
      ->raw(), 'Getting a raw property value.');

    // Test chaining.
    $this
      ->assertEqual($account->mail, $wrapper->author->mail
      ->value(), 'Testing chained usage.');
    $this
      ->assertEqual($account->name, $wrapper->author->name
      ->value(), 'Testing chained usage with callback and sanitizing.');

    // Test sanitized output.
    $options = array(
      'sanitize' => TRUE,
    );
    $this
      ->assertEqual(check_plain('<b>Is it bold?<b>'), $wrapper->title
      ->value($options), 'Getting sanitized field.');
    $this
      ->assertEqual(filter_xss($node->name), $wrapper->author->name
      ->value($options), 'Getting sanitized property with getter callback.');

    // Test getting an not existing property.
    try {
      echo $wrapper->dummy;
      $this
        ->fail('Getting an not existing property.');
    } catch (EntityMetadataWrapperException $e) {
      $this
        ->pass('Getting an not existing property.');
    }

    // Test setting.
    $wrapper->author = 0;
    $this
      ->assertEqual(0, $wrapper->author->uid
      ->value(), 'Setting a property.');
    try {
      $wrapper->url = 'dummy';
      $this
        ->fail('Setting an unsupported property.');
    } catch (EntityMetadataWrapperException $e) {
      $this
        ->pass('Setting an unsupported property.');
    }

    // Test value validation.
    $this
      ->assertFalse($wrapper->author->name
      ->validate(array(
      3,
    )), 'Validation correctly checks for valid data types.');
    try {
      $wrapper->author->mail = 'foo';
      $this
        ->fail('An invalid mail address has been set.');
    } catch (EntityMetadataWrapperException $e) {
      $this
        ->pass('Setting an invalid mail address throws exception.');
    }

    // Test unsetting a required property.
    try {
      $wrapper->author = NULL;
      $this
        ->fail('The required node author has been unset.');
    } catch (EntityMetadataWrapperException $e) {
      $this
        ->pass('Unsetting the required node author throws an exception.');
    }

    // Test setting a referenced entity by id.
    $wrapper->author
      ->set($GLOBALS['user']->uid);
    $this
      ->assertEqual($wrapper->author
      ->getIdentifier(), $GLOBALS['user']->uid, 'Get the identifier of a referenced entity.');
    $this
      ->assertEqual($wrapper->author->uid
      ->value(), $GLOBALS['user']->uid, 'Successfully set referenced entity using the identifier.');

    // Set by object.
    $wrapper->author
      ->set($GLOBALS['user']);
    $this
      ->assertEqual($wrapper->author->uid
      ->value(), $GLOBALS['user']->uid, 'Successfully set referenced entity using the entity.');

    // Test getting by the field API processed values like the node body.
    $body_value = $wrapper->body->value;
    $this
      ->assertEqual("<p>The body &amp; nothing.</p>\n", $body_value
      ->value(), "Getting processed value.");
    $this
      ->assertEqual("The body & nothing.\n", $body_value
      ->value(array(
      'decode' => TRUE,
    )), "Decoded value.");
    $this
      ->assertEqual("<b>The body & nothing.</b>", $body_value
      ->raw(), "Raw body returned.");

    // Test getting the summary.
    $this
      ->assertEqual("<p>The body.</p>\n", $wrapper->body->summary
      ->value(), "Getting body summary.");
    $wrapper->body
      ->set(array(
      'value' => "<b>The second body.</b>",
    ));
    $this
      ->assertEqual("<p>The second body.</p>\n", $wrapper->body->value
      ->value(), "Setting a processed field value and reading it again.");
    $this
      ->assertEqual($node->body[LANGUAGE_NONE][0]['value'], "<b>The second body.</b>", 'Update appears in the wrapped entity.');
    $this
      ->assert(isset($node->body[LANGUAGE_NONE][0]['safe_value']), 'Formatted text has been processed.');

    // Test translating the body on an English node.
    locale_add_language('de');
    $body['en'][0] = array(
      'value' => '<b>English body.</b>',
      'summary' => '<b>The body.</b>',
    );
    $node = $this
      ->drupalCreateNode(array(
      'body' => $body,
      'language' => 'en',
      'type' => 'page',
    ));
    $wrapper = entity_metadata_wrapper('node', $node);
    $wrapper
      ->language('de');
    $languages = language_list();
    $this
      ->assertEqual($wrapper
      ->getPropertyLanguage(), $languages['de'], 'Wrapper language has been set to German');
    $this
      ->assertEqual($wrapper->body->value
      ->value(), "<p>English body.</p>\n", 'Language fallback on default language.');

    // Set a German text using the wrapper.
    $wrapper->body
      ->set(array(
      'value' => "<b>Der zweite Text.</b>",
    ));
    $this
      ->assertEqual($wrapper->body->value
      ->value(), "<p>Der zweite Text.</p>\n", 'German body set and retrieved.');
    $wrapper
      ->language(LANGUAGE_NONE);
    $this
      ->assertEqual($wrapper->body->value
      ->value(), "<p>English body.</p>\n", 'Default language text is still there.');

    // Test iterator.
    $type_info = entity_get_property_info('node');
    $this
      ->assertFalse(array_diff_key($type_info['properties'], iterator_to_array($wrapper
      ->getIterator())), 'Iterator is working.');
    foreach ($wrapper as $property) {
      $this
        ->assertTrue($property instanceof EntityMetadataWrapper, 'Iterate over wrapper properties.');
    }

    // Test setting a new node.
    $node->title = 'foo';
    $wrapper
      ->set($node);
    $this
      ->assertEqual($wrapper->title
      ->value(), 'foo', 'Changed the wrapped node.');

    // Test getting options lists.
    $this
      ->assertEqual($wrapper->type
      ->optionsList(), node_type_get_names(), 'Options list returned.');

    // Test making use of a generic 'entity' reference property the
    // 'entity_test' module provides. The property defaults to the node author.
    $this
      ->assertEqual($wrapper->reference->uid
      ->value(), $wrapper->author
      ->getIdentifier(), 'Used generic entity reference property.');

    // Test updating a property of the generic entity reference.
    $wrapper->reference->name
      ->set('foo');
    $this
      ->assertEqual($wrapper->reference->name
      ->value(), 'foo', 'Updated property of generic entity reference');

    // For testing, just point the reference to the node itself now.
    $wrapper->reference
      ->set($wrapper);
    $this
      ->assertEqual($wrapper->reference->nid
      ->value(), $wrapper
      ->getIdentifier(), 'Correctly updated the generic entity referenced property.');

    // Test saving and deleting.
    $wrapper
      ->save();
    $wrapper
      ->delete();
    $return = node_load($wrapper
      ->getIdentifier());
    $this
      ->assertFalse($return, "Node has been successfully deleted.");

    // Ensure changing the bundle changes available wrapper properties.
    $wrapper->type
      ->set('article');
    $this
      ->assertTrue(isset($wrapper->field_tags), 'Changing bundle changes available wrapper properties.');

    // Test labels.
    $user = $this
      ->drupalCreateUser();
    user_save($user, array(
      'roles' => array(),
    ));
    $wrapper->author = $user->uid;
    $this
      ->assertEqual($wrapper
      ->label(), $node->title, 'Entity label returned.');
    $this
      ->assertEqual($wrapper->author->roles[0]
      ->label(), t('authenticated user'), 'Label from options list returned');
    $this
      ->assertEqual($wrapper->author->roles
      ->label(), t('authenticated user'), 'Label for a list from options list returned');
  }

  /**
   * Test supporting multi-valued fields.
   */
  public function testListMetadataWrappers() {
    $property = $this->field_name;
    $values = array();
    $values[LANGUAGE_NONE][0] = array(
      'value' => '<b>2009-09-05</b>',
    );
    $values[LANGUAGE_NONE][1] = array(
      'value' => '2009-09-05',
    );
    $values[LANGUAGE_NONE][2] = array(
      'value' => '2009-08-05',
    );
    $node = $this
      ->drupalCreateNode(array(
      'type' => 'page',
      $property => $values,
    ));
    $wrapper = entity_metadata_wrapper('node', $node);
    $this
      ->assertEqual('<b>2009-09-05</b>', $wrapper->{$property}[0]
      ->value(), 'Getting array entry.');
    $this
      ->assertEqual('2009-09-05', $wrapper->{$property}
      ->get(1)
      ->value(), 'Getting array entry.');
    $this
      ->assertEqual(3, count($wrapper->{$property}
      ->value()), 'Getting the whole array.');

    // Test sanitizing.
    $this
      ->assertEqual(check_plain('<b>2009-09-05</b>'), $wrapper->{$property}[0]
      ->value(array(
      'sanitize' => TRUE,
    )), 'Getting array entry.');

    // Test iterator.
    $this
      ->assertEqual(array_keys(iterator_to_array($wrapper->{$property}
      ->getIterator())), array_keys($wrapper->{$property}
      ->value()), 'Iterator is working.');
    foreach ($wrapper->{$property} as $p) {
      $this
        ->assertTrue($p instanceof EntityMetadataWrapper, 'Iterate over list wrapper properties.');
    }

    // Make sure changing the array changes the actual entity property.
    $wrapper->{$property}[0] = '2009-10-05';
    unset($wrapper->{$property}[1], $wrapper->{$property}[2]);
    $this
      ->assertEqual($wrapper->{$property}
      ->value(), array(
      '2009-10-05',
    ), 'Setting multiple property values.');

    // Test setting an arbitrary list item.
    $list = array(
      0 => REQUEST_TIME,
    );
    $wrapper = entity_metadata_wrapper('list<date>', $list);
    $wrapper[1] = strtotime('2009-09-05');
    $this
      ->assertEqual($wrapper
      ->value(), array(
      REQUEST_TIME,
      strtotime('2009-09-05'),
    ), 'Setting a list item.');
    $this
      ->assertEqual($wrapper
      ->count(), 2, 'List count is correct.');

    // Test using a list wrapper without data.
    $wrapper = entity_metadata_wrapper('list<date>');
    $info = array();
    foreach ($wrapper as $item) {
      $info[] = $item
        ->info();
    }
    $this
      ->assertTrue($info[0]['type'] == 'date', 'Iterated over empty list wrapper.');

    // Test using a list of entities with a list of term objects.
    $list = array();
    $list[] = entity_property_values_create_entity('taxonomy_term', array(
      'name' => 'term 1',
      'vocabulary' => 1,
    ))
      ->save()
      ->value();
    $list[] = entity_property_values_create_entity('taxonomy_term', array(
      'name' => 'term 2',
      'vocabulary' => 1,
    ))
      ->save()
      ->value();
    $wrapper = entity_metadata_wrapper('list<taxonomy_term>', $list);
    $this
      ->assertTrue($wrapper[0]->name
      ->value() == 'term 1', 'Used a list of entities.');

    // Test getting a list of identifiers.
    $ids = $wrapper
      ->value(array(
      'identifier' => TRUE,
    ));
    $this
      ->assertTrue(!is_object($ids[0]), 'Get a list of entity ids.');
    $wrapper = entity_metadata_wrapper('list<taxonomy_term>', $ids);
    $this
      ->assertTrue($wrapper[0]->name
      ->value() == 'term 1', 'Created a list of entities with ids.');

    // Test with a list of generic entities. The list is expected to be a list
    // of entity wrappers, otherwise the entity type is unknown.
    $node = $this
      ->drupalCreateNode(array(
      'title' => 'node 1',
    ));
    $list = array();
    $list[] = entity_metadata_wrapper('node', $node);
    $wrapper = entity_metadata_wrapper('list<entity>', $list);
    $this
      ->assertEqual($wrapper[0]->title
      ->value(), 'node 1', 'Wrapped node was found in generic list of entities.');
  }

  /**
   * Tests using the wrapper without any data.
   */
  public function testWithoutData() {
    $wrapper = entity_metadata_wrapper('node', NULL, array(
      'bundle' => 'page',
    ));
    $this
      ->assertTrue(isset($wrapper->title), 'Bundle properties have been added.');
    $info = $wrapper->author->mail
      ->info();
    $this
      ->assertTrue(!empty($info) && is_array($info) && isset($info['label']), 'Property info returned.');
  }

  /**
   * Test using access() method.
   */
  public function testAccess() {

    // Test without data.
    $account = $this
      ->drupalCreateUser(array(
      'bypass node access',
    ));
    $this
      ->assertTrue(entity_access('view', 'node', NULL, $account), 'Access without data checked.');

    // Test with actual data.
    $values[LANGUAGE_NONE][0] = array(
      'value' => '<b>2009-09-05</b>',
    );
    $values[LANGUAGE_NONE][1] = array(
      'value' => '2009-09-05',
    );
    $node = $this
      ->drupalCreateNode(array(
      'type' => 'page',
      $this->field_name => $values,
    ));
    $this
      ->assertTrue(entity_access('delete', 'node', $node, $account), 'Access with data checked.');

    // Test per property access without data.
    $account2 = $this
      ->drupalCreateUser(array(
      'bypass node access',
      'administer nodes',
    ));
    $wrapper = entity_metadata_wrapper('node', NULL, array(
      'bundle' => 'page',
    ));
    $this
      ->assertTrue($wrapper
      ->access('edit', $account), 'Access to node granted.');
    $this
      ->assertFalse($wrapper->status
      ->access('edit', $account), 'Access for admin property denied.');
    $this
      ->assertTrue($wrapper->status
      ->access('edit', $account2), 'Access for admin property allowed for the admin.');

    // Test per property access with data.
    $wrapper = entity_metadata_wrapper('node', $node, array(
      'bundle' => 'page',
    ));
    $this
      ->assertFalse($wrapper->status
      ->access('edit', $account), 'Access for admin property denied.');
    $this
      ->assertTrue($wrapper->status
      ->access('edit', $account2), 'Access for admin property allowed for the admin.');

    // Test field level access.
    $this
      ->assertTrue($wrapper->{$this->field_name}
      ->access('view'), 'Field access granted.');

    // Create node owned by anonymous and test access() method on each of its
    // properties.
    $node = $this
      ->drupalCreateNode(array(
      'type' => 'page',
      'uid' => 0,
    ));
    $wrapper = entity_metadata_wrapper('node', $node->nid);
    foreach ($wrapper as $name => $property) {
      $property
        ->access('view');
    }

    // Property access of entity references takes entity access into account.
    $node = $this
      ->drupalCreateNode(array(
      'type' => 'article',
    ));
    $wrapper = entity_metadata_wrapper('node', $node);
    $unprivileged_user = $this
      ->drupalCreateUser();
    $privileged_user = $this
      ->drupalCreateUser(array(
      'access user profiles',
    ));
    $this
      ->assertTrue($wrapper->author
      ->access('view', $privileged_user));
    $this
      ->assertFalse($wrapper->author
      ->access('view', $unprivileged_user));

    // Ensure the same works with multiple entity references by testing the
    // $node->field_tags example.
    $privileged_user = $this
      ->drupalCreateUser(array(
      'administer taxonomy',
    ));

    // Terms are view-able with access content, so make sure to remove this
    // permission first.
    user_role_revoke_permissions(DRUPAL_ANONYMOUS_RID, array(
      'access content',
    ));
    $unprivileged_user = drupal_anonymous_user();
    $this
      ->assertTrue($wrapper->field_tags
      ->access('view', $privileged_user), 'Privileged user has access.');
    $this
      ->assertTrue($wrapper->field_tags
      ->access('view', $unprivileged_user), 'Unprivileged user has access.');
    $this
      ->assertTrue($wrapper->field_tags[0]
      ->access('view', $privileged_user), 'Privileged user has access.');
    $this
      ->assertFalse($wrapper->field_tags[0]
      ->access('view', $unprivileged_user), 'Unprivileged user has no access.');
  }

  /**
   * Tests using a data structure with passed in metadata.
   */
  public function testDataStructureWrapper() {
    $log_entry = array(
      'type' => 'entity',
      'message' => $this
        ->randomName(8),
      'variables' => array(),
      'severity' => WATCHDOG_NOTICE,
      'link' => '',
      'user' => $GLOBALS['user'],
    );
    $info['property info'] = array(
      'type' => array(
        'type' => 'text',
        'label' => 'The category to which this message belongs.',
      ),
      'message' => array(
        'type' => 'text',
        'label' => 'The log message.',
      ),
      'user' => array(
        'type' => 'user',
        'label' => 'The user causing the log entry.',
      ),
    );
    $wrapper = entity_metadata_wrapper('log_entry', $log_entry, $info);
    $this
      ->assertEqual($wrapper->user->name
      ->value(), $GLOBALS['user']->name, 'Wrapped custom entity.');
  }

  /**
   * Tests using entity_property_query().
   */
  public function testEntityQuery() {

    // Create a test node.
    $title = '<b>Is it bold?<b>';
    $values[LANGUAGE_NONE][0] = array(
      'value' => 'foo',
    );
    $node = $this
      ->drupalCreateNode(array(
      $this->field_name => $values,
      'title' => $title,
      'uid' => $GLOBALS['user']->uid,
    ));
    $results = entity_property_query('node', 'title', $title);
    $this
      ->assertEqual($results, array(
      $node->nid,
    ), 'Queried nodes with a given title.');
    $results = entity_property_query('node', $this->field_name, 'foo');
    $this
      ->assertEqual($results, array(
      $node->nid,
    ), 'Queried nodes with a given field value.');
    $results = entity_property_query('node', $this->field_name, array(
      'foo',
      'bar',
    ));
    $this
      ->assertEqual($results, array(
      $node->nid,
    ), 'Queried nodes with a list of possible values.');
    $results = entity_property_query('node', 'author', $GLOBALS['user']);
    $this
      ->assertEqual($results, array(
      $node->nid,
    ), 'Queried nodes with a given author.');

    // Create another test node and try querying for tags.
    $tag = entity_property_values_create_entity('taxonomy_term', array(
      'name' => $this
        ->randomName(),
      'vocabulary' => 1,
    ))
      ->save();
    $field_tag_value[LANGUAGE_NONE][0]['tid'] = $tag
      ->getIdentifier();
    $node = $this
      ->drupalCreateNode(array(
      'type' => 'article',
      'field_tags' => $field_tag_value,
    ));

    // Try query-ing with a single value.
    $results = entity_property_query('node', 'field_tags', $tag
      ->getIdentifier());
    $this
      ->assertEqual($results, array(
      $node->nid,
    ), 'Queried nodes with a given term id.');
    $results = entity_property_query('node', 'field_tags', $tag
      ->value());
    $this
      ->assertEqual($results, array(
      $node->nid,
    ), 'Queried nodes with a given term object.');

    // Try query-ing with a list of possible values.
    $results = entity_property_query('node', 'field_tags', array(
      $tag
        ->getIdentifier(),
    ));
    $this
      ->assertEqual($results, array(
      $node->nid,
    ), 'Queried nodes with a list of term ids.');
  }

  /**
   * Tests serializing data wrappers, in particular for EntityDrupalWrapper.
   */
  public function testWrapperSerialization() {
    $node = $this
      ->drupalCreateNode();
    $wrapper = entity_metadata_wrapper('node', $node);
    $this
      ->assertTrue($wrapper
      ->value() == $node, 'Data correctly wrapped.');

    // Test serializing and make sure only the node id is stored.
    $this
      ->assertTrue(strpos(serialize($wrapper), $node->title) === FALSE, 'Node has been correctly serialized.');
    $this
      ->assertEqual(unserialize(serialize($wrapper))->title
      ->value(), $node->title, 'Serializing works right.');
    $wrapper2 = unserialize(serialize($wrapper));

    // Test serializing the unloaded wrapper.
    $this
      ->assertEqual(unserialize(serialize($wrapper2))->title
      ->value(), $node->title, 'Serializing works right.');

    // Test loading a not more existing node.
    $s = serialize($wrapper2);
    node_delete($node->nid);
    $this
      ->assertFalse(node_load($node->nid), 'Node deleted.');
    $value = unserialize($s)
      ->value();
    $this
      ->assertNull($value, 'Tried to load not existing node.');
  }

}

Members

Namesort descending Modifiers Type Description 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::$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::$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. 20
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 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. 6
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
EntityMetadataTestCase::getInfo public static function
EntityMetadataTestCase::setUp protected function Sets up a Drupal site for running functional and integration tests. Overrides DrupalWebTestCase::setUp
EntityMetadataTestCase::testAccess public function Test using access() method.
EntityMetadataTestCase::testDataStructureWrapper public function Tests using a data structure with passed in metadata.
EntityMetadataTestCase::testEntityMetadataWrapper public function Creates a user and a node, then tests getting the properties.
EntityMetadataTestCase::testEntityQuery public function Tests using entity_property_query().
EntityMetadataTestCase::testListMetadataWrappers public function Test supporting multi-valued fields.
EntityMetadataTestCase::testWithoutData public function Tests using the wrapper without any data.
EntityMetadataTestCase::testWrapperSerialization public function Tests serializing data wrappers, in particular for EntityDrupalWrapper.
EntityWebTestCase::createFile protected function Creates a random file of the given type.
EntityWebTestCase::createVocabulary protected function Creates a new vocabulary.