class FieldConfigEntityUnitTest
Same name in other branches
- 9 core/modules/field/tests/src/Unit/FieldConfigEntityUnitTest.php \Drupal\Tests\field\Unit\FieldConfigEntityUnitTest
- 8.9.x core/modules/field/tests/src/Unit/FieldConfigEntityUnitTest.php \Drupal\Tests\field\Unit\FieldConfigEntityUnitTest
- 10 core/modules/field/tests/src/Unit/FieldConfigEntityUnitTest.php \Drupal\Tests\field\Unit\FieldConfigEntityUnitTest
@coversDefaultClass \Drupal\field\Entity\FieldConfig @group field
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\RandomGeneratorTrait
- class \Drupal\Tests\field\Unit\FieldConfigEntityUnitTest extends \Drupal\Tests\UnitTestCase
Expanded class hierarchy of FieldConfigEntityUnitTest
File
-
core/
modules/ field/ tests/ src/ Unit/ FieldConfigEntityUnitTest.php, line 19
Namespace
Drupal\Tests\field\UnitView 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 {
parent::setUp();
$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')
->willReturn('test_field');
$this->fieldStorage
->expects($this->any())
->method('getName')
->willReturn('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')
->willReturn([
$this->fieldStorage
->getName() => $this->fieldStorage,
]);
}
/**
* @covers ::calculateDependencies
*/
public function testCalculateDependencies() : void {
// 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')
->willReturn([
'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')
->willReturn('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() : void {
$storage = $this->createMock('\\Drupal\\Core\\Config\\Entity\\ConfigEntityStorageInterface');
$storage->expects($this->any())
->method('load')
->with('test_bundle_not_exists')
->willReturn(NULL);
$this->entityTypeManager
->expects($this->any())
->method('getStorage')
->with('bundle_entity_type')
->willReturn($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() : void {
$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() : void {
$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)
->willReturn($this->entityType);
$this->entityType
->expects($this->once())
->method('getKey')
->with('id')
->willReturn('id');
$this->entityType
->expects($this->once())
->method('getPropertiesToExport')
->with('test_entity_type.test_bundle.field_test')
->willReturn(array_combine(array_keys($expected), array_keys($expected)));
$export = $field->toArray();
$this->assertEquals($expected, $export);
}
/**
* @covers ::getType
*/
public function testGetType() : void {
// 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
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. | |
ExpectDeprecationTrait::getCallableName | private static | function | Returns a callable as a string suitable for inclusion in a message. | |
ExpectDeprecationTrait::setUpErrorHandler | public | function | Sets up the test error handler. | |
ExpectDeprecationTrait::tearDownErrorHandler | public | function | Tears down the test error handler. | |
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 | |
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | |
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | |
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
UnitTestCase::$root | protected | property | The app root. | |
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::getStringTranslationStub | public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase::setUpBeforeClass | public static | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.