AdminSettingsTest.php in Sparkpost email 8.2

Namespace

Drupal\Tests\sparkpost\Functional

File

tests/src/Functional/AdminSettingsTest.php

<?php

namespace Drupal\Tests\sparkpost\Functional;

use Drupal\Tests\BrowserTestBase;

/**
 * Test basic functionality.
 *
 * @group sparkpost
 */
class AdminSettingsTest extends BrowserTestBase {

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'sparkpost',
  ];

  /**
   * Regular user.
   *
   * @var false|object
   */
  protected $user;

  /**
   * Admin user.
   *
   * @var false|object
   */
  protected $admin;

  /**
   * {@inheritdoc}
   */
  public function setUp() : void {
    parent::setUp();
    $this->user = $this
      ->drupalCreateUser();
    $this->admin = $this
      ->drupalCreateUser([
      'administer sparkpost',
    ]);
  }

  /**
   * Access admin pages.
   */
  public function testAdminAccess() {
    $this
      ->drupalLogin($this->user);

    // Try access sparkpost admin form.
    $this
      ->drupalGet('admin/config/services/sparkpost');
    $this
      ->assertSession()
      ->statusCodeEquals(403);

    // Try access test form.
    $this
      ->drupalGet('admin/config/services/sparkpost/test');
    $this
      ->assertSession()
      ->statusCodeEquals(403);

    // Login as admin.
    $this
      ->drupalLogout();
    $this
      ->drupalLogin($this->admin);

    // Try access sparkpost admin form.
    $this
      ->drupalGet('admin/config/services/sparkpost');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Try access test form.
    $this
      ->drupalGet('admin/config/services/sparkpost/test');
    $this
      ->assertSession()
      ->statusCodeEquals(403);

    // Set dummy access key.
    \Drupal::configFactory()
      ->getEditable('sparkpost.settings')
      ->set('api_key', 'API_KEY')
      ->save();

    // Try access test form.
    $this
      ->drupalGet('admin/config/services/sparkpost/test');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
  }

  /**
   * Test that queue is not processed on cron, if indicated by settings.
   */
  public function testSkipQueueOnCron() {
    \Drupal::configFactory()
      ->getEditable('sparkpost.settings')
      ->set('skip_cron', FALSE)
      ->set('async', TRUE)
      ->save();

    /** @var \Drupal\Core\Queue\QueueInterface $queue */
    $queue = \Drupal::queue('sparkpost_send');

    // Create a dummy item.
    $queue
      ->createItem($this
      ->createDummyMessage());
    self::assertEquals($queue
      ->numberOfItems(), 1);

    // Run cron.

    /** @var \Drupal\Core\Cron $cron */
    $cron = \Drupal::service('cron');
    $cron
      ->run();

    // Should have processed the item.
    self::assertEquals($queue
      ->numberOfItems(), 0);
    \Drupal::configFactory()
      ->getEditable('sparkpost.settings')
      ->set('skip_cron', TRUE)
      ->save();

    // We also need to clear the cache.
    \Drupal::service('plugin.cache_clearer')
      ->clearCachedDefinitions();
    $queue
      ->createItem($this
      ->createDummyMessage());
    self::assertEquals($queue
      ->numberOfItems(), 1);

    // Run cron.
    $cron
      ->run();

    // Should not have processed the item.
    self::assertEquals($queue
      ->numberOfItems(), 1);
  }

  /**
   * Helper to create a dummy message.
   *
   * @return \Drupal\sparkpost\MessageWrapperInterface
   *   The message wrapper
   */
  private function createDummyMessage() {

    /** @var \Drupal\sparkpost\MessageWrapperInterface $message */
    $message = \Drupal::service('sparkpost.message_wrapper');
    $message
      ->setDrupalMessage([]);
    $message
      ->setSparkpostMessage([]);
    return $message;
  }

}

Classes

Name	Description
AdminSettingsTest	Test basic functionality.