You are here

Home » API reference » Drupal 9 » FieldConfigEntityUnitTest.php

class FieldConfigEntityUnitTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/field/tests/src/Unit/FieldConfigEntityUnitTest.php \Drupal\Tests\field\Unit\FieldConfigEntityUnitTest

@coversDefaultClass \Drupal\field\Entity\FieldConfig @group field

Hierarchy

Expanded class hierarchy of FieldConfigEntityUnitTest

File

core/modules/field/tests/src/Unit/FieldConfigEntityUnitTest.php, line 22
Contains \Drupal\Tests\field\Unit\FieldConfigEntityUnitTest.

Namespace

Drupal\Tests\field\Unit
View source 
class FieldConfigEntityUnitTest extends UnitTestCase {

  /**
   * The entity type used for testing.
   *
   * @var \Drupal\Core\Config\Entity\ConfigEntityTypeInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $entityType;

  /**
   * The entity type manager used for testing.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $entityTypeManager;

  /**
   * The entity field manager used for testing.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $entityFieldManager;

  /**
   * The ID of the type of the entity under test.
   *
   * @var string
   */
  protected $entityTypeId;

  /**
   * The UUID generator used for testing.
   *
   * @var \Drupal\Component\Uuid\UuidInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $uuid;

  /**
   * The mock field storage.
   *
   * @var \Drupal\field\FieldStorageConfigInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $fieldStorage;

  /**
   * The mock field type plugin manager.
   *
   * @var \Drupal\Core\Field\FieldTypePluginManagerInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $fieldTypePluginManager;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    $this->entityTypeId = $this
      ->randomMachineName();
    $this->entityType = $this
      ->createMock('\\Drupal\\Core\\Config\\Entity\\ConfigEntityTypeInterface');
    $this->entityTypeManager = $this
      ->createMock(EntityTypeManagerInterface::class);
    $this->entityFieldManager = $this
      ->createMock(EntityFieldManagerInterface::class);
    $this->uuid = $this
      ->createMock('\\Drupal\\Component\\Uuid\\UuidInterface');
    $this->fieldTypePluginManager = $this
      ->createMock('Drupal\\Core\\Field\\FieldTypePluginManagerInterface');
    $container = new ContainerBuilder();
    $container
      ->set('entity_field.manager', $this->entityFieldManager);
    $container
      ->set('entity_type.manager', $this->entityTypeManager);
    $container
      ->set('uuid', $this->uuid);
    $container
      ->set('plugin.manager.field.field_type', $this->fieldTypePluginManager);
    \Drupal::setContainer($container);

    // Create a mock FieldStorageConfig object.
    $this->fieldStorage = $this
      ->createMock('\\Drupal\\field\\FieldStorageConfigInterface');
    $this->fieldStorage
      ->expects($this
      ->any())
      ->method('getType')
      ->will($this
      ->returnValue('test_field'));
    $this->fieldStorage
      ->expects($this
      ->any())
      ->method('getName')
      ->will($this
      ->returnValue('field_test'));
    $this->fieldStorage
      ->expects($this
      ->any())
      ->method('getSettings')
      ->willReturn([]);

    // Place the field in the mocked entity field manager's field registry.
    $this->entityFieldManager
      ->expects($this
      ->any())
      ->method('getFieldStorageDefinitions')
      ->with('test_entity_type')
      ->will($this
      ->returnValue([
      $this->fieldStorage
        ->getName() => $this->fieldStorage,
    ]));
  }

  /**
   * @covers ::calculateDependencies
   */
  public function testCalculateDependencies() {

    // Mock the interfaces necessary to create a dependency on a bundle entity.
    $target_entity_type = $this
      ->createMock('\\Drupal\\Core\\Entity\\EntityTypeInterface');
    $target_entity_type
      ->expects($this
      ->any())
      ->method('getBundleConfigDependency')
      ->will($this
      ->returnValue([
      'type' => 'config',
      'name' => 'test.test_entity_type.id',
    ]));
    $this->entityTypeManager
      ->expects($this
      ->any())
      ->method('getDefinition')
      ->willReturnMap([
      [
        $this->entityTypeId,
        TRUE,
        $this->entityType,
      ],
      [
        'test_entity_type',
        TRUE,
        $target_entity_type,
      ],
    ]);
    $this->fieldTypePluginManager
      ->expects($this
      ->any())
      ->method('getDefinition')
      ->with('test_field')
      ->willReturn([
      'provider' => 'test_module',
      'config_dependencies' => [
        'module' => [
          'test_module2',
        ],
      ],
      'class' => '\\Drupal\\Tests\\field\\Unit\\DependencyFieldItem',
    ]);
    $this->fieldStorage
      ->expects($this
      ->once())
      ->method('getConfigDependencyName')
      ->will($this
      ->returnValue('field.storage.test_entity_type.test_field'));
    $field = new FieldConfig([
      'field_name' => $this->fieldStorage
        ->getName(),
      'entity_type' => 'test_entity_type',
      'bundle' => 'test_bundle',
      'field_type' => 'test_field',
    ], $this->entityTypeId);
    $dependencies = $field
      ->calculateDependencies()
      ->getDependencies();
    $this
      ->assertContains('field.storage.test_entity_type.test_field', $dependencies['config']);
    $this
      ->assertContains('test.test_entity_type.id', $dependencies['config']);
    $this
      ->assertEquals([
      'test_module',
      'test_module2',
      'test_module3',
    ], $dependencies['module']);
  }

  /**
   * Tests that invalid bundles are handled.
   */
  public function testCalculateDependenciesIncorrectBundle() {
    $storage = $this
      ->createMock('\\Drupal\\Core\\Config\\Entity\\ConfigEntityStorageInterface');
    $storage
      ->expects($this
      ->any())
      ->method('load')
      ->with('test_bundle_not_exists')
      ->will($this
      ->returnValue(NULL));
    $this->entityTypeManager
      ->expects($this
      ->any())
      ->method('getStorage')
      ->with('bundle_entity_type')
      ->will($this
      ->returnValue($storage));
    $target_entity_type = new EntityType([
      'id' => 'test_entity_type',
      'bundle_entity_type' => 'bundle_entity_type',
    ]);
    $this->entityTypeManager
      ->expects($this
      ->any())
      ->method('getDefinition')
      ->willReturnMap([
      [
        $this->entityTypeId,
        TRUE,
        $this->entityType,
      ],
      [
        'test_entity_type',
        TRUE,
        $target_entity_type,
      ],
    ]);
    $this->fieldTypePluginManager
      ->expects($this
      ->any())
      ->method('getDefinition')
      ->with('test_field')
      ->willReturn([
      'provider' => 'test_module',
      'config_dependencies' => [
        'module' => [
          'test_module2',
        ],
      ],
      'class' => '\\Drupal\\Tests\\field\\Unit\\DependencyFieldItem',
    ]);
    $field = new FieldConfig([
      'field_name' => $this->fieldStorage
        ->getName(),
      'entity_type' => 'test_entity_type',
      'bundle' => 'test_bundle_not_exists',
      'field_type' => 'test_field',
    ], $this->entityTypeId);
    $this
      ->expectException(\LogicException::class);
    $this
      ->expectExceptionMessage('Missing bundle entity, entity type bundle_entity_type, entity id test_bundle_not_exists.');
    $field
      ->calculateDependencies();
  }

  /**
   * @covers ::onDependencyRemoval
   */
  public function testOnDependencyRemoval() {
    $this->fieldTypePluginManager
      ->expects($this
      ->any())
      ->method('getDefinition')
      ->with('test_field')
      ->willReturn([
      'class' => '\\Drupal\\Tests\\field\\Unit\\DependencyFieldItem',
    ]);
    $field = new FieldConfig([
      'field_name' => $this->fieldStorage
        ->getName(),
      'entity_type' => 'test_entity_type',
      'bundle' => 'test_bundle',
      'field_type' => 'test_field',
      'dependencies' => [
        'module' => [
          'fruiter',
        ],
      ],
      'third_party_settings' => [
        'fruiter' => [
          'fruit' => 'apple',
        ],
      ],
    ]);
    $changed = $field
      ->onDependencyRemoval([
      'module' => [
        'fruiter',
      ],
    ]);
    $this
      ->assertTrue($changed);
  }

  /**
   * @covers ::toArray
   */
  public function testToArray() {
    $field = new FieldConfig([
      'field_name' => $this->fieldStorage
        ->getName(),
      'entity_type' => 'test_entity_type',
      'bundle' => 'test_bundle',
      'field_type' => 'test_field',
    ], $this->entityTypeId);
    $expected = [
      'id' => 'test_entity_type.test_bundle.field_test',
      'uuid' => NULL,
      'status' => TRUE,
      'langcode' => 'en',
      'field_name' => 'field_test',
      'entity_type' => 'test_entity_type',
      'bundle' => 'test_bundle',
      'label' => '',
      'description' => '',
      'required' => FALSE,
      'default_value' => [],
      'default_value_callback' => '',
      'settings' => [],
      'dependencies' => [],
      'field_type' => 'test_field',
    ];
    $this->entityTypeManager
      ->expects($this
      ->any())
      ->method('getDefinition')
      ->with($this->entityTypeId)
      ->will($this
      ->returnValue($this->entityType));
    $this->entityType
      ->expects($this
      ->once())
      ->method('getKey')
      ->with('id')
      ->will($this
      ->returnValue('id'));
    $this->entityType
      ->expects($this
      ->once())
      ->method('getPropertiesToExport')
      ->with('test_entity_type.test_bundle.field_test')
      ->will($this
      ->returnValue(array_combine(array_keys($expected), array_keys($expected))));
    $export = $field
      ->toArray();
    $this
      ->assertEquals($expected, $export);
  }

  /**
   * @covers ::getType
   */
  public function testGetType() {

    // Ensure that FieldConfig::getType() is not delegated to
    // FieldStorage.
    $this->entityFieldManager
      ->expects($this
      ->never())
      ->method('getFieldStorageDefinitions');
    $this->fieldStorage
      ->expects($this
      ->never())
      ->method('getType');
    $field = new FieldConfig([
      'field_name' => $this->fieldStorage
        ->getName(),
      'entity_type' => 'test_entity_type',
      'bundle' => 'test_bundle',
      'field_type' => 'test_field',
    ], $this->entityTypeId);
    $this
      ->assertEquals('test_field', $field
      ->getType());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
FieldConfigEntityUnitTest::$entityFieldManager protected property The entity field manager used for testing.
FieldConfigEntityUnitTest::$entityType protected property The entity type used for testing.
FieldConfigEntityUnitTest::$entityTypeId protected property The ID of the type of the entity under test.
FieldConfigEntityUnitTest::$entityTypeManager protected property The entity type manager used for testing.
FieldConfigEntityUnitTest::$fieldStorage protected property The mock field storage.
FieldConfigEntityUnitTest::$fieldTypePluginManager protected property The mock field type plugin manager.
FieldConfigEntityUnitTest::$uuid protected property The UUID generator used for testing.
FieldConfigEntityUnitTest::setUp protected function Overrides UnitTestCase::setUp
FieldConfigEntityUnitTest::testCalculateDependencies public function @covers ::calculateDependencies
FieldConfigEntityUnitTest::testCalculateDependenciesIncorrectBundle public function Tests that invalid bundles are handled.
FieldConfigEntityUnitTest::testGetType public function @covers ::getType
FieldConfigEntityUnitTest::testOnDependencyRemoval public function @covers ::onDependencyRemoval
FieldConfigEntityUnitTest::testToArray public function @covers ::toArray
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals Deprecated protected function Asserts if two arrays are equal by sorting them first.
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::setUpBeforeClass public static function