ConnectionTest.php in Drupal 8

Namespace

Drupal\Tests\Core\Database

File

core/tests/Drupal/Tests/Core/Database/ConnectionTest.php

<?php

namespace Drupal\Tests\Core\Database;

use Drupal\Tests\Core\Database\Stub\StubConnection;
use Drupal\Tests\Core\Database\Stub\StubPDO;
use Drupal\Tests\UnitTestCase;

/**
 * Tests the Connection class.
 *
 * @group Database
 */
class ConnectionTest extends UnitTestCase {

  /**
   * Dataprovider for testPrefixRoundTrip().
   *
   * @return array
   *   Array of arrays with the following elements:
   *   - Arguments to pass to Connection::setPrefix().
   *   - Expected result from Connection::tablePrefix().
   */
  public function providerPrefixRoundTrip() {
    return [
      [
        [
          '' => 'test_',
        ],
        'test_',
      ],
      [
        [
          'fooTable' => 'foo_',
          'barTable' => 'bar_',
        ],
        [
          'fooTable' => 'foo_',
          'barTable' => 'bar_',
        ],
      ],
    ];
  }

  /**
   * Exercise setPrefix() and tablePrefix().
   *
   * @dataProvider providerPrefixRoundTrip
   */
  public function testPrefixRoundTrip($expected, $prefix_info) {
    $mock_pdo = $this
      ->createMock('Drupal\\Tests\\Core\\Database\\Stub\\StubPDO');
    $connection = new StubConnection($mock_pdo, []);

    // setPrefix() is protected, so we make it accessible with reflection.
    $reflection = new \ReflectionClass('Drupal\\Tests\\Core\\Database\\Stub\\StubConnection');
    $set_prefix = $reflection
      ->getMethod('setPrefix');
    $set_prefix
      ->setAccessible(TRUE);

    // Set the prefix data.
    $set_prefix
      ->invokeArgs($connection, [
      $prefix_info,
    ]);

    // Check the round-trip.
    foreach ($expected as $table => $prefix) {
      $this
        ->assertEquals($prefix, $connection
        ->tablePrefix($table));
    }
  }

  /**
   * Dataprovider for testPrefixTables().
   *
   * @return array
   *   Array of arrays with the following elements:
   *   - Expected result.
   *   - Table prefix.
   *   - Query to be prefixed.
   */
  public function providerTestPrefixTables() {
    return [
      [
        'SELECT * FROM test_table',
        'test_',
        'SELECT * FROM {table}',
      ],
      [
        'SELECT * FROM first_table JOIN second_thingie',
        [
          'table' => 'first_',
          'thingie' => 'second_',
        ],
        'SELECT * FROM {table} JOIN {thingie}',
      ],
    ];
  }

  /**
   * Exercise the prefixTables() method.
   *
   * @dataProvider providerTestPrefixTables
   */
  public function testPrefixTables($expected, $prefix_info, $query) {
    $mock_pdo = $this
      ->createMock('Drupal\\Tests\\Core\\Database\\Stub\\StubPDO');
    $connection = new StubConnection($mock_pdo, [
      'prefix' => $prefix_info,
    ]);
    $this
      ->assertEquals($expected, $connection
      ->prefixTables($query));
  }

  /**
   * Dataprovider for testEscapeMethods().
   *
   * @return array
   *   Array of arrays with the following elements:
   *   - Expected escaped string.
   *   - String to escape.
   */
  public function providerEscapeMethods() {
    return [
      [
        'thing',
        'thing',
      ],
      [
        '_item',
        '_item',
      ],
      [
        'item_',
        'item_',
      ],
      [
        '_item_',
        '_item_',
      ],
      [
        '',
        '!@#$%^&*()-=+',
      ],
      [
        '123',
        '!1@2#3',
      ],
    ];
  }

  /**
   * Test the various escaping methods.
   *
   * All tested together since they're basically the same method
   * with different names.
   *
   * @dataProvider providerEscapeMethods
   * @todo Separate test method for each escape method?
   */
  public function testEscapeMethods($expected, $name) {
    $mock_pdo = $this
      ->createMock('Drupal\\Tests\\Core\\Database\\Stub\\StubPDO');
    $connection = new StubConnection($mock_pdo, []);
    $this
      ->assertEquals($expected, $connection
      ->escapeDatabase($name));
    $this
      ->assertEquals($expected, $connection
      ->escapeTable($name));
    $this
      ->assertEquals($expected, $connection
      ->escapeField($name));
    $this
      ->assertEquals($expected, $connection
      ->escapeAlias($name));
  }

  /**
   * Dataprovider for testGetDriverClass().
   *
   * @return array
   *   Array of arrays with the following elements:
   *   - Expected namespaced class name.
   *   - Driver.
   *   - Namespace.
   *   - Class name without namespace.
   */
  public function providerGetDriverClass() {
    return [
      [
        'nonexistent_class',
        '\\',
        'nonexistent_class',
      ],
      [
        'Drupal\\Tests\\Core\\Database\\Stub\\Select',
        NULL,
        'Select',
      ],
      [
        'Drupal\\Tests\\Core\\Database\\Stub\\Driver\\Schema',
        'Drupal\\Tests\\Core\\Database\\Stub\\Driver',
        'Schema',
      ],
    ];
  }

  /**
   * Test getDriverClass().
   *
   * @dataProvider providerGetDriverClass
   */
  public function testGetDriverClass($expected, $namespace, $class) {
    $mock_pdo = $this
      ->createMock('Drupal\\Tests\\Core\\Database\\Stub\\StubPDO');
    $connection = new StubConnection($mock_pdo, [
      'namespace' => $namespace,
    ]);

    // Set the driver using our stub class' public property.
    $this
      ->assertEquals($expected, $connection
      ->getDriverClass($class));
  }

  /**
   * Dataprovider for testSchema().
   *
   * @return array
   *   Array of arrays with the following elements:
   *   - Expected namespaced class of schema object.
   *   - Driver for PDO connection.
   *   - Namespace for connection.
   */
  public function providerSchema() {
    return [
      [
        'Drupal\\Tests\\Core\\Database\\Stub\\Driver\\Schema',
        'stub',
        'Drupal\\Tests\\Core\\Database\\Stub\\Driver',
      ],
    ];
  }

  /**
   * Test Connection::schema().
   *
   * @dataProvider providerSchema
   */
  public function testSchema($expected, $driver, $namespace) {
    $mock_pdo = $this
      ->createMock('Drupal\\Tests\\Core\\Database\\Stub\\StubPDO');
    $connection = new StubConnection($mock_pdo, [
      'namespace' => $namespace,
    ]);
    $connection->driver = $driver;
    $this
      ->assertInstanceOf($expected, $connection
      ->schema());
  }

  /**
   * Test Connection::destroy().
   */
  public function testDestroy() {
    $mock_pdo = $this
      ->createMock('Drupal\\Tests\\Core\\Database\\Stub\\StubPDO');

    // Mocking StubConnection gives us access to the $schema attribute.
    $connection = new StubConnection($mock_pdo, [
      'namespace' => 'Drupal\\Tests\\Core\\Database\\Stub\\Driver',
    ]);

    // Generate a schema object in order to verify that we've NULLed it later.
    $this
      ->assertInstanceOf('Drupal\\Tests\\Core\\Database\\Stub\\Driver\\Schema', $connection
      ->schema());
    $connection
      ->destroy();
    $this
      ->assertAttributeEquals(NULL, 'schema', $connection);
  }

  /**
   * Dataprovider for testMakeComments().
   *
   * @return array
   *   Array of arrays with the following elements:
   *   - Expected filtered comment.
   *   - Arguments for Connection::makeComment().
   */
  public function providerMakeComments() {
    return [
      [
        '/*  */ ',
        [
          '',
        ],
      ],
      [
        '/* Exploit  *  / DROP TABLE node. -- */ ',
        [
          'Exploit * / DROP TABLE node; --',
        ],
      ],
      [
        '/* Exploit  *  / DROP TABLE node. --. another comment */ ',
        [
          'Exploit * / DROP TABLE node; --',
          'another comment',
        ],
      ],
    ];
  }

  /**
   * Test Connection::makeComments().
   *
   * @dataProvider providerMakeComments
   */
  public function testMakeComments($expected, $comment_array) {
    $mock_pdo = $this
      ->createMock('Drupal\\Tests\\Core\\Database\\Stub\\StubPDO');
    $connection = new StubConnection($mock_pdo, []);
    $this
      ->assertEquals($expected, $connection
      ->makeComment($comment_array));
  }

  /**
   * Dataprovider for testFilterComments().
   *
   * @return array
   *   Array of arrays with the following elements:
   *   - Expected filtered comment.
   *   - Comment to filter.
   */
  public function providerFilterComments() {
    return [
      [
        '',
        '',
      ],
      [
        'Exploit  *  / DROP TABLE node. --',
        'Exploit * / DROP TABLE node; --',
      ],
      [
        'Exploit  * / DROP TABLE node. --',
        'Exploit */ DROP TABLE node; --',
      ],
    ];
  }

  /**
   * Test Connection::filterComments().
   *
   * @dataProvider providerFilterComments
   */
  public function testFilterComments($expected, $comment) {
    $mock_pdo = $this
      ->createMock('Drupal\\Tests\\Core\\Database\\Stub\\StubPDO');
    $connection = new StubConnection($mock_pdo, []);

    // filterComment() is protected, so we make it accessible with reflection.
    $reflection = new \ReflectionClass('Drupal\\Tests\\Core\\Database\\Stub\\StubConnection');
    $filter_comment = $reflection
      ->getMethod('filterComment');
    $filter_comment
      ->setAccessible(TRUE);
    $this
      ->assertEquals($expected, $filter_comment
      ->invokeArgs($connection, [
      $comment,
    ]));
  }

  /**
   * Test rtrim() of query strings.
   *
   * @dataProvider provideQueriesToTrim
   */
  public function testQueryTrim($expected, $query, $options) {
    $mock_pdo = $this
      ->getMockBuilder(StubPdo::class)
      ->setMethods([
      'execute',
      'prepare',
      'setAttribute',
    ])
      ->getMock();

    // Ensure that PDO::prepare() is called only once, and with the
    // correctly trimmed query string.
    $mock_pdo
      ->expects($this
      ->once())
      ->method('prepare')
      ->with($expected)
      ->willReturnSelf();
    $connection = new StubConnection($mock_pdo, []);
    $connection
      ->query($query, [], $options);
  }

  /**
   * Dataprovider for testQueryTrim().
   *
   * @return array
   *   Array of arrays with the following elements:
   *   - Expected trimmed query.
   *   - Padded query.
   *   - Query options.
   */
  public function provideQueriesToTrim() {
    return [
      'remove_semicolon' => [
        'SELECT * FROM test',
        'SELECT * FROM test;',
        [],
      ],
      'keep_trailing_semicolon' => [
        'SELECT * FROM test;',
        'SELECT * FROM test;',
        [
          'allow_delimiter_in_query' => TRUE,
        ],
      ],
      'remove_semicolon_with_whitespace' => [
        'SELECT * FROM test',
        'SELECT * FROM test; ',
        [],
      ],
      'keep_trailing_semicolon_with_whitespace' => [
        'SELECT * FROM test;',
        'SELECT * FROM test; ',
        [
          'allow_delimiter_in_query' => TRUE,
        ],
      ],
    ];
  }

}

Classes

Name	Description
ConnectionTest	Tests the Connection class.