You are here

Home » API reference » SMS Framework 2.x » SmsFrameworkDeliveryReportEntityTest.php

class SmsFrameworkDeliveryReportEntityTest in SMS Framework 2.x

Same name and namespace in other branches
  1. 8 tests/src/Kernel/SmsFrameworkDeliveryReportEntityTest.php \Drupal\Tests\sms\Kernel\SmsFrameworkDeliveryReportEntityTest
  2. 2.1.x tests/src/Kernel/SmsFrameworkDeliveryReportEntityTest.php \Drupal\Tests\sms\Kernel\SmsFrameworkDeliveryReportEntityTest

Tests the SMS Delivery report entity.

@group SMS Framework @coversDefaultClass \Drupal\sms\Entity\SmsDeliveryReport

Hierarchy

Expanded class hierarchy of SmsFrameworkDeliveryReportEntityTest

File

tests/src/Kernel/SmsFrameworkDeliveryReportEntityTest.php, line 22

Namespace

Drupal\Tests\sms\Kernel
View source 
class SmsFrameworkDeliveryReportEntityTest extends KernelTestBase {
  use SmsFrameworkTestTrait;

  // Remove 'test' prefix so it will not be run by test runner and override.
  use SmsFrameworkDeliveryReportTestTrait {
    testTimeQueued as timeQueued;
    testTimeDelivered as timeDelivered;
  }

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'user',
    'sms',
    'sms_test_gateway',
    'telephone',
    'dynamic_entity_reference',
    'entity_test',
  ];

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('entity_test');
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('sms');
    $this
      ->installEntitySchema('sms_result');
    $this
      ->installEntitySchema('sms_report');
  }

  /**
   * {@inheritdoc}
   */
  protected function createDeliveryReport() {
    return SmsDeliveryReport::create();
  }

  /**
   * Tests time queued.
   *
   * @covers ::getTimeQueued
   * @covers ::setTimeQueued
   */
  public function testTimeQueued() {
    $report = $this
      ->createDeliveryReport();
    $this
      ->assertNull($report
      ->getTimeQueued(), 'Default value is NULL');

    // Save a version that has QUEUED as the status.
    $sms_message = SmsMessage::create();
    $sms_message
      ->save();
    $time = 123123123;
    $report
      ->setSmsMessage($sms_message)
      ->setStatus(SmsMessageReportStatus::QUEUED)
      ->setStatusTime($time)
      ->save();
    $return = $report
      ->setTimeQueued($time);
    $this
      ->assertTrue($return instanceof SmsDeliveryReportInterface);
    $this
      ->assertEquals($time, $report
      ->getTimeQueued());
  }

  /**
   * Tests time delivered.
   *
   * @covers ::getTimeDelivered
   * @covers ::setTimeDelivered
   */
  public function testTimeDelivered() {
    $report = $this
      ->createDeliveryReport();
    $this
      ->assertNull($report
      ->getTimeQueued(), 'Default value is NULL');

    // Save a version that has DELIVERED as the status.
    $sms_message = SmsMessage::create();
    $sms_message
      ->save();
    $time = 123123123;
    $report
      ->setSmsMessage($sms_message)
      ->setStatus(SmsMessageReportStatus::DELIVERED)
      ->setStatusTime($time)
      ->save();
    $return = $report
      ->setTimeDelivered($time);
    $this
      ->assertTrue($return instanceof SmsDeliveryReportInterface);
    $this
      ->assertEquals($time, $report
      ->getTimeDelivered());
  }

  /**
   * Tests saving and retrieval of a complete entity.
   *
   * @covers ::save
   */
  public function testSaveAndRetrieveReport() {

    /** @var \Drupal\sms\Entity\SmsDeliveryReport $report */
    $report = $this
      ->createDeliveryReport()
      ->setMessageId($this
      ->randomMachineName())
      ->setStatus(SmsMessageReportStatus::DELIVERED)
      ->setRecipient('1234567890')
      ->setStatusMessage('Message delivered')
      ->setStatusTime($this->container
      ->get('datetime.time')
      ->getRequestTime());
    $sms_message = SmsMessage::create();
    $sms_message
      ->save();
    $report
      ->setSmsMessage($sms_message)
      ->save();
    $storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('sms_report');
    $saved = $storage
      ->loadByProperties([
      'recipient' => '1234567890',
    ]);
    $this
      ->assertEquals(1, count($saved));
    $saved = reset($saved);
    $this
      ->assertEquals($report
      ->getRecipient(), $saved
      ->getRecipient());
    $this
      ->assertEquals($report
      ->getMessageId(), $saved
      ->getMessageId());
    $this
      ->assertEquals($report
      ->getStatus(), $saved
      ->getStatus());
    $this
      ->assertEquals($report
      ->getStatusMessage(), $saved
      ->getStatusMessage());
    $this
      ->assertEquals($report
      ->getStatusTime(), $saved
      ->getStatusTime());
    $this
      ->assertEquals($report
      ->uuid(), $saved
      ->uuid());
  }

  /**
   * Tests saving a delivery report without a parent SMS message.
   *
   * @covers ::save
   * @covers ::preSave
   */
  public function testSaveReportWithoutParent() {
    $this
      ->expectException(EntityStorageException::class);
    $this
      ->expectExceptionMessage('No parent SMS message specified for SMS delivery report');

    /** @var \Drupal\sms\Entity\SmsMessageResult $result */
    $result = $this
      ->createDeliveryReport()
      ->setMessageId($this
      ->randomMachineName())
      ->setStatus(SmsMessageReportStatus::DELIVERED)
      ->setRecipient('1234567890')
      ->setStatusMessage('Message delivered')
      ->setStatusTime($this->container
      ->get('datetime.time')
      ->getRequestTime());
    $result
      ->save();
  }

  /**
   * Test saving of delivery report revisions.
   */
  public function testReportRevisions() {
    $sms_message = SmsMessage::create();
    $sms_message
      ->save();
    $time_queued = $this->container
      ->get('datetime.time')
      ->getRequestTime();
    $time_delivered = $time_queued + 3600;

    /** @var \Drupal\sms\Entity\SmsDeliveryReport $report */
    $report = $this
      ->createDeliveryReport()
      ->setSmsMessage($sms_message)
      ->setMessageId($this
      ->randomMachineName())
      ->setStatus(SmsMessageReportStatus::QUEUED)
      ->setRecipient('1234567890')
      ->setStatusMessage('Message queued')
      ->setStatusTime($time_queued);
    $report
      ->save();
    $report
      ->setStatus(SmsMessageReportStatus::DELIVERED)
      ->setStatusMessage('Message delivered')
      ->setStatusTime($time_delivered)
      ->save();
    $this
      ->assertEquals($time_queued, $report
      ->getTimeQueued());
    $this
      ->assertEquals($time_delivered, $report
      ->getTimeDelivered());
  }

  /**
   * Tests the multiple revisioning of delivery reports.
   *
   * @covers ::getRevisionAtStatus
   */
  public function testMultipleReportRevisions() {
    $sms_message = SmsMessage::create();
    $sms_message
      ->save();
    $request_time = $this->container
      ->get('datetime.time')
      ->getRequestTime();
    $status_times = [
      'queued' => $request_time,
      'pending' => $request_time + 1800,
      'delivered' => $request_time + 3600,
    ];

    /** @var \Drupal\sms\Entity\SmsDeliveryReport $report */
    $report = $this
      ->createDeliveryReport()
      ->setSmsMessage($sms_message);
    foreach ($status_times as $status => $time) {
      $report
        ->setStatus($status)
        ->setStatusMessage('Status ' . $status)
        ->setStatusTime($time)
        ->save();
    }
    $this
      ->assertEquals($status_times['queued'], $report
      ->getRevisionAtStatus('queued')
      ->getStatusTime());
    $this
      ->assertEquals($status_times['pending'], $report
      ->getRevisionAtStatus('pending')
      ->getStatusTime());
    $this
      ->assertEquals($status_times['delivered'], $report
      ->getRevisionAtStatus('delivered')
      ->getStatusTime());

    // Create another revision with different status time.
    $report
      ->setStatus('queued')
      ->setStatusTime(1234567890)
      ->save();

    // Verify that the latest revision is always returned.
    $this
      ->assertEquals(1234567890, $report
      ->getRevisionAtStatus('queued')
      ->getStatusTime());
    $this
      ->assertEquals($status_times['pending'], $report
      ->getRevisionAtStatus('pending')
      ->getStatusTime());
    $this
      ->assertEquals($status_times['delivered'], $report
      ->getRevisionAtStatus('delivered')
      ->getStatusTime());
  }

}

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.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated 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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 3
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::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 24
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 4
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
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. 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.
SmsFrameworkDeliveryReportEntityTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
SmsFrameworkDeliveryReportEntityTest::createDeliveryReport protected function Creates an SMS delivery report for testing. Overrides SmsFrameworkDeliveryReportTestTrait::createDeliveryReport
SmsFrameworkDeliveryReportEntityTest::setUp public function Overrides KernelTestBase::setUp
SmsFrameworkDeliveryReportEntityTest::testMultipleReportRevisions public function Tests the multiple revisioning of delivery reports.
SmsFrameworkDeliveryReportEntityTest::testReportRevisions public function Test saving of delivery report revisions.
SmsFrameworkDeliveryReportEntityTest::testSaveAndRetrieveReport public function Tests saving and retrieval of a complete entity.
SmsFrameworkDeliveryReportEntityTest::testSaveReportWithoutParent public function Tests saving a delivery report without a parent SMS message.
SmsFrameworkDeliveryReportEntityTest::testTimeDelivered public function Tests time delivered.
SmsFrameworkDeliveryReportEntityTest::testTimeQueued public function Tests time queued.
SmsFrameworkDeliveryReportTestTrait::testMessageId public function Tests message ID.
SmsFrameworkDeliveryReportTestTrait::testRecipient public function Tests recipient.
SmsFrameworkDeliveryReportTestTrait::testStatus public function Tests status.
SmsFrameworkDeliveryReportTestTrait::testStatusMessage public function Tests status message.
SmsFrameworkDeliveryReportTestTrait::testStatusTime public function Tests status time.
SmsFrameworkDeliveryReportTestTrait::testTimeDelivered public function Tests time delivered. Aliased as: timeDelivered
SmsFrameworkDeliveryReportTestTrait::testTimeQueued public function Tests time queued. Aliased as: timeQueued
SmsFrameworkTestTrait::createEntityWithPhoneNumber protected function Creates an entity, and optionally adds phone numbers.
SmsFrameworkTestTrait::createMemoryGateway protected function Creates a memory gateway.
SmsFrameworkTestTrait::createMessageResult protected function Create a result and reports for a message.
SmsFrameworkTestTrait::getIncomingMessages protected function Get all messages received by a gateway.
SmsFrameworkTestTrait::getLastIncomingMessage protected function Get the last message sent to gateway.
SmsFrameworkTestTrait::getLastTestMessage public function Get the last SMS message sent to 'Memory' gateway.
SmsFrameworkTestTrait::getLastTestMessageReport protected function Gets the last SMS report for messages sent to 'Memory' gateway.
SmsFrameworkTestTrait::getLastVerification protected function Gets the last phone number verification that was created.
SmsFrameworkTestTrait::getTestMessageReport protected function Gets an SMS report for message with message ID.
SmsFrameworkTestTrait::getTestMessageReports protected function Gets all SMS reports for messages sent to 'Memory' gateway.
SmsFrameworkTestTrait::getTestMessages public function Get all SMS messages sent to a 'Memory' gateway.
SmsFrameworkTestTrait::randomPhoneNumbers protected function Generates random phone numbers for tests.
SmsFrameworkTestTrait::randomSmsMessage protected function Generates a random SMS message by the specified user.
SmsFrameworkTestTrait::resetIncomingMessages protected function Resets incoming messages stored in memory by gateway.
SmsFrameworkTestTrait::resetTestMessageReports protected function Resets the SMS reports stored in memory by 'Memory' gateway.
SmsFrameworkTestTrait::resetTestMessages public function Resets SMS messages stored in memory by 'Memory' gateway.
SmsFrameworkTestTrait::setFallbackGateway protected function Sets the fallback gateway.
SmsFrameworkTestTrait::verifyPhoneNumber protected function Forces verification of a phone number for an entity.
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.