class StandardProfileTest

Same name in other branches
  1. 8.9.x core/modules/rdf/tests/src/Functional/StandardProfileTest.php \Drupal\Tests\rdf\Functional\StandardProfileTest

Tests the RDF mappings and RDFa markup on top of the standard profile.

@group rdf @group legacy

Hierarchy

Expanded class hierarchy of StandardProfileTest

File

core/modules/rdf/tests/src/Functional/StandardProfileTest.php, line 21

Namespace

Drupal\Tests\rdf\Functional
View source
class StandardProfileTest extends BrowserTestBase {
    use RdfParsingTrait;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'starterkit_theme';
    
    /**
     * The profile used during tests.
     *
     * This purposefully uses the standard profile.
     *
     * @var string
     */
    public $profile = 'standard';
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'rdf',
    ];
    
    /**
     * The base URI.
     *
     * @var string
     */
    protected $baseUri;
    
    /**
     * The admin user.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $adminUser;
    
    /**
     * The web user.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $webUser;
    
    /**
     * The term to test.
     *
     * @var \Drupal\taxonomy\TermInterface
     */
    protected $term;
    
    /**
     * The image to test.
     *
     * @var \Drupal\file\FileInterface
     */
    protected $image;
    
    /**
     * The article to test.
     *
     * @var \Drupal\node\NodeInterface
     */
    protected $article;
    
    /**
     * The comment on the article to test.
     *
     * @var \Drupal\comment\CommentInterface
     */
    protected $articleComment;
    
    /**
     * The page to test.
     *
     * @var \Drupal\node\NodeInterface
     */
    protected $page;
    
    /**
     * The URI of the image to test.
     *
     * @var string
     */
    protected $imageUri;
    
    /**
     * The URI of the term to test.
     *
     * @var string
     */
    protected $termUri;
    
    /**
     * The URI of the article to test.
     *
     * @var string
     */
    protected $articleUri;
    
    /**
     * The URI of the page to test.
     *
     * @var string
     */
    protected $pageUri;
    
    /**
     * The URI of the author of the article to test.
     *
     * @var string
     */
    protected $authorUri;
    
    /**
     * The URI of the comment on the article to test.
     *
     * @var string
     */
    protected $articleCommentUri;
    
    /**
     * The URI of the author of the comment to test.
     *
     * @var string
     */
    protected $commenterUri;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->baseUri = Url::fromRoute('<front>', [], [
            'absolute' => TRUE,
        ])->toString();
        // Create two test users.
        $this->adminUser = $this->drupalCreateUser([
            'administer content types',
            'administer comments',
            'access comments',
            'access content',
        ]);
        $this->webUser = $this->drupalCreateUser([
            'access comments',
            'post comments',
            'skip comment approval',
            'access content',
        ]);
        $this->drupalLogin($this->adminUser);
        // Create term.
        $this->term = Term::create([
            'name' => $this->randomMachineName(),
            'description' => $this->randomMachineName(),
            'vid' => 'tags',
        ]);
        $this->term
            ->save();
        // Create image.
        \Drupal::service('file_system')->copy($this->root . '/core/misc/druplicon.png', 'public://example.jpg');
        $this->image = File::create([
            'uri' => 'public://example.jpg',
        ]);
        $this->image
            ->save();
        // Create article.
        $article_settings = [
            'type' => 'article',
            'promote' => NodeInterface::PROMOTED,
            'field_image' => [
                [
                    'target_id' => $this->image
                        ->id(),
                ],
            ],
            'field_tags' => [
                [
                    'target_id' => $this->term
                        ->id(),
                ],
            ],
        ];
        $this->article = $this->drupalCreateNode($article_settings);
        // Create second article to test teaser list.
        $this->drupalCreateNode([
            'type' => 'article',
            'promote' => NodeInterface::PROMOTED,
        ]);
        // Create article comment.
        $this->articleComment = $this->saveComment($this->article
            ->id(), $this->webUser
            ->id(), NULL, 0);
        // Create page.
        $this->page = $this->drupalCreateNode([
            'type' => 'page',
        ]);
        // Set URIs.
        // Image.
        $image_file = $this->article
            ->get('field_image')->entity;
        $this->imageUri = ImageStyle::load('wide')->buildUrl($image_file->getFileUri());
        // Term.
        $this->termUri = $this->term
            ->toUrl('canonical', [
            'absolute' => TRUE,
        ])
            ->toString();
        // Article.
        $this->articleUri = $this->article
            ->toUrl('canonical', [
            'absolute' => TRUE,
        ])
            ->toString();
        // Page.
        $this->pageUri = $this->page
            ->toUrl('canonical', [
            'absolute' => TRUE,
        ])
            ->toString();
        // Author.
        $this->authorUri = $this->adminUser
            ->toUrl('canonical', [
            'absolute' => TRUE,
        ])
            ->toString();
        // Comment.
        $this->articleCommentUri = $this->articleComment
            ->toUrl('canonical', [
            'absolute' => TRUE,
        ])
            ->toString();
        // Commenter.
        $this->commenterUri = $this->webUser
            ->toUrl('canonical', [
            'absolute' => TRUE,
        ])
            ->toString();
        $this->drupalLogout();
    }
    
    /**
     * Tests that data is exposed correctly when using standard profile.
     *
     * Because tests using standard profile take a very long time to run, and
     * because there is no manipulation of config or data within the test, simply
     * run all the tests from within this function.
     */
    public function testRdfaOutput() {
        $this->doFrontPageRdfaTests();
        $this->doArticleRdfaTests();
        $this->doPageRdfaTests();
        $this->doUserRdfaTests();
        $this->doTermRdfaTests();
    }
    
    /**
     * Tests that data is exposed in the front page teasers.
     */
    protected function doFrontPageRdfaTests() {
        // Feed the HTML into the parser.
        $this->drupalGet(Url::fromRoute('<front>'));
        // Ensure that both articles are listed.
        $this->assertEquals(2, $this->getElementByRdfTypeCount(Url::fromRoute('<front>'), $this->baseUri, 'http://schema.org/Article'), 'Two articles found on front page.');
        // Test interaction count.
        $expected_value = [
            'type' => 'literal',
            'value' => 'UserComments:1',
            'lang' => 'en',
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $this->articleUri, 'http://schema.org/interactionCount', $expected_value), 'Teaser comment count was found (schema:interactionCount).');
        // Test the properties that are common between pages and articles and are
        // displayed in full and teaser mode.
        $this->assertRdfaCommonNodeProperties($this->article, "Teaser");
        // Test properties that are displayed in both teaser and full mode.
        $this->assertRdfaArticleProperties("Teaser");
        // @todo Once the image points to the original instead of the processed
        //   image, move this to testArticleProperties().
        $expected_value = [
            'type' => 'uri',
            'value' => $this->imageUri,
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $this->articleUri, 'http://schema.org/image', $expected_value), 'Teaser image was found (schema:image).');
    }
    
    /**
     * Tests that article data is exposed using RDFa.
     *
     * Two fields are not tested for output here. Changed date is not displayed
     * on the page, so there is no test for output in node view. Comment count is
     * displayed in teaser view, so it is tested in the front article tests.
     */
    protected function doArticleRdfaTests() {
        // Feed the HTML into the parser.
        $this->drupalGet($this->article
            ->toUrl());
        // Type.
        $this->assertEquals('schema:Article', $this->getElementRdfType($this->article
            ->toUrl(), $this->baseUri, $this->articleUri), 'Article type was found (schema:Article).');
        // Test the properties that are common between pages and articles.
        $this->assertRdfaCommonNodeProperties($this->article, "Article");
        // Test properties that are displayed in both teaser and full mode.
        $this->assertRdfaArticleProperties("Article");
        // Test the comment properties displayed on articles.
        $this->assertRdfaNodeCommentProperties();
        // @todo Once the image points to the original instead of the processed
        //   image, move this to testArticleProperties().
        $expected_value = [
            'type' => 'uri',
            'value' => $this->imageUri,
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $this->articleUri, 'http://schema.org/image', $expected_value), 'Teaser image was found (schema:image).');
    }
    
    /**
     * Tests that page data is exposed using RDFa.
     *
     * Two fields are not tested for output here. Changed date is not displayed
     * on the page, so there is no test for output in node view. Comment count is
     * displayed in teaser view, so it is tested in the front page tests.
     */
    protected function doPageRdfaTests() {
        // The standard profile hides the created date on pages. Revert display to
        // true for testing.
        // @todo Clean-up standard profile defaults.
        $node_type = NodeType::load('page');
        $node_type->setDisplaySubmitted(TRUE);
        $node_type->save();
        // Type.
        $this->assertEquals('schema:WebPage', $this->getElementRdfType($this->page
            ->toUrl(), $this->baseUri, $this->pageUri), 'Page type was found (schema:WebPage).');
        // Test the properties that are common between pages and articles.
        $this->assertRdfaCommonNodeProperties($this->page, "Page");
    }
    
    /**
     * Tests that user data is exposed on user page.
     */
    protected function doUserRdfaTests() {
        $this->drupalLogin($this->rootUser);
        // User type.
        $this->assertEquals('schema:Person', $this->getElementRdfType($this->adminUser
            ->toUrl(), $this->baseUri, $this->authorUri), 'User type was found (schema:Person) on user page.');
        // User name.
        $expected_value = [
            'type' => 'literal',
            'value' => $this->adminUser
                ->label(),
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $this->authorUri, 'http://schema.org/name', $expected_value), 'User name was found (schema:name) on user page.');
        $this->drupalLogout();
    }
    
    /**
     * Tests that term data is exposed on term page.
     */
    protected function doTermRdfaTests() {
        // Term type.
        $this->assertEquals('schema:Thing', $this->getElementRdfType($this->term
            ->toUrl(), $this->baseUri, $this->termUri), 'Term type was found (schema:Thing) on term page.');
        // Term name.
        $expected_value = [
            'type' => 'literal',
            'value' => $this->term
                ->getName(),
            'lang' => 'en',
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $this->termUri, 'http://schema.org/name', $expected_value), 'Term name was found (schema:name) on term page.');
        // @todo Add test for term description once it is a field:
        //   https://www.drupal.org/node/569434.
    }
    
    /**
     * Tests output for properties held in common between articles and pages.
     *
     * @param \Drupal\node\NodeInterface $node
     *   The node being displayed.
     * @param string $message_prefix
     *   The word to use in the test assertion message.
     *
     * @throws \Drupal\Core\Entity\EntityMalformedException
     *
     * @internal
     */
    protected function assertRdfaCommonNodeProperties(NodeInterface $node, string $message_prefix) : void {
        $this->drupalGet($node->toUrl());
        $uri = $node->toUrl('canonical', [
            'absolute' => TRUE,
        ])
            ->toString();
        // Title.
        $expected_value = [
            'type' => 'literal',
            'value' => $node->get('title')->value,
            'lang' => 'en',
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $uri, 'http://schema.org/name', $expected_value), "{$message_prefix} title was found (schema:name).");
        // Created date.
        $expected_value = [
            'type' => 'literal',
            'value' => $this->container
                ->get('date.formatter')
                ->format($node->get('created')->value, 'custom', 'c', 'UTC'),
            'lang' => 'en',
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $uri, 'http://schema.org/dateCreated', $expected_value), "{$message_prefix} created date was found (schema:dateCreated) in teaser.");
        // Body.
        $expected_value = [
            'type' => 'literal',
            'value' => $node->get('body')->value,
            'lang' => 'en',
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $uri, 'http://schema.org/text', $expected_value), "{$message_prefix} body was found (schema:text) in teaser.");
        // Author.
        $expected_value = [
            'type' => 'uri',
            'value' => $this->authorUri,
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $uri, 'http://schema.org/author', $expected_value), "{$message_prefix} author was found (schema:author) in teaser.");
        // Author type.
        $this->assertEquals('schema:Person', $this->getElementRdfType($node->toUrl(), $this->baseUri, $this->authorUri), '$message_prefix author type was found (schema:Person).');
        // Author name.
        $expected_value = [
            'type' => 'literal',
            'value' => $this->adminUser
                ->label(),
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $this->authorUri, 'http://schema.org/name', $expected_value), "{$message_prefix} author name was found (schema:name).");
    }
    
    /**
     * Tests output for article properties displayed in both view modes.
     *
     * @param string $message_prefix
     *   The word to use in the test assertion message.
     *
     * @internal
     */
    protected function assertRdfaArticleProperties(string $message_prefix) : void {
        // Tags.
        $expected_value = [
            'type' => 'uri',
            'value' => $this->termUri,
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $this->articleUri, 'http://schema.org/about', $expected_value), "{$message_prefix} tag was found (schema:about).");
        // Tag type.
        // @todo Enable with https://www.drupal.org/node/2072791.
        // $this->assertEquals('schema:Thing', $graph->type($this->termUri), 'Tag type was found (schema:Thing).');
        // Tag name.
        $expected_value = [
            'type' => 'literal',
            'value' => $this->term
                ->getName(),
            'lang' => 'en',
        ];
        // @todo Enable with https://www.drupal.org/node/2072791.
        // $this->assertTrue($graph->hasProperty($this->termUri, 'http://schema.org/name', $expected_value), "$message_prefix name was found (schema:name).");
    }
    
    /**
     * Tests output for comment properties on nodes in full page view mode.
     *
     * @internal
     */
    protected function assertRdfaNodeCommentProperties() : void {
        $this->drupalGet($this->article
            ->toUrl());
        // Relationship between node and comment.
        $expected_value = [
            'type' => 'uri',
            'value' => $this->articleCommentUri,
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $this->articleUri, 'http://schema.org/comment', $expected_value), "Relationship between node and comment found (schema:comment).");
        // Comment type.
        $this->assertEquals('schema:Comment', $this->getElementRdfType($this->article
            ->toUrl(), $this->baseUri, $this->articleCommentUri), 'Comment type was found (schema:Comment).');
        // Comment title.
        $expected_value = [
            'type' => 'literal',
            'value' => $this->articleComment
                ->get('subject')->value,
            'lang' => 'en',
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $this->articleCommentUri, 'http://schema.org/name', $expected_value), "Article comment title was found (schema:name).");
        // Comment created date.
        $expected_value = [
            'type' => 'literal',
            'value' => $this->container
                ->get('date.formatter')
                ->format($this->articleComment
                ->get('created')->value, 'custom', 'c', 'UTC'),
            'lang' => 'en',
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $this->articleCommentUri, 'http://schema.org/dateCreated', $expected_value), "Article comment created date was found (schema:dateCreated).");
        // Comment body.
        $text = $this->articleComment
            ->get('comment_body')->value;
        $expected_value = [
            'type' => 'literal',
            // There is an extra carriage return in the value when parsing comments as
            // output by Bartik, so it must be added to the expected value.
'value' => "{$text}" . PHP_EOL,
            'lang' => 'en',
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $this->articleCommentUri, 'http://schema.org/text', $expected_value), "Article comment body was found (schema:text).");
        // Comment uid.
        $expected_value = [
            'type' => 'uri',
            'value' => $this->commenterUri,
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $this->articleCommentUri, 'http://schema.org/author', $expected_value), "Article comment author was found (schema:author).");
        // Comment author type.
        $this->assertEquals('schema:Person', $this->getElementRdfType($this->article
            ->toUrl(), $this->baseUri, $this->commenterUri), 'Comment author type was found (schema:Person).');
        // Comment author name.
        $expected_value = [
            'type' => 'literal',
            'value' => $this->webUser
                ->getAccountName(),
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $this->commenterUri, 'http://schema.org/name', $expected_value), "Comment author name was found (schema:name).");
    }
    
    /**
     * Creates a comment entity.
     *
     * @param int $nid
     *   Node id which will hold the comment.
     * @param int $uid
     *   User id of the author of the comment. Can be NULL if $contact provided.
     * @param mixed $contact
     *   Set to NULL for no contact info, TRUE to ignore success checking, and
     *   array of values to set contact info.
     * @param int $pid
     *   Comment id of the parent comment in a thread.
     *
     * @return \Drupal\comment\Entity\Comment
     *   The saved comment.
     */
    protected function saveComment($nid, $uid, $contact = NULL, $pid = 0) {
        $values = [
            'entity_id' => $nid,
            'entity_type' => 'node',
            'field_name' => 'comment',
            'uid' => $uid,
            'pid' => $pid,
            'subject' => $this->randomMachineName(),
            'comment_body' => $this->randomMachineName(),
            'status' => 1,
        ];
        if ($contact) {
            $values += $contact;
        }
        $comment = Comment::create($values);
        $comment->save();
        return $comment;
    }

}

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::$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.
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.
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.
RdfParsingTrait::getElementByRdfTypeCount protected function Counts the number of resources of the provided type.
RdfParsingTrait::getElementRdfType protected function Gets type of RDF Element.
RdfParsingTrait::getInstanceGraph private function Gets a new instance of EasyRdf\Graph or EasyRdf_Graph.
RdfParsingTrait::getInstanceParser private function Gets a new instance of EasyRdf\Parser\Rdfa or EasyRdf_Parser_Rdfa.
RdfParsingTrait::hasRdfChildProperty protected function Checks if a html document contains a resource with a given property value.
RdfParsingTrait::hasRdfProperty protected function Checks if a html document contains a resource with a given property value.
RdfParsingTrait::rdfElementIsBlankNode protected function Checks if RDF Node property is blank.
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.
StandardProfileTest::$adminUser protected property The admin user.
StandardProfileTest::$article protected property The article to test.
StandardProfileTest::$articleComment protected property The comment on the article to test.
StandardProfileTest::$articleCommentUri protected property The URI of the comment on the article to test.
StandardProfileTest::$articleUri protected property The URI of the article to test.
StandardProfileTest::$authorUri protected property The URI of the author of the article to test.
StandardProfileTest::$baseUri protected property The base URI.
StandardProfileTest::$commenterUri protected property The URI of the author of the comment to test.
StandardProfileTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
StandardProfileTest::$image protected property The image to test.
StandardProfileTest::$imageUri protected property The URI of the image to test.
StandardProfileTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
StandardProfileTest::$page protected property The page to test.
StandardProfileTest::$pageUri protected property The URI of the page to test.
StandardProfileTest::$profile public property The profile used during tests. Overrides BrowserTestBase::$profile
StandardProfileTest::$term protected property The term to test.
StandardProfileTest::$termUri protected property The URI of the term to test.
StandardProfileTest::$webUser protected property The web user.
StandardProfileTest::assertRdfaArticleProperties protected function Tests output for article properties displayed in both view modes.
StandardProfileTest::assertRdfaCommonNodeProperties protected function Tests output for properties held in common between articles and pages.
StandardProfileTest::assertRdfaNodeCommentProperties protected function Tests output for comment properties on nodes in full page view mode.
StandardProfileTest::doArticleRdfaTests protected function Tests that article data is exposed using RDFa.
StandardProfileTest::doFrontPageRdfaTests protected function Tests that data is exposed in the front page teasers.
StandardProfileTest::doPageRdfaTests protected function Tests that page data is exposed using RDFa.
StandardProfileTest::doTermRdfaTests protected function Tests that term data is exposed on term page.
StandardProfileTest::doUserRdfaTests protected function Tests that user data is exposed on user page.
StandardProfileTest::saveComment protected function Creates a comment entity.
StandardProfileTest::setUp protected function Overrides BrowserTestBase::setUp
StandardProfileTest::testRdfaOutput public function Tests that data is exposed correctly when using standard profile.
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.