ActiveTest.php

<?php

/**
 * @file
 * Definition of Drupal\field\Tests\ActiveTest.
 */
namespace Drupal\field\Tests;

class ActiveTest extends FieldTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'field_test',
  );
  public static function getInfo() {
    return array(
      'name' => 'Field active test',
      'description' => 'Test that fields are properly marked active or inactive.',
      'group' => 'Field API',
    );
  }

  /**
   * Test that fields are properly marked active or inactive.
   */
  function testActive() {
    $field_definition = array(
      'field_name' => 'field_1',
      'type' => 'test_field',
      // For this test, we need a storage backend provided by a different
      // module than field_test.module.
      'storage' => array(
        'type' => 'field_sql_storage',
      ),
    );
    field_create_field($field_definition);

    // Test disabling and enabling:
    // - the field type module,
    // - the storage module,
    // - both.
    $this
      ->_testActiveHelper($field_definition, array(
      'field_test',
    ));
    $this
      ->_testActiveHelper($field_definition, array(
      'field_sql_storage',
    ));
    $this
      ->_testActiveHelper($field_definition, array(
      'field_test',
      'field_sql_storage',
    ));
  }

  /**
   * Helper function for testActive().
   *
   * Test dependency between a field and a set of modules.
   *
   * @param $field_definition
   *   A field definition.
   * @param $modules
   *   An aray of module names. The field will be tested to be inactive as long
   *   as any of those modules is disabled.
   */
  function _testActiveHelper($field_definition, $modules) {
    $field_name = $field_definition['field_name'];

    // Read the field.
    $field = field_read_field($field_name);
    $this
      ->assertTrue($field_definition <= $field, 'The field was properly read.');
    module_disable($modules, FALSE);
    $fields = field_read_fields(array(
      'field_name' => $field_name,
    ), array(
      'include_inactive' => TRUE,
    ));
    $this
      ->assertTrue(isset($fields[$field_name]) && $field_definition < $field, 'The field is properly read when explicitly fetching inactive fields.');

    // Re-enable modules one by one, and check that the field is still inactive
    // while some modules remain disabled.
    while ($modules) {
      $field = field_read_field($field_name);
      $this
        ->assertTrue(empty($field), format_string('%modules disabled. The field is marked inactive.', array(
        '%modules' => implode(', ', $modules),
      )));
      $module = array_shift($modules);
      module_enable(array(
        $module,
      ), FALSE);
    }

    // Check that the field is active again after all modules have been
    // enabled.
    $field = field_read_field($field_name);
    $this
      ->assertTrue($field_definition <= $field, 'The field was was marked active.');
  }

}