class SchemaTest in Zircon Profile 8.0

Same name and namespace in other branches

8 core/modules/system/src/Tests/Database/SchemaTest.php \Drupal\system\Tests\Database\SchemaTest

Tests table creation and modification via the schema API.

@group Database

Hierarchy

class \Drupal\simpletest\TestBase uses AssertHelperTrait, RandomGeneratorTrait, SessionTestTrait
- class \Drupal\simpletest\KernelTestBase uses AssertContentTrait
  - class \Drupal\system\Tests\Database\SchemaTest

Expanded class hierarchy of SchemaTest

File

core/modules/system/src/Tests/Database/SchemaTest.php, line 22: Contains \Drupal\system\Tests\Database\SchemaTest.

Namespace

Drupal\system\Tests\Database

View source

class SchemaTest extends KernelTestBase {

  /**
   * A global counter for table and field creation.
   */
  protected $counter;

  /**
   * Tests database interactions.
   */
  function testSchema() {

    // Try creating a table.
    $table_specification = array(
      'description' => 'Schema table description may contain "quotes" and could be long—very long indeed.',
      'fields' => array(
        'id' => array(
          'type' => 'int',
          'default' => NULL,
        ),
        'test_field' => array(
          'type' => 'int',
          'not null' => TRUE,
          'description' => 'Schema table description may contain "quotes" and could be long—very long indeed. There could be "multiple quoted regions".',
        ),
        'test_field_string' => array(
          'type' => 'varchar',
          'length' => 20,
          'not null' => TRUE,
          'default' => "'\"funky default'\"",
          'description' => 'Schema column description for string.',
        ),
        'test_field_string_ascii' => array(
          'type' => 'varchar_ascii',
          'length' => 255,
          'description' => 'Schema column description for ASCII string.',
        ),
      ),
    );
    db_create_table('test_table', $table_specification);

    // Assert that the table exists.
    $this
      ->assertTrue(db_table_exists('test_table'), 'The table exists.');

    // Assert that the table comment has been set.
    $this
      ->checkSchemaComment($table_specification['description'], 'test_table');

    // Assert that the column comment has been set.
    $this
      ->checkSchemaComment($table_specification['fields']['test_field']['description'], 'test_table', 'test_field');
    if (Database::getConnection()
      ->databaseType() == 'mysql') {

      // Make sure that varchar fields have the correct collation.
      $columns = db_query('SHOW FULL COLUMNS FROM {test_table}');
      foreach ($columns as $column) {
        if ($column->Field == 'test_field_string') {
          $string_check = $column->Collation == 'utf8mb4_general_ci';
        }
        if ($column->Field == 'test_field_string_ascii') {
          $string_ascii_check = $column->Collation == 'ascii_general_ci';
        }
      }
      $this
        ->assertTrue(!empty($string_check), 'string field has the right collation.');
      $this
        ->assertTrue(!empty($string_ascii_check), 'ASCII string field has the right collation.');
    }

    // An insert without a value for the column 'test_table' should fail.
    $this
      ->assertFalse($this
      ->tryInsert(), 'Insert without a default failed.');

    // Add a default value to the column.
    db_field_set_default('test_table', 'test_field', 0);

    // The insert should now succeed.
    $this
      ->assertTrue($this
      ->tryInsert(), 'Insert with a default succeeded.');

    // Remove the default.
    db_field_set_no_default('test_table', 'test_field');

    // The insert should fail again.
    $this
      ->assertFalse($this
      ->tryInsert(), 'Insert without a default failed.');

    // Test for fake index and test for the boolean result of indexExists().
    $index_exists = Database::getConnection()
      ->schema()
      ->indexExists('test_table', 'test_field');
    $this
      ->assertIdentical($index_exists, FALSE, 'Fake index does not exists');

    // Add index.
    db_add_index('test_table', 'test_field', array(
      'test_field',
    ), $table_specification);

    // Test for created index and test for the boolean result of indexExists().
    $index_exists = Database::getConnection()
      ->schema()
      ->indexExists('test_table', 'test_field');
    $this
      ->assertIdentical($index_exists, TRUE, 'Index created.');

    // Rename the table.
    db_rename_table('test_table', 'test_table2');

    // Index should be renamed.
    $index_exists = Database::getConnection()
      ->schema()
      ->indexExists('test_table2', 'test_field');
    $this
      ->assertTrue($index_exists, 'Index was renamed.');

    // We need the default so that we can insert after the rename.
    db_field_set_default('test_table2', 'test_field', 0);
    $this
      ->assertFalse($this
      ->tryInsert(), 'Insert into the old table failed.');
    $this
      ->assertTrue($this
      ->tryInsert('test_table2'), 'Insert into the new table succeeded.');

    // We should have successfully inserted exactly two rows.
    $count = db_query('SELECT COUNT(*) FROM {test_table2}')
      ->fetchField();
    $this
      ->assertEqual($count, 2, 'Two fields were successfully inserted.');

    // Try to drop the table.
    db_drop_table('test_table2');
    $this
      ->assertFalse(db_table_exists('test_table2'), 'The dropped table does not exist.');

    // Recreate the table.
    db_create_table('test_table', $table_specification);
    db_field_set_default('test_table', 'test_field', 0);
    db_add_field('test_table', 'test_serial', array(
      'type' => 'int',
      'not null' => TRUE,
      'default' => 0,
      'description' => 'Added column description.',
    ));

    // Assert that the column comment has been set.
    $this
      ->checkSchemaComment('Added column description.', 'test_table', 'test_serial');

    // Change the new field to a serial column.
    db_change_field('test_table', 'test_serial', 'test_serial', array(
      'type' => 'serial',
      'not null' => TRUE,
      'description' => 'Changed column description.',
    ), array(
      'primary key' => array(
        'test_serial',
      ),
    ));

    // Assert that the column comment has been set.
    $this
      ->checkSchemaComment('Changed column description.', 'test_table', 'test_serial');
    $this
      ->assertTrue($this
      ->tryInsert(), 'Insert with a serial succeeded.');
    $max1 = db_query('SELECT MAX(test_serial) FROM {test_table}')
      ->fetchField();
    $this
      ->assertTrue($this
      ->tryInsert(), 'Insert with a serial succeeded.');
    $max2 = db_query('SELECT MAX(test_serial) FROM {test_table}')
      ->fetchField();
    $this
      ->assertTrue($max2 > $max1, 'The serial is monotone.');
    $count = db_query('SELECT COUNT(*) FROM {test_table}')
      ->fetchField();
    $this
      ->assertEqual($count, 2, 'There were two rows.');

    // Test renaming of keys and constraints.
    db_drop_table('test_table');
    $table_specification = array(
      'fields' => array(
        'id' => array(
          'type' => 'serial',
          'not null' => TRUE,
        ),
        'test_field' => array(
          'type' => 'int',
          'default' => 0,
        ),
      ),
      'primary key' => array(
        'id',
      ),
      'unique keys' => array(
        'test_field' => array(
          'test_field',
        ),
      ),
    );
    db_create_table('test_table', $table_specification);

    // Tests for indexes are Database specific.
    $db_type = Database::getConnection()
      ->databaseType();

    // Test for existing primary and unique keys.
    switch ($db_type) {
      case 'pgsql':
        $primary_key_exists = Database::getConnection()
          ->schema()
          ->constraintExists('test_table', '__pkey');
        $unique_key_exists = Database::getConnection()
          ->schema()
          ->constraintExists('test_table', 'test_field' . '__key');
        break;
      case 'sqlite':

        // SQLite does not create a standalone index for primary keys.
        $primary_key_exists = TRUE;
        $unique_key_exists = Database::getConnection()
          ->schema()
          ->indexExists('test_table', 'test_field');
        break;
      default:
        $primary_key_exists = Database::getConnection()
          ->schema()
          ->indexExists('test_table', 'PRIMARY');
        $unique_key_exists = Database::getConnection()
          ->schema()
          ->indexExists('test_table', 'test_field');
        break;
    }
    $this
      ->assertIdentical($primary_key_exists, TRUE, 'Primary key created.');
    $this
      ->assertIdentical($unique_key_exists, TRUE, 'Unique key created.');
    db_rename_table('test_table', 'test_table2');

    // Test for renamed primary and unique keys.
    switch ($db_type) {
      case 'pgsql':
        $renamed_primary_key_exists = Database::getConnection()
          ->schema()
          ->constraintExists('test_table2', '__pkey');
        $renamed_unique_key_exists = Database::getConnection()
          ->schema()
          ->constraintExists('test_table2', 'test_field' . '__key');
        break;
      case 'sqlite':

        // SQLite does not create a standalone index for primary keys.
        $renamed_primary_key_exists = TRUE;
        $renamed_unique_key_exists = Database::getConnection()
          ->schema()
          ->indexExists('test_table2', 'test_field');
        break;
      default:
        $renamed_primary_key_exists = Database::getConnection()
          ->schema()
          ->indexExists('test_table2', 'PRIMARY');
        $renamed_unique_key_exists = Database::getConnection()
          ->schema()
          ->indexExists('test_table2', 'test_field');
        break;
    }
    $this
      ->assertIdentical($renamed_primary_key_exists, TRUE, 'Primary key was renamed.');
    $this
      ->assertIdentical($renamed_unique_key_exists, TRUE, 'Unique key was renamed.');

    // For PostgreSQL check in addition that sequence was renamed.
    if ($db_type == 'pgsql') {

      // Get information about new table.
      $info = Database::getConnection()
        ->schema()
        ->queryTableInformation('test_table2');
      $sequence_name = Database::getConnection()
        ->schema()
        ->prefixNonTable('test_table2', 'id', 'seq');
      $this
        ->assertEqual($sequence_name, current($info->sequences), 'Sequence was renamed.');
    }

    // Use database specific data type and ensure that table is created.
    $table_specification = array(
      'description' => 'Schema table description.',
      'fields' => array(
        'timestamp' => array(
          'mysql_type' => 'timestamp',
          'pgsql_type' => 'timestamp',
          'sqlite_type' => 'datetime',
          'not null' => FALSE,
          'default' => NULL,
        ),
      ),
    );
    try {
      db_create_table('test_timestamp', $table_specification);
    } catch (\Exception $e) {
    }
    $this
      ->assertTrue(db_table_exists('test_timestamp'), 'Table with database specific datatype was created.');
  }

  /**
   * Tests that indexes on string fields are limited to 191 characters on MySQL.
   *
   * @see \Drupal\Core\Database\Driver\mysql\Schema::getNormalizedIndexes()
   */
  function testIndexLength() {
    if (Database::getConnection()
      ->databaseType() != 'mysql') {
      return;
    }
    $table_specification = array(
      'fields' => array(
        'id' => array(
          'type' => 'int',
          'default' => NULL,
        ),
        'test_field_text' => array(
          'type' => 'text',
          'not null' => TRUE,
        ),
        'test_field_string_long' => array(
          'type' => 'varchar',
          'length' => 255,
          'not null' => TRUE,
        ),
        'test_field_string_ascii_long' => array(
          'type' => 'varchar_ascii',
          'length' => 255,
        ),
        'test_field_string_short' => array(
          'type' => 'varchar',
          'length' => 128,
          'not null' => TRUE,
        ),
      ),
      'indexes' => array(
        'test_regular' => array(
          'test_field_text',
          'test_field_string_long',
          'test_field_string_ascii_long',
          'test_field_string_short',
        ),
        'test_length' => array(
          array(
            'test_field_text',
            128,
          ),
          array(
            'test_field_string_long',
            128,
          ),
          array(
            'test_field_string_ascii_long',
            128,
          ),
          array(
            'test_field_string_short',
            128,
          ),
        ),
        'test_mixed' => array(
          array(
            'test_field_text',
            200,
          ),
          'test_field_string_long',
          array(
            'test_field_string_ascii_long',
            200,
          ),
          'test_field_string_short',
        ),
      ),
    );
    db_create_table('test_table_index_length', $table_specification);
    $schema_object = Database::getConnection()
      ->schema();

    // Ensure expected exception thrown when adding index with missing info.
    $expected_exception_message = "MySQL needs the 'test_field_text' field specification in order to normalize the 'test_regular' index";
    $missing_field_spec = $table_specification;
    unset($missing_field_spec['fields']['test_field_text']);
    try {
      $schema_object
        ->addIndex('test_table_index_length', 'test_separate', [
        [
          'test_field_text',
          200,
        ],
      ], $missing_field_spec);
      $this
        ->fail('SchemaException not thrown when adding index with missing information.');
    } catch (SchemaException $e) {
      $this
        ->assertEqual($expected_exception_message, $e
        ->getMessage());
    }

    // Add a separate index.
    $schema_object
      ->addIndex('test_table_index_length', 'test_separate', [
      [
        'test_field_text',
        200,
      ],
    ], $table_specification);
    $table_specification_with_new_index = $table_specification;
    $table_specification_with_new_index['indexes']['test_separate'] = [
      [
        'test_field_text',
        200,
      ],
    ];

    // Ensure that the exceptions of addIndex are thrown as expected.
    try {
      $schema_object
        ->addIndex('test_table_index_length', 'test_separate', [
        [
          'test_field_text',
          200,
        ],
      ], $table_specification);
      $this
        ->fail('\\Drupal\\Core\\Database\\SchemaObjectExistsException exception missed.');
    } catch (SchemaObjectExistsException $e) {
      $this
        ->pass('\\Drupal\\Core\\Database\\SchemaObjectExistsException thrown when index already exists.');
    }
    try {
      $schema_object
        ->addIndex('test_table_non_existing', 'test_separate', [
        [
          'test_field_text',
          200,
        ],
      ], $table_specification);
      $this
        ->fail('\\Drupal\\Core\\Database\\SchemaObjectDoesNotExistException exception missed.');
    } catch (SchemaObjectDoesNotExistException $e) {
      $this
        ->pass('\\Drupal\\Core\\Database\\SchemaObjectDoesNotExistException thrown when index already exists.');
    }

    // Get index information.
    $results = db_query('SHOW INDEX FROM {test_table_index_length}');
    $expected_lengths = array(
      'test_regular' => array(
        'test_field_text' => 191,
        'test_field_string_long' => 191,
        'test_field_string_ascii_long' => NULL,
        'test_field_string_short' => NULL,
      ),
      'test_length' => array(
        'test_field_text' => 128,
        'test_field_string_long' => 128,
        'test_field_string_ascii_long' => 128,
        'test_field_string_short' => NULL,
      ),
      'test_mixed' => array(
        'test_field_text' => 191,
        'test_field_string_long' => 191,
        'test_field_string_ascii_long' => 200,
        'test_field_string_short' => NULL,
      ),
      'test_separate' => array(
        'test_field_text' => 191,
      ),
    );

    // Count the number of columns defined in the indexes.
    $column_count = 0;
    foreach ($table_specification_with_new_index['indexes'] as $index) {
      foreach ($index as $field) {
        $column_count++;
      }
    }
    $test_count = 0;
    foreach ($results as $result) {
      $this
        ->assertEqual($result->Sub_part, $expected_lengths[$result->Key_name][$result->Column_name], 'Index length matches expected value.');
      $test_count++;
    }
    $this
      ->assertEqual($test_count, $column_count, 'Number of tests matches expected value.');
  }

  /**
   * Tests inserting data into an existing table.
   *
   * @param $table
   *   The database table to insert data into.
   *
   * @return
   *   TRUE if the insert succeeded, FALSE otherwise.
   */
  function tryInsert($table = 'test_table') {
    try {
      db_insert($table)
        ->fields(array(
        'id' => mt_rand(10, 20),
      ))
        ->execute();
      return TRUE;
    } catch (\Exception $e) {
      return FALSE;
    }
  }

  /**
   * Checks that a table or column comment matches a given description.
   *
   * @param $description
   *   The asserted description.
   * @param $table
   *   The table to test.
   * @param $column
   *   Optional column to test.
   */
  function checkSchemaComment($description, $table, $column = NULL) {
    if (method_exists(Database::getConnection()
      ->schema(), 'getComment')) {
      $comment = Database::getConnection()
        ->schema()
        ->getComment($table, $column);

      // The schema comment truncation for mysql is different.
      if (Database::getConnection()
        ->databaseType() == 'mysql') {
        $max_length = $column ? 255 : 60;
        $description = Unicode::truncate($description, $max_length, TRUE, TRUE);
      }
      $this
        ->assertEqual($comment, $description, 'The comment matches the schema description.');
    }
  }

  /**
   * Tests creating unsigned columns and data integrity thereof.
   */
  function testUnsignedColumns() {

    // First create the table with just a serial column.
    $table_name = 'unsigned_table';
    $table_spec = array(
      'fields' => array(
        'serial_column' => array(
          'type' => 'serial',
          'unsigned' => TRUE,
          'not null' => TRUE,
        ),
      ),
      'primary key' => array(
        'serial_column',
      ),
    );
    db_create_table($table_name, $table_spec);

    // Now set up columns for the other types.
    $types = array(
      'int',
      'float',
      'numeric',
    );
    foreach ($types as $type) {
      $column_spec = array(
        'type' => $type,
        'unsigned' => TRUE,
      );
      if ($type == 'numeric') {
        $column_spec += array(
          'precision' => 10,
          'scale' => 0,
        );
      }
      $column_name = $type . '_column';
      $table_spec['fields'][$column_name] = $column_spec;
      db_add_field($table_name, $column_name, $column_spec);
    }

    // Finally, check each column and try to insert invalid values into them.
    foreach ($table_spec['fields'] as $column_name => $column_spec) {
      $this
        ->assertTrue(db_field_exists($table_name, $column_name), format_string('Unsigned @type column was created.', array(
        '@type' => $column_spec['type'],
      )));
      $this
        ->assertFalse($this
        ->tryUnsignedInsert($table_name, $column_name), format_string('Unsigned @type column rejected a negative value.', array(
        '@type' => $column_spec['type'],
      )));
    }
  }

  /**
   * Tries to insert a negative value into columns defined as unsigned.
   *
   * @param $table_name
   *   The table to insert.
   * @param $column_name
   *   The column to insert.
   *
   * @return
   *   TRUE if the insert succeeded, FALSE otherwise.
   */
  function tryUnsignedInsert($table_name, $column_name) {
    try {
      db_insert($table_name)
        ->fields(array(
        $column_name => -1,
      ))
        ->execute();
      return TRUE;
    } catch (\Exception $e) {
      return FALSE;
    }
  }

  /**
   * Tests adding columns to an existing table.
   */
  function testSchemaAddField() {

    // Test varchar types.
    foreach (array(
      1,
      32,
      128,
      256,
      512,
    ) as $length) {
      $base_field_spec = array(
        'type' => 'varchar',
        'length' => $length,
      );
      $variations = array(
        array(
          'not null' => FALSE,
        ),
        array(
          'not null' => FALSE,
          'default' => '7',
        ),
        array(
          'not null' => FALSE,
          'default' => substr('"thing"', 0, $length),
        ),
        array(
          'not null' => FALSE,
          'default' => substr("\"'hing", 0, $length),
        ),
        array(
          'not null' => TRUE,
          'initial' => 'd',
        ),
        array(
          'not null' => FALSE,
          'default' => NULL,
        ),
        array(
          'not null' => TRUE,
          'initial' => 'd',
          'default' => '7',
        ),
      );
      foreach ($variations as $variation) {
        $field_spec = $variation + $base_field_spec;
        $this
          ->assertFieldAdditionRemoval($field_spec);
      }
    }

    // Test int and float types.
    foreach (array(
      'int',
      'float',
    ) as $type) {
      foreach (array(
        'tiny',
        'small',
        'medium',
        'normal',
        'big',
      ) as $size) {
        $base_field_spec = array(
          'type' => $type,
          'size' => $size,
        );
        $variations = array(
          array(
            'not null' => FALSE,
          ),
          array(
            'not null' => FALSE,
            'default' => 7,
          ),
          array(
            'not null' => TRUE,
            'initial' => 1,
          ),
          array(
            'not null' => TRUE,
            'initial' => 1,
            'default' => 7,
          ),
        );
        foreach ($variations as $variation) {
          $field_spec = $variation + $base_field_spec;
          $this
            ->assertFieldAdditionRemoval($field_spec);
        }
      }
    }

    // Test numeric types.
    foreach (array(
      1,
      5,
      10,
      40,
      65,
    ) as $precision) {
      foreach (array(
        0,
        2,
        10,
        30,
      ) as $scale) {

        // Skip combinations where precision is smaller than scale.
        if ($precision <= $scale) {
          continue;
        }
        $base_field_spec = array(
          'type' => 'numeric',
          'scale' => $scale,
          'precision' => $precision,
        );
        $variations = array(
          array(
            'not null' => FALSE,
          ),
          array(
            'not null' => FALSE,
            'default' => 7,
          ),
          array(
            'not null' => TRUE,
            'initial' => 1,
          ),
          array(
            'not null' => TRUE,
            'initial' => 1,
            'default' => 7,
          ),
        );
        foreach ($variations as $variation) {
          $field_spec = $variation + $base_field_spec;
          $this
            ->assertFieldAdditionRemoval($field_spec);
        }
      }
    }
  }

  /**
   * Asserts that a given field can be added and removed from a table.
   *
   * The addition test covers both defining a field of a given specification
   * when initially creating at table and extending an existing table.
   *
   * @param $field_spec
   *   The schema specification of the field.
   */
  protected function assertFieldAdditionRemoval($field_spec) {

    // Try creating the field on a new table.
    $table_name = 'test_table_' . $this->counter++;
    $table_spec = array(
      'fields' => array(
        'serial_column' => array(
          'type' => 'serial',
          'unsigned' => TRUE,
          'not null' => TRUE,
        ),
        'test_field' => $field_spec,
      ),
      'primary key' => array(
        'serial_column',
      ),
    );
    db_create_table($table_name, $table_spec);
    $this
      ->pass(format_string('Table %table created.', array(
      '%table' => $table_name,
    )));

    // Check the characteristics of the field.
    $this
      ->assertFieldCharacteristics($table_name, 'test_field', $field_spec);

    // Clean-up.
    db_drop_table($table_name);

    // Try adding a field to an existing table.
    $table_name = 'test_table_' . $this->counter++;
    $table_spec = array(
      'fields' => array(
        'serial_column' => array(
          'type' => 'serial',
          'unsigned' => TRUE,
          'not null' => TRUE,
        ),
      ),
      'primary key' => array(
        'serial_column',
      ),
    );
    db_create_table($table_name, $table_spec);
    $this
      ->pass(format_string('Table %table created.', array(
      '%table' => $table_name,
    )));

    // Insert some rows to the table to test the handling of initial values.
    for ($i = 0; $i < 3; $i++) {
      db_insert($table_name)
        ->useDefaults(array(
        'serial_column',
      ))
        ->execute();
    }
    db_add_field($table_name, 'test_field', $field_spec);
    $this
      ->pass(format_string('Column %column created.', array(
      '%column' => 'test_field',
    )));

    // Check the characteristics of the field.
    $this
      ->assertFieldCharacteristics($table_name, 'test_field', $field_spec);

    // Clean-up.
    db_drop_field($table_name, 'test_field');

    // Add back the field and then try to delete a field which is also a primary
    // key.
    db_add_field($table_name, 'test_field', $field_spec);
    db_drop_field($table_name, 'serial_column');
    db_drop_table($table_name);
  }

  /**
   * Asserts that a newly added field has the correct characteristics.
   */
  protected function assertFieldCharacteristics($table_name, $field_name, $field_spec) {

    // Check that the initial value has been registered.
    if (isset($field_spec['initial'])) {

      // There should be no row with a value different then $field_spec['initial'].
      $count = db_select($table_name)
        ->fields($table_name, array(
        'serial_column',
      ))
        ->condition($field_name, $field_spec['initial'], '<>')
        ->countQuery()
        ->execute()
        ->fetchField();
      $this
        ->assertEqual($count, 0, 'Initial values filled out.');
    }

    // Check that the default value has been registered.
    if (isset($field_spec['default'])) {

      // Try inserting a row, and check the resulting value of the new column.
      $id = db_insert($table_name)
        ->useDefaults(array(
        'serial_column',
      ))
        ->execute();
      $field_value = db_select($table_name)
        ->fields($table_name, array(
        $field_name,
      ))
        ->condition('serial_column', $id)
        ->execute()
        ->fetchField();
      $this
        ->assertEqual($field_value, $field_spec['default'], 'Default value registered.');
    }
  }

  /**
   * Tests changing columns between types.
   */
  function testSchemaChangeField() {
    $field_specs = array(
      array(
        'type' => 'int',
        'size' => 'normal',
        'not null' => FALSE,
      ),
      array(
        'type' => 'int',
        'size' => 'normal',
        'not null' => TRUE,
        'initial' => 1,
        'default' => 17,
      ),
      array(
        'type' => 'float',
        'size' => 'normal',
        'not null' => FALSE,
      ),
      array(
        'type' => 'float',
        'size' => 'normal',
        'not null' => TRUE,
        'initial' => 1,
        'default' => 7.3,
      ),
      array(
        'type' => 'numeric',
        'scale' => 2,
        'precision' => 10,
        'not null' => FALSE,
      ),
      array(
        'type' => 'numeric',
        'scale' => 2,
        'precision' => 10,
        'not null' => TRUE,
        'initial' => 1,
        'default' => 7,
      ),
    );
    foreach ($field_specs as $i => $old_spec) {
      foreach ($field_specs as $j => $new_spec) {
        if ($i === $j) {

          // Do not change a field into itself.
          continue;
        }
        $this
          ->assertFieldChange($old_spec, $new_spec);
      }
    }
    $field_specs = array(
      array(
        'type' => 'varchar_ascii',
        'length' => '255',
      ),
      array(
        'type' => 'varchar',
        'length' => '255',
      ),
      array(
        'type' => 'text',
      ),
      array(
        'type' => 'blob',
        'size' => 'big',
      ),
    );
    foreach ($field_specs as $i => $old_spec) {
      foreach ($field_specs as $j => $new_spec) {
        if ($i === $j) {

          // Do not change a field into itself.
          continue;
        }

        // Note if the serialized data contained an object this would fail on
        // Postgres.
        // @see https://www.drupal.org/node/1031122
        $this
          ->assertFieldChange($old_spec, $new_spec, serialize([
          'string' => "This \n has \\\\ some backslash \"*string action.\\n",
        ]));
      }
    }
  }

  /**
   * Asserts that a field can be changed from one spec to another.
   *
   * @param $old_spec
   *   The beginning field specification.
   * @param $new_spec
   *   The ending field specification.
   */
  protected function assertFieldChange($old_spec, $new_spec, $test_data = NULL) {
    $table_name = 'test_table_' . $this->counter++;
    $table_spec = array(
      'fields' => array(
        'serial_column' => array(
          'type' => 'serial',
          'unsigned' => TRUE,
          'not null' => TRUE,
        ),
        'test_field' => $old_spec,
      ),
      'primary key' => array(
        'serial_column',
      ),
    );
    db_create_table($table_name, $table_spec);
    $this
      ->pass(format_string('Table %table created.', array(
      '%table' => $table_name,
    )));

    // Check the characteristics of the field.
    $this
      ->assertFieldCharacteristics($table_name, 'test_field', $old_spec);

    // Remove inserted rows.
    db_truncate($table_name)
      ->execute();
    if ($test_data) {
      $id = db_insert($table_name)
        ->fields([
        'test_field',
      ], [
        $test_data,
      ])
        ->execute();
    }

    // Change the field.
    db_change_field($table_name, 'test_field', 'test_field', $new_spec);
    if ($test_data) {
      $field_value = db_select($table_name)
        ->fields($table_name, [
        'test_field',
      ])
        ->condition('serial_column', $id)
        ->execute()
        ->fetchField();
      $this
        ->assertIdentical($field_value, $test_data);
    }

    // Check the field was changed.
    $this
      ->assertFieldCharacteristics($table_name, 'test_field', $new_spec);

    // Clean-up.
    db_drop_table($table_name);
  }

  /**
   * Tests the findTables() method.
   */
  public function testFindTables() {

    // We will be testing with three tables, two of them using the default
    // prefix and the third one with an individually specified prefix.
    // Set up a new connection with different connection info.
    $connection_info = Database::getConnectionInfo();

    // Add per-table prefix to the second table.
    $new_connection_info = $connection_info['default'];
    $new_connection_info['prefix']['test_2_table'] = $new_connection_info['prefix']['default'] . '_shared_';
    Database::addConnectionInfo('test', 'default', $new_connection_info);
    Database::setActiveConnection('test');

    // Create the tables.
    $table_specification = [
      'description' => 'Test table.',
      'fields' => [
        'id' => [
          'type' => 'int',
          'default' => NULL,
        ],
      ],
    ];
    Database::getConnection()
      ->schema()
      ->createTable('test_1_table', $table_specification);
    Database::getConnection()
      ->schema()
      ->createTable('test_2_table', $table_specification);
    Database::getConnection()
      ->schema()
      ->createTable('the_third_table', $table_specification);

    // Check the "all tables" syntax.
    $tables = Database::getConnection()
      ->schema()
      ->findTables('%');
    sort($tables);
    $expected = [
      // The 'config' table is added by
      // \Drupal\simpletest\KernelTestBase::containerBuild().
      'config',
      'test_1_table',
      // This table uses a per-table prefix, yet it is returned as un-prefixed.
      'test_2_table',
      'the_third_table',
    ];
    $this
      ->assertEqual($tables, $expected, 'All tables were found.');

    // Check the restrictive syntax.
    $tables = Database::getConnection()
      ->schema()
      ->findTables('test_%');
    sort($tables);
    $expected = [
      'test_1_table',
      'test_2_table',
    ];
    $this
      ->assertEqual($tables, $expected, 'Two tables were found.');

    // Go back to the initial connection.
    Database::setActiveConnection('default');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertContentTrait::$content	protected	property	The current raw content.
AssertContentTrait::$drupalSettings	protected	property	The drupalSettings value from the current raw $content.
AssertContentTrait::$elements	protected	property	The XML structure parsed from the current raw $content.	2
AssertContentTrait::$plainTextContent	protected	property	The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds	protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped	protected	function	Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion	protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption	protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected	protected	function	Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern	protected	function	Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw	protected	function	Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle	protected	function	Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern	protected	function	Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput	protected	function	Asserts themed output.
AssertContentTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertContentTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper	protected	function	Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertContentTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings	protected	function	Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent	protected	function	Gets the current raw content.
AssertContentTrait::getSelectedItem	protected	function	Get the selected value from a select field.
AssertContentTrait::getTextContent	protected	function	Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl	protected	function	Get the current URL from the cURL handler.	1
AssertContentTrait::parse	protected	function	Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace	protected	function	Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings	protected	function	Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent	protected	function	Sets the raw content (e.g. HTML).
AssertContentTrait::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings	protected	function	Casts MarkupInterface objects into strings.
KernelTestBase::$configDirectories	protected	property	The configuration directories for this test run.
KernelTestBase::$keyValueFactory	protected	property	A KeyValueMemoryFactory instance to use when building the container.
KernelTestBase::$moduleFiles	private	property
KernelTestBase::$modules	public static	property	Modules to enable.	192
KernelTestBase::$streamWrappers	protected	property	Array of registered stream wrappers.
KernelTestBase::$themeFiles	private	property
KernelTestBase::beforePrepareEnvironment	protected	function	Act on global state information before the environment is altered for a test. Overrides TestBase::beforePrepareEnvironment
KernelTestBase::containerBuild	public	function	Sets up the base service container for this test.	12
KernelTestBase::defaultLanguageData	protected	function	Provides the data for setting the default language on the container.	1
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
KernelTestBase::installConfig	protected	function	Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema	protected	function	Installs the storage schema for a specific entity type.
KernelTestBase::installSchema	protected	function	Installs a specific table from a module schema definition.
KernelTestBase::prepareConfigDirectories	protected	function	Create and set new configuration directories.	1
KernelTestBase::registerStreamWrapper	protected	function	Registers a stream wrapper for this test.
KernelTestBase::render	protected	function	Renders a render array.
KernelTestBase::setUp	protected	function	Performs setup tasks before each individual test method is run. Overrides TestBase::setUp
KernelTestBase::tearDown	protected	function	Performs cleanup tasks after each individual test method has been run. Overrides TestBase::tearDown
KernelTestBase::__construct		function	Constructor for Test. Overrides TestBase::__construct
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
RandomGeneratorTrait::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName	protected	function	Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject	public	function	Generates a random PHP object.
RandomGeneratorTrait::randomString	public	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
SchemaTest::$counter	protected	property	A global counter for table and field creation.
SchemaTest::assertFieldAdditionRemoval	protected	function	Asserts that a given field can be added and removed from a table.
SchemaTest::assertFieldChange	protected	function	Asserts that a field can be changed from one spec to another.
SchemaTest::assertFieldCharacteristics	protected	function	Asserts that a newly added field has the correct characteristics.
SchemaTest::checkSchemaComment		function	Checks that a table or column comment matches a given description.
SchemaTest::testFindTables	public	function	Tests the findTables() method.
SchemaTest::testIndexLength		function	Tests that indexes on string fields are limited to 191 characters on MySQL.
SchemaTest::testSchema		function	Tests database interactions.
SchemaTest::testSchemaAddField		function	Tests adding columns to an existing table.
SchemaTest::testSchemaChangeField		function	Tests changing columns between types.
SchemaTest::testUnsignedColumns		function	Tests creating unsigned columns and data integrity thereof.
SchemaTest::tryInsert		function	Tests inserting data into an existing table.
SchemaTest::tryUnsignedInsert		function	Tries to insert a negative value into columns defined as unsigned.
SessionTestTrait::$sessionName	protected	property	The name of the session cookie.
SessionTestTrait::generateSessionName	protected	function	Generates a session cookie name.
SessionTestTrait::getSessionName	protected	function	Returns the session name in use on the child site.
TestBase::$assertions	protected	property	Assertions thrown in that test case.
TestBase::$configImporter	protected	property	The config importer that can used in a test.	5
TestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
TestBase::$container	protected	property	The dependency injection container used in the test.
TestBase::$databasePrefix	protected	property	The database prefix of this test run.
TestBase::$dieOnFail	public	property	Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials	protected	property	HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod	protected	property	HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$kernel	protected	property	The DrupalKernel instance used in the test.	1
TestBase::$originalConf	protected	property	The original configuration (variables), if available.
TestBase::$originalConfig	protected	property	The original configuration (variables).
TestBase::$originalConfigDirectories	protected	property	The original configuration directories.
TestBase::$originalContainer	protected	property	The original container.
TestBase::$originalFileDirectory	protected	property	The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage	protected	property	The original language.
TestBase::$originalPrefix	protected	property	The original database prefix when running inside Simpletest.
TestBase::$originalProfile	protected	property	The original installation profile.
TestBase::$originalSessionName	protected	property	The name of the session cookie of the test-runner.
TestBase::$originalSettings	protected	property	The settings array.
TestBase::$originalShutdownCallbacks	protected	property	The original array of shutdown function callbacks.	1
TestBase::$originalSite	protected	property	The site directory of the original parent site.
TestBase::$originalUser	protected	property	The original user, before testing began.	1
TestBase::$privateFilesDirectory	protected	property	The private file directory for the test environment.
TestBase::$publicFilesDirectory	protected	property	The public file directory for the test environment.
TestBase::$results	public	property	Current results of this test case.
TestBase::$siteDirectory	protected	property	The site directory of this test run.
TestBase::$skipClasses	protected	property	This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	4
TestBase::$tempFilesDirectory	protected	property	The temporary file directory for the test environment.
TestBase::$testId	protected	property	The test run ID.
TestBase::$timeLimit	protected	property	Time limit for the test.
TestBase::$translationFilesDirectory	protected	property	The translation file directory for the test environment.
TestBase::$verbose	public	property	TRUE if verbose debugging is enabled.
TestBase::$verboseClassName	protected	property	Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory	protected	property	Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl	protected	property	URL to the verbose output file directory.
TestBase::$verboseId	protected	property	Incrementing identifier for verbose output filenames.
TestBase::assert	protected	function	Internal helper: stores the assert.
TestBase::assertEqual	protected	function	Check to see if two values are equal.
TestBase::assertErrorLogged	protected	function	Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse	protected	function	Check to see if a value is false.
TestBase::assertIdentical	protected	function	Check to see if two values are identical.
TestBase::assertIdenticalObject	protected	function	Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged	protected	function	Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual	protected	function	Check to see if two values are not equal.
TestBase::assertNotIdentical	protected	function	Check to see if two values are not identical.
TestBase::assertNotNull	protected	function	Check to see if a value is not NULL.
TestBase::assertNull	protected	function	Check to see if a value is NULL.
TestBase::assertTrue	protected	function	Check to see if a value is not false.
TestBase::changeDatabasePrefix	private	function	Changes the database connection to the prefixed one.
TestBase::checkRequirements	protected	function	Checks the matching requirements for Test.	2
TestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter	public	function	Returns a ConfigImporter object to import test importing of configuration.	5
TestBase::copyConfig	public	function	Copies configuration objects from source storage to target storage.
TestBase::deleteAssert	public static	function	Delete an assertion record by message ID.
TestBase::error	protected	function	Fire an error assertion.	3
TestBase::errorHandler	public	function	Handle errors during test runs.
TestBase::exceptionHandler	protected	function	Handle exceptions.
TestBase::fail	protected	function	Fire an assertion that is always negative.
TestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations	public static	function	Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall	protected	function	Cycles through backtrace until the first non-assertion method is found.
TestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection	public static	function	Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix	public	function	Gets the database prefix.
TestBase::getTempFilesDirectory	public	function	Gets the temporary files directory.
TestBase::insertAssert	public static	function	Store an assertion from outside the testing context.
TestBase::pass	protected	function	Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix	private	function	Generates a database prefix for running tests.
TestBase::prepareEnvironment	private	function	Prepares the current environment for running the test.
TestBase::restoreEnvironment	private	function	Cleans up the test environment and restores the original environment.
TestBase::run	public	function	Run all tests in this class.	1
TestBase::settingsSet	protected	function	Changes in memory settings.
TestBase::storeAssertion	protected	function	Helper method to store an assertion record in the configured database.
TestBase::verbose	protected	function	Logs a verbose message in a text file.

You are here

class SchemaTest in Zircon Profile 8.0

Hierarchy

File

Namespace

Members

API Navigation