You are here

Home » API reference » Workbench Email 8 » WorkbenchEmailTestBase.php

abstract class WorkbenchEmailTestBase in Workbench Email 8

Same name and namespace in other branches
  1. 2.x tests/src/Functional/WorkbenchEmailTestBase.php \Drupal\Tests\workbench_email\Functional\WorkbenchEmailTestBase

Defines a base class for workbench email tests.

Hierarchy

Expanded class hierarchy of WorkbenchEmailTestBase

File

tests/src/Functional/WorkbenchEmailTestBase.php, line 21

Namespace

Drupal\Tests\workbench_email\Functional
View source 
abstract class WorkbenchEmailTestBase extends BrowserTestBase {
  use AssertMailTrait;
  use NodeCreationTrait;
  use BlockCreationTrait;

  /**
   * The default theme.
   *
   * @var string
   */
  protected $defaultTheme = 'stark';

  /**
   * Test node type.
   *
   * @var \Drupal\node\NodeTypeInterface
   */
  protected $nodeType;

  /**
   * Approver role.
   *
   * @var \Drupal\user\RoleInterface
   */
  protected $approverRole;

  /**
   * Editor role.
   *
   * @var \Drupal\user\RoleInterface
   */
  protected $editorRole;

  /**
   * Approver 1.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $approver1;

  /**
   * Approver 2.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $approver2;

  /**
   * Approver 3 - blocked.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $approver3;

  /**
   * Approver 4 - no email address.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $approver4;

  /**
   * Editor.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $editor;

  /**
   * Admin.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $admin;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'workbench_email',
    'node',
    'options',
    'user',
    'system',
    'filter',
    'block',
    'field',
  ];

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();

    // Place some blocks.
    $this
      ->placeBlock('local_tasks_block', [
      'id' => 'tabs_block',
    ]);
    $this
      ->placeBlock('page_title_block');
    $this
      ->placeBlock('local_actions_block', [
      'id' => 'actions_block',
    ]);

    // Create two node-types and make them moderated.
    $this->nodeType = NodeType::create([
      'type' => 'test',
      'name' => 'Test',
    ]);
    $this
      ->setupModerationForNodeType($this->nodeType);
    $this->nodeType = NodeType::create([
      'type' => 'another',
      'name' => 'Another Test',
    ]);
    $this
      ->setupModerationForNodeType($this->nodeType);

    // Create an approver role and two users.
    $this->approverRole = $this
      ->drupalCreateRole($this
      ->getApproverPermissions(), 'approver', 'Approver');
    $this->approver1 = $this
      ->drupalCreateUser();
    $this->approver1
      ->addRole('approver');
    $this->approver1
      ->save();
    $this->approver2 = $this
      ->drupalCreateUser();
    $this->approver2
      ->addRole('approver');
    $this->approver2
      ->save();
    $this->approver3 = $this
      ->drupalCreateUser();
    $this->approver3
      ->addRole('approver');
    $this->approver3
      ->block();
    $this->approver3
      ->save();
    $this->approver4 = $this
      ->drupalCreateUser();
    $this->approver4
      ->addRole('approver');
    $this->approver4
      ->setEmail(NULL);
    $this->approver4
      ->save();

    // Create a editor role and user.
    $this->editorRole = $this
      ->drupalCreateRole($this
      ->getEditorPermissions(), 'editor', 'Editor');
    $this->editor = $this
      ->drupalCreateUser();
    $this->editor
      ->addRole('editor');
    $this->editor
      ->save();

    // Create an admin user.
    $this->admin = $this
      ->drupalCreateUser($this
      ->getAdminPermissions());

    // Add an email field notify to the node-type.
    FieldStorageConfig::create([
      'cardinality' => 1,
      'entity_type' => 'node',
      'field_name' => 'field_email',
      'type' => 'email',
    ])
      ->save();
    FieldConfig::create([
      'field_name' => 'field_email',
      'bundle' => 'test',
      'label' => 'Notify',
      'entity_type' => 'node',
    ])
      ->save();
    if (!($entity_form_display = EntityFormDisplay::load('node.test.default'))) {
      $entity_form_display = EntityFormDisplay::create([
        'targetEntityType' => 'node',
        'bundle' => 'test',
        'mode' => 'default',
        'status' => TRUE,
      ]);
    }
    $entity_form_display
      ->setComponent('field_email', [
      'type' => 'email_default',
    ])
      ->save();
  }

  /**
   * Enables moderation for a given node type.
   *
   * @param \Drupal\node\NodeTypeInterface $node_type
   *   Node type to enable moderation for.
   */
  protected abstract function setupModerationForNodeType(NodeTypeInterface $nodeType);

  /**
   * Gets approver permissions.
   *
   * @return array
   *   Permission names.
   */
  protected abstract function getApproverPermissions();

  /**
   * Gets editor permissions.
   *
   * @return array
   *   Permission names.
   */
  protected abstract function getEditorPermissions();

  /**
   * Gets permisisons for admin user.
   *
   * @return array
   *   Permission names.
   */
  protected abstract function getAdminPermissions();

  /**
   * Enables template for given transition or workflow.
   *
   * @return \Drupal\Core\Entity\EntityInterface
   *   Transition or workflow.
   */
  protected abstract function enableTemplateForTransitionOrWorkflow($transition_name, $template_name);

  /**
   * Get submit button title text for transition.
   *
   * @return string
   *   Button title.
   */
  protected abstract function getSubmitButtonTitleForTransition($from_state, $to_state);

  /**
   * Gets additional field data.
   *
   * @param string $from_state
   *   From state.
   * @param string $to_state
   *   To state.
   *
   * @return array
   *   Additional fields.
   */
  protected abstract function getAdditionalFieldsForTransition($from_state, $to_state);

  /**
   * Test administration.
   */
  public function testEndToEnd() {

    // Create some templates as admin.
    // - stuff got approved; and
    // - stuff needs review.
    $this
      ->drupalLogin($this->admin);
    $this
      ->visitAdminMenuParent();
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->clickLink('Email Templates');
    $assert = $this
      ->assertSession();
    $this
      ->assertEquals($this
      ->getSession()
      ->getCurrentUrl(), Url::fromUri('internal:/admin/structure/workbench-moderation/workbench-email-template')
      ->setOption('absolute', TRUE)
      ->toString());
    $assert
      ->pageTextContains('Email Template');
    $page
      ->clickLink('Add Email Template');
    $this
      ->submitForm([
      'id' => 'approved',
      'label' => 'Content approved',
      'body[value]' => 'Content with title [node:title] was approved. You can view it at [node:url].',
      'subject' => 'Content approved: [node:title]',
      'enabled_recipient_types[author]' => TRUE,
      'enabled_recipient_types[email]' => TRUE,
      'enabled_recipient_types[role]' => TRUE,
      'recipient_types[email][settings][fields][node:field_email]' => TRUE,
      'recipient_types[role][settings][roles][editor]' => TRUE,
    ], t('Save'));
    $assert
      ->pageTextContains('Created the Content approved Email Template');
    $page
      ->clickLink('Add Email Template');
    $this
      ->submitForm([
      'id' => 'needs_review',
      'label' => 'Content needs review',
      'body[value]' => 'Content with title [node:title] needs review. You can view it at [node:url].',
      'subject' => 'Content needs review',
      'replyTo' => '[node:author:mail]',
      'enabled_recipient_types[role]' => TRUE,
      'recipient_types[role][settings][roles][approver]' => TRUE,
      'bundles[node:test]' => TRUE,
    ], t('Save'));
    $assert
      ->pageTextContains('Created the Content needs review Email Template');

    // Test dependencies.
    $approver = Template::load('needs_review');
    $dependencies = $approver
      ->calculateDependencies()
      ->getDependencies()['config'];
    $this
      ->assertTrue(in_array('user.role.approver', $dependencies, TRUE));
    $this
      ->assertTrue(in_array('node.type.test', $dependencies, TRUE));
    $approver = Template::load('approved');
    $dependencies = $approver
      ->calculateDependencies()
      ->getDependencies()['config'];
    $this
      ->assertTrue(in_array('field.storage.node.field_email', $dependencies, TRUE));

    // Edit the template and test values persisted.
    $page
      ->clickLink('Content approved');
    $assert
      ->checkboxChecked('Notify (Content)');
    $this
      ->getSession()
      ->back();

    // Test editing a template.
    $page
      ->clickLink('Content needs review');
    $assert
      ->checkboxChecked('Approver', $page
      ->find('css', '#edit-recipient-types-role-settings-roles--wrapper'));
    $this
      ->submitForm([
      'label' => 'Content needs review',
      'body[value]' => 'Content with title [node:title] needs review. You can view it at [node:url].',
      'subject' => 'Content needs review: [node:title]',
      'replyTo' => '[node:author:mail]',
    ], t('Save'));
    $assert
      ->pageTextContains('Saved the Content needs review Email Template');

    // Edit the transition from needs review to published and use the
    // needs_review email template.
    $transitionOrWorkflow = $this
      ->enableTemplateForTransitionOrWorkflow('needs_review_published', 'approved');
    $this
      ->assertEquals($this
      ->getExpectedThirdPartySetting('needs_review_published', 'approved'), $transitionOrWorkflow
      ->getThirdPartySetting('workbench_email', 'workbench_email_templates'));
    $dependencies = $transitionOrWorkflow
      ->calculateDependencies()
      ->getDependencies()['config'];
    $this
      ->assertTrue(in_array('workbench_email.workbench_email_template.approved', $dependencies, TRUE));

    // Edit the transition from draft to needs review and add email config:
    // approver template.
    $this
      ->enableTemplateForTransitionOrWorkflow('draft_needs_review', 'needs_review');

    // Create a node and add to the notifier field.
    $this
      ->drupalLogin($this->editor);
    $this
      ->drupalGet('node/add/test');
    $this
      ->submitForm([
      'title[0][value]' => 'Test node',
      'field_email[0][value]' => 'foo@example.com',
    ] + $this
      ->getAdditionalFieldsForTransition('draft', 'draft'), $this
      ->getSubmitButtonTitleForTransition('draft', 'draft'));
    $node = $this
      ->getNodeByTitle('Test node');

    // Transition to needs review.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');

    // Reset collected email.
    $this->container
      ->get('state')
      ->set('system.test_mail_collector', []);
    $this
      ->submitForm([] + $this
      ->getAdditionalFieldsForTransition('draft', 'needs_review'), $this
      ->getSubmitButtonTitleForTransition('draft', 'needs_review'));
    $this
      ->assertNeedsReviewNotifications($node);

    // Now try again going straight to needs review (no draft).
    // Reset collected email.
    $this->container
      ->get('state')
      ->set('system.test_mail_collector', []);

    // Create a node and add to the notifier field.
    $this
      ->drupalGet('node/add/test');
    $this
      ->submitForm([
      'title[0][value]' => 'Test node 2',
    ] + $this
      ->getAdditionalFieldsForTransition('draft', 'needs_review'), $this
      ->getSubmitButtonTitleForTransition('draft', 'needs_review'));
    $node2 = $this
      ->getNodeByTitle('Test node 2');
    $this
      ->assertNeedsReviewNotifications($node2);

    // Login as approver and transition to approved.
    $this->container
      ->get('state')
      ->set('system.test_mail_collector', []);
    $this
      ->drupalLogin($this->approver1);
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->submitForm([] + $this
      ->getAdditionalFieldsForTransition('needs_review', 'published'), $this
      ->getSubmitButtonTitleForTransition('needs_review', 'published'));

    // Check mail goes to author and notifier.
    $captured_emails = $this->container
      ->get('state')
      ->get('system.test_mail_collector') ?: [];
    $last = end($captured_emails);
    $prev = prev($captured_emails);
    $mails = [
      $last['to'],
      $prev['to'],
    ];
    sort($mails);
    $expected = [
      $this->editor
        ->getEmail(),
      'foo@example.com',
    ];
    sort($expected);
    $this
      ->assertEquals($expected, $mails);
    $this
      ->assertEquals(sprintf('Content approved: %s', $node
      ->getTitle()), $last['subject']);
    $this
      ->assertEquals(sprintf('Content approved: %s', $node
      ->getTitle()), $prev['subject']);
    $this
      ->assertStringContainsString(sprintf('Content with title %s was approved. You can view it at', $node
      ->label()), preg_replace('/\\s+/', ' ', $prev['body']));
    $this
      ->assertStringContainsString(sprintf('Content with title %s was approved. You can view it at', $node
      ->label()), preg_replace('/\\s+/', ' ', $last['body']));
    $this
      ->assertStringContainsString($node
      ->toUrl('canonical', [
      'absolute' => TRUE,
    ])
      ->toString(), preg_replace('/\\s+/', ' ', $prev['body']));
    $this
      ->assertStringContainsString($node
      ->toUrl('canonical', [
      'absolute' => TRUE,
    ])
      ->toString(), preg_replace('/\\s+/', ' ', $last['body']));

    // Test again with node that was previously published.
    // Log back in as editor.
    $this
      ->drupalLogin($this->editor);
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->submitForm([] + $this
      ->getAdditionalFieldsForTransition('published', 'draft'), $this
      ->getSubmitButtonTitleForTransition('published', 'draft'));

    // And now request a review.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');

    // Reset collected email.
    $this->container
      ->get('state')
      ->set('system.test_mail_collector', []);
    $this
      ->submitForm([] + $this
      ->getAdditionalFieldsForTransition('draft', 'needs_review'), $this
      ->getSubmitButtonTitleForTransition('draft', 'needs_review'));
    $this
      ->assertNeedsReviewNotifications($node);

    // Try with the other node type, that isn't enabled.
    $this->container
      ->get('state')
      ->set('system.test_mail_collector', []);
    $this
      ->drupalGet('node/add/another');
    $this
      ->submitForm([
      'title[0][value]' => 'Another test node',
    ] + $this
      ->getAdditionalFieldsForTransition('draft', 'draft'), $this
      ->getSubmitButtonTitleForTransition('draft', 'draft'));
    $node = $this
      ->getNodeByTitle('Another test node');

    // Transition to needs review.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->submitForm([] + $this
      ->getAdditionalFieldsForTransition('draft', 'needs_review'), $this
      ->getSubmitButtonTitleForTransition('draft', 'needs_review'));

    // No mail should be sent.
    $captured_emails = $this->container
      ->get('state')
      ->get('system.test_mail_collector') ?: [];
    $this
      ->assertEmpty($captured_emails);
  }

  /**
   * Visits admin parent menu link.
   */
  protected abstract function visitAdminMenuParent();

  /**
   * Gets expected third party settings.
   *
   * @param string $transition_name
   *   Transition name.
   * @param string $template
   *   Template ID.
   *
   * @return array
   *   Expected settings.
   */
  protected abstract function getExpectedThirdPartySetting($transition_name, $template);

  /**
   * Assert notifications sent for needs review.
   *
   * @param \Drupal\node\NodeInterface $node
   *   Node updated.
   */
  protected function assertNeedsReviewNotifications(NodeInterface $node) {

    // Check mail goes to approvers.
    $captured_emails = $this->container
      ->get('state')
      ->get('system.test_mail_collector') ?: [];

    // Should only be two emails.
    $this
      ->assertCount(2, $captured_emails);
    $last = end($captured_emails);
    $prev = prev($captured_emails);
    $mails = [
      $last['to'],
      $prev['to'],
    ];
    sort($mails);
    $expected = [
      $this->approver1
        ->getEmail(),
      $this->approver2
        ->getEmail(),
    ];
    sort($expected);
    $this
      ->assertEquals($expected, $mails);
    $this
      ->assertEquals(sprintf('Content needs review: %s', $node
      ->getTitle()), $last['subject']);
    $this
      ->assertEquals(sprintf('Content needs review: %s', $node
      ->getTitle()), $prev['subject']);
    $this
      ->assertEquals($this->editor
      ->getEmail(), $last['reply-to']);
    $this
      ->assertEquals($this->editor
      ->getEmail(), $prev['reply-to']);
    $this
      ->assertStringContainsString(sprintf('Content with title %s needs review. You can view it at', $node
      ->label()), preg_replace('/\\s+/', ' ', $prev['body']));
    $this
      ->assertStringContainsString(sprintf('Content with title %s needs review. You can view it at', $node
      ->label()), preg_replace('/\\s+/', ' ', $last['body']));
    $this
      ->assertStringContainsString($node
      ->toUrl('canonical', [
      'absolute' => TRUE,
    ])
      ->toString(), preg_replace('/\\s+/', ' ', $prev['body']));
    $this
      ->assertStringContainsString($node
      ->toUrl('canonical', [
      'absolute' => TRUE,
    ])
      ->toString(), preg_replace('/\\s+/', ' ', $last['body']));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
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::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
AssertMailTrait::assertMail protected function Asserts that the most recently sent email message has the given value.
AssertMailTrait::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
AssertMailTrait::assertMailString protected function Asserts that the most recently sent email message has the string in it.
AssertMailTrait::getMails protected function Gets an array containing all emails sent during this test case.
AssertMailTrait::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title.
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
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.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
WorkbenchEmailTestBase::$admin protected property Admin.
WorkbenchEmailTestBase::$approver1 protected property Approver 1.
WorkbenchEmailTestBase::$approver2 protected property Approver 2.
WorkbenchEmailTestBase::$approver3 protected property Approver 3 - blocked.
WorkbenchEmailTestBase::$approver4 protected property Approver 4 - no email address.
WorkbenchEmailTestBase::$approverRole protected property Approver role.
WorkbenchEmailTestBase::$defaultTheme protected property The default theme. Overrides BrowserTestBase::$defaultTheme
WorkbenchEmailTestBase::$editor protected property Editor.
WorkbenchEmailTestBase::$editorRole protected property Editor role.
WorkbenchEmailTestBase::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules 2
WorkbenchEmailTestBase::$nodeType protected property Test node type.
WorkbenchEmailTestBase::assertNeedsReviewNotifications protected function Assert notifications sent for needs review.
WorkbenchEmailTestBase::enableTemplateForTransitionOrWorkflow abstract protected function Enables template for given transition or workflow. 2
WorkbenchEmailTestBase::getAdditionalFieldsForTransition abstract protected function Gets additional field data. 2
WorkbenchEmailTestBase::getAdminPermissions abstract protected function Gets permisisons for admin user. 2
WorkbenchEmailTestBase::getApproverPermissions abstract protected function Gets approver permissions. 2
WorkbenchEmailTestBase::getEditorPermissions abstract protected function Gets editor permissions. 2
WorkbenchEmailTestBase::getExpectedThirdPartySetting abstract protected function Gets expected third party settings. 2
WorkbenchEmailTestBase::getSubmitButtonTitleForTransition abstract protected function Get submit button title text for transition. 2
WorkbenchEmailTestBase::setUp public function Overrides BrowserTestBase::setUp
WorkbenchEmailTestBase::setupModerationForNodeType abstract protected function Enables moderation for a given node type. 2
WorkbenchEmailTestBase::testEndToEnd public function Test administration.
WorkbenchEmailTestBase::visitAdminMenuParent abstract protected function Visits admin parent menu link. 2
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.