You are here

class AjaxCommentsFunctionalTest in AJAX Comments 8

Javascript functional tests for ajax comments.

@group ajax_comments

Hierarchy

Expanded class hierarchy of AjaxCommentsFunctionalTest

File

tests/src/FunctionalJavascript/AjaxCommentsFunctionalTest.php, line 19

Namespace

Drupal\Tests\ajax_comments\FunctionalJavascript
View source
class AjaxCommentsFunctionalTest extends WebDriverTestBase {
  use CommentTestTrait;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'system',
    'ajax_comments',
    'node',
    'comment',
    'editor',
    'ckeditor',
    'filter',
  ];

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

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->entityTypeManager = $this->container
      ->get('entity_type.manager');

    // Ensure an `article` node type exists.
    $this
      ->drupalCreateContentType([
      'type' => 'article',
    ]);
    $this
      ->addDefaultCommentField('node', 'article');
    $comment_field = $this->entityTypeManager
      ->getStorage('field_config')
      ->load('node.article.comment');
    $comment_field
      ->setSetting('per_page', 10);
    $comment_field
      ->save();

    // Enable ajax comments on the comment field.
    $entity_view_display = EntityViewDisplay::load('node.article.default');
    $renderer = $entity_view_display
      ->getRenderer('comment');
    $renderer
      ->setThirdPartySetting('ajax_comments', 'enable_ajax_comments', '1');
    $entity_view_display
      ->save();
  }

  /**
   * Tests that comments can be posted and edited over ajax without errors.
   */
  public function testCommentPosting() {

    // Enable CKEditor.
    $format = $this
      ->randomMachineName();
    FilterFormat::create([
      'format' => $format,
      'name' => $this
        ->randomString(),
      'weight' => 1,
      'filters' => [],
    ])
      ->save();
    $settings['toolbar']['rows'] = [
      [
        [
          'name' => 'Links',
          'items' => [
            'DrupalLink',
            'DrupalUnlink',
          ],
        ],
      ],
    ];
    $editor = Editor::create([
      'format' => $format,
      'editor' => 'ckeditor',
    ]);
    $editor
      ->setSettings($settings);
    $editor
      ->save();
    $admin_user = $this
      ->drupalCreateUser([
      'access content',
      'access comments',
      // Usernames aren't shown in comment edit form autocomplete unless this
      // permission is granted.
      'access user profiles',
      'administer comments',
      'edit own comments',
      'post comments',
      'skip comment approval',
      'use text format ' . $format,
    ]);
    $this
      ->drupalLogin($admin_user);
    $node = $this
      ->drupalCreateNode([
      'type' => 'article',
      'comment' => CommentItemInterface::OPEN,
    ]);
    $this
      ->drupalGet($node
      ->toUrl());

    // Set up JavaScript to track errors.
    $onerror_javascript = <<<JS
    (function (){
      window.jsErrors = [];
      window.onerror = function (message, source, lineno, colno, error) {
        window.jsErrors.push(error);
      }
    }());
JS;
    $this
      ->getSession()
      ->executeScript($onerror_javascript);
    $page = $this
      ->getSession()
      ->getPage();

    // Post comments through ajax.
    for ($i = 0; $i < 11; $i++) {
      $comment_body_id = $page
        ->findField('comment_body[0][value]')
        ->getAttribute('id');
      $count = $i + 1;
      $ckeditor_javascript = <<<JS
    (function (){
      CKEDITOR.instances['{<span class="php-variable">$comment_body_id</span>}'].setData('New comment {<span class="php-variable">$count</span>}');
    }());
JS;
      $this
        ->getSession()
        ->executeScript($ckeditor_javascript);
      $page
        ->pressButton('Save');
      $this
        ->assertSession()
        ->assertWaitOnAjaxRequest(20000);
    }

    // Export the updated content of the page.
    if ($this->htmlOutputEnabled) {
      $out = $page
        ->getContent();
      $this
        ->htmlOutput($out);
    }
    $this
      ->assertSession()
      ->pageTextContains('Your comment has been posted.');
    $this
      ->assertSession()
      ->pageTextContains('New comment 1');
    $this
      ->assertSession()
      ->pageTextContains('New comment 2');
    $current_url = $this
      ->getSession()
      ->getCurrentUrl();
    $parts = parse_url($current_url);
    $path = empty($parts['path']) ? '/' : $parts['path'];
    $current_path = preg_replace('/^\\/[^\\.\\/]+\\.php\\//', '/', $path);
    $this
      ->assertSession()
      ->linkByHrefExists($current_path . '?page=1');
    $javascript_assertion = <<<JS
    (function () {
      return window.jsErrors.length === 0;
    }());
JS;
    $this
      ->assertJsCondition($javascript_assertion);

    // Using prepareRequest() followed by refreshVariables() seems to help
    // refresh the route permissions for the ajax_comments.update route.
    $this
      ->prepareRequest();
    $this
      ->refreshVariables();

    // Test updating a comment through ajax.
    $this
      ->clickLink('Edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest(20000);
    $comment_body_id = $page
      ->find('css', 'form.ajax-comments-form-edit textarea')
      ->getAttribute('id');
    $ckeditor_javascript = <<<JS
    (function (){
      CKEDITOR.instances['{<span class="php-variable">$comment_body_id</span>}'].setData('Updated comment');
    }());
JS;
    $this
      ->getSession()
      ->executeScript($ckeditor_javascript);
    if ($this->htmlOutputEnabled) {
      $out = $page
        ->getContent();
      $html_output = $out . '<hr />' . $this
        ->getHtmlOutputHeaders();
      $this
        ->htmlOutput($html_output);
    }

    // Save the edits to the comment.
    $this
      ->refreshVariables();
    $save_button = $page
      ->find('css', 'form.ajax-comments-form-edit input[value=Save]');
    $this
      ->assertTrue(!empty($save_button));
    $save_button
      ->press();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest(20000);
    if ($this->htmlOutputEnabled) {
      $out = $page
        ->getContent();
      $html_output = $out . '<hr />' . $this
        ->getHtmlOutputHeaders();
      $this
        ->htmlOutput($html_output);
    }
    $this
      ->assertSession()
      ->pageTextContains('Updated comment');
    $this
      ->assertJsCondition($javascript_assertion);

    // Test the cancel button.
    $this
      ->clickLink('Edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest(20000);
    $this
      ->assertSession()
      ->elementExists('css', 'form.ajax-comments-form-edit');
    if ($this->htmlOutputEnabled) {
      $out = $page
        ->getContent();
      $html_output = $out . '<hr />' . $this
        ->getHtmlOutputHeaders();
      $this
        ->htmlOutput($html_output);
    }
    $cancel_button = $page
      ->find('css', 'form.ajax-comments-form-edit input[value=Cancel]');
    $this
      ->assertTrue(!empty($cancel_button));
    $cancel_button
      ->press();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest(20000);
    if ($this->htmlOutputEnabled) {
      $out = $page
        ->getContent();
      $html_output = $out . '<hr />' . $this
        ->getHtmlOutputHeaders();
      $this
        ->htmlOutput($html_output);
    }

    // Test replying to a comment.
    $this
      ->clickLink('Reply');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest(20000);
    $comment_body_id = $page
      ->find('css', 'form.ajax-comments-form-reply textarea')
      ->getAttribute('id');
    $ckeditor_javascript = <<<JS
    (function (){
      CKEDITOR.instances['{<span class="php-variable">$comment_body_id</span>}'].setData('Comment reply');
    }());
JS;
    $this
      ->getSession()
      ->executeScript($ckeditor_javascript);
    if ($this->htmlOutputEnabled) {
      $out = $page
        ->getContent();
      $html_output = $out . '<hr />' . $this
        ->getHtmlOutputHeaders();
      $this
        ->htmlOutput($html_output);
    }
    $save_button = $page
      ->find('css', 'form.ajax-comments-form-reply input[value=Save]');
    $this
      ->assertTrue(!empty($save_button));
    $save_button
      ->press();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest(20000);
    if ($this->htmlOutputEnabled) {
      $out = $page
        ->getContent();
      $html_output = $out . '<hr />' . $this
        ->getHtmlOutputHeaders();
      $this
        ->htmlOutput($html_output);
    }
    $this
      ->assertSession()
      ->pageTextContains('Comment reply');
    $this
      ->assertJsCondition($javascript_assertion);

    // Test deleting a comment.
    $delete_link = $page
      ->findLink('Delete');
    $this
      ->assertTrue(!empty($delete_link));
    $delete_url = $delete_link
      ->getAttribute('href');
    $this
      ->assertTrue(!empty($delete_url));

    // Get the comment ID (in $matches[1]).
    preg_match('/comment\\/(.+)\\/delete/i', $delete_url, $matches);
    $this
      ->assertTrue(isset($matches[1]));
    $comment_to_delete = Comment::load($matches[1]);
    $comment_to_delete_body = $comment_to_delete
      ->get('comment_body')->value;
    $delete_form = $this->container
      ->get('entity_type.manager')
      ->getFormObject($comment_to_delete
      ->getEntityTypeId(), 'delete');
    $delete_form
      ->setEntity($comment_to_delete);

    // The delete confirmation question has tags stripped and is truncated
    // in the modal dialog box.
    $confirm_question = substr(strip_tags($delete_form
      ->getQuestion()), 0, 50);
    $delete_link
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest(20000);
    if ($this->htmlOutputEnabled) {
      $out = $page
        ->getContent();
      $html_output = $out . '<hr />' . $this
        ->getHtmlOutputHeaders();
      $this
        ->htmlOutput($html_output);
    }
    $this
      ->assertSession()
      ->pageTextContains($confirm_question);
    $delete_button = $page
      ->find('css', '.ui-dialog button.button--primary.js-form-submit');
    $this
      ->assertTrue(!empty($delete_button));
    $delete_button
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest(20000);
    if ($this->htmlOutputEnabled) {
      $out = $page
        ->getContent();
      $html_output = $out . '<hr />' . $this
        ->getHtmlOutputHeaders();
      $this
        ->htmlOutput($html_output);
    }
    $this
      ->assertSession()
      ->pageTextNotContains($comment_to_delete_body);
    $this
      ->assertJsCondition($javascript_assertion);

    // Test removing the role's permission to post comments.

    /** @var \Drupal\user\RoleInterface[] $roles */
    $roles = Role::loadMultiple($admin_user
      ->getRoles());
    foreach ($roles as $role) {
      $role
        ->revokePermission('post comments');
      $role
        ->trustData()
        ->save();
    }

    // Now try to submit a new comment. We haven't reloaded the page after
    // changing permissions, so the comment field should still be visible.
    $comment_body_id = $page
      ->findField('comment_body[0][value]')
      ->getAttribute('id');
    $ckeditor_javascript = <<<JS
    (function (){
      CKEDITOR.instances['{<span class="php-variable">$comment_body_id</span>}'].setData('This should fail.');
    }());
JS;
    $this
      ->getSession()
      ->executeScript($ckeditor_javascript);
    $page
      ->pressButton('Save');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest(20000);

    // Confirm that the new comment does not appear.
    $this
      ->assertSession()
      ->pageTextNotContains('This should fail.');

    // Confirm that the error message DOES appear.
    $this
      ->assertSession()
      ->pageTextContains('You do not have permission to post a comment.');
    if ($this->htmlOutputEnabled) {
      $out = $page
        ->getContent();
      $html_output = $out . '<hr />' . $this
        ->getHtmlOutputHeaders();
      $this
        ->htmlOutput($html_output);
    }

    // Restore the user's permission to post comments, and reload the page
    // so that the reply links are visible.

    /** @var \Drupal\user\RoleInterface[] $roles */
    $roles = Role::loadMultiple($admin_user
      ->getRoles());
    foreach ($roles as $role) {
      $role
        ->grantPermission('post comments');
      $role
        ->trustData()
        ->save();
    }

    // Reload the page.
    $this
      ->drupalGet($node
      ->toUrl());

    // Revoke the user's permission to post comments, again.

    /** @var \Drupal\user\RoleInterface[] $roles */
    $roles = Role::loadMultiple($admin_user
      ->getRoles());
    foreach ($roles as $role) {
      $role
        ->revokePermission('post comments');
      $role
        ->trustData()
        ->save();
    }

    // Click the link to reply to a comment. The link should still be present,
    // because we haven't reloaded the page since revoking the user's
    // permission.
    $reply_link = $page
      ->findLink('Reply');
    $reply_link
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest(20000);
    if ($this->htmlOutputEnabled) {
      $out = $page
        ->getContent();
      $html_output = $out . '<hr />' . $this
        ->getHtmlOutputHeaders();
      $this
        ->htmlOutput($html_output);
    }

    // Confirm that the error message appears.
    $this
      ->assertSession()
      ->pageTextContains('You do not have permission to post a comment.');

    // Again, restore the user's permission to post comments, and
    // reload the page so that the reply links are visible.

    /** @var \Drupal\user\RoleInterface[] $roles */
    $roles = Role::loadMultiple($admin_user
      ->getRoles());
    foreach ($roles as $role) {
      $role
        ->grantPermission('post comments');
      $role
        ->trustData()
        ->save();
    }

    // Reload the page.
    $this
      ->drupalGet($node
      ->toUrl());

    // Click the link to reply to a comment.
    $reply_link = $page
      ->findLink('Reply');
    $reply_link
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest(20000);

    // The reply form should load. Enter a comment in the reply field.
    $comment_body_id = $page
      ->find('css', 'form.ajax-comments-form-reply textarea')
      ->getAttribute('id');
    $ckeditor_javascript = <<<JS
    (function (){
      CKEDITOR.instances['{<span class="php-variable">$comment_body_id</span>}'].setData('This reply should fail.');
    }());
JS;
    $this
      ->getSession()
      ->executeScript($ckeditor_javascript);
    if ($this->htmlOutputEnabled) {
      $out = $page
        ->getContent();
      $html_output = $out . '<hr />' . $this
        ->getHtmlOutputHeaders();
      $this
        ->htmlOutput($html_output);
    }

    // Revoke the user's permission to post comments without reloading the page.

    /** @var \Drupal\user\RoleInterface[] $roles */
    $roles = Role::loadMultiple($admin_user
      ->getRoles());
    foreach ($roles as $role) {
      $role
        ->revokePermission('post comments');
      $role
        ->trustData()
        ->save();
    }

    // Now try to click the 'Save' button on the reply form.
    $save_button = $page
      ->find('css', 'form.ajax-comments-form-reply input[value=Save]');
    $this
      ->assertTrue(!empty($save_button));
    $save_button
      ->press();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest(20000);
    if ($this->htmlOutputEnabled) {
      $out = $page
        ->getContent();
      $html_output = $out . '<hr />' . $this
        ->getHtmlOutputHeaders();
      $this
        ->htmlOutput($html_output);
    }

    // Confirm that the new comment does not appear.
    $this
      ->assertSession()
      ->pageTextNotContains('This reply should fail.');

    // Confirm that the error message DOES appear.
    $this
      ->assertSession()
      ->pageTextContains('You do not have permission to post a comment.');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AjaxCommentsFunctionalTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
AjaxCommentsFunctionalTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
AjaxCommentsFunctionalTest::setUp protected function Overrides BrowserTestBase::setUp
AjaxCommentsFunctionalTest::testCommentPosting public function Tests that comments can be posted and edited over ajax without errors.
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
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::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::$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::getHttpClient protected function Obtain the HTTP client for the system under test.
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::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
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.
CommentTestTrait::addDefaultCommentField public function Adds the default comment field to an entity.
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::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. Aliased as: drupalCreateNode
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::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.
WebDriverTestBase::$disableCssAnimations protected property Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$minkDefaultDriverClass protected property To use a legacy phantomjs based approach, please use PhantomJSDriver::class. Overrides BrowserTestBase::$minkDefaultDriverClass 2
WebDriverTestBase::assertElementNotVisible Deprecated protected function Asserts that the element with the given CSS selector is not visible.
WebDriverTestBase::assertElementVisible Deprecated protected function Asserts that the element with the given CSS selector is visible.
WebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession public function Returns WebAssert object. Overrides UiHelperTrait::assertSession 1
WebDriverTestBase::createScreenshot protected function Creates a screenshot.
WebDriverTestBase::getDrupalSettings protected function Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders protected function Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::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. Overrides BrowserTestBase::getMinkDriverArgs
WebDriverTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink protected function Initializes Mink sessions. Overrides BrowserTestBase::initMink 1
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty
WebDriverTestBase::tearDown protected function Overrides BrowserTestBase::tearDown 1
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.