namespace Drupal\Tests\datetime\Kernel\Views;
+use Drupal\Component\Datetime\DateTimePlus;
use Drupal\datetime\Plugin\Field\FieldType\DateTimeItem;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\node\Entity\Node;
public static $testViews = ['test_filter_datetime'];
/**
- * For offset tests, set to the current time.
+ * An array of timezone extremes to test.
+ *
+ * @var string[]
*/
- protected static $date;
+ protected static $timezones = [
+ // UTC-12, no DST.
+ 'Pacific/Kwajalein',
+ // UTC-11, no DST.
+ 'Pacific/Midway',
+ // UTC-7, no DST.
+ 'America/Phoenix',
+ // UTC.
+ 'UTC',
+ // UTC+5:30, no DST.
+ 'Asia/Kolkata',
+ // UTC+12, no DST.
+ 'Pacific/Funafuti',
+ // UTC+13, no DST.
+ 'Pacific/Tongatapu',
+ ];
/**
* {@inheritdoc}
protected function setUp($import_test_views = TRUE) {
parent::setUp($import_test_views);
- // Set to 'today'.
- static::$date = REQUEST_TIME;
-
// Change field storage to date-only.
$storage = FieldStorageConfig::load('node.' . static::$field_name);
$storage->setSetting('datetime_type', DateTimeItem::DATETIME_TYPE_DATE);
$storage->save();
- $dates = [
- // Tomorrow.
- \Drupal::service('date.formatter')->format(static::$date + 86400, 'custom', DATETIME_DATE_STORAGE_FORMAT, DATETIME_STORAGE_TIMEZONE),
- // Today.
- \Drupal::service('date.formatter')->format(static::$date, 'custom', DATETIME_DATE_STORAGE_FORMAT, DATETIME_STORAGE_TIMEZONE),
- // Yesterday.
- \Drupal::service('date.formatter')->format(static::$date - 86400, 'custom', DATETIME_DATE_STORAGE_FORMAT, DATETIME_STORAGE_TIMEZONE),
- ];
+ // Retrieve tomorrow, today and yesterday dates just to create the nodes.
+ $timestamp = $this->getUTCEquivalentOfUserNowAsTimestamp();
+ $dates = $this->getRelativeDateValuesFromTimestamp($timestamp);
+ // Clean the nodes on setUp.
+ $this->nodes = [];
foreach ($dates as $date) {
$node = Node::create([
'title' => $this->randomMachineName(8),
'type' => 'page',
'field_date' => [
'value' => $date,
- ]
+ ],
]);
$node->save();
$this->nodes[] = $node;
$view = Views::getView('test_filter_datetime');
$field = static::$field_name . '_value';
- // Test simple operations.
- $view->initHandlers();
-
- // A greater than or equal to 'now', should return the 'today' and
- // the 'tomorrow' node.
- $view->filter[$field]->operator = '>=';
- $view->filter[$field]->value['type'] = 'offset';
- $view->filter[$field]->value['value'] = 'now';
- $view->setDisplay('default');
- $this->executeView($view);
- $expected_result = [
- ['nid' => $this->nodes[0]->id()],
- ['nid' => $this->nodes[1]->id()],
- ];
- $this->assertIdenticalResultset($view, $expected_result, $this->map);
- $view->destroy();
-
- // Only dates in the past.
- $view->initHandlers();
- $view->filter[$field]->operator = '<';
- $view->filter[$field]->value['type'] = 'offset';
- $view->filter[$field]->value['value'] = 'now';
- $view->setDisplay('default');
- $this->executeView($view);
- $expected_result = [
- ['nid' => $this->nodes[2]->id()],
- ];
- $this->assertIdenticalResultset($view, $expected_result, $this->map);
- $view->destroy();
-
- // Test offset for between operator. Only the 'tomorrow' node should appear.
- $view->initHandlers();
- $view->filter[$field]->operator = 'between';
- $view->filter[$field]->value['type'] = 'offset';
- $view->filter[$field]->value['max'] = '+2 days';
- $view->filter[$field]->value['min'] = '+1 day';
- $view->setDisplay('default');
- $this->executeView($view);
- $expected_result = [
- ['nid' => $this->nodes[0]->id()],
+ foreach (static::$timezones as $timezone) {
+
+ $this->setSiteTimezone($timezone);
+ $timestamp = $this->getUTCEquivalentOfUserNowAsTimestamp();
+ $dates = $this->getRelativeDateValuesFromTimestamp($timestamp);
+ $this->updateNodesDateFieldsValues($dates);
+
+ // Test simple operations.
+ $view->initHandlers();
+
+ // A greater than or equal to 'now', should return the 'today' and the
+ // 'tomorrow' node.
+ $view->filter[$field]->operator = '>=';
+ $view->filter[$field]->value['type'] = 'offset';
+ $view->filter[$field]->value['value'] = 'now';
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[0]->id()],
+ ['nid' => $this->nodes[1]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ $view->destroy();
+
+ // Only dates in the past.
+ $view->initHandlers();
+ $view->filter[$field]->operator = '<';
+ $view->filter[$field]->value['type'] = 'offset';
+ $view->filter[$field]->value['value'] = 'now';
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[2]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ $view->destroy();
+
+ // Test offset for between operator. Only 'tomorrow' node should appear.
+ $view->initHandlers();
+ $view->filter[$field]->operator = 'between';
+ $view->filter[$field]->value['type'] = 'offset';
+ $view->filter[$field]->value['max'] = '+2 days';
+ $view->filter[$field]->value['min'] = '+1 day';
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[0]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ $view->destroy();
+ }
+ }
+
+ /**
+ * Test date filter with date-only fields.
+ */
+ public function testDateIs() {
+ $view = Views::getView('test_filter_datetime');
+ $field = static::$field_name . '_value';
+
+ foreach (static::$timezones as $timezone) {
+
+ $this->setSiteTimezone($timezone);
+ $timestamp = $this->getUTCEquivalentOfUserNowAsTimestamp();
+ $dates = $this->getRelativeDateValuesFromTimestamp($timestamp);
+ $this->updateNodesDateFieldsValues($dates);
+
+ // Test simple operations.
+ $view->initHandlers();
+
+ // Filtering with nodes date-only values (format: Y-m-d) to test UTC
+ // conversion does NOT change the day.
+ $view->filter[$field]->operator = '=';
+ $view->filter[$field]->value['type'] = 'date';
+ $view->filter[$field]->value['value'] = $this->nodes[2]->field_date->first()->getValue()['value'];
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[2]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ $view->destroy();
+
+ // Test offset for between operator. Only 'today' and 'tomorrow' nodes
+ // should appear.
+ $view->initHandlers();
+ $view->filter[$field]->operator = 'between';
+ $view->filter[$field]->value['type'] = 'date';
+ $view->filter[$field]->value['max'] = $this->nodes[0]->field_date->first()->getValue()['value'];
+ $view->filter[$field]->value['min'] = $this->nodes[1]->field_date->first()->getValue()['value'];
+ $view->setDisplay('default');
+ $this->executeView($view);
+ $expected_result = [
+ ['nid' => $this->nodes[0]->id()],
+ ['nid' => $this->nodes[1]->id()],
+ ];
+ $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ $view->destroy();
+ }
+ }
+
+ /**
+ * Returns UTC timestamp of user's TZ 'now'.
+ *
+ * The date field stores date_only values without conversion, considering them
+ * already as UTC. This method returns the UTC equivalent of user's 'now' as a
+ * unix timestamp, so they match using Y-m-d format.
+ *
+ * @return int
+ * Unix timestamp.
+ */
+ protected function getUTCEquivalentOfUserNowAsTimestamp() {
+ $user_now = new DateTimePlus('now', new \DateTimeZone(drupal_get_user_timezone()));
+ $utc_equivalent = new DateTimePlus($user_now->format('Y-m-d H:i:s'), new \DateTimeZone(DATETIME_STORAGE_TIMEZONE));
+
+ return $utc_equivalent->getTimestamp();
+ }
+
+ /**
+ * Returns an array formatted date_only values.
+ *
+ * @param int $timestamp
+ * Unix Timestamp equivalent to user's "now".
+ *
+ * @return array
+ * An array of DATETIME_DATE_STORAGE_FORMAT date values. In order tomorrow,
+ * today and yesterday.
+ */
+ protected function getRelativeDateValuesFromTimestamp($timestamp) {
+ return [
+ // Tomorrow.
+ \Drupal::service('date.formatter')->format($timestamp + 86400, 'custom', DATETIME_DATE_STORAGE_FORMAT, DATETIME_STORAGE_TIMEZONE),
+ // Today.
+ \Drupal::service('date.formatter')->format($timestamp, 'custom', DATETIME_DATE_STORAGE_FORMAT, DATETIME_STORAGE_TIMEZONE),
+ // Yesterday.
+ \Drupal::service('date.formatter')->format($timestamp - 86400, 'custom', DATETIME_DATE_STORAGE_FORMAT, DATETIME_STORAGE_TIMEZONE),
];
- $this->assertIdenticalResultset($view, $expected_result, $this->map);
+ }
+
+ /**
+ * Updates tests nodes date fields values.
+ *
+ * @param array $dates
+ * An array of DATETIME_DATE_STORAGE_FORMAT date values.
+ */
+ protected function updateNodesDateFieldsValues(array $dates) {
+ foreach ($dates as $index => $date) {
+ $this->nodes[$index]->{static::$field_name}->value = $date;
+ $this->nodes[$index]->save();
+ }
}
}
projects / yaffs-website / blobdiff