class CommentNonNodeTest

Same name in other branches
  1. 8.9.x core/modules/comment/tests/src/Functional/CommentNonNodeTest.php \Drupal\Tests\comment\Functional\CommentNonNodeTest
  2. 10 core/modules/comment/tests/src/Functional/CommentNonNodeTest.php \Drupal\Tests\comment\Functional\CommentNonNodeTest
  3. 11.x core/modules/comment/tests/src/Functional/CommentNonNodeTest.php \Drupal\Tests\comment\Functional\CommentNonNodeTest

Tests commenting on a test entity.

@group comment

Hierarchy

Expanded class hierarchy of CommentNonNodeTest

File

core/modules/comment/tests/src/Functional/CommentNonNodeTest.php, line 23

Namespace

Drupal\Tests\comment\Functional
View source
class CommentNonNodeTest extends BrowserTestBase {
    use FieldUiTestTrait;
    use CommentTestTrait;
    protected static $modules = [
        'comment',
        'user',
        'field_ui',
        'entity_test',
        'block',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * An administrative user with permission to configure comment settings.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $adminUser;
    
    /**
     * The entity to use within tests.
     *
     * @var \Drupal\entity_test\Entity\EntityTest
     */
    protected $entity;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->drupalPlaceBlock('system_breadcrumb_block');
        $this->drupalPlaceBlock('page_title_block');
        // Create a bundle for entity_test.
        entity_test_create_bundle('entity_test', 'Entity Test', 'entity_test');
        CommentType::create([
            'id' => 'comment',
            'label' => 'Comment settings',
            'description' => 'Comment settings',
            'target_entity_type_id' => 'entity_test',
        ])->save();
        // Create comment field on entity_test bundle.
        $this->addDefaultCommentField('entity_test', 'entity_test');
        // Verify that bundles are defined correctly.
        $bundles = \Drupal::service('entity_type.bundle.info')->getBundleInfo('comment');
        $this->assertEquals('Comment settings', $bundles['comment']['label']);
        // Create test user.
        $this->adminUser = $this->drupalCreateUser([
            'administer comments',
            'skip comment approval',
            'post comments',
            'access comments',
            'view test entity',
            'administer entity_test content',
        ]);
        // Enable anonymous and authenticated user comments.
        user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, [
            'access comments',
            'post comments',
            'skip comment approval',
        ]);
        user_role_grant_permissions(RoleInterface::AUTHENTICATED_ID, [
            'access comments',
            'post comments',
            'skip comment approval',
        ]);
        // Create a test entity.
        $random_label = $this->randomMachineName();
        $data = [
            'type' => 'entity_test',
            'name' => $random_label,
        ];
        $this->entity = EntityTest::create($data);
        $this->entity
            ->save();
    }
    
    /**
     * Posts a comment.
     *
     * @param \Drupal\Core\Entity\EntityInterface|null $entity
     *   Entity to post comment on or NULL to post to the previously loaded page.
     * @param string $comment
     *   Comment body.
     * @param string $subject
     *   Comment subject.
     * @param mixed $contact
     *   Set to NULL for no contact info, TRUE to ignore success checking, and
     *   array of values to set contact info.
     *
     * @return \Drupal\comment\CommentInterface
     *   The new comment entity.
     */
    public function postComment(?EntityInterface $entity, $comment, $subject = '', $contact = NULL) {
        $edit = [];
        $edit['comment_body[0][value]'] = $comment;
        $field = FieldConfig::loadByName('entity_test', 'entity_test', 'comment');
        $preview_mode = $field->getSetting('preview');
        // Must get the page before we test for fields.
        if ($entity !== NULL) {
            $this->drupalGet('comment/reply/entity_test/' . $entity->id() . '/comment');
        }
        // Determine the visibility of subject form field.
        $display_repository = $this->container
            ->get('entity_display.repository');
        if ($display_repository->getFormDisplay('comment', 'comment')
            ->getComponent('subject')) {
            // Subject input allowed.
            $edit['subject[0][value]'] = $subject;
        }
        else {
            $this->assertSession()
                ->fieldValueNotEquals('subject[0][value]', '');
        }
        if ($contact !== NULL && is_array($contact)) {
            $edit += $contact;
        }
        switch ($preview_mode) {
            case DRUPAL_REQUIRED:
                // Preview required so no save button should be found.
                $this->assertSession()
                    ->buttonNotExists('Save');
                $this->submitForm($edit, 'Preview');
            // Don't break here so that we can test post-preview field presence and
            // function below.
            case DRUPAL_OPTIONAL:
                $this->assertSession()
                    ->buttonExists('Preview');
                $this->assertSession()
                    ->buttonExists('Save');
                $this->submitForm($edit, 'Save');
                break;
            case DRUPAL_DISABLED:
                $this->assertSession()
                    ->buttonNotExists('Preview');
                $this->assertSession()
                    ->buttonExists('Save');
                $this->submitForm($edit, 'Save');
                break;
        }
        $match = [];
        // Get comment ID
        preg_match('/#comment-([0-9]+)/', $this->getURL(), $match);
        // Get comment.
        if ($contact !== TRUE) {
            // If true then attempting to find error message.
            if ($subject) {
                $this->assertSession()
                    ->pageTextContains($subject);
            }
            $this->assertSession()
                ->pageTextContains($comment);
            // Check the comment ID was extracted.
            $this->assertArrayHasKey(1, $match);
        }
        return Comment::load($match[1]);
    }
    
    /**
     * Checks current page for specified comment.
     *
     * @param \Drupal\comment\CommentInterface $comment
     *   The comment object.
     * @param bool $reply
     *   Boolean indicating whether the comment is a reply to another comment.
     *
     * @return bool
     *   Boolean indicating whether the comment was found.
     */
    public function commentExists(CommentInterface $comment = NULL, $reply = FALSE) {
        if ($comment) {
            $regex = '/' . ($reply ? '<div class="indented">(.*?)' : '');
            $regex .= '<article(.*?)id="comment-' . $comment->id() . '"(.*?)';
            $regex .= $comment->getSubject() . '(.*?)';
            $regex .= $comment->comment_body->value . '(.*?)';
            $regex .= '/s';
            return (bool) preg_match($regex, $this->getSession()
                ->getPage()
                ->getContent());
        }
        else {
            return FALSE;
        }
    }
    
    /**
     * Checks whether the commenter's contact information is displayed.
     *
     * @return bool
     *   Contact info is available.
     */
    public function commentContactInfoAvailable() {
        return (bool) preg_match('/(input).*?(name="name").*?(input).*?(name="mail").*?(input).*?(name="homepage")/s', $this->getSession()
            ->getPage()
            ->getContent());
    }
    
    /**
     * Performs the specified operation on the specified comment.
     *
     * @param object $comment
     *   Comment to perform operation on.
     * @param string $operation
     *   Operation to perform.
     * @param bool $approval
     *   Operation is found on approval page.
     */
    public function performCommentOperation($comment, $operation, $approval = FALSE) {
        $edit = [];
        $edit['operation'] = $operation;
        $edit['comments[' . $comment->id() . ']'] = TRUE;
        $this->drupalGet('admin/content/comment' . ($approval ? '/approval' : ''));
        $this->submitForm($edit, 'Update');
        if ($operation == 'delete') {
            $this->submitForm([], 'Delete');
            $this->assertSession()
                ->pageTextContains('Deleted 1 comment.');
        }
        else {
            $this->assertSession()
                ->pageTextContains('The update has been performed.');
        }
    }
    
    /**
     * Gets the comment ID for an unapproved comment.
     *
     * @param string $subject
     *   Comment subject to find.
     *
     * @return int
     *   Comment ID.
     */
    public function getUnapprovedComment($subject) {
        $this->drupalGet('admin/content/comment/approval');
        preg_match('/href="(.*?)#comment-([^"]+)"(.*?)>(' . $subject . ')/', $this->getSession()
            ->getPage()
            ->getContent(), $match);
        return $match[2];
    }
    
    /**
     * Tests anonymous comment functionality.
     */
    public function testCommentFunctionality() {
        $limited_user = $this->drupalCreateUser([
            'administer entity_test fields',
        ]);
        $this->drupalLogin($limited_user);
        // Test that default field exists.
        $this->drupalGet('entity_test/structure/entity_test/fields');
        $this->assertSession()
            ->pageTextContains('Comments');
        $this->assertSession()
            ->linkByHrefExists('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
        // Test widget hidden option is not visible when there's no comments.
        $this->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->fieldNotExists('edit-default-value-input-comment-und-0-status-0');
        // Test that field to change cardinality is not available.
        $this->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.comment/storage');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->fieldNotExists('cardinality_number');
        $this->assertSession()
            ->fieldNotExists('cardinality');
        $this->drupalLogin($this->adminUser);
        // Test breadcrumb on comment add page.
        $this->drupalGet('comment/reply/entity_test/' . $this->entity
            ->id() . '/comment');
        $this->assertSession()
            ->elementTextEquals('xpath', '//nav[@aria-labelledby="system-breadcrumb"]/ol/li[last()]/a', $this->entity
            ->label());
        // Post a comment.
        
        /** @var \Drupal\comment\CommentInterface $comment1 */
        $comment1 = $this->postComment($this->entity, $this->randomMachineName(), $this->randomMachineName());
        $this->assertTrue($this->commentExists($comment1), 'Comment on test entity exists.');
        // Test breadcrumb on comment reply page.
        $this->drupalGet('comment/reply/entity_test/' . $this->entity
            ->id() . '/comment/' . $comment1->id());
        $this->assertSession()
            ->elementTextEquals('xpath', '//nav[@aria-labelledby="system-breadcrumb"]/ol/li[last()]/a', $comment1->getSubject());
        // Test breadcrumb on comment edit page.
        $this->drupalGet('comment/' . $comment1->id() . '/edit');
        $this->assertSession()
            ->elementTextEquals('xpath', '//nav[@aria-labelledby="system-breadcrumb"]/ol/li[last()]/a', $comment1->getSubject());
        // Test breadcrumb on comment delete page.
        $this->drupalGet('comment/' . $comment1->id() . '/delete');
        $this->assertSession()
            ->elementTextEquals('xpath', '//nav[@aria-labelledby="system-breadcrumb"]/ol/li[last()]/a', $comment1->getSubject());
        // Test threading replying to comment #1 creating comment #1_2.
        $this->drupalGet('comment/reply/entity_test/' . $this->entity
            ->id() . '/comment/' . $comment1->id());
        $comment1_2 = $this->postComment(NULL, $this->randomMachineName(), $this->randomMachineName());
        $this->assertTrue($this->commentExists($comment1_2, TRUE), 'Comment #1_2. Reply found.');
        $this->assertEquals('01.00/', $comment1_2->getThread());
        // Test nested threading replying to comment #1_2 creating comment #1_2_3.
        $this->drupalGet('comment/reply/entity_test/' . $this->entity
            ->id() . '/comment/' . $comment1_2->id());
        $comment1_2_3 = $this->postComment(NULL, $this->randomMachineName(), $this->randomMachineName());
        $this->assertTrue($this->commentExists($comment1_2_3, TRUE), 'Comment #1_2_3. Reply found.');
        $this->assertEquals('01.00.00/', $comment1_2_3->getThread());
        // Unpublish the comment.
        $this->performCommentOperation($comment1, 'unpublish');
        $this->drupalGet('admin/content/comment/approval');
        $this->assertSession()
            ->responseContains('comments[' . $comment1->id() . ']');
        // Publish the comment.
        $this->performCommentOperation($comment1, 'publish', TRUE);
        $this->drupalGet('admin/content/comment');
        $this->assertSession()
            ->responseContains('comments[' . $comment1->id() . ']');
        // Delete the comment.
        $this->performCommentOperation($comment1, 'delete');
        $this->drupalGet('admin/content/comment');
        $this->assertSession()
            ->responseNotContains('comments[' . $comment1->id() . ']');
        // Post another comment.
        $comment1 = $this->postComment($this->entity, $this->randomMachineName(), $this->randomMachineName());
        $this->assertTrue($this->commentExists($comment1), 'Comment on test entity exists.');
        // Check that the comment was found.
        $this->drupalGet('admin/content/comment');
        $this->assertSession()
            ->responseContains('comments[' . $comment1->id() . ']');
        // Check that entity access applies to administrative page.
        $this->assertSession()
            ->pageTextContains($this->entity
            ->label());
        $limited_user = $this->drupalCreateUser([
            'administer comments',
        ]);
        $this->drupalLogin($limited_user);
        $this->drupalGet('admin/content/comment');
        $this->assertSession()
            ->pageTextNotContains($this->entity
            ->label());
        $this->drupalLogout();
        // Deny anonymous users access to comments.
        user_role_change_permissions(RoleInterface::ANONYMOUS_ID, [
            'access comments' => FALSE,
            'post comments' => FALSE,
            'skip comment approval' => FALSE,
            'view test entity' => TRUE,
        ]);
        // Attempt to view comments while disallowed.
        $this->drupalGet('entity-test/' . $this->entity
            ->id());
        // Verify that comments were not displayed.
        $this->assertSession()
            ->responseNotMatches('@<h2[^>]*>Comments</h2>@');
        $this->assertSession()
            ->linkNotExists('Add new comment', 'Link to add comment was found.');
        // Attempt to view test entity comment form while disallowed.
        $this->drupalGet('comment/reply/entity_test/' . $this->entity
            ->id() . '/comment');
        $this->assertSession()
            ->statusCodeEquals(403);
        $this->assertSession()
            ->fieldNotExists('subject[0][value]');
        $this->assertSession()
            ->fieldNotExists('comment_body[0][value]');
        user_role_change_permissions(RoleInterface::ANONYMOUS_ID, [
            'access comments' => TRUE,
            'post comments' => FALSE,
            'view test entity' => TRUE,
            'skip comment approval' => FALSE,
        ]);
        $this->drupalGet('entity_test/' . $this->entity
            ->id());
        // Verify that the comment field title is displayed.
        $this->assertSession()
            ->responseMatches('@<h2[^>]*>Comments</h2>@');
        $this->assertSession()
            ->linkExists('Log in', 0, 'Link to login was found.');
        $this->assertSession()
            ->linkExists('register', 0, 'Link to register was found.');
        $this->assertSession()
            ->fieldNotExists('subject[0][value]');
        $this->assertSession()
            ->fieldNotExists('comment_body[0][value]');
        // Test the combination of anonymous users being able to post, but not view
        // comments, to ensure that access to post comments doesn't grant access to
        // view them.
        user_role_change_permissions(RoleInterface::ANONYMOUS_ID, [
            'access comments' => FALSE,
            'post comments' => TRUE,
            'skip comment approval' => TRUE,
            'view test entity' => TRUE,
        ]);
        $this->drupalGet('entity_test/' . $this->entity
            ->id());
        // Verify that comments were not displayed.
        $this->assertSession()
            ->responseNotMatches('@<h2[^>]*>Comments</h2>@');
        $this->assertSession()
            ->fieldValueEquals('subject[0][value]', '');
        $this->assertSession()
            ->fieldValueEquals('comment_body[0][value]', '');
        $this->drupalGet('comment/reply/entity_test/' . $this->entity
            ->id() . '/comment/' . $comment1->id());
        $this->assertSession()
            ->statusCodeEquals(403);
        $this->assertSession()
            ->pageTextNotContains($comment1->getSubject());
        // Test comment field widget changes.
        $limited_user = $this->drupalCreateUser([
            'administer entity_test fields',
            'view test entity',
            'administer entity_test content',
            'administer comments',
        ]);
        $this->drupalLogin($limited_user);
        $this->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
        $this->assertSession()
            ->checkboxNotChecked('edit-default-value-input-comment-0-status-0');
        $this->assertSession()
            ->checkboxNotChecked('edit-default-value-input-comment-0-status-1');
        $this->assertSession()
            ->checkboxChecked('edit-default-value-input-comment-0-status-2');
        // Test comment option change in field settings.
        $edit = [
            'default_value_input[comment][0][status]' => CommentItemInterface::CLOSED,
            'settings[anonymous]' => CommentInterface::ANONYMOUS_MAY_CONTACT,
        ];
        $this->submitForm($edit, 'Save settings');
        $this->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
        $this->assertSession()
            ->checkboxNotChecked('edit-default-value-input-comment-0-status-0');
        $this->assertSession()
            ->checkboxChecked('edit-default-value-input-comment-0-status-1');
        $this->assertSession()
            ->checkboxNotChecked('edit-default-value-input-comment-0-status-2');
        $this->assertSession()
            ->fieldValueEquals('settings[anonymous]', CommentInterface::ANONYMOUS_MAY_CONTACT);
        // Add a new comment-type.
        $bundle = CommentType::create([
            'id' => 'foobar',
            'label' => 'Foobar',
            'description' => '',
            'target_entity_type_id' => 'entity_test',
        ]);
        $bundle->save();
        // Add a new comment field.
        $storage_edit = [
            'settings[comment_type]' => 'foobar',
        ];
        $this->fieldUIAddNewField('entity_test/structure/entity_test', 'foobar', 'Foobar', 'comment', $storage_edit);
        // Add a third comment field.
        $this->fieldUIAddNewField('entity_test/structure/entity_test', 'barfoo', 'BarFoo', 'comment', $storage_edit);
        // Check the field contains the correct comment type.
        $field_storage = FieldStorageConfig::load('entity_test.field_barfoo');
        $this->assertInstanceOf(FieldStorageConfig::class, $field_storage);
        $this->assertEquals('foobar', $field_storage->getSetting('comment_type'));
        $this->assertEquals(1, $field_storage->getCardinality());
        // Test the new entity commenting inherits default.
        $random_label = $this->randomMachineName();
        $data = [
            'bundle' => 'entity_test',
            'name' => $random_label,
        ];
        $new_entity = EntityTest::create($data);
        $new_entity->save();
        $this->drupalGet('entity_test/manage/' . $new_entity->id() . '/edit');
        $this->assertSession()
            ->checkboxNotChecked('edit-field-foobar-0-status-1');
        $this->assertSession()
            ->checkboxChecked('edit-field-foobar-0-status-2');
        $this->assertSession()
            ->fieldNotExists('edit-field-foobar-0-status-0');
        // @todo Check proper URL and form https://www.drupal.org/node/2458323
        $this->drupalGet('comment/reply/entity_test/comment/' . $new_entity->id());
        $this->assertSession()
            ->fieldNotExists('subject[0][value]');
        $this->assertSession()
            ->fieldNotExists('comment_body[0][value]');
        // Test removal of comment_body field.
        $limited_user = $this->drupalCreateUser([
            'administer entity_test fields',
            'post comments',
            'administer comment fields',
            'administer comment types',
            'view test entity',
        ]);
        $this->drupalLogin($limited_user);
        $this->drupalGet('comment/reply/entity_test/' . $this->entity
            ->id() . '/comment');
        $this->assertSession()
            ->fieldValueEquals('comment_body[0][value]', '');
        $this->fieldUIDeleteField('admin/structure/comment/manage/comment', 'comment.comment.comment_body', 'Comment', 'Comment settings');
        $this->drupalGet('comment/reply/entity_test/' . $this->entity
            ->id() . '/comment');
        $this->assertSession()
            ->fieldNotExists('comment_body[0][value]');
        // Set subject field to autogenerate it.
        $edit = [
            'subject[0][value]' => '',
        ];
        $this->submitForm($edit, 'Save');
    }
    
    /**
     * Tests comment fields cannot be added to entity types without integer IDs.
     */
    public function testsNonIntegerIdEntities() {
        // Create a bundle for entity_test_string_id.
        entity_test_create_bundle('entity_test', 'Entity Test', 'entity_test_string_id');
        $limited_user = $this->drupalCreateUser([
            'administer entity_test_string_id fields',
            'administer comment types',
        ]);
        $this->drupalLogin($limited_user);
        // Visit the Field UI field add page.
        $this->drupalGet('entity_test_string_id/structure/entity_test/fields/add-field');
        // Ensure field isn't shown for string IDs.
        $this->assertSession()
            ->optionNotExists('edit-new-storage-type', 'comment');
        // Ensure a core field type shown.
        $this->assertSession()
            ->optionExists('edit-new-storage-type', 'boolean');
        // Attempt to add a comment-type referencing this entity-type.
        $this->drupalGet('admin/structure/comment/types/add');
        $this->assertSession()
            ->optionNotExists('edit-target-entity-type-id', 'entity_test_string_id');
        $this->assertSession()
            ->responseNotContains('Test entity with string_id');
        // Create a bundle for entity_test_no_id.
        entity_test_create_bundle('entity_test', 'Entity Test', 'entity_test_no_id');
        $this->drupalLogin($this->drupalCreateUser([
            'administer entity_test_no_id fields',
        ]));
        // Visit the Field UI field add page.
        $this->drupalGet('entity_test_no_id/structure/entity_test/fields/add-field');
        // Ensure field isn't shown for empty IDs.
        $this->assertSession()
            ->optionNotExists('edit-new-storage-type', 'comment');
        // Ensure a core field type shown.
        $this->assertSession()
            ->optionExists('edit-new-storage-type', 'boolean');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser&#039;s URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated 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 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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
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::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 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. 37
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::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
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 Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
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::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep public function Prevents serializing any properties.
CommentNonNodeTest::$adminUser protected property An administrative user with permission to configure comment settings.
CommentNonNodeTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
CommentNonNodeTest::$entity protected property The entity to use within tests.
CommentNonNodeTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
CommentNonNodeTest::commentContactInfoAvailable public function Checks whether the commenter&#039;s contact information is displayed.
CommentNonNodeTest::commentExists public function Checks current page for specified comment.
CommentNonNodeTest::getUnapprovedComment public function Gets the comment ID for an unapproved comment.
CommentNonNodeTest::performCommentOperation public function Performs the specified operation on the specified comment.
CommentNonNodeTest::postComment public function Posts a comment.
CommentNonNodeTest::setUp protected function Overrides BrowserTestBase::setUp
CommentNonNodeTest::testCommentFunctionality public function Tests anonymous comment functionality.
CommentNonNodeTest::testsNonIntegerIdEntities public function Tests comment fields cannot be added to entity types without integer IDs.
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
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FieldUiTestTrait::fieldUIAddExistingField public function Adds an existing field through the Field UI.
FieldUiTestTrait::fieldUIAddNewField public function Creates a new field through the Field UI.
FieldUiTestTrait::fieldUIDeleteField public function Deletes a field through the Field UI.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; 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. 1
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. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 22
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. 3
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. 1
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
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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. 1
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.
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. 1
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
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::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 1
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. 1
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 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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 2
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 Deprecated 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::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
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.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.