class FieldTargetDefinitionTest in Feeds 8.3

@coversDefaultClass \Drupal\feeds\FieldTargetDefinition @group feeds

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\feeds\Unit\FeedsUnitTestCase uses FeedsMockingTrait, FeedsReflectionTrait
    • class \Drupal\Tests\feeds\Unit\FieldTargetDefinitionTest

File

tests/src/Unit/FieldTargetDefinitionTest.php, line 14

Namespace

Drupal\Tests\feeds\Unit

class FieldTargetDefinitionTest extends FeedsUnitTestCase {

  /**
   * A prophesized data definition for the field item.
   *
   * @var \Prophecy\Prophecy\ProphecyInterface|\Drupal\Core\TypedData\ComplexDataDefinitionInterface
   */
  protected $itemDefinition;

  /**
   * A prophesized data definition for the field property.
   *
   * @var \Prophecy\Prophecy\ProphecyInterface|\Drupal\Core\TypedData\DataDefinitionInterface
   */
  protected $propertyDefinition;

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this->itemDefinition = $this
      ->prophesize(ComplexDataDefinitionInterface::class);
    $this->propertyDefinition = $this
      ->prophesize(DataDefinitionInterface::class);
  }

  /**
   * Creates a prophesized field definition.
   *
   * @return \Prophecy\Prophecy\ProphecyInterface|\Drupal\Core\Field\FieldDefinitionInterface
   *   A prophesized field definition.
   */
  protected function createFieldDefinition() {
    $field_definition = $this
      ->prophesize(FieldDefinitionInterface::class);
    $field_definition
      ->getItemDefinition()
      ->willReturn($this->itemDefinition
      ->reveal());
    return $field_definition;
  }

  /**
   * Tests that the label is taken from field definition.
   *
   * @covers ::getPropertyLabel
   */
  public function testGetPropertyLabel() {
    $this->propertyDefinition
      ->getLabel()
      ->willReturn('Foo label')
      ->shouldBeCalled();
    $this->itemDefinition
      ->getPropertyDefinition('foo')
      ->willReturn($this->propertyDefinition
      ->reveal())
      ->shouldBeCalled();
    $field_definition = $this
      ->createFieldDefinition();
    $target_definition = FieldTargetDefinition::createFromFieldDefinition($field_definition
      ->reveal());
    $this
      ->assertEquals('Foo label', $target_definition
      ->getPropertyLabel('foo'));
  }

  /**
   * Tests that a custom set property label takes precedence.
   *
   * @covers ::getPropertyLabel
   */
  public function testGetPropertyLabelWithCustomSetLabel() {
    $this->propertyDefinition
      ->getLabel()
      ->willReturn('Foo label');
    $this->itemDefinition
      ->getPropertyDefinition('foo')
      ->willReturn($this->propertyDefinition
      ->reveal());
    $field_definition = $this
      ->createFieldDefinition();
    $target_definition = FieldTargetDefinition::createFromFieldDefinition($field_definition
      ->reveal());
    $target_definition
      ->addProperty('foo', 'Custom label');
    $this
      ->assertEquals('Custom label', $target_definition
      ->getPropertyLabel('foo'));
  }

  /**
   * Tests no errors when the label for a custom property isn't set.
   *
   * @covers ::getPropertyLabel
   */
  public function testGetPropertyLabelOfNonExistingProperty() {
    $field_definition = $this
      ->createFieldDefinition();
    $target_definition = FieldTargetDefinition::createFromFieldDefinition($field_definition
      ->reveal());
    $target_definition
      ->addProperty('bar');
    $this
      ->assertEquals('', $target_definition
      ->getPropertyLabel('bar'));
  }

  /**
   * Tests that the description is taken from field definition.
   *
   * @covers ::getPropertyDescription
   */
  public function testGetPropertyDescription() {
    $this->propertyDefinition
      ->getDescription()
      ->willReturn('Foo description')
      ->shouldBeCalled();
    $this->itemDefinition
      ->getPropertyDefinition('foo')
      ->willReturn($this->propertyDefinition
      ->reveal())
      ->shouldBeCalled();
    $field_definition = $this
      ->createFieldDefinition();
    $target_definition = FieldTargetDefinition::createFromFieldDefinition($field_definition
      ->reveal());
    $this
      ->assertEquals('Foo description', $target_definition
      ->getPropertyDescription('foo'));
  }

  /**
   * Tests that a custom set property description takes precedence.
   *
   * @covers ::getPropertyDescription
   */
  public function testGetPropertyDescriptionWithCustomSetDescription() {
    $this->propertyDefinition
      ->getDescription()
      ->willReturn('Foo description');
    $this->itemDefinition
      ->getPropertyDefinition('foo')
      ->willReturn($this->propertyDefinition
      ->reveal());
    $field_definition = $this
      ->createFieldDefinition();
    $target_definition = FieldTargetDefinition::createFromFieldDefinition($field_definition
      ->reveal());
    $target_definition
      ->addProperty('foo', 'Custom label', 'Custom description');
    $this
      ->assertEquals('Custom description', $target_definition
      ->getPropertyDescription('foo'));
  }

  /**
   * Tests no errors when the description for a custom property isn't set.
   *
   * @covers ::getPropertyDescription
   */
  public function testGetPropertyDescriptionOfNonExistingProperty() {
    $field_definition = $this
      ->createFieldDefinition();
    $target_definition = FieldTargetDefinition::createFromFieldDefinition($field_definition
      ->reveal());
    $target_definition
      ->addProperty('bar');
    $this
      ->assertEquals('', $target_definition
      ->getPropertyDescription('bar'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FeedsMockingTrait::getMockAccount	protected	function	Mocks an account object.
FeedsMockingTrait::getMockedAccountSwitcher	protected	function	Returns a mocked AccountSwitcher object.
FeedsMockingTrait::getMockFeed	protected	function	Returns a mocked feed entity.
FeedsMockingTrait::getMockFeedType	protected	function	Returns a mocked feed type entity.
FeedsMockingTrait::getMockFieldDefinition	protected	function	Mocks a field definition.	1
FeedsMockingTrait::getMockFileSystem	protected	function	Mocks the file system.
FeedsReflectionTrait::callProtectedMethod	protected	function	Calls a protected method on the given object.
FeedsReflectionTrait::getMethod	protected	function	Gets a ReflectionMethod for a class method.
FeedsReflectionTrait::getProtectedClosure	protected	function	Returns a dynamically created closure for the object's method.
FeedsReflectionTrait::setProtectedProperty	protected	function	Sets a protected property.
FeedsUnitTestCase::absolutePath	protected	function	Returns the absolute directory path of the Feeds module.
FeedsUnitTestCase::defineConstants	protected	function	Defines stub constants.
FeedsUnitTestCase::getMockStreamWrapperManager	protected	function	Returns a mock stream wrapper manager.
FeedsUnitTestCase::resourcesPath	protected	function	Returns the absolute directory path of the resources folder.
FieldTargetDefinitionTest::$itemDefinition	protected	property	A prophesized data definition for the field item.
FieldTargetDefinitionTest::$propertyDefinition	protected	property	A prophesized data definition for the field property.
FieldTargetDefinitionTest::createFieldDefinition	protected	function	Creates a prophesized field definition.
FieldTargetDefinitionTest::setUp	public	function	Overrides FeedsUnitTestCase::setUp
FieldTargetDefinitionTest::testGetPropertyDescription	public	function	Tests that the description is taken from field definition.
FieldTargetDefinitionTest::testGetPropertyDescriptionOfNonExistingProperty	public	function	Tests no errors when the description for a custom property isn't set.
FieldTargetDefinitionTest::testGetPropertyDescriptionWithCustomSetDescription	public	function	Tests that a custom set property description takes precedence.
FieldTargetDefinitionTest::testGetPropertyLabel	public	function	Tests that the label is taken from field definition.
FieldTargetDefinitionTest::testGetPropertyLabelOfNonExistingProperty	public	function	Tests no errors when the label for a custom property isn't set.
FieldTargetDefinitionTest::testGetPropertyLabelWithCustomSetLabel	public	function	Tests that a custom set property label takes precedence.
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.