You are here

class SmsFrameworkProviderTest in SMS Framework 8

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

Tests SMS Framework provider service.

@group SMS Framework @coversDefaultClass \Drupal\sms\Provider\DefaultSmsProvider

Hierarchy

Expanded class hierarchy of SmsFrameworkProviderTest

File

tests/src/Kernel/SmsFrameworkProviderTest.php, line 23

Namespace

Drupal\Tests\sms\Kernel
View source
class SmsFrameworkProviderTest extends SmsFrameworkKernelBase {

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

  /**
   * SMS message entity storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $smsStorage;

  /**
   * The SMS provider.
   *
   * @var \Drupal\sms\Provider\SmsProviderInterface
   */
  protected $smsProvider;

  /**
   * A memory gateway.
   *
   * @var \Drupal\sms\Entity\SmsGatewayInterface
   */
  protected $gateway;

  /**
   * An incoming gateway.
   *
   * @var \Drupal\sms\Entity\SmsGatewayInterface
   */
  protected $incomingGateway;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('sms');
    $this
      ->installEntitySchema('sms_result');
    $this
      ->installEntitySchema('sms_report');
    $this->gateway = $this
      ->createMemoryGateway();
    $this->incomingGateway = $this
      ->createMemoryGateway([
      'plugin' => 'incoming',
    ]);
    $this->smsStorage = $this->container
      ->get('entity_type.manager')
      ->getStorage('sms');
    $this->smsProvider = $this->container
      ->get('sms.provider');
    $this
      ->setFallbackGateway($this->gateway);
  }

  /**
   * Test message is sent immediately.
   *
   * @covers ::send
   */
  public function testSend() {
    $message = $this
      ->createSmsMessage()
      ->addRecipients($this
      ->randomPhoneNumbers());
    $sms_messages = $this->smsProvider
      ->send($message);
    $this
      ->assertEquals(1, count($sms_messages), 'Return value contains 1 item.');
    $this
      ->assertTrue($sms_messages[0] instanceof StandardSmsMessageInterface, 'Return value is a SMS message.');
    $this
      ->assertEquals(1, count($this
      ->getTestMessages($this->gateway)));
    $this
      ->assertTrue($sms_messages[0]
      ->getResult() instanceof SmsMessageResultInterface);
  }

  /**
   * Ensures direction is set by the provider.
   *
   * @covers ::send
   */
  public function testSendNoDirection() {
    $sms_message = SmsMessage::create()
      ->setMessage($this
      ->randomString())
      ->addRecipients($this
      ->randomPhoneNumbers())
      ->setGateway($this->gateway);

    // This method will set direction.
    $this->smsProvider
      ->send($sms_message);
    $messages = $this
      ->getTestMessages($this->gateway);
    $this
      ->assertEquals(1, count($messages), 'Message was added to outgoing queue without direction being explicitly set');
    $this
      ->assertEquals(Direction::OUTGOING, $messages[0]
      ->getDirection(), 'Message direction set to outgoing.');
  }

  /**
   * Test message is received.
   *
   * @covers ::incoming
   */
  public function testIncoming() {
    $message = $this
      ->randomString();
    $sms_message = SmsMessage::create()
      ->setDirection(Direction::INCOMING)
      ->setMessage($message)
      ->setGateway($this->gateway);
    $sms_message
      ->setResult($this
      ->createMessageResult($sms_message));
    $sms_messages = $this->smsProvider
      ->incoming($sms_message);
    $this
      ->assertEquals($message, sms_test_gateway_get_incoming()['message'], 'Message was received.');
    $this
      ->assertEquals(1, count($sms_messages), 'Return value contains 1 item.');
    $this
      ->assertTrue($sms_messages[0] instanceof StandardSmsMessageInterface, 'Return value is a SMS message.');
    $this
      ->assertTrue($sms_messages[0]
      ->getResult() instanceof SmsMessageResultInterface);
  }

  /**
   * Ensures direction is set by the provider.
   *
   * @covers ::incoming
   */
  public function testIncomingNoDirection() {
    $sms_message = SmsMessage::create()
      ->setMessage($this
      ->randomString())
      ->addRecipients($this
      ->randomPhoneNumbers())
      ->setGateway($this->incomingGateway);
    $sms_message
      ->setResult($this
      ->createMessageResult($sms_message));

    // This method will set direction.
    $this->smsProvider
      ->incoming($sms_message);
    $messages = $this
      ->getIncomingMessages($this->incomingGateway);
    $this
      ->assertEquals(1, count($messages), 'Message was added to incoming queue without direction being explicitly set');
    $this
      ->assertEquals(Direction::INCOMING, $messages[0]
      ->getDirection(), 'Message direction set to incoming.');
  }

  /**
   * Ensures incoming message without recipients do not trigger exception.
   */
  public function testIncomingNoRecipients() {
    $this->incomingGateway
      ->setSkipQueue(TRUE)
      ->save();
    $sms_message = SmsMessage::create()
      ->setMessage($this
      ->randomString())
      ->setGateway($this->incomingGateway)
      ->setDirection(Direction::INCOMING);
    $sms_message
      ->setResult($this
      ->createMessageResult($sms_message));
    $this->smsProvider
      ->queue($sms_message);
    $messages = $this
      ->getIncomingMessages($this->incomingGateway);
    $this
      ->assertEquals(1, count($messages), 'Message was added to incoming queue without recipients.');
  }

  /**
   * Ensure no messages sent if no recipients.
   */
  public function testNoSendNoRecipients() {
    $sms_message = SmsMessage::create()
      ->setDirection(Direction::OUTGOING)
      ->setMessage($this
      ->randomString());
    $this
      ->setExpectedException(RecipientRouteException::class, 'There are no recipients');
    $this->smsProvider
      ->send($sms_message);
    $this
      ->assertEquals(0, count($this
      ->getTestMessages($this->gateway)));
  }

  /**
   * Ensures validation failure if no message.
   */
  public function testNoSendNoMessage() {
    $sms_message = SmsMessage::create()
      ->setDirection(Direction::OUTGOING)
      ->addRecipients($this
      ->randomPhoneNumbers());
    $this
      ->setExpectedException(SmsException::class, 'Can not queue SMS message because there are 1 validation error(s): [message]: This value should not be null.');
    $this->smsProvider
      ->queue($sms_message);
  }

  /**
   * Ensures exception if missing direction for queue method.
   *
   * @covers ::queue
   */
  public function testQueueNoDirection() {
    $sms_message = SmsMessage::create()
      ->setMessage($this
      ->randomString())
      ->addRecipients($this
      ->randomPhoneNumbers());
    $this
      ->setExpectedException(SmsDirectionException::class, 'Missing direction for message.');
    $this->smsProvider
      ->queue($sms_message);
  }

  /**
   * Test message is not sent because no gateway is set.
   *
   * @covers ::send
   */
  public function testSendNoFallbackGateway() {
    $this
      ->setFallbackGateway(NULL);
    $this
      ->setExpectedException(RecipientRouteException::class);
    $message = $this
      ->createSmsMessage()
      ->addRecipients($this
      ->randomPhoneNumbers());
    $this->smsProvider
      ->send($message);
  }

  /**
   * Test message is saved.
   */
  public function testQueueBasic() {
    $sms_message = $this
      ->createSmsMessage()
      ->addRecipients($this
      ->randomPhoneNumbers());
    $return = $this->smsProvider
      ->queue($sms_message);
    $this
      ->assertEquals(1, count(SmsMessage::loadMultiple()), 'SMS message saved.');
    $this
      ->assertEquals(1, count($return));
    $this
      ->assertTrue($return[0] instanceof SmsMessageInterface);
  }

  /**
   * Test message is not queued because no gateway is set.
   *
   * @covers ::send
   */
  public function testQueueNoFallbackGateway() {
    $this
      ->setFallbackGateway(NULL);
    $this
      ->setExpectedException(RecipientRouteException::class);
    $message = $this
      ->createSmsMessage()
      ->addRecipients($this
      ->randomPhoneNumbers());
    $this->smsProvider
      ->queue($message);
  }

  /**
   * Test message is sent immediately.
   */
  public function testSkipQueue() {
    $this->gateway
      ->setSkipQueue(TRUE)
      ->save();
    $sms_message = $this
      ->createSmsMessage()
      ->addRecipients($this
      ->randomPhoneNumbers());
    $this->smsProvider
      ->queue($sms_message);
    $this
      ->assertEquals(1, count($this
      ->getTestMessages($this->gateway)));
  }

  /**
   * Test sending standard SMS object queue in.
   */
  public function testQueueIn() {
    $sms_message = new StandardSmsMessage();
    $sms_message
      ->addRecipients($this
      ->randomPhoneNumbers())
      ->setMessage($this
      ->randomString())
      ->setDirection(Direction::INCOMING)
      ->setGateway($this->gateway);
    $sms_message
      ->setResult($this
      ->createMessageResult($sms_message));
    $sms_messages = $this->smsStorage
      ->loadByProperties([
      'direction' => Direction::INCOMING,
    ]);
    $this
      ->assertEquals(0, count($sms_messages), 'There is zero SMS message in the incoming queue.');
    $this->smsProvider
      ->queue($sms_message);
    $sms_messages = $this->smsStorage
      ->loadByProperties([
      'direction' => Direction::INCOMING,
    ]);
    $this
      ->assertEquals(1, count($sms_messages), 'There is one SMS message in the incoming queue.');
    $sms_message_loaded = reset($sms_messages);
    $this
      ->assertEquals(Direction::INCOMING, $sms_message_loaded
      ->getDirection());
  }

  /**
   * Test sending standard SMS object queue out.
   */
  public function testQueueOut() {
    $sms_message = new StandardSmsMessage();
    $sms_message
      ->addRecipients($this
      ->randomPhoneNumbers())
      ->setMessage($this
      ->randomString())
      ->setDirection(Direction::OUTGOING);
    $sms_messages = $this->smsStorage
      ->loadByProperties([
      'direction' => Direction::OUTGOING,
    ]);
    $this
      ->assertEquals(0, count($sms_messages), 'There is zero SMS message in the outgoing queue.');
    $this->smsProvider
      ->queue($sms_message);
    $sms_messages = $this->smsStorage
      ->loadByProperties([
      'direction' => Direction::OUTGOING,
    ]);
    $this
      ->assertEquals(1, count($sms_messages), 'There is one SMS message in the outgoing queue.');
    $sms_message_loaded = reset($sms_messages);
    $this
      ->assertEquals(Direction::OUTGOING, $sms_message_loaded
      ->getDirection());
  }

  /**
   * Test sending standard SMS object queue out skips queue.
   */
  public function testQueueOutSkipQueue() {
    $this->gateway
      ->setSkipQueue(TRUE)
      ->save();
    $sms_message = new StandardSmsMessage('', [], '', [], NULL);
    $sms_message
      ->addRecipients($this
      ->randomPhoneNumbers())
      ->setMessage($this
      ->randomString())
      ->setDirection(Direction::OUTGOING);
    $this->smsProvider
      ->queue($sms_message);
    $this
      ->assertEquals(1, count($this
      ->getTestMessages($this->gateway)), 'One standard SMS send skipped queue.');
  }

  /**
   * Test an exception is thrown if a message has no recipients.
   */
  public function testNoRecipients() {
    $this
      ->setExpectedException(RecipientRouteException::class, 'There are no recipients.');
    $sms_message = SmsMessage::create()
      ->setDirection(Direction::OUTGOING)
      ->setMessage($this
      ->randomString());
    $this->smsProvider
      ->send($sms_message);
  }

  /**
   * Test message is split into multiple messages if gateway demands it.
   */
  public function testChunking() {
    $gateway_chunked = SmsGateway::create([
      'plugin' => 'memory_chunked',
      'id' => 'memory_chunked',
      'settings' => [
        'gateway_id' => 'memory_chunked',
      ],
    ]);
    $gateway_chunked
      ->enable()
      ->save();
    $sms_message = $this
      ->createSmsMessage()
      ->setGateway($gateway_chunked)
      ->addRecipients([
      '123123123',
      '456456456',
      '789789789',
    ]);
    $return = $this->smsProvider
      ->queue($sms_message);
    $this
      ->assertEquals(2, count(SmsMessage::loadMultiple()), 'One SMS message has been split into two.');
    $this
      ->assertEquals(2, count($return), 'Provider queue method returned two messages.');
  }

  /**
   * Test message is not into multiple messages if gateway defines no chunking.
   */
  public function testNoChunking() {
    $sms_message = $this
      ->createSmsMessage()
      ->setGateway($this->gateway)
      ->addRecipients($this
      ->randomPhoneNumbers());
    $this->smsProvider
      ->queue($sms_message);
    $this
      ->assertEquals(1, count(SmsMessage::loadMultiple()), 'SMS message has not been split.');
  }

  /**
   * Test incoming messages do not get chunked.
   */
  public function testIncomingNotChunked() {
    $this->incomingGateway
      ->setSkipQueue(TRUE)
      ->save();
    $message = (new StandardSmsMessage())
      ->setMessage($this
      ->randomString())
      ->addRecipients($this
      ->randomPhoneNumbers())
      ->setDirection(Direction::INCOMING)
      ->setGateway($this->incomingGateway);
    $message
      ->setResult($this
      ->createMessageResult($message));
    $this->smsProvider
      ->queue($message);
    $incoming_messages = $this
      ->getIncomingMessages($this->incomingGateway);
    $this
      ->assertEquals(1, count($incoming_messages), 'There is one incoming message.');
  }

  /**
   * Ensure events are executed when a message added to the outgoing queue.
   */
  public function testEventsQueueOutgoing() {
    $sms_message = $this
      ->createSmsMessage()
      ->setGateway($this->gateway)
      ->setDirection(Direction::OUTGOING)
      ->addRecipients($this
      ->randomPhoneNumbers());
    $this->smsProvider
      ->queue($sms_message);
    $expected = [
      SmsEvents::MESSAGE_PRE_PROCESS,
      SmsEvents::MESSAGE_QUEUE_PRE_PROCESS,
      SmsEvents::MESSAGE_QUEUE_POST_PROCESS,
    ];
    $execution_order = \Drupal::state()
      ->get('sms_test_event_subscriber__execution_order', []);
    $this
      ->assertEquals($expected, $execution_order);

    // Ensure SmsEvents::MESSAGE_PRE_PROCESS is not executed. See
    // '_skip_preprocess_event' option.
    $this->container
      ->get('cron')
      ->run();
    $expected[] = SmsEvents::MESSAGE_OUTGOING_PRE_PROCESS;
    $expected[] = SmsEvents::MESSAGE_OUTGOING_POST_PROCESS;
    $expected[] = SmsEvents::MESSAGE_POST_PROCESS;
    $execution_order = \Drupal::state()
      ->get('sms_test_event_subscriber__execution_order', []);
    $this
      ->assertEquals($expected, $execution_order);
  }

  /**
   * Test events for outgoing queue skip queue.
   *
   * Ensure events are executed when a message added to the outgoing queue and
   * the gateway is set to skip queue.
   */
  public function testEventsQueueOutgoingSkipQueue() {
    $this->gateway
      ->setSkipQueue(TRUE)
      ->save();
    $sms_message = $this
      ->createSmsMessage()
      ->setGateway($this->gateway)
      ->setDirection(Direction::OUTGOING)
      ->addRecipients($this
      ->randomPhoneNumbers());
    $this->smsProvider
      ->queue($sms_message);
    $expected = [
      SmsEvents::MESSAGE_PRE_PROCESS,
      SmsEvents::MESSAGE_QUEUE_PRE_PROCESS,
      SmsEvents::MESSAGE_OUTGOING_PRE_PROCESS,
      SmsEvents::MESSAGE_OUTGOING_POST_PROCESS,
      SmsEvents::MESSAGE_POST_PROCESS,
      SmsEvents::MESSAGE_QUEUE_POST_PROCESS,
    ];
    $execution_order = \Drupal::state()
      ->get('sms_test_event_subscriber__execution_order', []);
    $this
      ->assertEquals($expected, $execution_order);
  }

  /**
   * Ensure events are executed when a message added to the incoming queue.
   */
  public function testEventsQueueIncoming() {
    $sms_message = $this
      ->createSmsMessage()
      ->setGateway($this->gateway)
      ->setDirection(Direction::INCOMING)
      ->addRecipients($this
      ->randomPhoneNumbers());
    $sms_message
      ->setResult($this
      ->createMessageResult($sms_message));
    $this->smsProvider
      ->queue($sms_message);
    $expected = [
      SmsEvents::MESSAGE_PRE_PROCESS,
      SmsEvents::MESSAGE_QUEUE_PRE_PROCESS,
      SmsEvents::MESSAGE_QUEUE_POST_PROCESS,
    ];
    $execution_order = \Drupal::state()
      ->get('sms_test_event_subscriber__execution_order', []);
    $this
      ->assertEquals($expected, $execution_order);

    // Ensure SmsEvents::MESSAGE_PRE_PROCESS is not executed. See
    // '_skip_preprocess_event' option.
    $this->container
      ->get('cron')
      ->run();
    $expected[] = SmsEvents::MESSAGE_INCOMING_PRE_PROCESS;
    $expected[] = 'Drupal\\sms_test_gateway\\Plugin\\SmsGateway\\Memory::incomingEvent';
    $expected[] = SmsEvents::MESSAGE_INCOMING_POST_PROCESS;
    $expected[] = SmsEvents::MESSAGE_POST_PROCESS;
    $execution_order = \Drupal::state()
      ->get('sms_test_event_subscriber__execution_order', []);
    $this
      ->assertEquals($expected, $execution_order);
  }

  /**
   * Tests events for incoming queue skip queue.
   *
   * Ensure events are executed when a message added to the incoming queue and
   * the gateway is set to skip queue.
   */
  public function testEventsQueueIncomingSkipQueue() {
    $this->gateway
      ->setSkipQueue(TRUE)
      ->save();
    $sms_message = $this
      ->createSmsMessage()
      ->setGateway($this->gateway)
      ->setDirection(Direction::INCOMING)
      ->addRecipients($this
      ->randomPhoneNumbers());
    $sms_message
      ->setResult($this
      ->createMessageResult($sms_message));
    $this->smsProvider
      ->queue($sms_message);
    $expected = [
      SmsEvents::MESSAGE_PRE_PROCESS,
      SmsEvents::MESSAGE_QUEUE_PRE_PROCESS,
      SmsEvents::MESSAGE_INCOMING_PRE_PROCESS,
      'Drupal\\sms_test_gateway\\Plugin\\SmsGateway\\Memory::incomingEvent',
      SmsEvents::MESSAGE_INCOMING_POST_PROCESS,
      SmsEvents::MESSAGE_POST_PROCESS,
      SmsEvents::MESSAGE_QUEUE_POST_PROCESS,
    ];
    $execution_order = \Drupal::state()
      ->get('sms_test_event_subscriber__execution_order', []);
    $this
      ->assertEquals($expected, $execution_order);
  }

  /**
   * Ensure events are executed when a message is sent.
   */
  public function testEventsOutgoing() {
    $sms_message = $this
      ->createSmsMessage()
      ->setGateway($this->gateway)
      ->setDirection(Direction::OUTGOING)
      ->addRecipients($this
      ->randomPhoneNumbers());
    $this->smsProvider
      ->send($sms_message);
    $expected = [
      SmsEvents::MESSAGE_PRE_PROCESS,
      SmsEvents::MESSAGE_OUTGOING_PRE_PROCESS,
      SmsEvents::MESSAGE_OUTGOING_POST_PROCESS,
      SmsEvents::MESSAGE_POST_PROCESS,
    ];
    $execution_order = \Drupal::state()
      ->get('sms_test_event_subscriber__execution_order', []);
    $this
      ->assertEquals($expected, $execution_order);
  }

  /**
   * Ensure events are executed when a message is received.
   */
  public function testEventsIncoming() {
    $sms_message = $this
      ->createSmsMessage()
      ->setGateway($this->gateway)
      ->setDirection(Direction::INCOMING)
      ->addRecipients($this
      ->randomPhoneNumbers());
    $sms_message
      ->setResult($this
      ->createMessageResult($sms_message));
    $this->smsProvider
      ->incoming($sms_message);
    $expected = [
      SmsEvents::MESSAGE_PRE_PROCESS,
      SmsEvents::MESSAGE_INCOMING_PRE_PROCESS,
      'Drupal\\sms_test_gateway\\Plugin\\SmsGateway\\Memory::incomingEvent',
      SmsEvents::MESSAGE_INCOMING_POST_PROCESS,
      SmsEvents::MESSAGE_POST_PROCESS,
    ];
    $execution_order = \Drupal::state()
      ->get('sms_test_event_subscriber__execution_order', []);
    $this
      ->assertEquals($expected, $execution_order);
  }

  /**
   * Create a SMS message entity for testing.
   *
   * @param array $values
   *   An mixed array of values to pass when creating the SMS message entity.
   *
   * @return \Drupal\sms\Entity\SmsMessageInterface
   *   A SMS message entity for testing.
   */
  protected function createSmsMessage(array $values = []) {
    return SmsMessage::create($values)
      ->setDirection(Direction::OUTGOING)
      ->setMessage($this
      ->randomString());
  }

}

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.
SmsFrameworkProviderTest::$gateway protected property A memory gateway.
SmsFrameworkProviderTest::$incomingGateway protected property An incoming gateway.
SmsFrameworkProviderTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
SmsFrameworkProviderTest::$smsProvider protected property The SMS provider.
SmsFrameworkProviderTest::$smsStorage protected property SMS message entity storage.
SmsFrameworkProviderTest::createSmsMessage protected function Create a SMS message entity for testing.
SmsFrameworkProviderTest::setUp protected function Overrides SmsFrameworkKernelBase::setUp
SmsFrameworkProviderTest::testChunking public function Test message is split into multiple messages if gateway demands it.
SmsFrameworkProviderTest::testEventsIncoming public function Ensure events are executed when a message is received.
SmsFrameworkProviderTest::testEventsOutgoing public function Ensure events are executed when a message is sent.
SmsFrameworkProviderTest::testEventsQueueIncoming public function Ensure events are executed when a message added to the incoming queue.
SmsFrameworkProviderTest::testEventsQueueIncomingSkipQueue public function Tests events for incoming queue skip queue.
SmsFrameworkProviderTest::testEventsQueueOutgoing public function Ensure events are executed when a message added to the outgoing queue.
SmsFrameworkProviderTest::testEventsQueueOutgoingSkipQueue public function Test events for outgoing queue skip queue.
SmsFrameworkProviderTest::testIncoming public function Test message is received.
SmsFrameworkProviderTest::testIncomingNoDirection public function Ensures direction is set by the provider.
SmsFrameworkProviderTest::testIncomingNoRecipients public function Ensures incoming message without recipients do not trigger exception.
SmsFrameworkProviderTest::testIncomingNotChunked public function Test incoming messages do not get chunked.
SmsFrameworkProviderTest::testNoChunking public function Test message is not into multiple messages if gateway defines no chunking.
SmsFrameworkProviderTest::testNoRecipients public function Test an exception is thrown if a message has no recipients.
SmsFrameworkProviderTest::testNoSendNoMessage public function Ensures validation failure if no message.
SmsFrameworkProviderTest::testNoSendNoRecipients public function Ensure no messages sent if no recipients.
SmsFrameworkProviderTest::testQueueBasic public function Test message is saved.
SmsFrameworkProviderTest::testQueueIn public function Test sending standard SMS object queue in.
SmsFrameworkProviderTest::testQueueNoDirection public function Ensures exception if missing direction for queue method.
SmsFrameworkProviderTest::testQueueNoFallbackGateway public function Test message is not queued because no gateway is set.
SmsFrameworkProviderTest::testQueueOut public function Test sending standard SMS object queue out.
SmsFrameworkProviderTest::testQueueOutSkipQueue public function Test sending standard SMS object queue out skips queue.
SmsFrameworkProviderTest::testSend public function Test message is sent immediately.
SmsFrameworkProviderTest::testSendNoDirection public function Ensures direction is set by the provider.
SmsFrameworkProviderTest::testSendNoFallbackGateway public function Test message is not sent because no gateway is set.
SmsFrameworkProviderTest::testSkipQueue public function Test message is sent immediately.
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.