class QueryFactoryTest in Drupal 8

@coversDefaultClass \Drupal\Core\Config\Entity\Query\QueryFactory @group Config

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\Core\Config\Entity\Query\QueryFactoryTest

File

core/tests/Drupal/Tests/Core/Config/Entity/Query/QueryFactoryTest.php, line 13

Namespace

Drupal\Tests\Core\Config\Entity\Query

class QueryFactoryTest extends UnitTestCase {

  /**
   * @covers ::getKeys
   * @covers ::getValues
   *
   * @dataProvider providerTestGetKeys
   */
  public function testGetKeys(array $expected, $key, Config $config) {
    $config_factory = $this
      ->createMock('Drupal\\Core\\Config\\ConfigFactoryInterface');
    $key_value_factory = $this
      ->createMock('Drupal\\Core\\KeyValueStore\\KeyValueFactoryInterface');
    $config_manager = $this
      ->createMock('Drupal\\Core\\Config\\ConfigManagerInterface');
    $config_entity_type = $this
      ->createMock('Drupal\\Core\\Config\\Entity\\ConfigEntityTypeInterface');
    $query_factory = new QueryFactory($config_factory, $key_value_factory, $config_manager);
    $method = new \ReflectionMethod($query_factory, 'getKeys');
    $method
      ->setAccessible(TRUE);
    $actual = $method
      ->invoke($query_factory, $config, $key, 'get', $config_entity_type);
    $this
      ->assertEquals($expected, $actual);
  }
  public function providerTestGetKeys() {
    $tests = [];
    $tests[] = [
      [
        'uuid:abc',
      ],
      'uuid',
      $this
        ->getConfigObject('test')
        ->set('uuid', 'abc'),
    ];

    // Tests a lookup being set to a top level key when sub-keys exist.
    $tests[] = [
      [],
      'uuid',
      $this
        ->getConfigObject('test')
        ->set('uuid.blah', 'abc'),
    ];

    // Tests a non existent key.
    $tests[] = [
      [],
      'uuid',
      $this
        ->getConfigObject('test'),
    ];

    // Tests a non existent sub key.
    $tests[] = [
      [],
      'uuid.blah',
      $this
        ->getConfigObject('test')
        ->set('uuid', 'abc'),
    ];

    // Tests a existent sub key.
    $tests[] = [
      [
        'uuid.blah:abc',
      ],
      'uuid.blah',
      $this
        ->getConfigObject('test')
        ->set('uuid.blah', 'abc'),
    ];

    // One wildcard.
    $tests[] = [
      [
        'test.*.value:a',
        'test.*.value:b',
      ],
      'test.*.value',
      $this
        ->getConfigObject('test')
        ->set('test.a.value', 'a')
        ->set('test.b.value', 'b'),
    ];

    // Three wildcards.
    $tests[] = [
      [
        'test.*.sub2.*.sub4.*.value:aaa',
        'test.*.sub2.*.sub4.*.value:aab',
        'test.*.sub2.*.sub4.*.value:bab',
      ],
      'test.*.sub2.*.sub4.*.value',
      $this
        ->getConfigObject('test')
        ->set('test.a.sub2.a.sub4.a.value', 'aaa')
        ->set('test.a.sub2.a.sub4.b.value', 'aab')
        ->set('test.b.sub2.a.sub4.b.value', 'bab'),
    ];

    // Three wildcards in a row.
    $tests[] = [
      [
        'test.*.*.*.value:abc',
        'test.*.*.*.value:abd',
      ],
      'test.*.*.*.value',
      $this
        ->getConfigObject('test')
        ->set('test.a.b.c.value', 'abc')
        ->set('test.a.b.d.value', 'abd'),
    ];
    return $tests;
  }

  /**
   * @covers ::getKeys
   * @covers ::getValues
   */
  public function testGetKeysWildCardEnd() {
    $config_factory = $this
      ->createMock('Drupal\\Core\\Config\\ConfigFactoryInterface');
    $key_value_factory = $this
      ->createMock('Drupal\\Core\\KeyValueStore\\KeyValueFactoryInterface');
    $config_manager = $this
      ->createMock('Drupal\\Core\\Config\\ConfigManagerInterface');
    $config_entity_type = $this
      ->createMock('Drupal\\Core\\Config\\Entity\\ConfigEntityTypeInterface');
    $config_entity_type
      ->expects($this
      ->atLeastOnce())
      ->method('id')
      ->willReturn('test_config_entity_type');
    $query_factory = new QueryFactory($config_factory, $key_value_factory, $config_manager);
    $method = new \ReflectionMethod($query_factory, 'getKeys');
    $method
      ->setAccessible(TRUE);
    $this
      ->expectException(\LogicException::class);
    $this
      ->expectExceptionMessage('test_config_entity_type lookup key test.* ends with a wildcard this can not be used as a lookup');
    $method
      ->invoke($query_factory, $this
      ->getConfigObject('test'), 'test.*', 'get', $config_entity_type);
  }

  /**
   * Gets a test configuration object.
   *
   * @param string $name
   *   The config name.
   *
   * @return \Drupal\Core\Config\Config|\PHPUnit\Framework\MockObject\MockObject
   *   The test configuration object.
   */
  protected function getConfigObject($name) {
    $config = $this
      ->getMockBuilder('Drupal\\Core\\Config\\Config')
      ->disableOriginalConstructor()
      ->setMethods([
      'save',
      'delete',
    ])
      ->getMock();
    return $config
      ->setName($name);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
QueryFactoryTest::getConfigObject	protected	function	Gets a test configuration object.
QueryFactoryTest::providerTestGetKeys	public	function
QueryFactoryTest::testGetKeys	public	function	@covers ::getKeys @covers ::getValues
QueryFactoryTest::testGetKeysWildCardEnd	public	function	@covers ::getKeys @covers ::getValues
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated	protected	function	Mocks a block with a block plugin.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.
UnitTestCase::setUp	protected	function		340