class BaseFieldDefinitionTest in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/tests/Drupal/Tests/Core/Entity/BaseFieldDefinitionTest.php \Drupal\Tests\Core\Entity\BaseFieldDefinitionTest
Unit test for BaseFieldDefinition.
@group Entity @coversDefaultClass \Drupal\Core\Field\BaseFieldDefinition
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \Drupal\Tests\PHPUnit_Framework_TestCase
- class \Drupal\Tests\Core\Entity\BaseFieldDefinitionTest
Expanded class hierarchy of BaseFieldDefinitionTest
File
- core/
tests/ Drupal/ Tests/ Core/ Entity/ BaseFieldDefinitionTest.php, line 21 - Contains \Drupal\Tests\Core\Entity\BaseFieldDefinitionTest.
Namespace
Drupal\Tests\Core\EntityView source
class BaseFieldDefinitionTest extends UnitTestCase {
/**
* A dummy field type name.
*
* @var string
*/
protected $fieldType;
/**
* A dummy field type definition.
*
* @var string
*/
protected $fieldTypeDefinition;
/**
* {@inheritdoc}
*/
protected function setUp() {
// Mock the field type manager and place it in the container.
$field_type_manager = $this
->getMock('Drupal\\Core\\Field\\FieldTypePluginManagerInterface');
$this->fieldType = $this
->randomMachineName();
$this->fieldTypeDefinition = array(
'id' => $this->fieldType,
'storage_settings' => array(
'some_setting' => 'value 1',
),
'field_settings' => array(
'some_instance_setting' => 'value 2',
),
);
$field_type_manager
->expects($this
->any())
->method('getDefinitions')
->will($this
->returnValue(array(
$this->fieldType => $this->fieldTypeDefinition,
)));
$field_type_manager
->expects($this
->any())
->method('getDefinition')
->with($this->fieldType)
->will($this
->returnValue($this->fieldTypeDefinition));
$field_type_manager
->expects($this
->any())
->method('getDefaultStorageSettings')
->with($this->fieldType)
->will($this
->returnValue($this->fieldTypeDefinition['storage_settings']));
$field_type_manager
->expects($this
->any())
->method('getDefaultFieldSettings')
->with($this->fieldType)
->will($this
->returnValue($this->fieldTypeDefinition['field_settings']));
$container = new ContainerBuilder();
$container
->set('plugin.manager.field.field_type', $field_type_manager);
\Drupal::setContainer($container);
}
/**
* Tests field name methods.
*
* @covers ::getName
*/
public function testFieldName() {
$definition = BaseFieldDefinition::create($this->fieldType);
$field_name = $this
->randomMachineName();
$definition
->setName($field_name);
$this
->assertEquals($field_name, $definition
->getName());
}
/**
* Tests field label methods.
*
* @covers ::getLabel
*/
public function testFieldLabel() {
$definition = BaseFieldDefinition::create($this->fieldType);
$label = $this
->randomMachineName();
$definition
->setLabel($label);
$this
->assertEquals($label, $definition
->getLabel());
}
/**
* Tests field description methods.
*
* @covers ::getDescription
*/
public function testFieldDescription() {
$definition = BaseFieldDefinition::create($this->fieldType);
$description = $this
->randomMachineName();
$definition
->setDescription($description);
$this
->assertEquals($description, $definition
->getDescription());
}
/**
* Tests field type methods.
*
* @covers ::getType
*/
public function testFieldType() {
$definition = BaseFieldDefinition::create($this->fieldType);
$this
->assertEquals($this->fieldType, $definition
->getType());
}
/**
* Tests field settings methods.
*
* @covers ::getSetting
* @covers ::setSetting
* @covers ::getSettings
*/
public function testFieldSettings() {
$definition = BaseFieldDefinition::create($this->fieldType);
$setting = $this
->randomMachineName();
$value = $this
->randomMachineName();
$definition
->setSetting($setting, $value);
$this
->assertEquals($value, $definition
->getSetting($setting));
$default_settings = $this->fieldTypeDefinition['storage_settings'] + $this->fieldTypeDefinition['field_settings'];
$this
->assertEquals(array(
$setting => $value,
) + $default_settings, $definition
->getSettings());
}
/**
* Tests the initialization of default field settings.
*
* @covers ::getSetting
* @covers ::setSetting
* @covers ::getSettings
*/
public function testDefaultFieldSettings() {
$definition = BaseFieldDefinition::create($this->fieldType);
$expected_settings = $this->fieldTypeDefinition['storage_settings'] + $this->fieldTypeDefinition['field_settings'];
$this
->assertEquals($expected_settings, $definition
->getSettings());
foreach ($expected_settings as $setting => $value) {
$this
->assertEquals($value, $definition
->getSetting($setting));
}
}
/**
* Tests field default value.
*
* @covers ::getDefaultValue
* @covers ::setDefaultValue
*/
public function testFieldDefaultValue() {
$definition = BaseFieldDefinition::create($this->fieldType);
$default_value = array(
'value' => $this
->randomMachineName(),
);
$expected_default_value = array(
$default_value,
);
$definition
->setDefaultValue($default_value);
$entity = $this
->getMockBuilder('Drupal\\Core\\Entity\\ContentEntityBase')
->disableOriginalConstructor()
->getMock();
// Set the field item list class to be used to avoid requiring the typed
// data manager to retrieve it.
$definition
->setClass('Drupal\\Core\\Field\\FieldItemList');
$this
->assertEquals($expected_default_value, $definition
->getDefaultValue($entity));
$data_definition = $this
->getMockBuilder('Drupal\\Core\\TypedData\\DataDefinition')
->disableOriginalConstructor()
->getMock();
$data_definition
->expects($this
->any())
->method('getClass')
->will($this
->returnValue('Drupal\\Core\\Field\\FieldItemBase'));
$definition
->setItemDefinition($data_definition);
// Set default value only with a literal.
$definition
->setDefaultValue($default_value['value']);
$this
->assertEquals($expected_default_value, $definition
->getDefaultValue($entity));
// Set default value with an indexed array.
$definition
->setDefaultValue($expected_default_value);
$this
->assertEquals($expected_default_value, $definition
->getDefaultValue($entity));
// Set default value with an empty array.
$definition
->setDefaultValue(array());
$this
->assertEquals(array(), $definition
->getDefaultValue($entity));
// Set default value with NULL.
$definition
->setDefaultValue(NULL);
$this
->assertEquals([], $definition
->getDefaultValue($entity));
}
/**
* Tests field translatable methods.
*
* @covers ::isTranslatable
* @covers ::setTranslatable
*/
public function testFieldTranslatable() {
$definition = BaseFieldDefinition::create($this->fieldType);
$this
->assertFalse($definition
->isTranslatable());
$definition
->setTranslatable(TRUE);
$this
->assertTrue($definition
->isTranslatable());
$definition
->setTranslatable(FALSE);
$this
->assertFalse($definition
->isTranslatable());
}
/**
* Tests field revisionable methods.
*
* @covers ::isRevisionable
* @covers ::setRevisionable
*/
public function testFieldRevisionable() {
$definition = BaseFieldDefinition::create($this->fieldType);
$this
->assertFalse($definition
->isRevisionable());
$definition
->setRevisionable(TRUE);
$this
->assertTrue($definition
->isRevisionable());
$definition
->setRevisionable(FALSE);
$this
->assertFalse($definition
->isRevisionable());
}
/**
* Tests field cardinality.
*
* @covers ::getCardinality
* @covers ::setCardinality
*/
public function testFieldCardinality() {
$definition = BaseFieldDefinition::create($this->fieldType);
$this
->assertEquals(1, $definition
->getCardinality());
$definition
->setCardinality(2);
$this
->assertEquals(2, $definition
->getCardinality());
$definition
->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
$this
->assertEquals(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED, $definition
->getCardinality());
}
/**
* Tests required.
*
* @covers ::isRequired
* @covers ::setRequired
*/
public function testFieldRequired() {
$definition = BaseFieldDefinition::create($this->fieldType);
$this
->assertFalse($definition
->isRequired());
$definition
->setRequired(TRUE);
$this
->assertTrue($definition
->isRequired());
$definition
->setRequired(FALSE);
$this
->assertFalse($definition
->isRequired());
}
/**
* Tests provider.
*
* @covers ::getProvider
* @covers ::setProvider
*/
public function testFieldProvider() {
$definition = BaseFieldDefinition::create($this->fieldType);
$provider = $this
->randomMachineName();
$definition
->setProvider($provider);
$this
->assertEquals($provider, $definition
->getProvider());
}
/**
* Tests custom storage.
*
* @covers ::hasCustomStorage
* @covers ::setCustomStorage
*/
public function testCustomStorage() {
$definition = BaseFieldDefinition::create($this->fieldType);
$this
->assertFalse($definition
->hasCustomStorage());
$definition
->setCustomStorage(TRUE);
$this
->assertTrue($definition
->hasCustomStorage());
$definition
->setCustomStorage(FALSE);
$this
->assertFalse($definition
->hasCustomStorage());
}
/**
* Tests default value callbacks.
*
* @covers ::setDefaultValueCallback
*/
public function testDefaultValueCallback() {
$definition = BaseFieldDefinition::create($this->fieldType);
$callback = get_class($this) . '::mockDefaultValueCallback';
// setDefaultValueCallback returns $this.
$this
->assertSame($definition, $definition
->setDefaultValueCallback($callback));
}
/**
* Tests invalid default value callbacks.
*
* @covers ::setDefaultValueCallback
* @expectedException \InvalidArgumentException
*/
public function testInvalidDefaultValueCallback() {
$definition = BaseFieldDefinition::create($this->fieldType);
// setDefaultValueCallback returns $this.
$this
->assertSame($definition, $definition
->setDefaultValueCallback([
get_class($this),
'mockDefaultValueCallback',
]));
}
/**
* Tests NULL default value callbacks.
*
* @covers ::setDefaultValueCallback
*/
public function testNullDefaultValueCallback() {
$definition = BaseFieldDefinition::create($this->fieldType);
// setDefaultValueCallback returns $this.
$this
->assertSame($definition, $definition
->setDefaultValueCallback(NULL));
}
/**
* Provides a Mock base field default value callback.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* Entity interface.
* @param \Drupal\Core\Field\FieldDefinitionInterface $definition
* Field definition.
*
* @return string
* Default value.
*/
public static function mockDefaultValueCallback($entity, $definition) {
return 'a default value';
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BaseFieldDefinitionTest:: |
protected | property | A dummy field type name. | |
BaseFieldDefinitionTest:: |
protected | property | A dummy field type definition. | |
BaseFieldDefinitionTest:: |
public static | function | Provides a Mock base field default value callback. | |
BaseFieldDefinitionTest:: |
protected | function |
Overrides UnitTestCase:: |
|
BaseFieldDefinitionTest:: |
public | function | Tests custom storage. | |
BaseFieldDefinitionTest:: |
public | function | Tests the initialization of default field settings. | |
BaseFieldDefinitionTest:: |
public | function | Tests default value callbacks. | |
BaseFieldDefinitionTest:: |
public | function | Tests field cardinality. | |
BaseFieldDefinitionTest:: |
public | function | Tests field default value. | |
BaseFieldDefinitionTest:: |
public | function | Tests field description methods. | |
BaseFieldDefinitionTest:: |
public | function | Tests field label methods. | |
BaseFieldDefinitionTest:: |
public | function | Tests field name methods. | |
BaseFieldDefinitionTest:: |
public | function | Tests provider. | |
BaseFieldDefinitionTest:: |
public | function | Tests required. | |
BaseFieldDefinitionTest:: |
public | function | Tests field revisionable methods. | |
BaseFieldDefinitionTest:: |
public | function | Tests field settings methods. | |
BaseFieldDefinitionTest:: |
public | function | Tests field translatable methods. | |
BaseFieldDefinitionTest:: |
public | function | Tests field type methods. | |
BaseFieldDefinitionTest:: |
public | function | Tests invalid default value callbacks. | |
BaseFieldDefinitionTest:: |
public | function | Tests NULL default value callbacks. | |
UnitTestCase:: |
protected | property | The random generator. | |
UnitTestCase:: |
protected | property | The app root. | |
UnitTestCase:: |
protected | function | Asserts if two arrays are equal by sorting them first. | |
UnitTestCase:: |
protected | function | Mocks a block with a block plugin. | |
UnitTestCase:: |
protected | function | Returns a stub class resolver. | |
UnitTestCase:: |
public | function | Returns a stub config factory that behaves according to the passed in array. | |
UnitTestCase:: |
public | function | Returns a stub config storage that returns the supplied configuration. | |
UnitTestCase:: |
protected | function | Sets up a container with a cache tags invalidator. | |
UnitTestCase:: |
protected | function | Gets the random generator for the utility methods. | |
UnitTestCase:: |
public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase:: |
public | function | Generates a unique random string containing letters and numbers. |