FieldBulkDeleteTestCase

  1. drupal
    1. 8
    2. 7

Unit test class for field bulk delete and batch purge functionality.

Hierarchy

Properties

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

Functions & methods

NameDescription
DrupalTestCase::assertInternal helper: stores the assert.
DrupalTestCase::assertEqualCheck to see if two values are equal.
DrupalTestCase::assertFalseCheck to see if a value is false (an empty string, 0, NULL, or FALSE).
DrupalTestCase::assertIdenticalCheck to see if two values are identical.
DrupalTestCase::assertNotEqualCheck to see if two values are not equal.
DrupalTestCase::assertNotIdenticalCheck to see if two values are not identical.
DrupalTestCase::assertNotNullCheck to see if a value is not NULL.
DrupalTestCase::assertNullCheck to see if a value is NULL.
DrupalTestCase::assertTrueCheck to see if a value is not false (not an empty string, 0, NULL, or FALSE).
DrupalTestCase::deleteAssertDelete an assertion record by message ID.
DrupalTestCase::errorFire an error assertion.
DrupalTestCase::errorHandlerHandle errors during test runs.
DrupalTestCase::exceptionHandlerHandle exceptions.
DrupalTestCase::failFire an assertion that is always negative.
DrupalTestCase::generatePermutationsConverts a list of possible parameters into a stack of permutations.
DrupalTestCase::getAssertionCallCycles through backtrace until the first non-assertion method is found.
DrupalTestCase::insertAssertStore an assertion from outside the testing context.
DrupalTestCase::passFire an assertion that is always positive.
DrupalTestCase::randomNameGenerates a random string containing letters and numbers.
DrupalTestCase::randomStringGenerates a random string of ASCII characters of codes 32 to 126.
DrupalTestCase::runRun all tests in this class.
DrupalTestCase::verboseLogs verbose message in a text file.
DrupalWebTestCase::assertFieldAsserts that a field exists with the given name or id.
DrupalWebTestCase::assertFieldByIdAsserts that a field exists in the current page with the given id and value.
DrupalWebTestCase::assertFieldByNameAsserts that a field exists in the current page with the given name and value.
DrupalWebTestCase::assertFieldByXPathAsserts that a field exists in the current page by the given XPath.
DrupalWebTestCase::assertFieldCheckedAsserts that a checkbox field in the current page is checked.
DrupalWebTestCase::assertLinkPass if a link with the specified label is found, and optional with the specified index.
DrupalWebTestCase::assertLinkByHrefPass if a link containing a given href (part) is found.
DrupalWebTestCase::assertMailAsserts that the most recently sent e-mail message has the given value.
DrupalWebTestCase::assertMailPatternAsserts that the most recently sent e-mail message has the pattern in it.
DrupalWebTestCase::assertMailStringAsserts that the most recently sent e-mail message has the string in it.
DrupalWebTestCase::assertNoDuplicateIdsAsserts that each HTML ID is used for just a single element.
DrupalWebTestCase::assertNoFieldAsserts that a field does not exist with the given name or id.
DrupalWebTestCase::assertNoFieldByIdAsserts that a field does not exist with the given id and value.
DrupalWebTestCase::assertNoFieldByNameAsserts that a field does not exist with the given name and value.
DrupalWebTestCase::assertNoFieldByXPathAsserts that a field does not exist in the current page by the given XPath.
DrupalWebTestCase::assertNoFieldCheckedAsserts that a checkbox field in the current page is not checked.
DrupalWebTestCase::assertNoLinkPass if a link with the specified label is not found.
DrupalWebTestCase::assertNoLinkByHrefPass if a link containing a given href (part) is not found.
DrupalWebTestCase::assertNoOptionSelectedAsserts that a select option in the current page is not checked.
DrupalWebTestCase::assertNoPatternWill trigger a pass if the perl regex pattern is not present in raw content.
DrupalWebTestCase::assertNoRawPass if the raw text is NOT found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated.
DrupalWebTestCase::assertNoResponseAsserts the page did not return the specified response code.
DrupalWebTestCase::assertNoTextPass if the text is NOT found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents.
DrupalWebTestCase::assertNoTitlePass if the page title is not the given string.
DrupalWebTestCase::assertNoUniqueTextPass if the text is found MORE THAN ONCE on the text version of the page.
DrupalWebTestCase::assertOptionSelectedAsserts that a select option in the current page is checked.
DrupalWebTestCase::assertPatternWill trigger a pass if the Perl regex pattern is found in the raw content.
DrupalWebTestCase::assertRawPass if the raw text IS found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated.
DrupalWebTestCase::assertResponseAsserts the page responds with the specified response code.
DrupalWebTestCase::assertTextPass if the text IS found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents.
DrupalWebTestCase::assertTextHelperHelper for assertText and assertNoText.
DrupalWebTestCase::assertTitlePass if the page title is the given string.
DrupalWebTestCase::assertUniqueTextPass if the text is found ONLY ONCE on the text version of the page.
DrupalWebTestCase::assertUniqueTextHelperHelper for assertUniqueText and assertNoUniqueText.
DrupalWebTestCase::assertUrlPass if the internal browser's URL matches the given path.
DrupalWebTestCase::buildXPathQueryBuilds an XPath query.
DrupalWebTestCase::checkForMetaRefreshCheck for meta refresh tag and if found call drupalGet() recursively. This function looks for the http-equiv attribute to be set to "Refresh" and is case-sensitive.
DrupalWebTestCase::checkPermissionsCheck to make sure that the array of permissions are valid.
DrupalWebTestCase::clickLinkFollows a link by name.
DrupalWebTestCase::constructFieldXpathHelper function: construct an XPath for the given set of attributes and value.
DrupalWebTestCase::cronRunRuns cron in the Drupal installed by Simpletest.
DrupalWebTestCase::curlCloseClose the cURL handler and unset the handler.
DrupalWebTestCase::curlExecInitializes and executes a cURL request.
DrupalWebTestCase::curlHeaderCallbackReads headers and registers errors received from the tested site.
DrupalWebTestCase::curlInitializeInitializes the cURL connection.
DrupalWebTestCase::drupalCompareFilesCompare two files based on size and file name.
DrupalWebTestCase::drupalCreateContentTypeCreates a custom content type based on default settings.
DrupalWebTestCase::drupalCreateNodeCreates a node based on default settings.
DrupalWebTestCase::drupalCreateRoleInternal helper function; Create a role with specified permissions.
DrupalWebTestCase::drupalCreateUserCreate a user with a given set of permissions. The permissions correspond to the names given on the privileges page.
DrupalWebTestCase::drupalGetRetrieves a Drupal path or an absolute path.
DrupalWebTestCase::drupalGetAJAXRetrieve a Drupal path or an absolute path and JSON decode the result.
DrupalWebTestCase::drupalGetContentGets the current raw HTML of requested page.
DrupalWebTestCase::drupalGetHeaderGets the value of an HTTP response header. If multiple requests were required to retrieve the page, only the headers from the last request will be checked by default. However, if TRUE is passed as the second argument, all requests will be processed…
DrupalWebTestCase::drupalGetHeadersGets the HTTP response headers of the requested page. Normally we are only interested in the headers returned by the last request. However, if a page is redirected or HTTP authentication is in use, multiple requests will be required to retrieve the…
DrupalWebTestCase::drupalGetMailsGets an array containing all e-mails sent during this test case.
DrupalWebTestCase::drupalGetNodeByTitleGet a node from the database based on its title.
DrupalWebTestCase::drupalGetSettingsGets the value of the Drupal.settings JavaScript variable for the currently loaded page.
DrupalWebTestCase::drupalGetTestFilesGet a list files that can be used in tests.
DrupalWebTestCase::drupalGetTokenGenerate a token for the currently logged in user.
DrupalWebTestCase::drupalHeadRetrieves only the headers for a Drupal path or an absolute path.
DrupalWebTestCase::drupalLoginLog in a user with the internal browser.
DrupalWebTestCase::drupalLogout
DrupalWebTestCase::drupalPostExecute a POST request on a Drupal page. It will be done as usual POST request with SimpleBrowser.
DrupalWebTestCase::drupalPostAJAXExecute an Ajax submission.
DrupalWebTestCase::drupalSetContentSets the raw HTML content. This can be useful when a page has been fetched outside of the internal browser and assertions need to be made on the returned page.
DrupalWebTestCase::drupalSetSettingsSets the value of the Drupal.settings JavaScript variable for the currently loaded page.
DrupalWebTestCase::getAbsoluteUrlTakes a path and returns an absolute path.
DrupalWebTestCase::getAllOptionsGet all option elements, including nested options, in a select.
DrupalWebTestCase::getSelectedItemGet the selected value from a select field.
DrupalWebTestCase::getUrlGet the current url from the cURL handler.
DrupalWebTestCase::handleFormHandle form input related to drupalPost(). Ensure that the specified fields exist and attempt to create POST data in the correct manner for the particular field type.
DrupalWebTestCase::parseParse content returned from curlExec using DOM and SimpleXML.
DrupalWebTestCase::preloadRegistryPreload the registry from the testing site.
DrupalWebTestCase::refreshVariablesRefresh the in-memory set of variables. Useful after a page request is made that changes a variable in a different thread.
DrupalWebTestCase::resetAllReset all data structures after having enabled new modules.
DrupalWebTestCase::tearDownDelete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix.
DrupalWebTestCase::verboseEmailOutputs to verbose the most recent $count emails sent.
DrupalWebTestCase::xpathPerform an xpath search on the contents of the internal browser. The search is relative to the root element (HTML tag normally) of the page.
DrupalWebTestCase::__constructConstructor for DrupalWebTestCase. Overrides DrupalTestCase::__construct
FieldBulkDeleteTestCase::getInfo
FieldBulkDeleteTestCase::setUpSet the default field storage backend for fields created during tests. Overrides FieldTestCase::setUp
FieldBulkDeleteTestCase::testDeleteFieldInstanceVerify that deleting an instance leaves the field data items in the database and that the appropriate Field API functions can operate on the deleted data and instance.
FieldBulkDeleteTestCase::testPurgeFieldVerify that fields are preserved and purged correctly as multiple instances are deleted and purged.
FieldBulkDeleteTestCase::testPurgeInstanceVerify that field data items and instances are purged when an instance is deleted.
FieldBulkDeleteTestCase::_generateStubEntitiesConvenience function for Field API tests.
FieldTestCase::assertFieldValuesAssert that a field has the expected values in an entity.
FieldTestCase::_generateTestFieldValuesGenerate random values for a field_test field.

modules/field/tests/field.test, line 2961

View source
<?php
class FieldBulkDeleteTestCase extends FieldTestCase {
  protected $field;

  public static function getInfo() {
    return array(
      'name' => 'Field bulk delete tests', 
      'description' => 'Bulk delete fields and instances, and clean up afterwards.', 
      'group' => 'Field API',
    );
  }

  /**
   * Convenience function for Field API tests.
   *
   * Given an array of potentially fully-populated entities and an
   * optional field name, generate an array of stub entities of the
   * same fieldable type which contains the data for the field name
   * (if given).
   *
   * @param $entity_type
   *   The entity type of $entities.
   * @param $entities
   *   An array of entities of type $entity_type.
   * @param $field_name
   *   Optional; a field name whose data should be copied from
   *   $entities into the returned stub entities.
   * @return
   *   An array of stub entities corresponding to $entities.
   */
  function _generateStubEntities($entity_type, $entities, $field_name = NULL) {
    $stubs = array();
    foreach ($entities as $entity) {
      $stub = entity_create_stub_entity($entity_type, entity_extract_ids($entity_type, $entity));
      if (isset($field_name)) {
        $stub->{$field_name} = $entity->{$field_name};
      }
      $stubs[] = $stub;
    }
    return $stubs;
  }

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

    // Clean up data from previous test cases.
    $this->fields = array();
    $this->instances = array();

    // Create two bundles.
    $this->bundles = array(
      'bb_1' => 'bb_1',
      'bb_2' => 'bb_2',
    );
    foreach ($this->bundles as $name => $desc) {
      field_test_create_bundle($name, $desc);
    }

    // Create two fields.
    $field = array(
      'field_name' => 'bf_1',
      'type' => 'test_field',
      'cardinality' => 1,
    );
    $this->fields[] = field_create_field($field);
    $field = array(
      'field_name' => 'bf_2',
      'type' => 'test_field',
      'cardinality' => 4,
    );
    $this->fields[] = field_create_field($field);

    // For each bundle, create an instance of each field, and 10
    // entities with values for each field.
    $id = 0;
    $this->entity_type = 'test_entity';
    foreach ($this->bundles as $bundle) {
      foreach ($this->fields as $field) {
        $instance = array(
          'field_name' => $field['field_name'], 
          'entity_type' => $this->entity_type, 
          'bundle' => $bundle, 
          'widget' => array(
            'type' => 'test_field_widget',
          ),
        );
        $this->instances[] = field_create_instance($instance);
      }

      for ($i = 0; $i < 10; $i++) {
        $entity = field_test_create_stub_entity($id, $id, $bundle);
        foreach ($this->fields as $field) {
          $entity->{$field['field_name']}[LANGUAGE_NONE] = $this->_generateTestFieldValues($field['cardinality']);
        }
        $this->entities[$id] = $entity;
        field_attach_insert($this->entity_type, $entity);
        $id++;
      }
    }
  }

  /**
   * Verify that deleting an instance leaves the field data items in
   * the database and that the appropriate Field API functions can
   * operate on the deleted data and instance.
   *
   * This tests how EntityFieldQuery interacts with
   * field_delete_instance() and could be moved to FieldCrudTestCase,
   * but depends on this class's setUp().
   */
  function testDeleteFieldInstance() {
    $bundle = reset($this->bundles);
    $field = reset($this->fields);

    // There are 10 entities of this bundle.
    $query = new EntityFieldQuery();
    $found = $query
      ->fieldCondition($field)
      ->entityCondition('bundle', $bundle)
      ->execute();
    $this->assertEqual(count($found['test_entity']), 10, 'Correct number of entities found before deleting');

    // Delete the instance.
    $instance = field_info_instance($this->entity_type, $field['field_name'], $bundle);
    field_delete_instance($instance);

    // The instance still exists, deleted.
    $instances = field_read_instances(array('field_id' => $field['id'], 'deleted' => 1), array('include_deleted' => 1, 'include_inactive' => 1));
    $this->assertEqual(count($instances), 1, 'There is one deleted instance');
    $this->assertEqual($instances[0]['bundle'], $bundle, 'The deleted instance is for the correct bundle');

    // There are 0 entities of this bundle with non-deleted data.
    $query = new EntityFieldQuery();
    $found = $query
      ->fieldCondition($field)
      ->entityCondition('bundle', $bundle)
      ->execute();
    $this->assertTrue(!isset($found['test_entity']), 'No entities found after deleting');

    // There are 10 entities of this bundle when deleted fields are allowed, and
    // their values are correct.
    $query = new EntityFieldQuery();
    $found = $query
      ->fieldCondition($field)
      ->entityCondition('bundle', $bundle)
      ->deleted(TRUE)
      ->execute();
    field_attach_load($this->entity_type, $found[$this->entity_type], FIELD_LOAD_CURRENT, array('field_id' => $field['id'], 'deleted' => 1));
    $this->assertEqual(count($found['test_entity']), 10, 'Correct number of entities found after deleting');
    foreach ($found['test_entity'] as $id => $entity) {
      $this->assertEqual($this->entities[$id]->{$field['field_name']}, $entity->{$field['field_name']}, "Entity $id with deleted data loaded correctly");
    }
  }

  /**
   * Verify that field data items and instances are purged when an
   * instance is deleted.
   */
  function testPurgeInstance() {
    field_test_memorize();

    $bundle = reset($this->bundles);
    $field = reset($this->fields);

    // Delete the instance.
    $instance = field_info_instance($this->entity_type, $field['field_name'], $bundle);
    field_delete_instance($instance);

    // No field hooks were called.
    $mem = field_test_memorize();
    $this->assertEqual(count($mem), 0, 'No field hooks were called');

    $batch_size = 2;
    for ($count = 8; $count >= 0; $count -= 2) {
      // Purge two entities.
      field_purge_batch($batch_size);

      // There are $count deleted entities left.
      $query = new EntityFieldQuery();
      $found = $query
        ->fieldCondition($field)
        ->entityCondition('bundle', $bundle)
        ->deleted(TRUE)
        ->execute();
      $this->assertEqual($count ? count($found['test_entity']) : count($found), $count, 'Correct number of entities found after purging 2');
    }

    // hook_field_delete() was called on a pseudo-entity for each entity. Each
    // pseudo entity has a $field property that matches the original entity,
    // but no others.
    $mem = field_test_memorize();
    $this->assertEqual(count($mem['field_test_field_delete']), 10, 'hook_field_delete was called for the right number of entities');
    $stubs = $this->_generateStubEntities($this->entity_type, $this->entities, $field['field_name']);
    $count = count($stubs);
    foreach ($mem['field_test_field_delete'] as $args) {
      $entity = $args[1];
      $this->assertEqual($stubs[$entity->ftid], $entity, 'hook_field_delete() called with the correct stub');
      unset($stubs[$entity->ftid]);
    }
    $this->assertEqual(count($stubs), $count -10, 'hook_field_delete was called with each entity once');

    // The instance still exists, deleted.
    $instances = field_read_instances(array('field_id' => $field['id'], 'deleted' => 1), array('include_deleted' => 1, 'include_inactive' => 1));
    $this->assertEqual(count($instances), 1, 'There is one deleted instance');

    // Purge the instance.
    field_purge_batch($batch_size);

    // The instance is gone.
    $instances = field_read_instances(array('field_id' => $field['id'], 'deleted' => 1), array('include_deleted' => 1, 'include_inactive' => 1));
    $this->assertEqual(count($instances), 0, 'The instance is gone');

    // The field still exists, not deleted, because it has a second instance.
    $fields = field_read_fields(array('id' => $field['id']), array('include_deleted' => 1, 'include_inactive' => 1));
    $this->assertTrue(isset($fields[$field['id']]), 'The field exists and is not deleted');
  }

  /**
   * Verify that fields are preserved and purged correctly as multiple
   * instances are deleted and purged.
   */
  function testPurgeField() {
    $field = reset($this->fields);

    // Delete the first instance.
    $instance = field_info_instance($this->entity_type, $field['field_name'], 'bb_1');
    field_delete_instance($instance);

    // Purge the data.
    field_purge_batch(10);

    // Purge again to purge the instance.
    field_purge_batch(0);

    // The field still exists, not deleted.
    $fields = field_read_fields(array('id' => $field['id']), array('include_deleted' => 1));
    $this->assertTrue(isset($fields[$field['id']]) && !$fields[$field['id']]['deleted'], 'The field exists and is not deleted');

    // Delete the second instance.
    $instance = field_info_instance($this->entity_type, $field['field_name'], 'bb_2');
    field_delete_instance($instance);

    // Purge the data.
    field_purge_batch(10);

    // The field still exists, deleted.
    $fields = field_read_fields(array('id' => $field['id']), array('include_deleted' => 1));
    $this->assertTrue(isset($fields[$field['id']]) && $fields[$field['id']]['deleted'], 'The field exists and is deleted');

    // Purge again to purge the instance and the field.
    field_purge_batch(0);

    // The field is gone.
    $fields = field_read_fields(array('id' => $field['id']), array('include_deleted' => 1, 'include_inactive' => 1));
    $this->assertEqual(count($fields), 0, 'The field is purged.');
  }
}
?>