class TypedDataTest in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/system/src/Tests/TypedData/TypedDataTest.php \Drupal\system\Tests\TypedData\TypedDataTest
Tests the functionality of all core data types.
@group TypedData
Hierarchy
- class \Drupal\simpletest\TestBase uses AssertHelperTrait, RandomGeneratorTrait, SessionTestTrait
- class \Drupal\simpletest\KernelTestBase uses AssertContentTrait
- class \Drupal\system\Tests\TypedData\TypedDataTest
- class \Drupal\simpletest\KernelTestBase uses AssertContentTrait
Expanded class hierarchy of TypedDataTest
File
- core/
modules/ system/ src/ Tests/ TypedData/ TypedDataTest.php, line 23 - Contains \Drupal\system\Tests\TypedData\TypedDataTest.
Namespace
Drupal\system\Tests\TypedDataView source
class TypedDataTest extends KernelTestBase {
/**
* The typed data manager to use.
*
* @var \Drupal\Core\TypedData\TypedDataManager
*/
protected $typedDataManager;
/**
* Modules to enable.
*
* @var array
*/
public static $modules = array(
'system',
'field',
'file',
'user',
);
protected function setUp() {
parent::setup();
$this
->installEntitySchema('file');
$this->typedDataManager = $this->container
->get('typed_data_manager');
}
/**
* Creates a typed data object and ensures it implements TypedDataInterface.
*
* @see \Drupal\Core\TypedData\TypedDataManager::create().
*/
protected function createTypedData($definition, $value = NULL, $name = NULL) {
if (is_array($definition)) {
$definition = DataDefinition::create($definition['type']);
}
$data = $this->typedDataManager
->create($definition, $value, $name);
$this
->assertTrue($data instanceof \Drupal\Core\TypedData\TypedDataInterface, 'Typed data object is an instance of the typed data interface.');
return $data;
}
/**
* Tests the basics around constructing and working with typed data objects.
*/
public function testGetAndSet() {
// Boolean type.
$typed_data = $this
->createTypedData(array(
'type' => 'boolean',
), TRUE);
$this
->assertTrue($typed_data instanceof \Drupal\Core\TypedData\Type\BooleanInterface, 'Typed data object is an instance of BooleanInterface.');
$this
->assertTrue($typed_data
->getValue() === TRUE, 'Boolean value was fetched.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue(FALSE);
$this
->assertTrue($typed_data
->getValue() === FALSE, 'Boolean value was changed.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$this
->assertTrue(is_string($typed_data
->getString()), 'Boolean value was converted to string');
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getValue(), 'Boolean wrapper is null-able.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue('invalid');
$this
->assertEqual($typed_data
->validate()
->count(), 1, 'Validation detected invalid value.');
// String type.
$value = $this
->randomString();
$typed_data = $this
->createTypedData(array(
'type' => 'string',
), $value);
$this
->assertTrue($typed_data instanceof \Drupal\Core\TypedData\Type\StringInterface, 'Typed data object is an instance of StringInterface.');
$this
->assertTrue($typed_data
->getValue() === $value, 'String value was fetched.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$new_value = $this
->randomString();
$typed_data
->setValue($new_value);
$this
->assertTrue($typed_data
->getValue() === $new_value, 'String value was changed.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
// Funky test.
$this
->assertTrue(is_string($typed_data
->getString()), 'String value was converted to string');
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getValue(), 'String wrapper is null-able.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue(array(
'no string',
));
$this
->assertEqual($typed_data
->validate()
->count(), 1, 'Validation detected invalid value.');
// Integer type.
$value = rand();
$typed_data = $this
->createTypedData(array(
'type' => 'integer',
), $value);
$this
->assertTrue($typed_data instanceof \Drupal\Core\TypedData\Type\IntegerInterface, 'Typed data object is an instance of IntegerInterface.');
$this
->assertTrue($typed_data
->getValue() === $value, 'Integer value was fetched.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$new_value = rand();
$typed_data
->setValue($new_value);
$this
->assertTrue($typed_data
->getValue() === $new_value, 'Integer value was changed.');
$this
->assertTrue(is_string($typed_data
->getString()), 'Integer value was converted to string');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getValue(), 'Integer wrapper is null-able.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue('invalid');
$this
->assertEqual($typed_data
->validate()
->count(), 1, 'Validation detected invalid value.');
// Float type.
$value = 123.45;
$typed_data = $this
->createTypedData(array(
'type' => 'float',
), $value);
$this
->assertTrue($typed_data instanceof \Drupal\Core\TypedData\Type\FloatInterface, 'Typed data object is an instance of FloatInterface.');
$this
->assertTrue($typed_data
->getValue() === $value, 'Float value was fetched.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$new_value = 678.9;
$typed_data
->setValue($new_value);
$this
->assertTrue($typed_data
->getValue() === $new_value, 'Float value was changed.');
$this
->assertTrue(is_string($typed_data
->getString()), 'Float value was converted to string');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getValue(), 'Float wrapper is null-able.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue('invalid');
$this
->assertEqual($typed_data
->validate()
->count(), 1, 'Validation detected invalid value.');
// Date Time type.
$value = '2014-01-01T20:00:00+00:00';
$typed_data = $this
->createTypedData(array(
'type' => 'datetime_iso8601',
), $value);
$this
->assertTrue($typed_data instanceof \Drupal\Core\TypedData\Type\DateTimeInterface, 'Typed data object is an instance of DateTimeInterface.');
$this
->assertTrue($typed_data
->getValue() == $value, 'Date value was fetched.');
$this
->assertEqual($typed_data
->getValue(), $typed_data
->getDateTime()
->format('c'), 'Value representation of a date is ISO 8601');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$new_value = '2014-01-02T20:00:00+00:00';
$typed_data
->setValue($new_value);
$this
->assertTrue($typed_data
->getDateTime()
->format('c') === $new_value, 'Date value was changed and set by an ISO8601 date.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$this
->assertTrue($typed_data
->getDateTime()
->format('Y-m-d') == '2014-01-02', 'Date value was changed and set by date string.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getDateTime(), 'Date wrapper is null-able.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue('invalid');
$this
->assertEqual($typed_data
->validate()
->count(), 1, 'Validation detected invalid value.');
// Check implementation of DateTimeInterface.
$typed_data = $this
->createTypedData(array(
'type' => 'datetime_iso8601',
), '2014-01-01T20:00:00+00:00');
$this
->assertTrue($typed_data
->getDateTime() instanceof DrupalDateTime);
$typed_data
->setDateTime(new DrupalDateTime('2014-01-02T20:00:00+00:00'));
$this
->assertEqual($typed_data
->getValue(), '2014-01-02T20:00:00+00:00');
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getDateTime());
// Timestamp type.
$value = REQUEST_TIME;
$typed_data = $this
->createTypedData(array(
'type' => 'timestamp',
), $value);
$this
->assertTrue($typed_data instanceof \Drupal\Core\TypedData\Type\DateTimeInterface, 'Typed data object is an instance of DateTimeInterface.');
$this
->assertTrue($typed_data
->getValue() == $value, 'Timestamp value was fetched.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$new_value = REQUEST_TIME + 1;
$typed_data
->setValue($new_value);
$this
->assertTrue($typed_data
->getValue() === $new_value, 'Timestamp value was changed and set.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getDateTime(), 'Timestamp wrapper is null-able.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue('invalid');
$this
->assertEqual($typed_data
->validate()
->count(), 1, 'Validation detected invalid value.');
// Check implementation of DateTimeInterface.
$typed_data = $this
->createTypedData(array(
'type' => 'timestamp',
), REQUEST_TIME);
$this
->assertTrue($typed_data
->getDateTime() instanceof DrupalDateTime);
$typed_data
->setDateTime(DrupalDateTime::createFromTimestamp(REQUEST_TIME + 1));
$this
->assertEqual($typed_data
->getValue(), REQUEST_TIME + 1);
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getDateTime());
// DurationIso8601 type.
$value = 'PT20S';
$typed_data = $this
->createTypedData(array(
'type' => 'duration_iso8601',
), $value);
$this
->assertTrue($typed_data instanceof \Drupal\Core\TypedData\Type\DurationInterface, 'Typed data object is an instance of DurationInterface.');
$this
->assertIdentical($typed_data
->getValue(), $value, 'DurationIso8601 value was fetched.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue('P40D');
$this
->assertEqual($typed_data
->getDuration()->d, 40, 'DurationIso8601 value was changed and set by duration string.');
$this
->assertTrue(is_string($typed_data
->getString()), 'DurationIso8601 value was converted to string');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getValue(), 'DurationIso8601 wrapper is null-able.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue('invalid');
$this
->assertEqual($typed_data
->validate()
->count(), 1, 'Validation detected invalid value.');
// Check implementation of DurationInterface.
$typed_data = $this
->createTypedData(array(
'type' => 'duration_iso8601',
), 'PT20S');
$this
->assertTrue($typed_data
->getDuration() instanceof \DateInterval);
$typed_data
->setDuration(new \DateInterval('P40D'));
// @todo: Should we make this "nicer"?
$this
->assertEqual($typed_data
->getValue(), 'P0Y0M40DT0H0M0S');
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getDuration());
// Time span type.
$value = 20;
$typed_data = $this
->createTypedData(array(
'type' => 'timespan',
), $value);
$this
->assertTrue($typed_data instanceof \Drupal\Core\TypedData\Type\DurationInterface, 'Typed data object is an instance of DurationInterface.');
$this
->assertIdentical($typed_data
->getValue(), $value, 'Time span value was fetched.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue(60 * 60 * 4);
$this
->assertEqual($typed_data
->getDuration()->s, 14400, 'Time span was changed');
$this
->assertTrue(is_string($typed_data
->getString()), 'Time span value was converted to string');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getValue(), 'Time span wrapper is null-able.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue('invalid');
$this
->assertEqual($typed_data
->validate()
->count(), 1, 'Validation detected invalid value.');
// Check implementation of DurationInterface.
$typed_data = $this
->createTypedData(array(
'type' => 'timespan',
), 20);
$this
->assertTrue($typed_data
->getDuration() instanceof \DateInterval);
$typed_data
->setDuration(new \DateInterval('PT4H'));
$this
->assertEqual($typed_data
->getValue(), 60 * 60 * 4);
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getDuration());
// URI type.
$uri = 'http://example.com/foo/';
$typed_data = $this
->createTypedData(array(
'type' => 'uri',
), $uri);
$this
->assertTrue($typed_data instanceof \Drupal\Core\TypedData\Type\UriInterface, 'Typed data object is an instance of UriInterface.');
$this
->assertTrue($typed_data
->getValue() === $uri, 'URI value was fetched.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue($uri . 'bar.txt');
$this
->assertTrue($typed_data
->getValue() === $uri . 'bar.txt', 'URI value was changed.');
$this
->assertTrue(is_string($typed_data
->getString()), 'URI value was converted to string');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getValue(), 'URI wrapper is null-able.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue('invalid');
$this
->assertEqual($typed_data
->validate()
->count(), 1, 'Validation detected invalid value.');
$typed_data
->setValue('public://field/image/Photo on 4-28-14 at 12.01 PM.jpg');
$this
->assertEqual($typed_data
->validate()
->count(), 0, 'Filename with spaces is valid.');
// Generate some files that will be used to test the binary data type.
$files = array();
for ($i = 0; $i < 3; $i++) {
$path = "public://example_{$i}.png";
file_unmanaged_copy(\Drupal::root() . '/core/misc/druplicon.png', $path);
$image = entity_create('file', array(
'uri' => $path,
));
$image
->save();
$files[] = $image;
}
// Email type.
$value = $this
->randomString();
$typed_data = $this
->createTypedData(array(
'type' => 'email',
), $value);
$this
->assertTrue($typed_data instanceof \Drupal\Core\TypedData\Type\StringInterface, 'Typed data object is an instance of StringInterface.');
$this
->assertIdentical($typed_data
->getValue(), $value, 'Email value was fetched.');
$new_value = 'test@example.com';
$typed_data
->setValue($new_value);
$this
->assertIdentical($typed_data
->getValue(), $new_value, 'Email value was changed.');
$this
->assertTrue(is_string($typed_data
->getString()), 'Email value was converted to string');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getValue(), 'Email wrapper is null-able.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue('invalidATexample.com');
$this
->assertEqual($typed_data
->validate()
->count(), 1, 'Validation detected invalid value.');
// Binary type.
$typed_data = $this
->createTypedData(array(
'type' => 'binary',
), $files[0]
->getFileUri());
$this
->assertTrue($typed_data instanceof \Drupal\Core\TypedData\Type\BinaryInterface, 'Typed data object is an instance of BinaryInterface.');
$this
->assertTrue(is_resource($typed_data
->getValue()), 'Binary value was fetched.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
// Try setting by URI.
$typed_data
->setValue($files[1]
->getFileUri());
$this
->assertEqual(fgets($typed_data
->getValue()), fgets(fopen($files[1]
->getFileUri(), 'r')), 'Binary value was changed.');
$this
->assertTrue(is_string($typed_data
->getString()), 'Binary value was converted to string');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
// Try setting by resource.
$typed_data
->setValue(fopen($files[2]
->getFileUri(), 'r'));
$this
->assertEqual(fgets($typed_data
->getValue()), fgets(fopen($files[2]
->getFileUri(), 'r')), 'Binary value was changed.');
$this
->assertTrue(is_string($typed_data
->getString()), 'Binary value was converted to string');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getValue(), 'Binary wrapper is null-able.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue('invalid');
$this
->assertEqual($typed_data
->validate()
->count(), 1, 'Validation detected invalid value.');
// Any type.
$value = array(
'foo',
);
$typed_data = $this
->createTypedData(array(
'type' => 'any',
), $value);
$this
->assertIdentical($typed_data
->getValue(), $value, 'Any value was fetched.');
$new_value = 'test@example.com';
$typed_data
->setValue($new_value);
$this
->assertIdentical($typed_data
->getValue(), $new_value, 'Any value was changed.');
$this
->assertTrue(is_string($typed_data
->getString()), 'Any value was converted to string');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getValue(), 'Any wrapper is null-able.');
$this
->assertEqual($typed_data
->validate()
->count(), 0);
// We cannot test invalid values as everything is valid for the any type,
// but make sure an array or object value passes validation also.
$typed_data
->setValue(array(
'entry',
));
$this
->assertEqual($typed_data
->validate()
->count(), 0);
$typed_data
->setValue((object) array(
'entry',
));
$this
->assertEqual($typed_data
->validate()
->count(), 0);
}
/**
* Tests using typed data lists.
*/
public function testTypedDataLists() {
// Test working with an existing list of strings.
$value = array(
'one',
'two',
'three',
);
$typed_data = $this
->createTypedData(ListDataDefinition::create('string'), $value);
$this
->assertEqual($typed_data
->getValue(), $value, 'List value has been set.');
// Test iterating.
$count = 0;
foreach ($typed_data as $item) {
$this
->assertTrue($item instanceof TypedDataInterface);
$count++;
}
$this
->assertEqual($count, 3);
// Test getting the string representation.
$this
->assertEqual($typed_data
->getString(), 'one, two, three');
$typed_data[1] = '';
$this
->assertEqual($typed_data
->getString(), 'one, three');
// Test using array access.
$this
->assertEqual($typed_data[0]
->getValue(), 'one');
$typed_data[] = 'four';
$this
->assertEqual($typed_data[3]
->getValue(), 'four');
$this
->assertEqual($typed_data
->count(), 4);
$this
->assertTrue(isset($typed_data[0]));
$this
->assertTrue(!isset($typed_data[6]));
// Test isEmpty and cloning.
$this
->assertFalse($typed_data
->isEmpty());
$clone = clone $typed_data;
$this
->assertTrue($typed_data
->getValue() === $clone
->getValue());
$this
->assertTrue($typed_data[0] !== $clone[0]);
$clone
->setValue(array());
$this
->assertTrue($clone
->isEmpty());
// Make sure that resetting the value using NULL results in an empty array.
$clone
->setValue(array());
$typed_data
->setValue(NULL);
$this
->assertIdentical($typed_data
->getValue(), array());
$this
->assertIdentical($clone
->getValue(), array());
// Test dealing with NULL items.
$typed_data[] = NULL;
$this
->assertTrue($typed_data
->isEmpty());
$this
->assertEqual(count($typed_data), 1);
$typed_data[] = '';
$this
->assertFalse($typed_data
->isEmpty());
$this
->assertEqual(count($typed_data), 2);
$typed_data[] = 'three';
$this
->assertFalse($typed_data
->isEmpty());
$this
->assertEqual(count($typed_data), 3);
$this
->assertEqual($typed_data
->getValue(), array(
NULL,
'',
'three',
));
// Test unsetting.
unset($typed_data[1]);
$this
->assertEqual(count($typed_data), 2);
// Check that items were shifted.
$this
->assertEqual($typed_data[1]
->getValue(), 'three');
// Getting a not set list item returns NULL, and does not create a new item.
$this
->assertNull($typed_data[2]);
$this
->assertEqual(count($typed_data), 2);
// Test setting the list with less values.
$typed_data
->setValue(array(
'one',
));
$this
->assertEqual($typed_data
->count(), 1);
// Test setting invalid values.
try {
$typed_data
->setValue('string');
$this
->fail('No exception has been thrown when setting an invalid value.');
} catch (\Exception $e) {
$this
->pass('Exception thrown:' . $e
->getMessage());
}
}
/**
* Tests the filter() method on typed data lists.
*/
public function testTypedDataListsFilter() {
// Check that an all-pass filter leaves the list untouched.
$value = array(
'zero',
'one',
);
$typed_data = $this
->createTypedData(ListDataDefinition::create('string'), $value);
$typed_data
->filter(function (TypedDataInterface $item) {
return TRUE;
});
$this
->assertEqual($typed_data
->count(), 2);
$this
->assertEqual($typed_data[0]
->getValue(), 'zero');
$this
->assertEqual($typed_data[0]
->getName(), 0);
$this
->assertEqual($typed_data[1]
->getValue(), 'one');
$this
->assertEqual($typed_data[1]
->getName(), 1);
// Check that a none-pass filter empties the list.
$value = array(
'zero',
'one',
);
$typed_data = $this
->createTypedData(ListDataDefinition::create('string'), $value);
$typed_data
->filter(function (TypedDataInterface $item) {
return FALSE;
});
$this
->assertEqual($typed_data
->count(), 0);
// Check that filtering correctly renumbers elements.
$value = array(
'zero',
'one',
'two',
);
$typed_data = $this
->createTypedData(ListDataDefinition::create('string'), $value);
$typed_data
->filter(function (TypedDataInterface $item) {
return $item
->getValue() !== 'one';
});
$this
->assertEqual($typed_data
->count(), 2);
$this
->assertEqual($typed_data[0]
->getValue(), 'zero');
$this
->assertEqual($typed_data[0]
->getName(), 0);
$this
->assertEqual($typed_data[1]
->getValue(), 'two');
$this
->assertEqual($typed_data[1]
->getName(), 1);
}
/**
* Tests using a typed data map.
*/
public function testTypedDataMaps() {
// Test working with a simple map.
$value = array(
'one' => 'eins',
'two' => 'zwei',
'three' => 'drei',
);
$definition = MapDataDefinition::create()
->setPropertyDefinition('one', DataDefinition::create('string'))
->setPropertyDefinition('two', DataDefinition::create('string'))
->setPropertyDefinition('three', DataDefinition::create('string'));
$typed_data = $this
->createTypedData($definition, $value);
// Test iterating.
$count = 0;
foreach ($typed_data as $item) {
$this
->assertTrue($item instanceof \Drupal\Core\TypedData\TypedDataInterface);
$count++;
}
$this
->assertEqual($count, 3);
// Test retrieving metadata.
$this
->assertEqual(array_keys($typed_data
->getDataDefinition()
->getPropertyDefinitions()), array_keys($value));
$definition = $typed_data
->getDataDefinition()
->getPropertyDefinition('one');
$this
->assertEqual($definition
->getDataType(), 'string');
$this
->assertNull($typed_data
->getDataDefinition()
->getPropertyDefinition('invalid'));
// Test getting and setting properties.
$this
->assertEqual($typed_data
->get('one')
->getValue(), 'eins');
$this
->assertEqual($typed_data
->toArray(), $value);
$typed_data
->set('one', 'uno');
$this
->assertEqual($typed_data
->get('one')
->getValue(), 'uno');
// Make sure the update is reflected in the value of the map also.
$value = $typed_data
->getValue();
$this
->assertEqual($value, array(
'one' => 'uno',
'two' => 'zwei',
'three' => 'drei',
));
$properties = $typed_data
->getProperties();
$this
->assertEqual(array_keys($properties), array_keys($value));
$this
->assertIdentical($properties['one'], $typed_data
->get('one'), 'Properties are identical.');
// Test setting a not defined property. It shouldn't show up in the
// properties, but be kept in the values.
$typed_data
->setValue(array(
'foo' => 'bar',
));
$this
->assertEqual(array_keys($typed_data
->getProperties()), array(
'one',
'two',
'three',
));
$this
->assertEqual(array_keys($typed_data
->getValue()), array(
'foo',
'one',
'two',
'three',
));
// Test getting the string representation.
$typed_data
->setValue(array(
'one' => 'eins',
'two' => '',
'three' => 'drei',
));
$this
->assertEqual($typed_data
->getString(), 'eins, drei');
// Test isEmpty and cloning.
$this
->assertFalse($typed_data
->isEmpty());
$clone = clone $typed_data;
$this
->assertTrue($typed_data
->getValue() === $clone
->getValue());
$this
->assertTrue($typed_data
->get('one') !== $clone
->get('one'));
$clone
->setValue(array());
$this
->assertTrue($clone
->isEmpty());
// Make sure the difference between NULL (not set) and an empty array is
// kept.
$typed_data
->setValue(NULL);
$this
->assertNull($typed_data
->getValue());
$typed_data
->setValue(array());
$value = $typed_data
->getValue();
$this
->assertTrue(isset($value) && is_array($value));
// Test accessing invalid properties.
$typed_data
->setValue($value);
try {
$typed_data
->get('invalid');
$this
->fail('No exception has been thrown when getting an invalid value.');
} catch (\Exception $e) {
$this
->pass('Exception thrown:' . $e
->getMessage());
}
// Test setting invalid values.
try {
$typed_data
->setValue('invalid');
$this
->fail('No exception has been thrown when setting an invalid value.');
} catch (\Exception $e) {
$this
->pass('Exception thrown:' . $e
->getMessage());
}
// Test adding a new property to the map.
$typed_data
->getDataDefinition()
->setPropertyDefinition('zero', DataDefinition::create('any'));
$typed_data
->set('zero', 'null');
$this
->assertEqual($typed_data
->get('zero')
->getValue(), 'null');
$definition = $typed_data
->get('zero')
->getDataDefinition();
$this
->assertEqual($definition
->getDataType(), 'any', 'Definition for a new map entry returned.');
}
/**
* Tests typed data validation.
*/
public function testTypedDataValidation() {
$definition = DataDefinition::create('integer')
->setConstraints(array(
'Range' => array(
'min' => 5,
),
));
$violations = $this->typedDataManager
->create($definition, 10)
->validate();
$this
->assertEqual($violations
->count(), 0);
$integer = $this->typedDataManager
->create($definition, 1);
$violations = $integer
->validate();
$this
->assertEqual($violations
->count(), 1);
// Test translating violation messages.
$message = t('This value should be %limit or more.', array(
'%limit' => 5,
));
$this
->assertEqual($violations[0]
->getMessage(), $message, 'Translated violation message retrieved.');
$this
->assertEqual($violations[0]
->getPropertyPath(), '');
$this
->assertIdentical($violations[0]
->getRoot(), $integer, 'Root object returned.');
// Test translating violation messages when pluralization is used.
$definition = DataDefinition::create('string')
->setConstraints(array(
'Length' => array(
'min' => 10,
),
));
$violations = $this->typedDataManager
->create($definition, "short")
->validate();
$this
->assertEqual($violations
->count(), 1);
$message = t('This value is too short. It should have %limit characters or more.', array(
'%limit' => 10,
));
$this
->assertEqual($violations[0]
->getMessage(), $message, 'Translated violation message retrieved.');
// Test having multiple violations.
$definition = DataDefinition::create('integer')
->setConstraints(array(
'Range' => array(
'min' => 5,
),
'Null' => array(),
));
$violations = $this->typedDataManager
->create($definition, 10)
->validate();
$this
->assertEqual($violations
->count(), 1);
$violations = $this->typedDataManager
->create($definition, 1)
->validate();
$this
->assertEqual($violations
->count(), 2);
// Test validating property containers and make sure the NotNull and Null
// constraints work with typed data containers.
$definition = BaseFieldDefinition::create('integer')
->setConstraints(array(
'NotNull' => array(),
));
$field_item = $this->typedDataManager
->create($definition, array(
'value' => 10,
));
$violations = $field_item
->validate();
$this
->assertEqual($violations
->count(), 0);
$field_item = $this->typedDataManager
->create($definition, array(
'value' => 'no integer',
));
$violations = $field_item
->validate();
$this
->assertEqual($violations
->count(), 1);
$this
->assertEqual($violations[0]
->getPropertyPath(), '0.value');
// Test that the field item may not be empty.
$field_item = $this->typedDataManager
->create($definition);
$violations = $field_item
->validate();
$this
->assertEqual($violations
->count(), 1);
// Test the Null constraint with typed data containers.
$definition = BaseFieldDefinition::create('float')
->setConstraints(array(
'Null' => array(),
));
$field_item = $this->typedDataManager
->create($definition, array(
'value' => 11.5,
));
$violations = $field_item
->validate();
$this
->assertEqual($violations
->count(), 1);
$field_item = $this->typedDataManager
->create($definition);
$violations = $field_item
->validate();
$this
->assertEqual($violations
->count(), 0);
// Test getting constraint definitions by type.
$definitions = $this->typedDataManager
->getValidationConstraintManager()
->getDefinitionsByType('entity');
$this
->assertTrue(isset($definitions['EntityType']), 'Constraint plugin found for type entity.');
$this
->assertTrue(isset($definitions['Null']), 'Constraint plugin found for type entity.');
$this
->assertTrue(isset($definitions['NotNull']), 'Constraint plugin found for type entity.');
$definitions = $this->typedDataManager
->getValidationConstraintManager()
->getDefinitionsByType('string');
$this
->assertFalse(isset($definitions['EntityType']), 'Constraint plugin not found for type string.');
$this
->assertTrue(isset($definitions['Null']), 'Constraint plugin found for type string.');
$this
->assertTrue(isset($definitions['NotNull']), 'Constraint plugin found for type string.');
// Test automatic 'required' validation.
$definition = DataDefinition::create('integer')
->setRequired(TRUE);
$violations = $this->typedDataManager
->create($definition)
->validate();
$this
->assertEqual($violations
->count(), 1);
$violations = $this->typedDataManager
->create($definition, 0)
->validate();
$this
->assertEqual($violations
->count(), 0);
// Test validating a list of a values and make sure property paths starting
// with "0" are created.
$definition = BaseFieldDefinition::create('integer');
$violations = $this->typedDataManager
->create($definition, array(
array(
'value' => 10,
),
))
->validate();
$this
->assertEqual($violations
->count(), 0);
$violations = $this->typedDataManager
->create($definition, array(
array(
'value' => 'string',
),
))
->validate();
$this
->assertEqual($violations
->count(), 1);
$this
->assertEqual($violations[0]
->getInvalidValue(), 'string');
$this
->assertIdentical($violations[0]
->getPropertyPath(), '0.value');
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 2 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertHelperTrait:: |
protected | function | Casts MarkupInterface objects into strings. | |
KernelTestBase:: |
protected | property | The configuration directories for this test run. | |
KernelTestBase:: |
protected | property | A KeyValueMemoryFactory instance to use when building the container. | |
KernelTestBase:: |
private | property | ||
KernelTestBase:: |
protected | property | Array of registered stream wrappers. | |
KernelTestBase:: |
private | property | ||
KernelTestBase:: |
protected | function |
Act on global state information before the environment is altered for a test. Overrides TestBase:: |
|
KernelTestBase:: |
public | function | Sets up the base service container for this test. | 12 |
KernelTestBase:: |
protected | function | Provides the data for setting the default language on the container. | 1 |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs a specific table from a module schema definition. | |
KernelTestBase:: |
protected | function | Create and set new configuration directories. | 1 |
KernelTestBase:: |
protected | function | Registers a stream wrapper for this test. | |
KernelTestBase:: |
protected | function | Renders a render array. | |
KernelTestBase:: |
protected | function |
Performs cleanup tasks after each individual test method has been run. Overrides TestBase:: |
|
KernelTestBase:: |
function |
Constructor for Test. Overrides TestBase:: |
||
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
SessionTestTrait:: |
protected | property | The name of the session cookie. | |
SessionTestTrait:: |
protected | function | Generates a session cookie name. | |
SessionTestTrait:: |
protected | function | Returns the session name in use on the child site. | |
TestBase:: |
protected | property | Assertions thrown in that test case. | |
TestBase:: |
protected | property | The config importer that can used in a test. | 5 |
TestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
TestBase:: |
protected | property | The dependency injection container used in the test. | |
TestBase:: |
protected | property | The database prefix of this test run. | |
TestBase:: |
public | property | Whether to die in case any test assertion fails. | |
TestBase:: |
protected | property | HTTP authentication credentials (<username>:<password>). | |
TestBase:: |
protected | property | HTTP authentication method (specified as a CURLAUTH_* constant). | |
TestBase:: |
protected | property | The DrupalKernel instance used in the test. | 1 |
TestBase:: |
protected | property | The original configuration (variables), if available. | |
TestBase:: |
protected | property | The original configuration (variables). | |
TestBase:: |
protected | property | The original configuration directories. | |
TestBase:: |
protected | property | The original container. | |
TestBase:: |
protected | property | The original file directory, before it was changed for testing purposes. | |
TestBase:: |
protected | property | The original language. | |
TestBase:: |
protected | property | The original database prefix when running inside Simpletest. | |
TestBase:: |
protected | property | The original installation profile. | |
TestBase:: |
protected | property | The name of the session cookie of the test-runner. | |
TestBase:: |
protected | property | The settings array. | |
TestBase:: |
protected | property | The original array of shutdown function callbacks. | 1 |
TestBase:: |
protected | property | The site directory of the original parent site. | |
TestBase:: |
protected | property | The original user, before testing began. | 1 |
TestBase:: |
protected | property | The private file directory for the test environment. | |
TestBase:: |
protected | property | The public file directory for the test environment. | |
TestBase:: |
public | property | Current results of this test case. | |
TestBase:: |
protected | property | The site directory of this test run. | |
TestBase:: |
protected | property | This class is skipped when looking for the source of an assertion. | |
TestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 4 |
TestBase:: |
protected | property | The temporary file directory for the test environment. | |
TestBase:: |
protected | property | The test run ID. | |
TestBase:: |
protected | property | Time limit for the test. | |
TestBase:: |
protected | property | The translation file directory for the test environment. | |
TestBase:: |
public | property | TRUE if verbose debugging is enabled. | |
TestBase:: |
protected | property | Safe class name for use in verbose output filenames. | |
TestBase:: |
protected | property | Directory where verbose output files are put. | |
TestBase:: |
protected | property | URL to the verbose output file directory. | |
TestBase:: |
protected | property | Incrementing identifier for verbose output filenames. | |
TestBase:: |
protected | function | Internal helper: stores the assert. | |
TestBase:: |
protected | function | Check to see if two values are equal. | |
TestBase:: |
protected | function | Asserts that a specific error has been logged to the PHP error log. | |
TestBase:: |
protected | function | Check to see if a value is false. | |
TestBase:: |
protected | function | Check to see if two values are identical. | |
TestBase:: |
protected | function | Checks to see if two objects are identical. | |
TestBase:: |
protected | function | Asserts that no errors have been logged to the PHP error.log thus far. | |
TestBase:: |
protected | function | Check to see if two values are not equal. | |
TestBase:: |
protected | function | Check to see if two values are not identical. | |
TestBase:: |
protected | function | Check to see if a value is not NULL. | |
TestBase:: |
protected | function | Check to see if a value is NULL. | |
TestBase:: |
protected | function | Check to see if a value is not false. | |
TestBase:: |
private | function | Changes the database connection to the prefixed one. | |
TestBase:: |
protected | function | Checks the matching requirements for Test. | 2 |
TestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
TestBase:: |
public | function | Returns a ConfigImporter object to import test importing of configuration. | 5 |
TestBase:: |
public | function | Copies configuration objects from source storage to target storage. | |
TestBase:: |
public static | function | Delete an assertion record by message ID. | |
TestBase:: |
protected | function | Fire an error assertion. | 3 |
TestBase:: |
public | function | Handle errors during test runs. | |
TestBase:: |
protected | function | Handle exceptions. | |
TestBase:: |
protected | function | Fire an assertion that is always negative. | |
TestBase:: |
public static | function | Ensures test files are deletable within file_unmanaged_delete_recursive(). | |
TestBase:: |
public static | function | Converts a list of possible parameters into a stack of permutations. | |
TestBase:: |
protected | function | Cycles through backtrace until the first non-assertion method is found. | |
TestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
TestBase:: |
public static | function | Returns the database connection to the site running Simpletest. | |
TestBase:: |
public | function | Gets the database prefix. | |
TestBase:: |
public | function | Gets the temporary files directory. | |
TestBase:: |
public static | function | Store an assertion from outside the testing context. | |
TestBase:: |
protected | function | Fire an assertion that is always positive. | |
TestBase:: |
private | function | Generates a database prefix for running tests. | |
TestBase:: |
private | function | Prepares the current environment for running the test. | |
TestBase:: |
private | function | Cleans up the test environment and restores the original environment. | |
TestBase:: |
public | function | Run all tests in this class. | 1 |
TestBase:: |
protected | function | Changes in memory settings. | |
TestBase:: |
protected | function | Helper method to store an assertion record in the configured database. | |
TestBase:: |
protected | function | Logs a verbose message in a text file. | |
TypedDataTest:: |
public static | property |
Modules to enable. Overrides KernelTestBase:: |
|
TypedDataTest:: |
protected | property | The typed data manager to use. | |
TypedDataTest:: |
protected | function | Creates a typed data object and ensures it implements TypedDataInterface. | |
TypedDataTest:: |
protected | function |
Performs setup tasks before each individual test method is run. Overrides KernelTestBase:: |
|
TypedDataTest:: |
public | function | Tests the basics around constructing and working with typed data objects. | |
TypedDataTest:: |
public | function | Tests using typed data lists. | |
TypedDataTest:: |
public | function | Tests the filter() method on typed data lists. | |
TypedDataTest:: |
public | function | Tests using a typed data map. | |
TypedDataTest:: |
public | function | Tests typed data validation. |