You are here

Home » API reference » Webform Scheduled Tasks 8.2 » SubmissionsCompletedSinceLastSuccessTest.php

class SubmissionsCompletedSinceLastSuccessTest in Webform Scheduled Tasks 8.2

Submissions since last success result set plugin test.

@coversDefaultClass \Drupal\webform_scheduled_tasks\Plugin\WebformScheduledTasks\ResultSet\SubmissionsCompletedSinceLastSuccess @group webform_scheduled_tasks

Hierarchy

Expanded class hierarchy of SubmissionsCompletedSinceLastSuccessTest

File

tests/src/Kernel/SubmissionsCompletedSinceLastSuccessTest.php, line 18

Namespace

Drupal\Tests\webform_scheduled_tasks\Kernel
View source 
class SubmissionsCompletedSinceLastSuccessTest extends KernelTestBase {

  /**
   * Modules to install.
   *
   * @var array
   */
  public static $modules = [
    'system',
    'user',
    'webform',
    'webform_scheduled_tasks',
    'webform_scheduled_tasks_test_types',
  ];

  /**
   * The time service.
   *
   * @var \Drupal\Component\Datetime\TimeInterface
   */
  protected $time;

  /**
   * A test scheduled task.
   *
   * @var \Drupal\webform_scheduled_tasks\Entity\WebformScheduledTaskInterface
   */
  protected $schedule;

  /**
   * The current time.
   *
   * @var int
   */
  protected $currentTime = 1000000000;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installSchema('webform', [
      'webform',
    ]);
    $this
      ->installEntitySchema('webform_submission');
    $this
      ->installEntitySchema('user');
    $current_time =& $this->currentTime;
    $this->time = $this
      ->prophesize(TimeInterface::class);
    $this->time
      ->getRequestTime()
      ->will(function () use (&$current_time) {
      return $current_time;
    });
    $this->container
      ->set('datetime.time', $this->time
      ->reveal());
    $schedule_webform = Webform::create([
      'id' => 'scheduled_webform',
    ]);
    $schedule_webform
      ->save();
    $this->schedule = WebformScheduledTask::create([
      'id' => 'test_task',
      'webform' => $schedule_webform
        ->id(),
      'result_set_type' => 'submissions_completed_since_last_success',
      'task_type' => 'test_task',
    ]);
    $this->schedule
      ->save();
  }

  /**
   * @covers ::getResultSet
   */
  public function testBasicIncrementalSubmissions() {
    $published_submissions = [
      $this
        ->createTestSubmission(),
      $this
        ->createTestSubmission(),
      $this
        ->createTestSubmission(),
    ];
    $draft_submission = $this
      ->createTestSubmission([
      'in_draft' => TRUE,
    ]);
    $this
      ->timePasses();
    $this
      ->assertSubmissionResults($published_submissions);
    $this->schedule
      ->registerSuccessfulTask();
    $new_submissions = [
      $this
        ->createTestSubmission(),
      $this
        ->createTestSubmission(),
      $this
        ->createTestSubmission(),
    ];
    $this
      ->timePasses();
    $this
      ->assertSubmissionResults($new_submissions);
    $this->schedule
      ->registerSuccessfulTask();

    // Draft submissions created previously, will be included in the list of
    // submissions once they are out of draft status.
    $draft_submission->in_draft = FALSE;
    $draft_submission
      ->save();
    $this
      ->timePasses();
    $this
      ->assertSubmissionResults([
      $draft_submission,
    ]);
    $this->schedule
      ->registerSuccessfulTask();
  }

  /**
   * @covers ::getResultSet
   */
  public function testSubmissionCreationTimeScheduleRaceConditions() {

    // @codingStandardsIgnoreStart
    // In the following timeline, the plugin should select submission b to c,
    // but exclude d, since it was created on or after the thread started
    // running. The next run will capture d and e, since the recorded time for a
    // successful run is the request time:
    // (sub a) (last completed) (sub c) (request time) (sub e) (execute)
    //           (sub b)                    (sub d)
    // The "last completed" in the diagram will be primed to the current time.
    // @codingStandardsIgnoreEnd
    $this
      ->assertSubmissionResults([]);
    $this->schedule
      ->registerSuccessfulTask();

    // Submission B will be created at exactly the same time that the last task
    // ran.
    $submission_b = $this
      ->createTestSubmission([]);
    $this
      ->timePasses();
    $submission_c = $this
      ->createTestSubmission([]);
    $this
      ->timePasses();

    // Submission D happens at the exact time the plugin is executing for a
    // second time.
    $submission_d = $this
      ->createTestSubmission([]);

    // Submission E happens between the request time and the time the plugin
    // takes to execute. Simulate this by pitching submission e, 1 second into
    // the future.
    $submission_e = $this
      ->createTestSubmission([
      'completed' => $this->currentTime + 1,
    ]);
    $this
      ->assertSubmissionResults([
      $submission_b,
      $submission_c,
    ]);
    $this->schedule
      ->registerSuccessfulTask();

    // Elapse two seconds, one of the simulated second of execution that
    // submission e used and one second between running intervals of the next
    // scheduled job.
    $this
      ->timePasses();
    $this
      ->timePasses();
    $this
      ->assertSubmissionResults([
      $submission_d,
      $submission_e,
    ]);
  }

  /**
   * @covers ::getResultSet
   */
  public function testAllResultsAreIncludedForFailedTask() {
    $submissions = [
      $this
        ->createTestSubmission(),
      $this
        ->createTestSubmission(),
      $this
        ->createTestSubmission(),
    ];
    $this
      ->assertSubmissionResults($submissions);
    $this->schedule
      ->registerFailedTask();
    $this
      ->assertSubmissionResults($submissions);
    $this->schedule
      ->registerFailedTask();
  }

  /**
   * Simulate time passing.
   */
  protected function timePasses() {
    $this->currentTime++;
  }

  /**
   * Create a test submission.
   */
  protected function createTestSubmission($fields = []) {
    $submission = WebformSubmission::create($fields + [
      'webform_id' => 'scheduled_webform',
    ]);
    $submission
      ->save();
    return $submission;
  }

  /**
   * Assert the expected submissions in a schedule result set.
   */
  protected function assertSubmissionResults($expectedSubmissions) {
    $this->schedule = WebformScheduledTask::load($this->schedule
      ->id());
    $results = iterator_to_array($this->schedule
      ->getResultSetPlugin()
      ->getResultSet());
    $entity_id = function (EntityInterface $entity) {
      return $entity
        ->id();
    };
    $this
      ->assertEquals(array_map($entity_id, $expectedSubmissions), array_map($entity_id, $results));
  }

}

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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
SubmissionsCompletedSinceLastSuccessTest::$currentTime protected property The current time.
SubmissionsCompletedSinceLastSuccessTest::$modules public static property Modules to install. Overrides KernelTestBase::$modules
SubmissionsCompletedSinceLastSuccessTest::$schedule protected property A test scheduled task.
SubmissionsCompletedSinceLastSuccessTest::$time protected property The time service.
SubmissionsCompletedSinceLastSuccessTest::assertSubmissionResults protected function Assert the expected submissions in a schedule result set.
SubmissionsCompletedSinceLastSuccessTest::createTestSubmission protected function Create a test submission.
SubmissionsCompletedSinceLastSuccessTest::setUp protected function Overrides KernelTestBase::setUp
SubmissionsCompletedSinceLastSuccessTest::testAllResultsAreIncludedForFailedTask public function @covers ::getResultSet
SubmissionsCompletedSinceLastSuccessTest::testBasicIncrementalSubmissions public function @covers ::getResultSet
SubmissionsCompletedSinceLastSuccessTest::testSubmissionCreationTimeScheduleRaceConditions public function @covers ::getResultSet
SubmissionsCompletedSinceLastSuccessTest::timePasses protected function Simulate time passing.
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.