You are here

class DateTimeTest in Drupal 10

Same name and namespace in other branches
  1. 8 core/modules/system/tests/src/Functional/System/DateTimeTest.php \Drupal\Tests\system\Functional\System\DateTimeTest
  2. 9 core/modules/system/tests/src/Functional/System/DateTimeTest.php \Drupal\Tests\system\Functional\System\DateTimeTest

Configure date and time settings. Test date formatting and time zone handling, including daylight saving time.

@group system

Hierarchy

Expanded class hierarchy of DateTimeTest

File

core/modules/system/tests/src/Functional/System/DateTimeTest.php, line 15

Namespace

Drupal\Tests\system\Functional\System
View source
class DateTimeTest extends BrowserTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'block',
    'node',
    'language',
    'field',
    'field_ui',
    'datetime',
    'options',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';
  protected function setUp() : void {
    parent::setUp();

    // Create admin user and log in admin user.
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'administer site configuration',
      'administer content types',
      'administer nodes',
      'administer node fields',
      'administer node form display',
      'administer node display',
    ]));
    $this
      ->drupalPlaceBlock('local_actions_block');
  }

  /**
   * Tests time zones and DST handling.
   */
  public function testTimeZoneHandling() {

    // Setup date/time settings for Honolulu time.
    $config = $this
      ->config('system.date')
      ->set('timezone.default', 'Pacific/Honolulu')
      ->set('timezone.user.configurable', 0)
      ->save();
    DateFormat::load('medium')
      ->setPattern('Y-m-d H:i:s O')
      ->save();

    // Create some nodes with different authored-on dates.
    $date1 = '2007-01-31 21:00:00 -1000';
    $date2 = '2007-07-31 21:00:00 -1000';
    $this
      ->drupalCreateContentType([
      'type' => 'article',
    ]);
    $node1 = $this
      ->drupalCreateNode([
      'created' => strtotime($date1),
      'type' => 'article',
    ]);
    $node2 = $this
      ->drupalCreateNode([
      'created' => strtotime($date2),
      'type' => 'article',
    ]);

    // Confirm date format and time zone.
    $this
      ->drupalGet('node/' . $node1
      ->id());

    // Date should be identical, with GMT offset of -10 hours.
    $this
      ->assertSession()
      ->pageTextContains('2007-01-31 21:00:00 -1000');
    $this
      ->drupalGet('node/' . $node2
      ->id());

    // Date should be identical, with GMT offset of -10 hours.
    $this
      ->assertSession()
      ->pageTextContains('2007-07-31 21:00:00 -1000');

    // Set time zone to Los Angeles time.
    $config
      ->set('timezone.default', 'America/Los_Angeles')
      ->save();
    \Drupal::entityTypeManager()
      ->getViewBuilder('node')
      ->resetCache([
      $node1,
      $node2,
    ]);

    // Confirm date format and time zone.
    $this
      ->drupalGet('node/' . $node1
      ->id());

    // Date should be two hours ahead, with GMT offset of -8 hours.
    $this
      ->assertSession()
      ->pageTextContains('2007-01-31 23:00:00 -0800');
    $this
      ->drupalGet('node/' . $node2
      ->id());

    // Date should be three hours ahead, with GMT offset of -7 hours.
    $this
      ->assertSession()
      ->pageTextContains('2007-08-01 00:00:00 -0700');
  }

  /**
   * Tests date format configuration.
   */
  public function testDateFormatConfiguration() {

    // Confirm 'no custom date formats available' message appears.
    $this
      ->drupalGet('admin/config/regional/date-time');

    // Add custom date format.
    $this
      ->clickLink('Add format');
    $date_format_id = strtolower($this
      ->randomMachineName(8));
    $name = ucwords($date_format_id);
    $date_format = 'd.m.Y - H:i';
    $edit = [
      'id' => $date_format_id,
      'label' => $name,
      'date_format_pattern' => $date_format,
    ];
    $this
      ->drupalGet('admin/config/regional/date-time/formats/add');
    $this
      ->submitForm($edit, 'Add format');

    // Verify that the user is redirected to the correct page.
    $this
      ->assertSession()
      ->addressEquals(Url::fromRoute('entity.date_format.collection'));

    // Check that date format added confirmation message appears.
    $this
      ->assertSession()
      ->pageTextContains('Custom date format added.');

    // Check that custom date format appears in the date format list.
    $this
      ->assertSession()
      ->pageTextContains($name);

    // Check that the delete link for custom date format appears.
    $this
      ->assertSession()
      ->pageTextContains('Delete');

    // Edit the custom date format and re-save without editing the format.
    $this
      ->drupalGet('admin/config/regional/date-time');
    $this
      ->clickLink('Edit');
    $this
      ->submitForm([], 'Save format');

    // Verify that the user is redirected to the correct page.
    $this
      ->assertSession()
      ->addressEquals(Url::fromRoute('entity.date_format.collection'));
    $this
      ->assertSession()
      ->pageTextContains('Custom date format updated.');

    // Edit custom date format.
    $this
      ->drupalGet('admin/config/regional/date-time');
    $this
      ->clickLink('Edit');
    $edit = [
      'date_format_pattern' => 'Y m',
    ];
    $this
      ->drupalGet($this
      ->getUrl());
    $this
      ->submitForm($edit, 'Save format');

    // Verify that the user is redirected to the correct page.
    $this
      ->assertSession()
      ->addressEquals(Url::fromRoute('entity.date_format.collection'));
    $this
      ->assertSession()
      ->pageTextContains('Custom date format updated.');

    // Delete custom date format.
    $this
      ->clickLink('Delete');
    $this
      ->drupalGet('admin/config/regional/date-time/formats/manage/' . $date_format_id . '/delete');
    $this
      ->submitForm([], 'Delete');

    // Verify that the user is redirected to the correct page.
    $this
      ->assertSession()
      ->addressEquals(Url::fromRoute('entity.date_format.collection'));
    $this
      ->assertSession()
      ->pageTextContains("The date format {$name} has been deleted.");

    // Make sure the date does not exist in config.
    $date_format = DateFormat::load($date_format_id);
    $this
      ->assertNull($date_format);

    // Add a new date format with an existing format.
    $date_format_id = strtolower($this
      ->randomMachineName(8));
    $name = ucwords($date_format_id);
    $date_format = 'Y';
    $edit = [
      'id' => $date_format_id,
      'label' => $name,
      'date_format_pattern' => $date_format,
    ];
    $this
      ->drupalGet('admin/config/regional/date-time/formats/add');
    $this
      ->submitForm($edit, 'Add format');

    // Verify that the user is redirected to the correct page.
    $this
      ->assertSession()
      ->addressEquals(Url::fromRoute('entity.date_format.collection'));
    $this
      ->assertSession()
      ->pageTextContains('Custom date format added.');

    // Check that the custom date format appears in the date format list.
    $this
      ->assertSession()
      ->pageTextContains($name);

    // Check that the delete link for custom date format appears.
    $this
      ->assertSession()
      ->pageTextContains('Delete');
    $date_format = DateFormat::create([
      'id' => 'xss_short',
      'label' => 'XSS format',
      'pattern' => '\\<\\s\\c\\r\\i\\p\\t\\>\\a\\l\\e\\r\\t\\(\'\\X\\S\\S\'\\)\\;\\<\\/\\s\\c\\r\\i\\p\\t\\>',
    ]);
    $date_format
      ->save();
    $this
      ->drupalGet(Url::fromRoute('entity.date_format.collection'));

    // Ensure that the date format is properly escaped.
    $this
      ->assertSession()
      ->assertEscaped("<script>alert('XSS');</script>");

    // Add a new date format with HTML in it.
    $date_format_id = strtolower($this
      ->randomMachineName(8));
    $name = ucwords($date_format_id);
    $date_format = '& \\<\\e\\m\\>Y\\<\\/\\e\\m\\>';
    $edit = [
      'id' => $date_format_id,
      'label' => $name,
      'date_format_pattern' => $date_format,
    ];
    $this
      ->drupalGet('admin/config/regional/date-time/formats/add');
    $this
      ->submitForm($edit, 'Add format');

    // Verify that the user is redirected to the correct page.
    $this
      ->assertSession()
      ->addressEquals(Url::fromRoute('entity.date_format.collection'));
    $this
      ->assertSession()
      ->pageTextContains('Custom date format added.');

    // Check that the custom date format appears in the date format list.
    $this
      ->assertSession()
      ->pageTextContains($name);
    $this
      ->assertSession()
      ->assertEscaped('<em>' . date("Y") . '</em>');
  }

  /**
   * Tests handling case with invalid data in selectors (like February, 31st).
   */
  public function testEnteringDateTimeViaSelectors() {
    $this
      ->drupalCreateContentType([
      'type' => 'page_with_date',
      'name' => 'Page with date',
    ]);
    $this
      ->drupalGet('admin/structure/types/manage/page_with_date');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->drupalGet('admin/structure/types/manage/page_with_date/fields/add-field');
    $edit = [
      'new_storage_type' => 'datetime',
      'label' => 'dt',
      'field_name' => 'dt',
    ];
    $this
      ->drupalGet('admin/structure/types/manage/page_with_date/fields/add-field');
    $this
      ->submitForm($edit, 'Save and continue');

    // Check that the new datetime field was created, and process is now set
    // to continue for configuration.
    $this
      ->assertSession()
      ->pageTextContains('These settings apply to the');
    $this
      ->drupalGet('admin/structure/types/manage/page_with_date/fields/node.page_with_date.field_dt/storage');
    $edit = [
      'settings[datetime_type]' => 'datetime',
      'cardinality' => 'number',
      'cardinality_number' => '1',
    ];
    $this
      ->drupalGet('admin/structure/types/manage/page_with_date/fields/node.page_with_date.field_dt/storage');
    $this
      ->submitForm($edit, 'Save field settings');
    $this
      ->drupalGet('admin/structure/types/manage/page_with_date/fields');
    $this
      ->assertSession()
      ->pageTextContains('field_dt');
    $this
      ->drupalGet('admin/structure/types/manage/page_with_date/form-display');
    $edit = [
      'fields[field_dt][type]' => 'datetime_datelist',
      'fields[field_dt][region]' => 'content',
    ];
    $this
      ->drupalGet('admin/structure/types/manage/page_with_date/form-display');
    $this
      ->submitForm($edit, 'Save');
    $this
      ->drupalLogout();

    // Now log in as a regular editor.
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'create page_with_date content',
    ]));
    $this
      ->drupalGet('node/add/page_with_date');
    $edit = [
      'title[0][value]' => 'sample doc',
      'field_dt[0][value][year]' => '2016',
      'field_dt[0][value][month]' => '2',
      'field_dt[0][value][day]' => '31',
      'field_dt[0][value][hour]' => '1',
      'field_dt[0][value][minute]' => '30',
    ];
    $this
      ->drupalGet('node/add/page_with_date');
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Selected combination of day and month is not valid.');
    $edit['field_dt[0][value][day]'] = '29';
    $this
      ->drupalGet('node/add/page_with_date');
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextNotContains('Selected combination of day and month is not valid.');
    $this
      ->drupalGet('node/1');
    $this
      ->assertSession()
      ->pageTextContains('Mon, 02/29/2016 - 01:30');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 14
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function
BrowserTestBase::tearDown protected function 2
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType
DateTimeTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
DateTimeTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
DateTimeTest::setUp protected function Overrides BrowserTestBase::setUp
DateTimeTest::testDateFormatConfiguration public function Tests date format configuration.
DateTimeTest::testEnteringDateTimeViaSelectors public function Tests handling case with invalid data in selectors (like February, 31st).
DateTimeTest::testTimeZoneHandling public function Tests time zones and DST handling.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation.
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 4
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 21
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 3
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 1
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 1
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site under test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path.
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.