Commit 1607956d authored by Damien McKenna's avatar Damien McKenna Committed by Damien McKenna
Browse files

Issue #2898235 by DamienMcKenna, veugenio, photuris5, drumm: Improved test...

Issue #2898235 by DamienMcKenna, veugenio, photuris5, drumm: Improved test coverage for timezone handling.
parent e3303d3d
Loading
Loading
Loading
Loading
+2 −0
Original line number Diff line number Diff line
Date 7.x-2.x-dev, 2022-xx-xx
----------------------------
#2898235 by DamienMcKenna, veugenio, photuris5, drumm: Improved test coverage
  for timezone handling.


Date 7.x-2.13, 2022-08-04
+6 −2
Original line number Diff line number Diff line
@@ -190,8 +190,12 @@ abstract class DateFieldTestBase extends DrupalWebTestCase {
    $widget_type = !empty($widget_type) ? $widget_type : 'date_select';
    $this->verbose(!empty($tz_handling));
    $tz_handling = !empty($tz_handling) ? $tz_handling : 'site';
    $granularity = !empty($granularity) ? $granularity : array('year', 'month',
      'day', 'hour', 'minute',
    $granularity = !empty($granularity) ? $granularity : array(
      'year',
      'month',
      'day',
      'hour',
      'minute',
    );
    $year_range = !empty($year_range) ? $year_range : '2010:+1';
    $input_format = !empty($input_format) ? $input_format : date_default_format($widget_type);
+140 −34
Original line number Diff line number Diff line
@@ -84,7 +84,7 @@ class DateTimezoneTestCase extends DateFieldTestBase {
    $edit = array(
      'field[settings][granularity][hour]' => FALSE,
    );
    $this->drupalPost('admin/structure/types/manage/story/fields/field_' . strtolower($label), $edit, t('Save settings'));
    $this->drupalPost('admin/structure/types/manage/story/fields/field_' . strtolower($label), $edit, 'Save settings');
    $this->assertText("Dates without hours granularity must not use any timezone handling.", "Dates without hours granularity required to use timezone handling of 'none.'");
    $this->deleteDateField($label);
  }
@@ -270,6 +270,11 @@ class DateTimezoneTestCase extends DateFieldTestBase {

  /**
   * Verify field timezones work properly when date-conversion is enabled.
   *
   * The time values used in this test are based upon example data from an issue
   * listed on d.o.
   *
   * @see https://www.drupal.org/project/drupalorg/issues/3164818
   */
  public function testFieldConversionDate() {
    // @todo Create a date format "l, jS F, Y, g:i:s a, e I" that would look
@@ -297,7 +302,7 @@ class DateTimezoneTestCase extends DateFieldTestBase {
    $this->drupalGet('user/' . $this->loggedInUser->uid . '/edit');
    $this->assertResponse(200);
    $edit = array(
      'timezone' => 'America/New_York',
      'timezone' => 'America/Chicago',
    );
    $this->drupalPost(NULL, $edit, 'Save');
    $this->assertResponse(200);
@@ -308,7 +313,7 @@ class DateTimezoneTestCase extends DateFieldTestBase {
    $this->assertResponse(200);
    $edit = array(
      'title' => 'Testing how dates work with timezone conversion enabled',
      'field_test[und][0][value][date]' => '12/31/2021 - 10:00',
      'field_test[und][0][value][date]' => '07/21/2021 - 18:30',
    );
    $this->drupalPost(NULL, $edit, 'Save');

@@ -322,8 +327,9 @@ class DateTimezoneTestCase extends DateFieldTestBase {
    $this->verbose($node);

    // Confirm the data is stored correctly.
    $this->assertEqual($node->field_test[LANGUAGE_NONE][0]['value'], '2021-12-31 10:00:00');
    $this->assertEqual($node->field_test[LANGUAGE_NONE][0]['timezone_db'], 'America/New_York');
    $this->assertEqual($node->field_test[LANGUAGE_NONE][0]['value'], '2021-07-21 18:30:00');
    $this->assertEqual($node->field_test[LANGUAGE_NONE][0]['timezone'], 'America/Chicago');
    $this->assertEqual($node->field_test[LANGUAGE_NONE][0]['timezone_db'], 'America/Chicago');

    // Load the node page.
    $this->drupalGet('node/1');
@@ -331,13 +337,13 @@ class DateTimezoneTestCase extends DateFieldTestBase {
    $this->assertText('Testing how dates work with timezone conversion enabled');

    // Confirm the date value displays correctly.
    $this->assertText('Friday, December 31, 2021 - 10:00');
    $this->assertText('Wednesday, July 21, 2021 - 18:30');

    // Change the user's timezone to something else.
    $this->drupalGet('user/' . $this->loggedInUser->uid . '/edit');
    $this->assertResponse(200);
    $edit = array(
      'timezone' => 'Europe/Berlin',
      'timezone' => 'America/New_York',
    );
    $this->drupalPost(NULL, $edit, 'Save');
    $this->assertResponse(200);
@@ -349,9 +355,17 @@ class DateTimezoneTestCase extends DateFieldTestBase {
    $this->assertText('Testing how dates work with timezone conversion enabled');

    // @todo This takes daylights savings time into account so it might stop
    // working when DST is no longer active.
    // working when DST is no longer active. Maybe. I'm not currently sure.
    // @todo Is this correct?
    $this->assertText('Friday, December 31, 2021 - 04:00');
    // The "date" conversion logic does not change the time display based upon
    // the viewer's configured timezone, therefore the item should have the same
    // 6:30pm display as it did previously.
    // @code
    // $this->assertText('Wednesday, July 21, 2021 - 18:30');
    // @endcode
    // @todo This is incorrect, it should actually show 18:30.
    // @see https://www.drupal.org/project/date/issues/998076
    $this->assertText('Wednesday, July 21, 2021 - 17:30');
  }

  /**
@@ -546,14 +560,51 @@ class DateTimezoneTestCase extends DateFieldTestBase {
  }

  /**
   * Validates timezone handling with a multi-value date field.
   * Validates timezone handling with a multi-value field w hour granularity.
   */
  public function testMultiValueTimezoneHour() {
    // Create date fields with combinations of various types and granularity
    // using the "Date's Timezone" strategy.
    $field_type = 'datetime';
    $tz_handling = 'date';
    $granularity = 'hour';

    // Create date field.
    $field_name = "field_test";
    $label = 'Test';
    $options = array(
      'label' => $label,
      'widget_type' => 'date_text',
      'field_name' => $field_name,
      'field_type' => $field_type,
      'input_format' => 'custom',
      'input_format_custom' => 'm/d/Y - H:i:s T',
      'cardinality' => 3,
      'tz_handling' => $tz_handling,
      'granularity' => array(
        'year',
        'month',
        'day',
        'hour',
      ),
    );
    $this->createMultiDateField($options);

    // Submit a date field form with multiple values.
    $this->dateMultiValueForm($field_name, $field_type, $granularity, $tz_handling);

    $this->deleteDateField($label);
  }

  /**
   * Validates timezone handling with a multi-value field w minute granularity.
   */
  public function testMultiUserTimezone() {
  public function testMultiValueTimezoneMinute() {
    // Create date fields with combinations of various types and granularity
    // using the "Date's Timezone" strategy.
    $field_type = 'datetime';
    $tz_handling = 'date';
    $max_granularity = 'minute';
    $granularity = 'minute';

    // Create date field.
    $field_name = "field_test";
@@ -567,11 +618,57 @@ class DateTimezoneTestCase extends DateFieldTestBase {
      'input_format_custom' => 'm/d/Y - H:i:s T',
      'cardinality' => 3,
      'tz_handling' => $tz_handling,
      'granularity' => array(
        'year',
        'month',
        'day',
        'hour',
        'minute',
      ),
    );
    $this->createMultiDateField($options);

    // Submit a date field form with multiple values.
    $this->dateMultiValueForm($field_name, $field_type, $max_granularity, $tz_handling);
    $this->dateMultiValueForm($field_name, $field_type, $granularity, $tz_handling);

    $this->deleteDateField($label);
  }

  /**
   * Validates timezone handling with a multi-value field w second granularity.
   */
  public function testMultiValueTimezoneSecond() {
    // Create date fields with combinations of various types and granularity
    // using the "Date's Timezone" strategy.
    $field_type = 'datetime';
    $tz_handling = 'date';
    $granularity = 'second';

    // Create date field.
    $field_name = "field_test";
    $label = 'Test';
    $options = array(
      'label' => $label,
      'widget_type' => 'date_text',
      'field_name' => $field_name,
      'field_type' => $field_type,
      'input_format' => 'custom',
      'input_format_custom' => 'm/d/Y - H:i:s T',
      'cardinality' => 3,
      'tz_handling' => $tz_handling,
      'granularity' => array(
        'year',
        'month',
        'day',
        'hour',
        'minute',
        'second',
      ),
    );
    $this->createMultiDateField($options);

    // Submit a date field form with multiple values.
    $this->dateMultiValueForm($field_name, $field_type, $granularity, $tz_handling);

    $this->deleteDateField($label);
  }
@@ -579,7 +676,7 @@ class DateTimezoneTestCase extends DateFieldTestBase {
  /**
   * Tests the submission of a date field's widget with unlimited cardinality.
   */
  public function dateMultiValueForm($field_name, $field_type, $max_granularity, $tz_handling) {
  protected function dateMultiValueForm($field_name, $field_type, $granularity, $tz_handling) {
    variable_set('date_format_long', 'D, m/d/Y - H:i:s T');

    $edit = array();
@@ -589,20 +686,19 @@ class DateTimezoneTestCase extends DateFieldTestBase {
      'America/Chicago', 'America/Los_Angeles', 'America/New_York',
    );

    switch ($max_granularity) {
    switch ($granularity) {
      case 'hour':
        $edit[$field_name . '[und][0][value][date]'] = '10/07/2010 - 10:30';
        $edit[$field_name . '[und][0][value][date]'] = '10/07/2010 - 10';
        $edit[$field_name . '[und][0][timezone][timezone]'] = 'America/Chicago';
        $should_be[0] = 'Thu, 10/07/2010 - 10 CDT';

        $edit[$field_name . '[und][1][value][date]'] = '10/07/2010 - 10:30';
        $edit[$field_name . '[und][1][value][date]'] = '10/07/2010 - 10';
        $edit[$field_name . '[und][1][timezone][timezone]'] = 'America/Los_Angeles';
        $should_be[1] = 'Thu, 10/07/2010 - 10 PDT';

        $edit[$field_name . '[und][2][value][date]'] = '10/07/2010 - 10:30';
        $edit[$field_name . '[und][2][value][date]'] = '10/07/2010 - 10';
        $edit[$field_name . '[und][2][timezone][timezone]'] = 'America/New_York';
        $should_be[2] = 'Thu, 10/07/2010 - 10 EDT';

        break;

      case 'minute':
@@ -617,50 +713,57 @@ class DateTimezoneTestCase extends DateFieldTestBase {
        $edit[$field_name . '[und][2][value][date]'] = '10/07/2010 - 10:30';
        $edit[$field_name . '[und][2][timezone][timezone]'] = 'America/New_York';
        $should_be[2] = 'Thu, 10/07/2010 - 10:30 EDT';

        break;

      case 'second':
        $edit[$field_name . '[und][0][value][date]'] = '10/07/2010 - 10:30';
        $edit[$field_name . '[und][0][value][date]'] = '10/07/2010 - 10:30:30';
        $edit[$field_name . '[und][0][timezone][timezone]'] = 'America/Chicago';
        $should_be[0] = 'Thu, 10/07/2010 - 10:30:30 CDT';

        $edit[$field_name . '[und][1][value][date]'] = '10/07/2010 - 10:30';
        $edit[$field_name . '[und][1][value][date]'] = '10/07/2010 - 10:30:30';
        $edit[$field_name . '[und][1][timezone][timezone]'] = 'America/Los_Angeles';
        $should_be[1] = 'Thu, 10/07/2010 - 10:30:30 PDT';

        $edit[$field_name . '[und][2][value][date]'] = '10/07/2010 - 10:30';
        $edit[$field_name . '[und][2][value][date]'] = '10/07/2010 - 10:30:30';
        $edit[$field_name . '[und][2][timezone][timezone]'] = 'America/New_York';
        $should_be[2] = 'Thu, 10/07/2010 - 10:30:30 EDT';
        break;

      default:
        throw new \Exception("Oh dear! Unknown granularity '$granularity'.");
    }

    $this->drupalPost('node/add/story', $edit, t('Save'));
    $this->drupalPost('node/add/story', $edit, 'Save');
    $this->assertText($edit['title'], "Node has been created");
    $this->assertNoText('does not match the expected format.');

    foreach ($should_be as $assertion) {
      $this->assertText($assertion, "Found the correct date for a $field_type field using $max_granularity granularity with $tz_handling timezone handling.");
      $this->assertText($assertion, "Found the correct date for a $field_type field using $granularity granularity with $tz_handling timezone handling.");
    }

    // Goto the edit page and save the node again.
    $node = $this->drupalGetNodeByTitle($edit['title']);
    $this->assertNotNull($node);
    if (!empty($node)) {
      $this->verbose($node);
      $this->drupalGet('node/' . $node->nid . '/edit');

      // Re-assert the proper date timezones.
      foreach ($timezones as $key => $timezone) {
      $this->assertOptionSelected('edit-field-test-und-' . $key . '-timezone-timezone', $timezone, "Found the correct timezone $timezone for a $field_type field using $max_granularity granularity with $tz_handling timezone handling.");
        $this->assertOptionSelected('edit-field-test-und-' . $key . '-timezone-timezone', $timezone, "Found the correct timezone $timezone for a $field_type field using $granularity granularity with $tz_handling timezone handling.");
      }
    }
  }

  /**
   * Replacement for dateForm().
   */
  public function buildDateForm($field_name, $field_type, $max_granularity, $tz_handling) {
  protected function buildDateForm($field_name, $field_type, $granularity, $tz_handling) {
    variable_set('date_format_long', 'D, m/d/Y - H:i:s');
    $edit = array();
    $edit['title'] = self::randomName(8);
    $edit[$field_name . '[und][0][show_todate]'] = '1';
    switch ($max_granularity) {
    switch ($granularity) {
      case 'year':
        $edit[$field_name . '[und][0][value][date]'] = '2010';
        $edit[$field_name . '[und][0][value2][date]'] = '2011';
@@ -711,10 +814,13 @@ class DateTimezoneTestCase extends DateFieldTestBase {
          $should_be = 'Thu, 10/07/2010 - 10:30:30 to 11:30:30';
        }
        break;

      default:
        throw new \Exception("Oh dear! Unknown granularity '$granularity'.");
    }
    $this->drupalPost('node/add/story', $edit, t('Save'));
    $this->drupalPost('node/add/story', $edit, 'Save');
    $this->assertText($edit['title'], "Node has been created");
    $this->assertText($should_be, "Found the correct date for a $field_type field using $max_granularity granularity with $tz_handling timezone handling.");
    $this->assertText($should_be, "Found the correct date for a $field_type field using $granularity granularity with $tz_handling timezone handling.");
  }

}