class FieldAttachStorageTestCase
Unit test class for storage-related field_attach_* functions.
All field_attach_* test work with all field_storage plugins and all hook_field_attach_pre_{load,insert,update}() hooks.
Hierarchy
- class \DrupalTestCase
- class \DrupalWebTestCase extends \DrupalTestCase
- class \FieldTestCase extends \DrupalWebTestCase
- class \FieldAttachTestCase extends \FieldTestCase
- class \FieldAttachStorageTestCase extends \FieldAttachTestCase
- class \FieldAttachTestCase extends \FieldTestCase
- class \FieldTestCase extends \DrupalWebTestCase
- class \DrupalWebTestCase extends \DrupalTestCase
Expanded class hierarchy of FieldAttachStorageTestCase
File
-
modules/
field/ tests/ field.test, line 145
View source
class FieldAttachStorageTestCase extends FieldAttachTestCase {
public static function getInfo() {
return array(
'name' => 'Field attach tests (storage-related)',
'description' => 'Test storage-related Field Attach API functions.',
'group' => 'Field API',
);
}
/**
* Check field values insert, update and load.
*
* Works independently of the underlying field storage backend. Inserts or
* updates random field data and then loads and verifies the data.
*/
function testFieldAttachSaveLoad() {
// Configure the instance so that we test hook_field_load() (see
// field_test_field_load() in field_test.module).
$this->instance['settings']['test_hook_field_load'] = TRUE;
field_update_instance($this->instance);
$langcode = LANGUAGE_NONE;
$entity_type = 'test_entity';
$values = array();
// TODO : test empty values filtering and "compression" (store consecutive deltas).
// Preparation: create three revisions and store them in $revision array.
for ($revision_id = 0; $revision_id < 3; $revision_id++) {
$revision[$revision_id] = field_test_create_stub_entity(0, $revision_id, $this->instance['bundle']);
// Note: we try to insert one extra value.
$values[$revision_id] = $this->_generateTestFieldValues($this->field['cardinality'] + 1);
$current_revision = $revision_id;
// If this is the first revision do an insert.
if (!$revision_id) {
$revision[$revision_id]->{$this->field_name}[$langcode] = $values[$revision_id];
field_attach_insert($entity_type, $revision[$revision_id]);
}
else {
// Otherwise do an update.
$revision[$revision_id]->{$this->field_name}[$langcode] = $values[$revision_id];
field_attach_update($entity_type, $revision[$revision_id]);
}
}
// Confirm current revision loads the correct data.
$entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
field_attach_load($entity_type, array(
0 => $entity,
));
// Number of values per field loaded equals the field cardinality.
$this->assertEqual(count($entity->{$this->field_name}[$langcode]), $this->field['cardinality'], 'Current revision: expected number of values');
for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
// The field value loaded matches the one inserted or updated.
$this->assertEqual($entity->{$this->field_name}[$langcode][$delta]['value'], $values[$current_revision][$delta]['value'], format_string('Current revision: expected value %delta was found.', array(
'%delta' => $delta,
)));
// The value added in hook_field_load() is found.
$this->assertEqual($entity->{$this->field_name}[$langcode][$delta]['additional_key'], 'additional_value', format_string('Current revision: extra information for value %delta was found', array(
'%delta' => $delta,
)));
}
// Confirm each revision loads the correct data.
foreach (array_keys($revision) as $revision_id) {
$entity = field_test_create_stub_entity(0, $revision_id, $this->instance['bundle']);
field_attach_load_revision($entity_type, array(
0 => $entity,
));
// Number of values per field loaded equals the field cardinality.
$this->assertEqual(count($entity->{$this->field_name}[$langcode]), $this->field['cardinality'], format_string('Revision %revision_id: expected number of values.', array(
'%revision_id' => $revision_id,
)));
for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
// The field value loaded matches the one inserted or updated.
$this->assertEqual($entity->{$this->field_name}[$langcode][$delta]['value'], $values[$revision_id][$delta]['value'], format_string('Revision %revision_id: expected value %delta was found.', array(
'%revision_id' => $revision_id,
'%delta' => $delta,
)));
// The value added in hook_field_load() is found.
$this->assertEqual($entity->{$this->field_name}[$langcode][$delta]['additional_key'], 'additional_value', format_string('Revision %revision_id: extra information for value %delta was found', array(
'%revision_id' => $revision_id,
'%delta' => $delta,
)));
}
}
}
/**
* Test the 'multiple' load feature.
*/
function testFieldAttachLoadMultiple() {
$entity_type = 'test_entity';
$langcode = LANGUAGE_NONE;
// Define 2 bundles.
$bundles = array(
1 => 'test_bundle_1',
2 => 'test_bundle_2',
);
field_test_create_bundle($bundles[1]);
field_test_create_bundle($bundles[2]);
// Define 3 fields:
// - field_1 is in bundle_1 and bundle_2,
// - field_2 is in bundle_1,
// - field_3 is in bundle_2.
$field_bundles_map = array(
1 => array(
1,
2,
),
2 => array(
1,
),
3 => array(
2,
),
);
for ($i = 1; $i <= 3; $i++) {
$field_names[$i] = 'field_' . $i;
$field = array(
'field_name' => $field_names[$i],
'type' => 'test_field',
);
$field = field_create_field($field);
$field_ids[$i] = $field['id'];
foreach ($field_bundles_map[$i] as $bundle) {
$instance = array(
'field_name' => $field_names[$i],
'entity_type' => 'test_entity',
'bundle' => $bundles[$bundle],
'settings' => array(
// Configure the instance so that we test hook_field_load()
// (see field_test_field_load() in field_test.module).
'test_hook_field_load' => TRUE,
),
);
field_create_instance($instance);
}
}
// Create one test entity per bundle, with random values.
foreach ($bundles as $index => $bundle) {
$entities[$index] = field_test_create_stub_entity($index, $index, $bundle);
$entity = clone $entities[$index];
$instances = field_info_instances('test_entity', $bundle);
foreach ($instances as $field_name => $instance) {
$values[$index][$field_name] = mt_rand(1, 127);
$entity->{$field_name} = array(
$langcode => array(
array(
'value' => $values[$index][$field_name],
),
),
);
}
field_attach_insert($entity_type, $entity);
}
// Check that a single load correctly loads field values for both entities.
field_attach_load($entity_type, $entities);
foreach ($entities as $index => $entity) {
$instances = field_info_instances($entity_type, $bundles[$index]);
foreach ($instances as $field_name => $instance) {
// The field value loaded matches the one inserted.
$this->assertEqual($entity->{$field_name}[$langcode][0]['value'], $values[$index][$field_name], format_string('Entity %index: expected value was found.', array(
'%index' => $index,
)));
// The value added in hook_field_load() is found.
$this->assertEqual($entity->{$field_name}[$langcode][0]['additional_key'], 'additional_value', format_string('Entity %index: extra information was found', array(
'%index' => $index,
)));
}
}
// Check that the single-field load option works.
$entity = field_test_create_stub_entity(1, 1, $bundles[1]);
field_attach_load($entity_type, array(
1 => $entity,
), FIELD_LOAD_CURRENT, array(
'field_id' => $field_ids[1],
));
$this->assertEqual($entity->{$field_names[1]}[$langcode][0]['value'], $values[1][$field_names[1]], format_string('Entity %index: expected value was found.', array(
'%index' => 1,
)));
$this->assertEqual($entity->{$field_names[1]}[$langcode][0]['additional_key'], 'additional_value', format_string('Entity %index: extra information was found', array(
'%index' => 1,
)));
$this->assert(!isset($entity->{$field_names[2]}), format_string('Entity %index: field %field_name is not loaded.', array(
'%index' => 2,
'%field_name' => $field_names[2],
)));
$this->assert(!isset($entity->{$field_names[3]}), format_string('Entity %index: field %field_name is not loaded.', array(
'%index' => 3,
'%field_name' => $field_names[3],
)));
}
/**
* Test saving and loading fields using different storage backends.
*/
function testFieldAttachSaveLoadDifferentStorage() {
$entity_type = 'test_entity';
$langcode = LANGUAGE_NONE;
// Create two fields using different storage backends, and their instances.
$fields = array(
array(
'field_name' => 'field_1',
'type' => 'test_field',
'cardinality' => 4,
'storage' => array(
'type' => 'field_sql_storage',
),
),
array(
'field_name' => 'field_2',
'type' => 'test_field',
'cardinality' => 4,
'storage' => array(
'type' => 'field_test_storage',
),
),
);
foreach ($fields as $field) {
field_create_field($field);
$instance = array(
'field_name' => $field['field_name'],
'entity_type' => 'test_entity',
'bundle' => 'test_bundle',
);
field_create_instance($instance);
}
$entity_init = field_test_create_stub_entity();
// Create entity and insert random values.
$entity = clone $entity_init;
$values = array();
foreach ($fields as $field) {
$values[$field['field_name']] = $this->_generateTestFieldValues($this->field['cardinality']);
$entity->{$field['field_name']}[$langcode] = $values[$field['field_name']];
}
field_attach_insert($entity_type, $entity);
// Check that values are loaded as expected.
$entity = clone $entity_init;
field_attach_load($entity_type, array(
$entity->ftid => $entity,
));
foreach ($fields as $field) {
$this->assertEqual($values[$field['field_name']], $entity->{$field['field_name']}[$langcode], format_string('%storage storage: expected values were found.', array(
'%storage' => $field['storage']['type'],
)));
}
}
/**
* Test storage details alteration.
*
* @see field_test_storage_details_alter()
*/
function testFieldStorageDetailsAlter() {
$field_name = 'field_test_change_my_details';
$field = array(
'field_name' => $field_name,
'type' => 'test_field',
'cardinality' => 4,
'storage' => array(
'type' => 'field_test_storage',
),
);
$field = field_create_field($field);
$instance = array(
'field_name' => $field_name,
'entity_type' => 'test_entity',
'bundle' => 'test_bundle',
);
field_create_instance($instance);
$field = field_info_field($instance['field_name']);
$instance = field_info_instance($instance['entity_type'], $instance['field_name'], $instance['bundle']);
// The storage details are indexed by a storage engine type.
$this->assertTrue(array_key_exists('drupal_variables', $field['storage']['details']), 'The storage type is Drupal variables.');
$details = $field['storage']['details']['drupal_variables'];
// The field_test storage details are indexed by variable name. The details
// are altered, so moon and mars are correct for this test.
$this->assertTrue(array_key_exists('moon', $details[FIELD_LOAD_CURRENT]), 'Moon is available in the instance array.');
$this->assertTrue(array_key_exists('mars', $details[FIELD_LOAD_REVISION]), 'Mars is available in the instance array.');
// Test current and revision storage details together because the columns
// are the same.
foreach ((array) $field['columns'] as $column_name => $attributes) {
$this->assertEqual($details[FIELD_LOAD_CURRENT]['moon'][$column_name], $column_name, format_string('Column name %value matches the definition in %bin.', array(
'%value' => $column_name,
'%bin' => 'moon[FIELD_LOAD_CURRENT]',
)));
$this->assertEqual($details[FIELD_LOAD_REVISION]['mars'][$column_name], $column_name, format_string('Column name %value matches the definition in %bin.', array(
'%value' => $column_name,
'%bin' => 'mars[FIELD_LOAD_REVISION]',
)));
}
}
/**
* Tests insert and update with missing or NULL fields.
*/
function testFieldAttachSaveMissingData() {
$entity_type = 'test_entity';
$entity_init = field_test_create_stub_entity();
$langcode = LANGUAGE_NONE;
// Insert: Field is missing.
$entity = clone $entity_init;
field_attach_insert($entity_type, $entity);
$entity = clone $entity_init;
field_attach_load($entity_type, array(
$entity->ftid => $entity,
));
$this->assertTrue(empty($entity->{$this->field_name}), 'Insert: missing field results in no value saved');
// Insert: Field is NULL.
field_cache_clear();
$entity = clone $entity_init;
$entity->{$this->field_name} = NULL;
field_attach_insert($entity_type, $entity);
$entity = clone $entity_init;
field_attach_load($entity_type, array(
$entity->ftid => $entity,
));
$this->assertTrue(empty($entity->{$this->field_name}), 'Insert: NULL field results in no value saved');
// Add some real data.
field_cache_clear();
$entity = clone $entity_init;
$values = $this->_generateTestFieldValues(1);
$entity->{$this->field_name}[$langcode] = $values;
field_attach_insert($entity_type, $entity);
$entity = clone $entity_init;
field_attach_load($entity_type, array(
$entity->ftid => $entity,
));
$this->assertEqual($entity->{$this->field_name}[$langcode], $values, 'Field data saved');
// Update: Field is missing. Data should survive.
field_cache_clear();
$entity = clone $entity_init;
field_attach_update($entity_type, $entity);
$entity = clone $entity_init;
field_attach_load($entity_type, array(
$entity->ftid => $entity,
));
$this->assertEqual($entity->{$this->field_name}[$langcode], $values, 'Update: missing field leaves existing values in place');
// Update: Field is NULL. Data should be wiped.
field_cache_clear();
$entity = clone $entity_init;
$entity->{$this->field_name} = NULL;
field_attach_update($entity_type, $entity);
$entity = clone $entity_init;
field_attach_load($entity_type, array(
$entity->ftid => $entity,
));
$this->assertTrue(empty($entity->{$this->field_name}), 'Update: NULL field removes existing values');
// Re-add some data.
field_cache_clear();
$entity = clone $entity_init;
$values = $this->_generateTestFieldValues(1);
$entity->{$this->field_name}[$langcode] = $values;
field_attach_update($entity_type, $entity);
$entity = clone $entity_init;
field_attach_load($entity_type, array(
$entity->ftid => $entity,
));
$this->assertEqual($entity->{$this->field_name}[$langcode], $values, 'Field data saved');
// Update: Field is empty array. Data should be wiped.
field_cache_clear();
$entity = clone $entity_init;
$entity->{$this->field_name} = array();
field_attach_update($entity_type, $entity);
$entity = clone $entity_init;
field_attach_load($entity_type, array(
$entity->ftid => $entity,
));
$this->assertTrue(empty($entity->{$this->field_name}), 'Update: empty array removes existing values');
}
/**
* Test insert with missing or NULL fields, with default value.
*/
function testFieldAttachSaveMissingDataDefaultValue() {
// Add a default value function.
$this->instance['default_value_function'] = 'field_test_default_value';
field_update_instance($this->instance);
$entity_type = 'test_entity';
$entity_init = field_test_create_stub_entity();
$langcode = LANGUAGE_NONE;
// Insert: Field is NULL.
$entity = clone $entity_init;
$entity->{$this->field_name}[$langcode] = NULL;
field_attach_insert($entity_type, $entity);
$entity = clone $entity_init;
field_attach_load($entity_type, array(
$entity->ftid => $entity,
));
$this->assertTrue(empty($entity->{$this->field_name}[$langcode]), 'Insert: NULL field results in no value saved');
// Insert: Field is missing.
field_cache_clear();
$entity = clone $entity_init;
field_attach_insert($entity_type, $entity);
$entity = clone $entity_init;
field_attach_load($entity_type, array(
$entity->ftid => $entity,
));
$values = field_test_default_value($entity_type, $entity, $this->field, $this->instance);
$this->assertEqual($entity->{$this->field_name}[$langcode], $values, 'Insert: missing field results in default value saved');
}
/**
* Test field_has_data().
*/
function testFieldHasData() {
$entity_type = 'test_entity';
$langcode = LANGUAGE_NONE;
$field_name = 'field_1';
$field = array(
'field_name' => $field_name,
'type' => 'test_field',
);
$field = field_create_field($field);
$this->assertFalse(field_has_data($field), "No data should be detected.");
$instance = array(
'field_name' => $field_name,
'entity_type' => 'test_entity',
'bundle' => 'test_bundle',
);
$instance = field_create_instance($instance);
$table = _field_sql_storage_tablename($field);
$revision_table = _field_sql_storage_revision_tablename($field);
$columns = array(
'entity_type',
'entity_id',
'revision_id',
'delta',
'language',
$field_name . '_value',
);
$eid = 0;
// Insert values into the field revision table.
$query = db_insert($revision_table)->fields($columns);
$query->values(array(
$entity_type,
$eid,
0,
0,
$langcode,
1,
));
$query->execute();
$this->assertTrue(field_has_data($field), "Revision data only should be detected.");
$field_name = 'field_2';
$field = array(
'field_name' => $field_name,
'type' => 'test_field',
);
$field = field_create_field($field);
$this->assertFalse(field_has_data($field), "No data should be detected.");
$instance = array(
'field_name' => $field_name,
'entity_type' => 'test_entity',
'bundle' => 'test_bundle',
);
$instance = field_create_instance($instance);
$table = _field_sql_storage_tablename($field);
$revision_table = _field_sql_storage_revision_tablename($field);
$columns = array(
'entity_type',
'entity_id',
'revision_id',
'delta',
'language',
$field_name . '_value',
);
$eid = 1;
// Insert values into the field table.
$query = db_insert($table)->fields($columns);
$query->values(array(
$entity_type,
$eid,
0,
0,
$langcode,
1,
));
$query->execute();
$this->assertTrue(field_has_data($field), "Values only in field table should be detected.");
}
/**
* Test field_attach_delete().
*/
function testFieldAttachDelete() {
$entity_type = 'test_entity';
$langcode = LANGUAGE_NONE;
$rev[0] = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
// Create revision 0
$values = $this->_generateTestFieldValues($this->field['cardinality']);
$rev[0]->{$this->field_name}[$langcode] = $values;
field_attach_insert($entity_type, $rev[0]);
// Create revision 1
$rev[1] = field_test_create_stub_entity(0, 1, $this->instance['bundle']);
$rev[1]->{$this->field_name}[$langcode] = $values;
field_attach_update($entity_type, $rev[1]);
// Create revision 2
$rev[2] = field_test_create_stub_entity(0, 2, $this->instance['bundle']);
$rev[2]->{$this->field_name}[$langcode] = $values;
field_attach_update($entity_type, $rev[2]);
// Confirm each revision loads
foreach (array_keys($rev) as $vid) {
$read = field_test_create_stub_entity(0, $vid, $this->instance['bundle']);
field_attach_load_revision($entity_type, array(
0 => $read,
));
$this->assertEqual(count($read->{$this->field_name}[$langcode]), $this->field['cardinality'], "The test entity revision {$vid} has {$this->field['cardinality']} values.");
}
// Delete revision 1, confirm the other two still load.
field_attach_delete_revision($entity_type, $rev[1]);
foreach (array(
0,
2,
) as $vid) {
$read = field_test_create_stub_entity(0, $vid, $this->instance['bundle']);
field_attach_load_revision($entity_type, array(
0 => $read,
));
$this->assertEqual(count($read->{$this->field_name}[$langcode]), $this->field['cardinality'], "The test entity revision {$vid} has {$this->field['cardinality']} values.");
}
// Confirm the current revision still loads
$read = field_test_create_stub_entity(0, 2, $this->instance['bundle']);
field_attach_load($entity_type, array(
0 => $read,
));
$this->assertEqual(count($read->{$this->field_name}[$langcode]), $this->field['cardinality'], "The test entity current revision has {$this->field['cardinality']} values.");
// Delete all field data, confirm nothing loads
field_attach_delete($entity_type, $rev[2]);
foreach (array(
0,
1,
2,
) as $vid) {
$read = field_test_create_stub_entity(0, $vid, $this->instance['bundle']);
field_attach_load_revision($entity_type, array(
0 => $read,
));
$this->assertIdentical($read->{$this->field_name}, array(), "The test entity revision {$vid} is deleted.");
}
$read = field_test_create_stub_entity(0, 2, $this->instance['bundle']);
field_attach_load($entity_type, array(
0 => $read,
));
$this->assertIdentical($read->{$this->field_name}, array(), 'The test entity current revision is deleted.');
}
/**
* Test field_attach_create_bundle() and field_attach_rename_bundle().
*/
function testFieldAttachCreateRenameBundle() {
// Create a new bundle. This has to be initiated by the module so that its
// hook_entity_info() is consistent.
$new_bundle = 'test_bundle_' . drupal_strtolower($this->randomName());
field_test_create_bundle($new_bundle);
// Add an instance to that bundle.
$this->instance['bundle'] = $new_bundle;
field_create_instance($this->instance);
// Save an entity with data in the field.
$entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
$langcode = LANGUAGE_NONE;
$values = $this->_generateTestFieldValues($this->field['cardinality']);
$entity->{$this->field_name}[$langcode] = $values;
$entity_type = 'test_entity';
field_attach_insert($entity_type, $entity);
// Verify the field data is present on load.
$entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
field_attach_load($entity_type, array(
0 => $entity,
));
$this->assertEqual(count($entity->{$this->field_name}[$langcode]), $this->field['cardinality'], "Data is retrieved for the new bundle");
// Rename the bundle. This has to be initiated by the module so that its
// hook_entity_info() is consistent.
$new_bundle = 'test_bundle_' . drupal_strtolower($this->randomName());
field_test_rename_bundle($this->instance['bundle'], $new_bundle);
// Check that the instance definition has been updated.
$this->instance = field_info_instance($entity_type, $this->field_name, $new_bundle);
$this->assertIdentical($this->instance['bundle'], $new_bundle, "Bundle name has been updated in the instance.");
// Verify the field data is present on load.
$entity = field_test_create_stub_entity(0, 0, $new_bundle);
field_attach_load($entity_type, array(
0 => $entity,
));
$this->assertEqual(count($entity->{$this->field_name}[$langcode]), $this->field['cardinality'], "Bundle name has been updated in the field storage");
}
/**
* Test field_attach_delete_bundle().
*/
function testFieldAttachDeleteBundle() {
// Create a new bundle. This has to be initiated by the module so that its
// hook_entity_info() is consistent.
$new_bundle = 'test_bundle_' . drupal_strtolower($this->randomName());
field_test_create_bundle($new_bundle);
// Add an instance to that bundle.
$this->instance['bundle'] = $new_bundle;
field_create_instance($this->instance);
// Create a second field for the test bundle
$field_name = drupal_strtolower($this->randomName() . '_field_name');
$field = array(
'field_name' => $field_name,
'type' => 'test_field',
'cardinality' => 1,
);
field_create_field($field);
$instance = array(
'field_name' => $field_name,
'entity_type' => 'test_entity',
'bundle' => $this->instance['bundle'],
'label' => $this->randomName() . '_label',
'description' => $this->randomName() . '_description',
'weight' => mt_rand(0, 127),
// test_field has no instance settings
'widget' => array(
'type' => 'test_field_widget',
'settings' => array(
'size' => mt_rand(0, 255),
),
),
);
field_create_instance($instance);
// Save an entity with data for both fields
$entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
$langcode = LANGUAGE_NONE;
$values = $this->_generateTestFieldValues($this->field['cardinality']);
$entity->{$this->field_name}[$langcode] = $values;
$entity->{$field_name}[$langcode] = $this->_generateTestFieldValues(1);
field_attach_insert('test_entity', $entity);
// Verify the fields are present on load
$entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
field_attach_load('test_entity', array(
0 => $entity,
));
$this->assertEqual(count($entity->{$this->field_name}[$langcode]), 4, 'First field got loaded');
$this->assertEqual(count($entity->{$field_name}[$langcode]), 1, 'Second field got loaded');
// Delete the bundle. This has to be initiated by the module so that its
// hook_entity_info() is consistent.
field_test_delete_bundle($this->instance['bundle']);
// Verify no data gets loaded
$entity = field_test_create_stub_entity(0, 0, $this->instance['bundle']);
field_attach_load('test_entity', array(
0 => $entity,
));
$this->assertFalse(isset($entity->{$this->field_name}[$langcode]), 'No data for first field');
$this->assertFalse(isset($entity->{$field_name}[$langcode]), 'No data for second field');
// Verify that the instances are gone
$this->assertFalse(field_read_instance('test_entity', $this->field_name, $this->instance['bundle']), "First field is deleted");
$this->assertFalse(field_read_instance('test_entity', $field_name, $instance['bundle']), "Second field is deleted");
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DrupalTestCase::$assertions | protected | property | Assertions thrown in that test case. | ||
DrupalTestCase::$databasePrefix | protected | property | The database prefix of this test run. | ||
DrupalTestCase::$originalFileDirectory | protected | property | The original file directory, before it was changed for testing purposes. | ||
DrupalTestCase::$originalLanguage | protected | property | The original language. | ||
DrupalTestCase::$originalLanguageDefault | protected | property | The original default language. | ||
DrupalTestCase::$originalTheme | protected | property | The original theme. | ||
DrupalTestCase::$originalThemeKey | protected | property | The original theme key. | ||
DrupalTestCase::$originalThemePath | protected | property | The original theme path. | ||
DrupalTestCase::$results | public | property | Current results of this test case. | ||
DrupalTestCase::$setup | protected | property | Flag to indicate whether the test has been set up. | ||
DrupalTestCase::$setupDatabasePrefix | protected | property | |||
DrupalTestCase::$setupEnvironment | protected | property | |||
DrupalTestCase::$skipClasses | protected | property | This class is skipped when looking for the source of an assertion. | ||
DrupalTestCase::$testId | protected | property | The test run ID. | ||
DrupalTestCase::$timeLimit | protected | property | Time limit for the test. | ||
DrupalTestCase::$useSetupInstallationCache | public | property | Whether to cache the installation part of the setUp() method. | ||
DrupalTestCase::$useSetupModulesCache | public | property | Whether to cache the modules installation part of the setUp() method. | ||
DrupalTestCase::$verboseDirectoryUrl | protected | property | URL to the verbose output file directory. | ||
DrupalTestCase::assert | protected | function | Internal helper: stores the assert. | ||
DrupalTestCase::assertEqual | protected | function | Check to see if two values are equal. | ||
DrupalTestCase::assertFalse | protected | function | Check to see if a value is false (an empty string, 0, NULL, or FALSE). | ||
DrupalTestCase::assertIdentical | protected | function | Check to see if two values are identical. | ||
DrupalTestCase::assertNotEqual | protected | function | Check to see if two values are not equal. | ||
DrupalTestCase::assertNotIdentical | protected | function | Check to see if two values are not identical. | ||
DrupalTestCase::assertNotNull | protected | function | Check to see if a value is not NULL. | ||
DrupalTestCase::assertNull | protected | function | Check to see if a value is NULL. | ||
DrupalTestCase::assertTrue | protected | function | Check to see if a value is not false (not an empty string, 0, NULL, or FALSE). | ||
DrupalTestCase::deleteAssert | public static | function | Delete an assertion record by message ID. | ||
DrupalTestCase::error | protected | function | Fire an error assertion. | 1 | |
DrupalTestCase::errorHandler | public | function | Handle errors during test runs. | 1 | |
DrupalTestCase::exceptionHandler | protected | function | Handle exceptions. | ||
DrupalTestCase::fail | protected | function | Fire an assertion that is always negative. | ||
DrupalTestCase::generatePermutations | public static | function | Converts a list of possible parameters into a stack of permutations. | ||
DrupalTestCase::getAssertionCall | protected | function | Cycles through backtrace until the first non-assertion method is found. | ||
DrupalTestCase::getDatabaseConnection | public static | function | Returns the database connection to the site running Simpletest. | ||
DrupalTestCase::insertAssert | public static | function | Store an assertion from outside the testing context. | ||
DrupalTestCase::pass | protected | function | Fire an assertion that is always positive. | ||
DrupalTestCase::randomName | public static | function | Generates a random string containing letters and numbers. | ||
DrupalTestCase::randomString | public static | function | Generates a random string of ASCII characters of codes 32 to 126. | ||
DrupalTestCase::run | public | function | Run all tests in this class. | ||
DrupalTestCase::verbose | protected | function | Logs a verbose message in a text file. | ||
DrupalWebTestCase::$additionalCurlOptions | protected | property | Additional cURL options. | ||
DrupalWebTestCase::$content | protected | property | The content of the page currently loaded in the internal browser. | ||
DrupalWebTestCase::$cookieFile | protected | property | The current cookie file used by cURL. | ||
DrupalWebTestCase::$cookies | protected | property | The cookies of the page currently loaded in the internal browser. | ||
DrupalWebTestCase::$curlHandle | protected | property | The handle of the current cURL connection. | ||
DrupalWebTestCase::$drupalSettings | protected | property | The value of the Drupal.settings JavaScript variable for the page currently loaded in the internal browser. | ||
DrupalWebTestCase::$elements | protected | property | The parsed version of the page. | ||
DrupalWebTestCase::$generatedTestFiles | protected | property | Whether the files were copied to the test files directory. | ||
DrupalWebTestCase::$headers | protected | property | The headers of the page currently loaded in the internal browser. | ||
DrupalWebTestCase::$httpauth_credentials | protected | property | HTTP authentication credentials (<username>:<password>). | ||
DrupalWebTestCase::$httpauth_method | protected | property | HTTP authentication method | ||
DrupalWebTestCase::$loggedInUser | protected | property | The current user logged in using the internal browser. | ||
DrupalWebTestCase::$originalCleanUrl | protected | property | The original clean_url variable value. | ||
DrupalWebTestCase::$originalLanguageUrl | protected | property | The original language URL. | ||
DrupalWebTestCase::$originalProfile | protected | property | The original active installation profile. | ||
DrupalWebTestCase::$originalShutdownCallbacks | protected | property | The original shutdown handlers array, before it was cleaned for testing purposes. | ||
DrupalWebTestCase::$originalUser | protected | property | The original user, before it was changed to a clean uid = 1 for testing purposes. | ||
DrupalWebTestCase::$plainTextContent | protected | property | The content of the page currently loaded in the internal browser (plain text version). | ||
DrupalWebTestCase::$private_files_directory | protected | property | The private files directory created for testing purposes. | ||
DrupalWebTestCase::$profile | protected | property | The profile to install as a basis for testing. | 20 | |
DrupalWebTestCase::$public_files_directory | protected | property | The public files directory created for testing purposes. | ||
DrupalWebTestCase::$redirect_count | protected | property | The number of redirects followed during the handling of a request. | ||
DrupalWebTestCase::$session_id | protected | property | The current session ID, if available. | ||
DrupalWebTestCase::$session_name | protected | property | The current session name, if available. | ||
DrupalWebTestCase::$temp_files_directory | protected | property | The temporary files directory created for testing purposes. | ||
DrupalWebTestCase::$url | protected | property | The URL currently loaded in the internal browser. | ||
DrupalWebTestCase::assertField | protected | function | Asserts that a field exists with the given name or ID. | ||
DrupalWebTestCase::assertFieldById | protected | function | Asserts that a field exists in the current page with the given ID and value. | ||
DrupalWebTestCase::assertFieldByName | protected | function | Asserts that a field exists in the current page with the given name and value. | ||
DrupalWebTestCase::assertFieldByXPath | protected | function | Asserts that a field exists in the current page by the given XPath. | ||
DrupalWebTestCase::assertFieldChecked | protected | function | Asserts that a checkbox field in the current page is checked. | ||
DrupalWebTestCase::assertLink | protected | function | Pass if a link with the specified label is found, and optional with the specified index. |
||
DrupalWebTestCase::assertLinkByHref | protected | function | Pass if a link containing a given href (part) is found. | ||
DrupalWebTestCase::assertMail | protected | function | Asserts that the most recently sent e-mail message has the given value. | ||
DrupalWebTestCase::assertMailPattern | protected | function | Asserts that the most recently sent e-mail message has the pattern in it. | ||
DrupalWebTestCase::assertMailString | protected | function | Asserts that the most recently sent e-mail message has the string in it. | ||
DrupalWebTestCase::assertNoDuplicateIds | protected | function | Asserts that each HTML ID is used for just a single element. | ||
DrupalWebTestCase::assertNoField | protected | function | Asserts that a field does not exist with the given name or ID. | ||
DrupalWebTestCase::assertNoFieldById | protected | function | Asserts that a field does not exist with the given ID and value. | ||
DrupalWebTestCase::assertNoFieldByName | protected | function | Asserts that a field does not exist with the given name and value. | ||
DrupalWebTestCase::assertNoFieldByXPath | protected | function | Asserts that a field doesn't exist or its value doesn't match, by XPath. | ||
DrupalWebTestCase::assertNoFieldChecked | protected | function | Asserts that a checkbox field in the current page is not checked. | ||
DrupalWebTestCase::assertNoLink | protected | function | Pass if a link with the specified label is not found. | ||
DrupalWebTestCase::assertNoLinkByHref | protected | function | Pass if a link containing a given href (part) is not found. | ||
DrupalWebTestCase::assertNoOptionSelected | protected | function | Asserts that a select option in the current page is not checked. | ||
DrupalWebTestCase::assertNoPattern | protected | function | Will trigger a pass if the perl regex pattern is not present in raw content. | ||
DrupalWebTestCase::assertNoRaw | protected | function | Pass if the raw text is NOT found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated. |
||
DrupalWebTestCase::assertNoResponse | protected | function | Asserts the page did not return the specified response code. | ||
DrupalWebTestCase::assertNoText | protected | function | Pass if the text is NOT found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents. |
||
DrupalWebTestCase::assertNoTitle | protected | function | Pass if the page title is not the given string. | ||
DrupalWebTestCase::assertNoUniqueText | protected | function | Pass if the text is found MORE THAN ONCE on the text version of the page. | ||
DrupalWebTestCase::assertOptionSelected | protected | function | Asserts that a select option in the current page is checked. | ||
DrupalWebTestCase::assertPattern | protected | function | Will trigger a pass if the Perl regex pattern is found in the raw content. | ||
DrupalWebTestCase::assertRaw | protected | function | Pass if the raw text IS found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated. |
||
DrupalWebTestCase::assertResponse | protected | function | Asserts the page responds with the specified response code. | ||
DrupalWebTestCase::assertText | protected | function | Pass if the text IS found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents. |
||
DrupalWebTestCase::assertTextHelper | protected | function | Helper for assertText and assertNoText. | ||
DrupalWebTestCase::assertThemeOutput | protected | function | Asserts themed output. | ||
DrupalWebTestCase::assertTitle | protected | function | Pass if the page title is the given string. | ||
DrupalWebTestCase::assertUniqueText | protected | function | Pass if the text is found ONLY ONCE on the text version of the page. | ||
DrupalWebTestCase::assertUniqueTextHelper | protected | function | Helper for assertUniqueText and assertNoUniqueText. | ||
DrupalWebTestCase::assertUrl | protected | function | Pass if the internal browser's URL matches the given path. | ||
DrupalWebTestCase::buildXPathQuery | protected | function | Builds an XPath query. | ||
DrupalWebTestCase::changeDatabasePrefix | protected | function | Changes the database connection to the prefixed one. | ||
DrupalWebTestCase::checkForMetaRefresh | protected | function | Check for meta refresh tag and if found call drupalGet() recursively. This function looks for the http-equiv attribute to be set to "Refresh" and is case-sensitive. |
||
DrupalWebTestCase::checkPermissions | protected | function | Check to make sure that the array of permissions are valid. | ||
DrupalWebTestCase::clickLink | protected | function | Follows a link by name. | ||
DrupalWebTestCase::constructFieldXpath | protected | function | Helper function: construct an XPath for the given set of attributes and value. | ||
DrupalWebTestCase::copySetupCache | protected | function | Copy the setup cache from/to another table and files directory. | ||
DrupalWebTestCase::cronRun | protected | function | Runs cron in the Drupal installed by Simpletest. | ||
DrupalWebTestCase::curlClose | protected | function | Close the cURL handler and unset the handler. | ||
DrupalWebTestCase::curlExec | protected | function | Initializes and executes a cURL request. | ||
DrupalWebTestCase::curlHeaderCallback | protected | function | Reads headers and registers errors received from the tested site. | ||
DrupalWebTestCase::curlInitialize | protected | function | Initializes the cURL connection. | ||
DrupalWebTestCase::drupalCompareFiles | protected | function | Compare two files based on size and file name. | ||
DrupalWebTestCase::drupalCreateContentType | protected | function | Creates a custom content type based on default settings. | ||
DrupalWebTestCase::drupalCreateNode | protected | function | Creates a node based on default settings. | ||
DrupalWebTestCase::drupalCreateRole | protected | function | Creates a role with specified permissions. | ||
DrupalWebTestCase::drupalCreateUser | protected | function | Create a user with a given set of permissions. | ||
DrupalWebTestCase::drupalGet | protected | function | Retrieves a Drupal path or an absolute path. | ||
DrupalWebTestCase::drupalGetAJAX | protected | function | Retrieve a Drupal path or an absolute path and JSON decode the result. | ||
DrupalWebTestCase::drupalGetContent | protected | function | Gets the current raw HTML of requested page. | ||
DrupalWebTestCase::drupalGetHeader | protected | function | Gets the value of an HTTP response header. If multiple requests were required to retrieve the page, only the headers from the last request will be checked by default. However, if TRUE is passed as the second argument, all requests will be processed… |
||
DrupalWebTestCase::drupalGetHeaders | protected | function | Gets the HTTP response headers of the requested page. Normally we are only interested in the headers returned by the last request. However, if a page is redirected or HTTP authentication is in use, multiple requests will be required to retrieve the… |
||
DrupalWebTestCase::drupalGetMails | protected | function | Gets an array containing all e-mails sent during this test case. | ||
DrupalWebTestCase::drupalGetNodeByTitle | function | Get a node from the database based on its title. | |||
DrupalWebTestCase::drupalGetSettings | protected | function | Gets the value of the Drupal.settings JavaScript variable for the currently loaded page. | ||
DrupalWebTestCase::drupalGetTestFiles | protected | function | Get a list files that can be used in tests. | ||
DrupalWebTestCase::drupalGetToken | protected | function | Generate a token for the currently logged in user. | ||
DrupalWebTestCase::drupalHead | protected | function | Retrieves only the headers for a Drupal path or an absolute path. | ||
DrupalWebTestCase::drupalLogin | protected | function | Log in a user with the internal browser. | ||
DrupalWebTestCase::drupalLogout | protected | function | |||
DrupalWebTestCase::drupalPost | protected | function | Execute a POST request on a Drupal page. It will be done as usual POST request with SimpleBrowser. |
||
DrupalWebTestCase::drupalPostAJAX | protected | function | Execute an Ajax submission. | ||
DrupalWebTestCase::drupalSetContent | protected | function | Sets the raw HTML content. This can be useful when a page has been fetched outside of the internal browser and assertions need to be made on the returned page. |
||
DrupalWebTestCase::drupalSetSettings | protected | function | Sets the value of the Drupal.settings JavaScript variable for the currently loaded page. | ||
DrupalWebTestCase::getAbsoluteUrl | protected | function | Takes a path and returns an absolute path. | ||
DrupalWebTestCase::getAllOptions | protected | function | Get all option elements, including nested options, in a select. | ||
DrupalWebTestCase::getSelectedItem | protected | function | Get the selected value from a select field. | ||
DrupalWebTestCase::getSetupCacheKey | protected | function | Returns the cache key used for the setup caching. | ||
DrupalWebTestCase::getUrl | protected | function | Get the current URL from the cURL handler. | ||
DrupalWebTestCase::handleForm | protected | function | Handle form input related to drupalPost(). Ensure that the specified fields exist and attempt to create POST data in the correct manner for the particular field type. |
||
DrupalWebTestCase::loadSetupCache | protected | function | Copies the cached tables and files for a cached installation setup. | ||
DrupalWebTestCase::parse | protected | function | Parse content returned from curlExec using DOM and SimpleXML. | ||
DrupalWebTestCase::preloadRegistry | protected | function | Preload the registry from the testing site. | ||
DrupalWebTestCase::prepareDatabasePrefix | protected | function | Generates a database prefix for running tests. | ||
DrupalWebTestCase::prepareEnvironment | protected | function | Prepares the current environment for running the test. | ||
DrupalWebTestCase::recursiveDirectoryCopy | protected | function | Recursively copy one directory to another. | ||
DrupalWebTestCase::refreshVariables | protected | function | Refresh the in-memory set of variables. Useful after a page request is made that changes a variable in a different thread. |
1 | |
DrupalWebTestCase::resetAll | protected | function | Reset all data structures after having enabled new modules. | ||
DrupalWebTestCase::storeSetupCache | protected | function | Store the installation setup to a cache. | ||
DrupalWebTestCase::tearDown | protected | function | Delete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix. |
7 | |
DrupalWebTestCase::verboseEmail | protected | function | Outputs to verbose the most recent $count emails sent. | ||
DrupalWebTestCase::xpath | protected | function | Perform an xpath search on the contents of the internal browser. The search is relative to the root element (HTML tag normally) of the page. |
||
DrupalWebTestCase::__construct | function | Constructor for DrupalWebTestCase. | Overrides DrupalTestCase::__construct | 1 | |
FieldAttachStorageTestCase::getInfo | public static | function | |||
FieldAttachStorageTestCase::testFieldAttachCreateRenameBundle | function | Test field_attach_create_bundle() and field_attach_rename_bundle(). | |||
FieldAttachStorageTestCase::testFieldAttachDelete | function | Test field_attach_delete(). | |||
FieldAttachStorageTestCase::testFieldAttachDeleteBundle | function | Test field_attach_delete_bundle(). | |||
FieldAttachStorageTestCase::testFieldAttachLoadMultiple | function | Test the 'multiple' load feature. | |||
FieldAttachStorageTestCase::testFieldAttachSaveLoad | function | Check field values insert, update and load. | |||
FieldAttachStorageTestCase::testFieldAttachSaveLoadDifferentStorage | function | Test saving and loading fields using different storage backends. | |||
FieldAttachStorageTestCase::testFieldAttachSaveMissingData | function | Tests insert and update with missing or NULL fields. | |||
FieldAttachStorageTestCase::testFieldAttachSaveMissingDataDefaultValue | function | Test insert with missing or NULL fields, with default value. | |||
FieldAttachStorageTestCase::testFieldHasData | function | Test field_has_data(). | |||
FieldAttachStorageTestCase::testFieldStorageDetailsAlter | function | Test storage details alteration. | |||
FieldAttachTestCase::$field | protected | property | |||
FieldAttachTestCase::$field_2 | protected | property | |||
FieldAttachTestCase::$field_id | protected | property | |||
FieldAttachTestCase::$field_id_2 | protected | property | |||
FieldAttachTestCase::$field_name | protected | property | |||
FieldAttachTestCase::$field_name_2 | protected | property | |||
FieldAttachTestCase::$instance | protected | property | |||
FieldAttachTestCase::$instance_2 | protected | property | |||
FieldAttachTestCase::createFieldWithInstance | function | Create a field and an instance of it. | |||
FieldAttachTestCase::setUp | function | Set the default field storage backend for fields created during tests. | Overrides FieldTestCase::setUp | ||
FieldTestCase::$default_storage | property | ||||
FieldTestCase::assertFieldValues | function | Assert that a field has the expected values in an entity. | |||
FieldTestCase::_generateTestFieldValues | function | Generate random values for a field_test field. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.