You are here

Home » API reference » Recurring Time Period 8 » RollingIntervalTest.php

class RollingIntervalTest in Recurring Time Period 8

Tests the rolling interval plugin.

@group recurring_period

Hierarchy

Expanded class hierarchy of RollingIntervalTest

File

tests/src/Kernel/RollingIntervalTest.php, line 12

Namespace

Drupal\Tests\recurring_period\Kernel
View source 
class RollingIntervalTest extends RecurringPeriodTestBase {

  /**
   * Tests the TODO.
   *
   * @dataProvider rollingIntervalProvider
   */
  public function testRollingInterval($configuration, $start_date, $period_dates) {
    $rolling_interval_plugin = $this->recurringPeriodManager
      ->createInstance('rolling_interval', $configuration);
    $timezone_london = new \DateTimeZone('Europe/London');
    $start_date_time = new \DateTimeImmutable($start_date, $timezone_london);
    $period = $rolling_interval_plugin
      ->getPeriodFromDate($start_date_time);
    $first_period_dates = array_shift($period_dates);
    $this
      ->assertEquals($first_period_dates[0], $period
      ->getStartDate()
      ->format(\DateTimeInterface::ATOM));
    $this
      ->assertEquals($first_period_dates[1], $period
      ->getEndDate()
      ->format(\DateTimeInterface::ATOM));
    while ($next_period_dates = array_shift($period_dates)) {

      // TODO: also check the value of calculateDate().
      $period = $rolling_interval_plugin
        ->getNextPeriod($period);
      $this
        ->assertEquals($next_period_dates[0], $period
        ->getStartDate()
        ->format(\DateTimeInterface::ATOM));
      $this
        ->assertEquals($next_period_dates[1], $period
        ->getEndDate()
        ->format(\DateTimeInterface::ATOM));
    }
  }
  public function rollingIntervalProvider() {
    return [
      '1 month' => [
        // Configuration.
        [
          'interval' => [
            'period' => 'month',
            'interval' => 1,
          ],
        ],
        // Start date.
        '2017-01-01T09:00:00',
        // Successive period dates.
        [
          [
            '2017-01-01T09:00:00+00:00',
            '2017-02-01T09:00:00+00:00',
          ],
          [
            '2017-02-01T09:00:00+00:00',
            '2017-03-01T09:00:00+00:00',
          ],
          // The end of this period is after the change to DST, so the offset
          // changes from 0 to +1.
          [
            '2017-03-01T09:00:00+00:00',
            '2017-04-01T09:00:00+01:00',
          ],
          [
            '2017-04-01T09:00:00+01:00',
            '2017-05-01T09:00:00+01:00',
          ],
          [
            '2017-05-01T09:00:00+01:00',
            '2017-06-01T09:00:00+01:00',
          ],
          [
            '2017-06-01T09:00:00+01:00',
            '2017-07-01T09:00:00+01:00',
          ],
          [
            '2017-07-01T09:00:00+01:00',
            '2017-08-01T09:00:00+01:00',
          ],
          [
            '2017-08-01T09:00:00+01:00',
            '2017-09-01T09:00:00+01:00',
          ],
          [
            '2017-09-01T09:00:00+01:00',
            '2017-10-01T09:00:00+01:00',
          ],
          [
            '2017-10-01T09:00:00+01:00',
            '2017-11-01T09:00:00+00:00',
          ],
          [
            '2017-11-01T09:00:00+00:00',
            '2017-12-01T09:00:00+00:00',
          ],
          [
            '2017-12-01T09:00:00+00:00',
            '2018-01-01T09:00:00+00:00',
          ],
        ],
      ],
      '2 weeks' => [
        // Configuration.
        [
          'interval' => [
            'period' => 'week',
            'interval' => 2,
          ],
        ],
        // Start date.
        '2017-01-01T09:00:00',
        // Successive period dates.
        [
          [
            '2017-01-01T09:00:00+00:00',
            '2017-01-15T09:00:00+00:00',
          ],
          [
            '2017-01-15T09:00:00+00:00',
            '2017-01-29T09:00:00+00:00',
          ],
        ],
      ],
    ];
  }

  /**
   * Tests a 2 week interval in UTC.
   */
  public function test2WeekInterval() {
    $timezone_utc = new \DateTimeZone('UTC');

    /** @var RecurringPeriodInterface $plugin */
    $plugin = $this->recurringPeriodManager
      ->createInstance('rolling_interval', [
      'interval' => [
        'period' => 'week',
        'interval' => 2,
      ],
    ]);
    $start_date = new \DateTimeImmutable('2017-01-01T09:00:00', $timezone_utc);
    $expected_end_date = new \DateTimeImmutable('2017-01-15T09:00:00', $timezone_utc);
    $actual_end_date = $plugin
      ->calculateDate($start_date);
    $this
      ->assertEquals($expected_end_date, $actual_end_date);

    // The timestamp difference should be 14*86400 seconds.
    $expected_timestamp_diff = 14 * 86400;
    $actual_timestamp_diff = (int) $actual_end_date
      ->format('U') - (int) $start_date
      ->format('U');
    $this
      ->assertEquals($expected_timestamp_diff, $actual_timestamp_diff);
  }

  /**
   * Tests a 2 week interval spanning a daylight saving change.
   */
  public function test2WeekIntervalSpanningDSTChange() {
    $timezone_london = new \DateTimeZone('Europe/London');

    /** @var RecurringPeriodInterface $plugin */
    $plugin = $this->recurringPeriodManager
      ->createInstance('rolling_interval', [
      'interval' => [
        'period' => 'week',
        'interval' => 2,
      ],
    ]);
    $start_date = new \DateTimeImmutable('2017-10-17T09:00:00', $timezone_london);
    $expected_end_date = new \DateTimeImmutable('2017-10-31T09:00:00', $timezone_london);
    $actual_end_date = $plugin
      ->calculateDate($start_date);
    $this
      ->assertEquals($expected_end_date, $actual_end_date);

    // The timestamp difference should take into account the extra hour
    // because of the the switch from DST.
    $expected_timestamp_diff = 14 * 86400 + 3600;
    $actual_timestamp_diff = (int) $actual_end_date
      ->format('U') - (int) $start_date
      ->format('U');
    $this
      ->assertEquals($expected_timestamp_diff, $actual_timestamp_diff);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
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.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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. 1
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.
RecurringPeriodTestBase::$modules public static property The modules to enable. Overrides KernelTestBase::$modules
RecurringPeriodTestBase::$recurringPeriodManager protected property The recurring period plugin manager.
RecurringPeriodTestBase::setUp protected function Overrides KernelTestBase::setUp
RollingIntervalTest::rollingIntervalProvider public function
RollingIntervalTest::test2WeekInterval public function Tests a 2 week interval in UTC.
RollingIntervalTest::test2WeekIntervalSpanningDSTChange public function Tests a 2 week interval spanning a daylight saving change.
RollingIntervalTest::testRollingInterval public function Tests the TODO.
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. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.