class ContextDefinitionTest in Drupal 8

Tests the ContextDefinition class.

@group Plugin

@coversDefaultClass \Drupal\Core\Plugin\Context\ContextDefinition

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\Core\Plugin\Context\ContextDefinitionTest

File

core/tests/Drupal/Tests/Core/Plugin/Context/ContextDefinitionTest.php, line 16

Namespace

Drupal\Tests\Core\Plugin\Context

class ContextDefinitionTest extends UnitTestCase {

  /**
   * Very simple data provider.
   */
  public function providerGetDataDefinition() {
    return [
      [
        TRUE,
      ],
      [
        FALSE,
      ],
    ];
  }

  /**
   * @dataProvider providerGetDataDefinition
   * @covers ::getDataDefinition
   * @uses \Drupal
   */
  public function testGetDataDefinition($is_multiple) {
    $data_type = 'valid';
    $mock_data_definition = $this
      ->getMockBuilder('\\Drupal\\Core\\TypedData\\ListDataDefinitionInterface')
      ->setMethods([
      'setLabel',
      'setDescription',
      'setRequired',
      'getConstraints',
      'setConstraints',
    ])
      ->getMockForAbstractClass();
    $mock_data_definition
      ->expects($this
      ->once())
      ->method('setLabel')
      ->willReturnSelf();
    $mock_data_definition
      ->expects($this
      ->once())
      ->method('setDescription')
      ->willReturnSelf();
    $mock_data_definition
      ->expects($this
      ->once())
      ->method('setRequired')
      ->willReturnSelf();
    $mock_data_definition
      ->expects($this
      ->once())
      ->method('getConstraints')
      ->willReturn([]);
    $mock_data_definition
      ->expects($this
      ->once())
      ->method('setConstraints')
      ->willReturn(NULL);

    // Follow code paths for both multiple and non-multiple definitions.
    $create_definition_method = 'createDataDefinition';
    if ($is_multiple) {
      $create_definition_method = 'createListDataDefinition';
    }
    $mock_data_manager = $this
      ->createMock(TypedDataManagerInterface::class);

    // Our mocked data manager will return our mocked data definition for a
    // valid data type.
    $mock_data_manager
      ->expects($this
      ->once())
      ->method($create_definition_method)
      ->willReturnMap([
      [
        'not_valid',
        NULL,
      ],
      [
        'valid',
        $mock_data_definition,
      ],
    ]);

    // Mock a ContextDefinition object, setting up expectations for many of the
    // methods.
    $mock_context_definition = $this
      ->getMockBuilder('Drupal\\Core\\Plugin\\Context\\ContextDefinition')
      ->disableOriginalConstructor()
      ->setMethods([
      'isMultiple',
      'getTypedDataManager',
      'getDataType',
      'getLabel',
      'getDescription',
      'isRequired',
      'getConstraints',
      'setConstraints',
    ])
      ->getMock();
    $mock_context_definition
      ->expects($this
      ->once())
      ->method('isMultiple')
      ->willReturn($is_multiple);
    $mock_context_definition
      ->expects($this
      ->once())
      ->method('getTypedDataManager')
      ->willReturn($mock_data_manager);
    $mock_context_definition
      ->expects($this
      ->once())
      ->method('getDataType')
      ->willReturn($data_type);
    $mock_context_definition
      ->expects($this
      ->once())
      ->method('getConstraints')
      ->willReturn([]);
    $this
      ->assertSame($mock_data_definition, $mock_context_definition
      ->getDataDefinition());
  }

  /**
   * @dataProvider providerGetDataDefinition
   * @covers ::getDataDefinition
   * @uses \Drupal
   */
  public function testGetDataDefinitionInvalidType($is_multiple) {

    // Since we're trying to make getDataDefinition() throw an exception in
    // isolation, we use a data type which is not valid.
    $data_type = 'not_valid';
    $mock_data_definition = $this
      ->getMockBuilder('\\Drupal\\Core\\TypedData\\ListDataDefinitionInterface')
      ->getMockForAbstractClass();

    // Follow code paths for both multiple and non-multiple definitions.
    $create_definition_method = 'createDataDefinition';
    if ($is_multiple) {
      $create_definition_method = 'createListDataDefinition';
    }
    $mock_data_manager = $this
      ->createMock(TypedDataManagerInterface::class);

    // Our mocked data manager will return NULL for a non-valid data type. This
    // will eventually cause getDataDefinition() to throw an exception.
    $mock_data_manager
      ->expects($this
      ->once())
      ->method($create_definition_method)
      ->willReturnMap([
      [
        'not_valid',
        NULL,
      ],
      [
        'valid',
        $mock_data_definition,
      ],
    ]);

    // Mock a ContextDefinition object with expectations for only the methods
    // that will be called before the expected exception.
    $mock_context_definition = $this
      ->getMockBuilder('Drupal\\Core\\Plugin\\Context\\ContextDefinition')
      ->disableOriginalConstructor()
      ->setMethods([
      'isMultiple',
      'getTypedDataManager',
      'getDataType',
    ])
      ->getMock();
    $mock_context_definition
      ->expects($this
      ->once())
      ->method('isMultiple')
      ->willReturn($is_multiple);
    $mock_context_definition
      ->expects($this
      ->once())
      ->method('getTypedDataManager')
      ->willReturn($mock_data_manager);
    $mock_context_definition
      ->method('getDataType')
      ->willReturn($data_type);
    $this
      ->expectException(\Exception::class);
    $mock_context_definition
      ->getDataDefinition();
  }

  /**
   * Data provider for testGetConstraint
   */
  public function providerGetConstraint() {
    return [
      [
        NULL,
        [],
        'nonexistent_constraint_name',
      ],
      [
        'not_null',
        [
          'constraint_name' => 'not_null',
        ],
        'constraint_name',
      ],
    ];
  }

  /**
   * @dataProvider providerGetConstraint
   * @covers ::getConstraint
   * @uses \Drupal
   */
  public function testGetConstraint($expected, $constraint_array, $constraint) {
    $mock_context_definition = $this
      ->getMockBuilder('Drupal\\Core\\Plugin\\Context\\ContextDefinition')
      ->disableOriginalConstructor()
      ->setMethods([
      'getConstraints',
    ])
      ->getMock();
    $mock_context_definition
      ->expects($this
      ->once())
      ->method('getConstraints')
      ->willReturn($constraint_array);
    $this
      ->assertEquals($expected, $mock_context_definition
      ->getConstraint($constraint));
  }

  /**
   * @covers ::getDefaultValue
   * @covers ::setDefaultValue
   */
  public function testDefaultValue() {
    $context_definition = new ContextDefinition();
    $this
      ->assertNull($context_definition
      ->getDefaultValue());
    $context_definition
      ->setDefaultValue('test');
    $this
      ->assertSame('test', $context_definition
      ->getDefaultValue());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContextDefinitionTest::providerGetConstraint	public	function	Data provider for testGetConstraint
ContextDefinitionTest::providerGetDataDefinition	public	function	Very simple data provider.
ContextDefinitionTest::testDefaultValue	public	function	@covers ::getDefaultValue @covers ::setDefaultValue
ContextDefinitionTest::testGetConstraint	public	function	@dataProvider providerGetConstraint @covers ::getConstraint @uses \Drupal
ContextDefinitionTest::testGetDataDefinition	public	function	@dataProvider providerGetDataDefinition @covers ::getDataDefinition @uses \Drupal
ContextDefinitionTest::testGetDataDefinitionInvalidType	public	function	@dataProvider providerGetDataDefinition @covers ::getDataDefinition @uses \Drupal
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.
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