You are here

Home » API reference » Site Alert 8 » CliCommandsTest.php

class CliCommandsTest in Site Alert 8

Tests for the site alert CLI Commands service.

@group site_alert @coversDefaultClass \Drupal\site_alert\CliCommands

Hierarchy

Expanded class hierarchy of CliCommandsTest

File

tests/src/Kernel/CliCommandsTest.php, line 15

Namespace

Drupal\Tests\site_alert\Kernel
View source 
class CliCommandsTest extends SiteAlertKernelTestBase {
  use SiteAlertTestTrait;

  /**
   * The service to execute CLI commands. This is the system under test.
   *
   * @var \Drupal\site_alert\CliCommandsInterface
   */
  protected $cliCommands;

  /**
   * The site alert entity storage handler.
   *
   * @var \Drupal\site_alert\SiteAlertStorageInterface
   */
  protected $siteAlertStorage;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->siteAlertStorage = $this->entityTypeManager
      ->getStorage('site_alert');
    $this->cliCommands = $this->container
      ->get('site_alert.cli_commands');
  }

  /**
   * Test site alert creation with message and severity.
   *
   * @covers ::create
   */
  public function testCreateSiteAlert() : void {

    // Create a simple alert with a message, and a severity.
    $label = 'phpunit_test_create';
    $message = "A nice bit of message here.";
    $severity = 'low';
    $options = [
      'severity' => $severity,
    ];
    $this->cliCommands
      ->create($label, $message, $options);

    // Check that the created alert contains the expected data.
    $site_alert = $this
      ->loadAlertByLabel($label);
    $this
      ->assertAlert($site_alert, $label, $message, $severity, TRUE);
  }

  /**
   * Test site alert creation with severity and scheduling options.
   *
   * @param string|null $severity
   *   Optional severity.
   * @param string|null $start
   *   Optional start time.
   * @param string|null $end
   *   Optional end time.
   *
   * @covers ::create
   * @dataProvider createSiteAlertWithOptionsProvider
   */
  public function testCreateSiteAlertWithOptions(?string $severity, ?string $start = NULL, ?string $end = NULL) : void {

    // Create a simple alert with a message, and a severity.
    $label = 'phpunit_test_create';
    $message = "A nice bit of message here.";
    $severity = 'low';
    $start = '2022-09-12T15:30:01';
    $end = '2022-09-13T15:45:01';
    $options = [
      'severity' => $severity,
      'start' => $start,
      'end' => $end,
    ];
    $this->cliCommands
      ->create($label, $message, $options);

    // Check that the created alert contains the expected data.
    $expected_severity = $severity ?? 'medium';
    $site_alert = $this
      ->loadAlertByLabel($label);
    $this
      ->assertAlert($site_alert, $label, $message, $expected_severity, TRUE, $options);
  }

  /**
   * Data provider for ::testCreateSiteAlertWithOptions().
   *
   * @return array
   *   An array of test cases, each test case an array with the following
   *   elements:
   *   - An optional severity.
   *   - An optional start time.
   *   - An optional end time.
   */
  public function createSiteAlertWithOptionsProvider() : array {
    return [
      [
        'low',
        '2022-09-12T15:30:01',
        '2022-09-13T15:45:01',
      ],
      [
        NULL,
        '2022-09-12T15:30:01',
        '2022-09-13T15:45:01',
      ],
      [
        'medium',
        NULL,
        '2022-09-13T15:45:01',
      ],
      [
        'high',
        '2022-09-12T15:30:01',
        NULL,
      ],
      [
        NULL,
        NULL,
        '2022-09-13T15:45:01',
      ],
      [
        NULL,
        '2022-09-12T15:30:01',
        NULL,
      ],
      [
        'low',
        NULL,
        NULL,
      ],
      [
        NULL,
        NULL,
        NULL,
      ],
    ];
  }

  /**
   * Test site alert delete.
   *
   * @covers ::delete
   */
  public function testDeleteSiteAlert() : void {

    // Create a simple alert with a message, and a severity.
    $label = 'phpunit_test_delete';
    $message = "A nice bit of message here.";
    $options = [
      'severity' => 'low',
    ];
    $this->cliCommands
      ->create($label, $message, $options);

    // Delete should result in at least one removal.
    $result = $this->cliCommands
      ->delete($label);
    $this
      ->assertGreaterThan(0, $result);

    // If it was deleted, there should be no more found.
    $siteAlerts = $this
      ->loadAlertsByLabel($label);
    $this
      ->assertCount(0, $siteAlerts);
  }

  /**
   * Checks that invalid combinations of parameters throw an exception.
   *
   * @covers ::disable
   */
  public function testDisableSiteAlertValidation() : void {
    $this
      ->expectException(\InvalidArgumentException::class);
    $this->cliCommands
      ->disable('some-non-existing-site-alert');
  }

  /**
   * Checks that a site alert can be disabled by passing the label.
   *
   * @covers ::disable
   */
  public function testDisableSiteAlertByLabel() : void {

    // Create an active alert.
    $label = 'phpunit_test_disable';
    $message = 'This alert is active, for now.';
    $this->cliCommands
      ->create($label, $message, []);

    // There should be 1 active alert.
    $this
      ->assertActiveAlertCount(1);

    // Disable the alert. This should return the number of alerts that were
    // disabled.
    $count = $this->cliCommands
      ->disable('phpunit_test_disable');
    $this
      ->assertEquals(1, $count);
    $this
      ->assertActiveAlertCount(0);

    // Try to disable the alert again. This should throw an exception indicating
    // that no alerts were disabled.
    $this
      ->expectException(\InvalidArgumentException::class);
    $this
      ->expectExceptionMessage("No active site alerts found with the label 'phpunit_test_disable'.");
    $this->cliCommands
      ->disable('phpunit_test_disable');
  }

  /**
   * Checks that all site alerts can be disabled by passing the 'all' option.
   *
   * @covers ::disable
   */
  public function testDisableAllSiteAlerts() : void {

    // Create a range of active and inactive alerts.
    $alerts = [
      [
        'phpunit_test_disable_1',
        'An active alert',
        [],
      ],
      [
        'phpunit_test_disable_2',
        'Another active alert',
        [],
      ],
      [
        'phpunit_test_disable_3',
        'An inactive alert',
        [
          'active' => FALSE,
        ],
      ],
    ];
    foreach ($alerts as [
      $label,
      $message,
      $options,
    ]) {
      $this->cliCommands
        ->create($label, $message, $options);
    }

    // There should be 2 active alerts.
    $this
      ->assertActiveAlertCount(2);

    // Disable all alerts. This should return the number of alerts that were
    // disabled.
    $count = $this->cliCommands
      ->disable(NULL, [
      'all' => TRUE,
    ]);
    $this
      ->assertEquals(2, $count);
    $this
      ->assertActiveAlertCount(0);

    // Try to disable all alerts again. This should return 0 indicating that no
    // alerts were disabled.
    $count = $this->cliCommands
      ->disable(NULL, [
      'all' => TRUE,
    ]);
    $this
      ->assertEquals(0, $count);
    $this
      ->assertActiveAlertCount(0);
  }

  /**
   * Checks that invalid combinations of parameters throw an exception.
   *
   * @covers ::enable
   */
  public function testEnableSiteAlertValidation() : void {
    $this
      ->expectException(\InvalidArgumentException::class);
    $this->cliCommands
      ->enable('some-non-existing-site-alert');
  }

  /**
   * Checks that a site alert can be enabled by passing the label.
   *
   * @covers ::enable
   */
  public function testEnableSiteAlertByLabel() : void {

    // Create an inactive alert.
    $label = 'phpunit_test_enable';
    $message = 'This alert is not yet active.';
    $this->cliCommands
      ->create($label, $message, [
      'active' => FALSE,
    ]);

    // There should be 1 inactive alert.
    $this
      ->assertInactiveAlertCount(1);

    // Enable the alert. This should return the number of alerts that were
    // enabled.
    $count = $this->cliCommands
      ->enable('phpunit_test_enable');
    $this
      ->assertEquals(1, $count);
    $this
      ->assertActiveAlertCount(1);
    $this
      ->assertInactiveAlertCount(0);

    // Try to enable the alert again. This should throw an exception indicating
    // that no alerts were enabled.
    $this
      ->expectException(\InvalidArgumentException::class);
    $this
      ->expectExceptionMessage("No inactive site alerts found with the label 'phpunit_test_enable'.");
    $this->cliCommands
      ->enable('phpunit_test_enable');
  }

}

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
CliCommandsTest::$cliCommands protected property The service to execute CLI commands. This is the system under test.
CliCommandsTest::$siteAlertStorage protected property The site alert entity storage handler.
CliCommandsTest::createSiteAlertWithOptionsProvider public function Data provider for ::testCreateSiteAlertWithOptions().
CliCommandsTest::setUp protected function Overrides SiteAlertKernelTestBase::setUp
CliCommandsTest::testCreateSiteAlert public function Test site alert creation with message and severity.
CliCommandsTest::testCreateSiteAlertWithOptions public function Test site alert creation with severity and scheduling options.
CliCommandsTest::testDeleteSiteAlert public function Test site alert delete.
CliCommandsTest::testDisableAllSiteAlerts public function Checks that all site alerts can be disabled by passing the 'all' option.
CliCommandsTest::testDisableSiteAlertByLabel public function Checks that a site alert can be disabled by passing the label.
CliCommandsTest::testDisableSiteAlertValidation public function Checks that invalid combinations of parameters throw an exception.
CliCommandsTest::testEnableSiteAlertByLabel public function Checks that a site alert can be enabled by passing the label.
CliCommandsTest::testEnableSiteAlertValidation public function Checks that invalid combinations of parameters throw an exception.
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.
SiteAlertKernelTestBase::$alerts protected property Test site alert entities.
SiteAlertKernelTestBase::$entityTypeManager protected property The entity type manager.
SiteAlertKernelTestBase::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
SiteAlertKernelTestBase::createAlerts protected function Creates site alert entities for the given identifiers.
SiteAlertTestTrait::assertActiveAlertCount protected function Checks that the database contains the expected number of active alerts.
SiteAlertTestTrait::assertAlert protected function Checks that the given site alert entity contains the given data.
SiteAlertTestTrait::assertAlertByLabel protected function Checks that the site alert with the given label contains the given data.
SiteAlertTestTrait::assertAlertCount protected function Checks that the database contains the expected number of alerts.
SiteAlertTestTrait::assertInactiveAlertCount protected function Checks that the database contains the expected number of inactive alerts.
SiteAlertTestTrait::getAlertCount protected function Returns the number of alerts with the given active status.
SiteAlertTestTrait::loadAlertByLabel protected function Returns the site alert with the given label.
SiteAlertTestTrait::loadAlertsByLabel protected function Returns all site alerts with a matching label.
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.