Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests\datetime\Kernel;
Chris@0: 
Chris@0: use Drupal\Core\Field\FieldItemListInterface;
Chris@0: use Drupal\Core\Field\FieldItemInterface;
Chris@0: use Drupal\datetime\Plugin\Field\FieldType\DateTimeItem;
Chris@14: use Drupal\datetime\Plugin\Field\FieldType\DateTimeItemInterface;
Chris@0: use Drupal\entity_test\Entity\EntityTest;
Chris@0: use Drupal\field\Entity\FieldConfig;
Chris@0: use Drupal\Tests\field\Kernel\FieldKernelTestBase;
Chris@0: use Drupal\field\Entity\FieldStorageConfig;
Chris@0: 
Chris@0: /**
Chris@0:  * Tests the new entity API for the date field type.
Chris@0:  *
Chris@0:  * @group datetime
Chris@0:  */
Chris@0: class DateTimeItemTest extends FieldKernelTestBase {
Chris@0: 
Chris@0:   /**
Chris@0:    * A field storage to use in this test class.
Chris@0:    *
Chris@0:    * @var \Drupal\field\Entity\FieldStorageConfig
Chris@0:    */
Chris@0:   protected $fieldStorage;
Chris@0: 
Chris@0:   /**
Chris@0:    * The field used in this test class.
Chris@0:    *
Chris@0:    * @var \Drupal\field\Entity\FieldConfig
Chris@0:    */
Chris@0:   protected $field;
Chris@0: 
Chris@0:   /**
Chris@0:    * Modules to enable.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   public static $modules = ['datetime'];
Chris@0: 
Chris@0:   protected function setUp() {
Chris@0:     parent::setUp();
Chris@0: 
Chris@0:     // Create a field with settings to validate.
Chris@0:     $this->fieldStorage = FieldStorageConfig::create([
Chris@0:       'field_name' => 'field_datetime',
Chris@0:       'type' => 'datetime',
Chris@0:       'entity_type' => 'entity_test',
Chris@0:       'settings' => ['datetime_type' => DateTimeItem::DATETIME_TYPE_DATETIME],
Chris@0:     ]);
Chris@0:     $this->fieldStorage->save();
Chris@0:     $this->field = FieldConfig::create([
Chris@0:       'field_storage' => $this->fieldStorage,
Chris@0:       'bundle' => 'entity_test',
Chris@0:       'settings' => [
Chris@0:         'default_value' => 'blank',
Chris@0:       ],
Chris@0:     ]);
Chris@0:     $this->field->save();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests using entity fields of the datetime field type.
Chris@0:    */
Chris@0:   public function testDateTime() {
Chris@0:     $this->fieldStorage->setSetting('datetime_type', DateTimeItem::DATETIME_TYPE_DATETIME);
Chris@0:     $this->fieldStorage->save();
Chris@0: 
Chris@0:     // Verify entity creation.
Chris@0:     $entity = EntityTest::create();
Chris@0:     $value = '2014-01-01T20:00:00';
Chris@0:     $entity->field_datetime = $value;
Chris@0:     $entity->name->value = $this->randomMachineName();
Chris@0:     $this->entityValidateAndSave($entity);
Chris@0: 
Chris@0:     // Verify entity has been created properly.
Chris@0:     $id = $entity->id();
Chris@0:     $entity = EntityTest::load($id);
Chris@0:     $this->assertTrue($entity->field_datetime instanceof FieldItemListInterface, 'Field implements interface.');
Chris@0:     $this->assertTrue($entity->field_datetime[0] instanceof FieldItemInterface, 'Field item implements interface.');
Chris@0:     $this->assertEqual($entity->field_datetime->value, $value);
Chris@0:     $this->assertEqual($entity->field_datetime[0]->value, $value);
Chris@18:     $this->assertEqual(DateTimeItemInterface::STORAGE_TIMEZONE, $entity->field_datetime[0]->getProperties()['value']->getDateTime()->getTimeZone()->getName());
Chris@14:     $this->assertEquals(DateTimeItemInterface::STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName());
Chris@0: 
Chris@0:     // Verify changing the date value.
Chris@0:     $new_value = '2016-11-04T00:21:00';
Chris@0:     $entity->field_datetime->value = $new_value;
Chris@0:     $this->assertEqual($entity->field_datetime->value, $new_value);
Chris@18:     $this->assertEqual(DateTimeItemInterface::STORAGE_TIMEZONE, $entity->field_datetime[0]->getProperties()['value']->getDateTime()->getTimeZone()->getName());
Chris@14:     $this->assertEquals(DateTimeItemInterface::STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName());
Chris@0: 
Chris@0:     // Read changed entity and assert changed values.
Chris@0:     $this->entityValidateAndSave($entity);
Chris@0:     $entity = EntityTest::load($id);
Chris@0:     $this->assertEqual($entity->field_datetime->value, $new_value);
Chris@18:     $this->assertEqual(DateTimeItemInterface::STORAGE_TIMEZONE, $entity->field_datetime[0]->getProperties()['value']->getDateTime()->getTimeZone()->getName());
Chris@14:     $this->assertEquals(DateTimeItemInterface::STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName());
Chris@0: 
Chris@0:     // Test the generateSampleValue() method.
Chris@0:     $entity = EntityTest::create();
Chris@0:     $entity->field_datetime->generateSampleItems();
Chris@0:     $this->entityValidateAndSave($entity);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests using entity fields of the date field type.
Chris@0:    */
Chris@0:   public function testDateOnly() {
Chris@0:     $this->fieldStorage->setSetting('datetime_type', DateTimeItem::DATETIME_TYPE_DATE);
Chris@0:     $this->fieldStorage->save();
Chris@0: 
Chris@0:     // Verify entity creation.
Chris@0:     $entity = EntityTest::create();
Chris@0:     $value = '2014-01-01';
Chris@0:     $entity->field_datetime = $value;
Chris@0:     $entity->name->value = $this->randomMachineName();
Chris@0:     $this->entityValidateAndSave($entity);
Chris@0: 
Chris@0:     // Verify entity has been created properly.
Chris@0:     $id = $entity->id();
Chris@0:     $entity = EntityTest::load($id);
Chris@0:     $this->assertTrue($entity->field_datetime instanceof FieldItemListInterface, 'Field implements interface.');
Chris@0:     $this->assertTrue($entity->field_datetime[0] instanceof FieldItemInterface, 'Field item implements interface.');
Chris@0:     $this->assertEqual($entity->field_datetime->value, $value);
Chris@0:     $this->assertEqual($entity->field_datetime[0]->value, $value);
Chris@14:     $this->assertEquals(DateTimeItemInterface::STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName());
Chris@14:     $this->assertEquals('12:00:00', $entity->field_datetime->date->format('H:i:s'));
Chris@14:     $entity->field_datetime->date->setDefaultDateTime();
Chris@14:     $this->assertEquals('12:00:00', $entity->field_datetime->date->format('H:i:s'));
Chris@0: 
Chris@0:     // Verify changing the date value.
Chris@0:     $new_value = '2016-11-04';
Chris@0:     $entity->field_datetime->value = $new_value;
Chris@0:     $this->assertEqual($entity->field_datetime->value, $new_value);
Chris@14:     $this->assertEquals(DateTimeItemInterface::STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName());
Chris@14:     $this->assertEquals('12:00:00', $entity->field_datetime->date->format('H:i:s'));
Chris@14:     $entity->field_datetime->date->setDefaultDateTime();
Chris@14:     $this->assertEquals('12:00:00', $entity->field_datetime->date->format('H:i:s'));
Chris@0: 
Chris@0:     // Read changed entity and assert changed values.
Chris@0:     $this->entityValidateAndSave($entity);
Chris@0:     $entity = EntityTest::load($id);
Chris@0:     $this->assertEqual($entity->field_datetime->value, $new_value);
Chris@14:     $this->assertEquals(DateTimeItemInterface::STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName());
Chris@14:     $this->assertEquals('12:00:00', $entity->field_datetime->date->format('H:i:s'));
Chris@14:     $entity->field_datetime->date->setDefaultDateTime();
Chris@14:     $this->assertEquals('12:00:00', $entity->field_datetime->date->format('H:i:s'));
Chris@0: 
Chris@0:     // Test the generateSampleValue() method.
Chris@0:     $entity = EntityTest::create();
Chris@0:     $entity->field_datetime->generateSampleItems();
Chris@14:     $this->assertEquals('12:00:00', $entity->field_datetime->date->format('H:i:s'));
Chris@14:     $entity->field_datetime->date->setDefaultDateTime();
Chris@14:     $this->assertEquals('12:00:00', $entity->field_datetime->date->format('H:i:s'));
Chris@0:     $this->entityValidateAndSave($entity);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests DateTimeItem::setValue().
Chris@0:    */
Chris@0:   public function testSetValue() {
Chris@0:     // Test a date+time field.
Chris@0:     $this->fieldStorage->setSetting('datetime_type', DateTimeItem::DATETIME_TYPE_DATETIME);
Chris@0:     $this->fieldStorage->save();
Chris@0: 
Chris@0:     // Test DateTimeItem::setValue() using string.
Chris@0:     $entity = EntityTest::create();
Chris@0:     $value = '2014-01-01T20:00:00';
Chris@0:     $entity->get('field_datetime')->set(0, $value);
Chris@0:     $this->entityValidateAndSave($entity);
Chris@0:     // Load the entity and ensure the field was saved correctly.
Chris@0:     $id = $entity->id();
Chris@0:     $entity = EntityTest::load($id);
Chris@0:     $this->assertEqual($entity->field_datetime[0]->value, $value, 'DateTimeItem::setValue() works with string value.');
Chris@14:     $this->assertEquals(DateTimeItemInterface::STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName());
Chris@0: 
Chris@0:     // Test DateTimeItem::setValue() using property array.
Chris@0:     $entity = EntityTest::create();
Chris@0:     $value = '2014-01-01T20:00:00';
Chris@0:     $entity->set('field_datetime', $value);
Chris@0:     $this->entityValidateAndSave($entity);
Chris@0:     // Load the entity and ensure the field was saved correctly.
Chris@0:     $id = $entity->id();
Chris@0:     $entity = EntityTest::load($id);
Chris@0:     $this->assertEqual($entity->field_datetime[0]->value, $value, 'DateTimeItem::setValue() works with array value.');
Chris@14:     $this->assertEquals(DateTimeItemInterface::STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName());
Chris@0: 
Chris@0:     // Test a date-only field.
Chris@0:     $this->fieldStorage->setSetting('datetime_type', DateTimeItem::DATETIME_TYPE_DATE);
Chris@0:     $this->fieldStorage->save();
Chris@0: 
Chris@0:     // Test DateTimeItem::setValue() using string.
Chris@0:     $entity = EntityTest::create();
Chris@0:     $value = '2014-01-01';
Chris@0:     $entity->get('field_datetime')->set(0, $value);
Chris@0:     $this->entityValidateAndSave($entity);
Chris@0:     // Load the entity and ensure the field was saved correctly.
Chris@0:     $id = $entity->id();
Chris@0:     $entity = EntityTest::load($id);
Chris@0:     $this->assertEqual($entity->field_datetime[0]->value, $value, 'DateTimeItem::setValue() works with string value.');
Chris@14:     $this->assertEquals(DateTimeItemInterface::STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName());
Chris@0: 
Chris@0:     // Test DateTimeItem::setValue() using property array.
Chris@0:     $entity = EntityTest::create();
Chris@0:     $value = '2014-01-01';
Chris@0:     $entity->set('field_datetime', $value);
Chris@0:     $this->entityValidateAndSave($entity);
Chris@0:     // Load the entity and ensure the field was saved correctly.
Chris@0:     $id = $entity->id();
Chris@0:     $entity = EntityTest::load($id);
Chris@0:     $this->assertEqual($entity->field_datetime[0]->value, $value, 'DateTimeItem::setValue() works with array value.');
Chris@14:     $this->assertEquals(DateTimeItemInterface::STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName());
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests setting the value of the DateTimeItem directly.
Chris@0:    */
Chris@0:   public function testSetValueProperty() {
Chris@0:     // Test Date::setValue() with a date+time field.
Chris@0:     // Test a date+time field.
Chris@0:     $this->fieldStorage->setSetting('datetime_type', DateTimeItem::DATETIME_TYPE_DATETIME);
Chris@0:     $this->fieldStorage->save();
Chris@0:     $entity = EntityTest::create();
Chris@0:     $value = '2014-01-01T20:00:00';
Chris@0: 
Chris@0:     $entity->set('field_datetime', $value);
Chris@0:     $this->entityValidateAndSave($entity);
Chris@0:     // Load the entity and ensure the field was saved correctly.
Chris@0:     $id = $entity->id();
Chris@0:     $entity = EntityTest::load($id);
Chris@0:     $this->assertEqual($entity->field_datetime[0]->value, $value, '"Value" property can be set directly.');
Chris@14:     $this->assertEquals(DateTimeItemInterface::STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName());
Chris@0: 
Chris@0:     // Test Date::setValue() with a date-only field.
Chris@0:     // Test a date+time field.
Chris@0:     $this->fieldStorage->setSetting('datetime_type', DateTimeItem::DATETIME_TYPE_DATE);
Chris@0:     $this->fieldStorage->save();
Chris@0:     $entity = EntityTest::create();
Chris@0:     $value = '2014-01-01';
Chris@0: 
Chris@0:     $entity->set('field_datetime', $value);
Chris@0:     $this->entityValidateAndSave($entity);
Chris@0:     // Load the entity and ensure the field was saved correctly.
Chris@0:     $id = $entity->id();
Chris@0:     $entity = EntityTest::load($id);
Chris@0:     $this->assertEqual($entity->field_datetime[0]->value, $value, '"Value" property can be set directly.');
Chris@14:     $this->assertEquals(DateTimeItemInterface::STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName());
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests the constraint validations for fields with date and time.
Chris@0:    *
Chris@0:    * @dataProvider datetimeValidationProvider
Chris@0:    */
Chris@0:   public function testDatetimeValidation($value) {
Chris@0:     $this->setExpectedException(\PHPUnit_Framework_AssertionFailedError::class);
Chris@0: 
Chris@0:     $this->fieldStorage->setSetting('datetime_type', DateTimeItem::DATETIME_TYPE_DATETIME);
Chris@0:     $this->fieldStorage->save();
Chris@0:     $entity = EntityTest::create();
Chris@0: 
Chris@0:     $entity->set('field_datetime', $value);
Chris@0:     $this->entityValidateAndSave($entity);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Provider for testDatetimeValidation().
Chris@0:    */
Chris@0:   public function datetimeValidationProvider() {
Chris@0:     return [
Chris@0:       // Valid ISO 8601 dates, but unsupported by DateTimeItem.
Chris@0:       ['2014-01-01T20:00:00Z'],
Chris@0:       ['2014-01-01T20:00:00+04:00'],
Chris@0:       ['2014-01-01T20:00:00+0400'],
Chris@0:       ['2014-01-01T20:00:00+04'],
Chris@0:       ['2014-01-01T20:00:00.123'],
Chris@0:       ['2014-01-01T200000'],
Chris@0:       ['2014-01-01T2000'],
Chris@0:       ['2014-01-01T20'],
Chris@0:       ['20140101T20:00:00'],
Chris@0:       ['2014-01T20:00:00'],
Chris@0:       ['2014-001T20:00:00'],
Chris@0:       ['2014001T20:00:00'],
Chris@0:       // Valid date strings, but unsupported by DateTimeItem.
Chris@0:       ['2016-11-03 20:52:00'],
Chris@0:       ['Thu, 03 Nov 2014 20:52:00 -0400'],
Chris@0:       ['Thursday, November 3, 2016 - 20:52'],
Chris@0:       ['Thu, 11/03/2016 - 20:52'],
Chris@0:       ['11/03/2016 - 20:52'],
Chris@0:       // Invalid date strings.
Chris@0:       ['YYYY-01-01T20:00:00'],
Chris@0:       ['2014-MM-01T20:00:00'],
Chris@0:       ['2014-01-DDT20:00:00'],
Chris@0:       ['2014-01-01Thh:00:00'],
Chris@0:       ['2014-01-01T20:mm:00'],
Chris@0:       ['2014-01-01T20:00:ss'],
Chris@0:       // Invalid dates.
Chris@0:       ['2014-13-13T20:00:00'],
Chris@0:       ['2014-01-55T20:00:00'],
Chris@0:       ['2014-01-01T25:00:00'],
Chris@0:       ['2014-01-01T00:70:00'],
Chris@0:       ['2014-01-01T00:00:70'],
Chris@0:       // Proper format for different field setting.
Chris@0:       ['2014-01-01'],
Chris@0:       // Wrong input type.
Chris@0:       [['2014', '01', '01', '00', '00', '00']],
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests the constraint validations for fields with date only.
Chris@0:    *
Chris@0:    * @dataProvider dateonlyValidationProvider
Chris@0:    */
Chris@0:   public function testDateonlyValidation($value) {
Chris@0:     $this->setExpectedException(\PHPUnit_Framework_AssertionFailedError::class);
Chris@0: 
Chris@0:     $this->fieldStorage->setSetting('datetime_type', DateTimeItem::DATETIME_TYPE_DATE);
Chris@0:     $this->fieldStorage->save();
Chris@0:     $entity = EntityTest::create();
Chris@0: 
Chris@0:     $entity->set('field_datetime', $value);
Chris@0:     $this->entityValidateAndSave($entity);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Provider for testDatetimeValidation().
Chris@0:    */
Chris@0:   public function dateonlyValidationProvider() {
Chris@0:     return [
Chris@0:       // Valid date strings, but unsupported by DateTimeItem.
Chris@0:       ['Thu, 03 Nov 2014'],
Chris@0:       ['Thursday, November 3, 2016'],
Chris@0:       ['Thu, 11/03/2016'],
Chris@0:       ['11/03/2016'],
Chris@0:       // Invalid date strings.
Chris@0:       ['YYYY-01-01'],
Chris@0:       ['2014-MM-01'],
Chris@0:       ['2014-01-DD'],
Chris@0:       // Invalid dates.
Chris@0:       ['2014-13-01'],
Chris@0:       ['2014-01-55'],
Chris@0:       // Proper format for different field setting.
Chris@0:       ['2014-01-01T20:00:00'],
Chris@0:       // Wrong input type.
Chris@0:       [['2014', '01', '01']],
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0: }