AssertContentTrait.php
Same filename in other branches
Namespace
Drupal\KernelTestsFile
-
core/
tests/ Drupal/ KernelTests/ AssertContentTrait.php
View source
<?php
namespace Drupal\KernelTests;
use Drupal\Component\Serialization\Json;
use Drupal\Component\Utility\Html;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Component\Utility\Xss;
use Drupal\Core\Render\RenderContext;
use Symfony\Component\CssSelector\CssSelectorConverter;
/**
* Provides test methods to assert content.
*/
trait AssertContentTrait {
/**
* The current raw content.
*
* @var string
*/
protected $content;
/**
* The plain-text content of raw $content (text nodes).
*
* @var string
*/
protected $plainTextContent;
/**
* The drupalSettings value from the current raw $content.
*
* Variable drupalSettings refers to the drupalSettings JavaScript variable.
*
* @var array
*/
protected $drupalSettings;
/**
* The XML structure parsed from the current raw $content.
*
* @var \SimpleXMLElement
*/
protected $elements;
/**
* Gets the current raw content.
*/
protected function getRawContent() {
return $this->content;
}
/**
* Sets the raw content (e.g. HTML).
*
* @param string|\Stringable $content
* The raw content to set.
*/
protected function setRawContent($content) {
$this->content = $content;
$this->plainTextContent = NULL;
$this->elements = NULL;
$this->drupalSettings = [];
if (preg_match('@<script type="application/json" data-drupal-selector="drupal-settings-json">([^<]*)</script>@', $content, $matches)) {
$this->drupalSettings = Json::decode($matches[1]);
}
}
/**
* Retrieves the plain-text content from the current raw content.
*/
protected function getTextContent() {
if (!isset($this->plainTextContent)) {
$raw_content = $this->getRawContent();
// Strip everything between the HEAD tags.
$raw_content = preg_replace('@<head>(.+?)</head>@si', '', $raw_content);
$this->plainTextContent = Xss::filter($raw_content, []);
}
return $this->plainTextContent;
}
/**
* Removes all white-space between HTML tags from the raw content.
*
* White-space is only removed if there are no non-white-space characters
* between HTML tags.
*
* Use this (once) after performing an operation that sets new raw content,
* and when you want to use e.g. assertText() but ignore potential white-space
* caused by HTML output templates.
*/
protected function removeWhiteSpace() {
$this->content = preg_replace('@>\\s+<@', '><', $this->content);
$this->plainTextContent = NULL;
$this->elements = NULL;
}
/**
* Gets the value of drupalSettings for the currently-loaded page.
*
* Variable drupalSettings refers to the drupalSettings JavaScript variable.
*/
protected function getDrupalSettings() {
return $this->drupalSettings;
}
/**
* Sets the value of drupalSettings for the currently-loaded page.
*
* Variable drupalSettings refers to the drupalSettings JavaScript variable.
*/
protected function setDrupalSettings($settings) {
$this->drupalSettings = $settings;
}
/**
* Parse content returned from curlExec using DOM and SimpleXML.
*
* @return \SimpleXMLElement|false
* A SimpleXMLElement or FALSE on failure.
*/
protected function parse() {
if (!isset($this->elements)) {
$content = $this->getRawContent();
$dom = Html::load($content);
if ($dom) {
// It's much easier to work with simplexml than DOM, luckily enough
// we can just simply import our DOM tree.
$this->elements = @simplexml_import_dom($dom);
}
}
$this->assertNotFalse($this->elements, 'The current HTML page should be available for DOM navigation.');
return $this->elements;
}
/**
* Builds an XPath query.
*
* Builds an XPath query by replacing placeholders in the query by the value
* of the arguments.
*
* XPath 1.0 (the version supported by libxml2, the underlying XML library
* used by PHP) doesn't support any form of quotation. This function
* simplifies the building of XPath expression.
*
* @param string $xpath
* An XPath query, possibly with placeholders in the form ':name'.
* @param array $args
* An array of arguments with keys in the form ':name' matching the
* placeholders in the query. The values may be either strings or numeric
* values.
*
* @return string
* An XPath query with arguments replaced.
*/
protected function buildXPathQuery($xpath, array $args = []) {
// Replace placeholders.
foreach ($args as $placeholder => $value) {
// Cast MarkupInterface objects to string.
if (is_object($value)) {
$value = (string) $value;
}
// XPath 1.0 doesn't support a way to escape single or double quotes in a
// string literal. We split double quotes out of the string, and encode
// them separately.
if (is_string($value)) {
// Explode the text at the quote characters.
$parts = explode('"', $value);
// Quote the parts.
foreach ($parts as &$part) {
$part = '"' . $part . '"';
}
// Return the string.
$value = count($parts) > 1 ? 'concat(' . implode(', \'"\', ', $parts) . ')' : $parts[0];
}
// Use preg_replace_callback() instead of preg_replace() to prevent the
// regular expression engine from trying to substitute backreferences.
$replacement = function ($matches) use ($value) {
return $value;
};
$xpath = preg_replace_callback('/' . preg_quote($placeholder) . '\\b/', $replacement, $xpath);
}
return $xpath;
}
/**
* Performs an xpath search on the contents of the internal browser.
*
* The search is relative to the root element (HTML tag normally) of the page.
*
* @param string $xpath
* The xpath string to use in the search.
* @param array $arguments
* An array of arguments with keys in the form ':name' matching the
* placeholders in the query. The values may be either strings or numeric
* values.
*
* @return \SimpleXMLElement[]|bool
* The return value of the xpath search or FALSE on failure. For details on
* the xpath string format and return values see the SimpleXML
* documentation.
*
* @see http://php.net/manual/function.simplexml-element-xpath.php
*/
protected function xpath($xpath, array $arguments = []) {
if ($this->parse()) {
$xpath = $this->buildXPathQuery($xpath, $arguments);
$result = $this->elements
->xpath($xpath);
// Some combinations of PHP / libxml versions return an empty array
// instead of the documented FALSE. Forcefully convert any falsish values
// to an empty array to allow foreach(...) constructions.
return $result ?: [];
}
return FALSE;
}
/**
* Searches elements using a CSS selector in the raw content.
*
* The search is relative to the root element (HTML tag normally) of the page.
*
* @param string $selector
* CSS selector to use in the search.
*
* @return \SimpleXMLElement[]
* The return value of the XPath search performed after converting the CSS
* selector to an XPath selector.
*/
protected function cssSelect($selector) {
return $this->xpath((new CssSelectorConverter())->toXPath($selector));
}
/**
* Get all option elements, including nested options, in a select.
*
* @param \SimpleXMLElement $element
* The element for which to get the options.
*
* @return \SimpleXmlElement[]
* Option elements in select.
*/
protected function getAllOptions(\SimpleXMLElement $element) {
$options = [];
// Add all options items.
foreach ($element->option as $option) {
$options[] = $option;
}
// Search option group children.
if (isset($element->optgroup)) {
$nested_options = [];
foreach ($element->optgroup as $group) {
$nested_options[] = $this->getAllOptions($group);
}
$options = array_merge($options, ...$nested_options);
}
return $options;
}
/**
* Passes if a link with the specified label is found.
*
* An optional link index may be passed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $label
* Text between the anchor tags.
* @param int $index
* Link position counting from zero.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages: use strtr() to embed variables in the message text, not
* t(). If left blank, a default message will be displayed.
*
* @return bool
* TRUE if the assertion succeeded.
*/
protected function assertLink($label, $index = 0, $message = '') {
// Cast MarkupInterface objects to string.
$label = (string) $label;
$links = $this->xpath('//a[normalize-space(text())=:label]', [
':label' => $label,
]);
$message = $message ? $message : strtr('Link with label %label found.', [
'%label' => $label,
]);
$this->assertArrayHasKey($index, $links, $message);
return TRUE;
}
/**
* Passes if a link with the specified label is not found.
*
* @param string|\Drupal\Component\Render\MarkupInterface $label
* Text between the anchor tags.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE if the assertion succeeded.
*/
protected function assertNoLink($label, $message = '') {
// Cast MarkupInterface objects to string.
$label = (string) $label;
$links = $this->xpath('//a[normalize-space(text())=:label]', [
':label' => $label,
]);
$message = $message ? $message : new FormattableMarkup('Link with label %label not found.', [
'%label' => $label,
]);
$this->assertEmpty($links, $message);
return TRUE;
}
/**
* Passes if a link containing a given href (part) is found.
*
* @param string $href
* The full or partial value of the 'href' attribute of the anchor tag.
* @param string $index
* Link position counting from zero.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE if the assertion succeeded.
*/
protected function assertLinkByHref($href, $index = 0, $message = '') {
$links = $this->xpath('//a[contains(@href, :href)]', [
':href' => $href,
]);
$message = $message ? $message : new FormattableMarkup('Link containing href %href found.', [
'%href' => $href,
]);
$this->assertArrayHasKey($index, $links, $message);
return TRUE;
}
/**
* Passes if a link containing a given href (part) is not found.
*
* @param string $href
* The full or partial value of the 'href' attribute of the anchor tag.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE if the assertion succeeded.
*/
protected function assertNoLinkByHref($href, $message = '') {
$links = $this->xpath('//a[contains(@href, :href)]', [
':href' => $href,
]);
$message = $message ? $message : new FormattableMarkup('No link containing href %href found.', [
'%href' => $href,
]);
$this->assertEmpty($links, $message);
return TRUE;
}
/**
* Passes if a link containing a given href is not found in the main region.
*
* @param string $href
* The full or partial value of the 'href' attribute of the anchor tag.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE if the assertion succeeded.
*/
protected function assertNoLinkByHrefInMainRegion($href, $message = '') {
$links = $this->xpath('//main//a[contains(@href, :href)]', [
':href' => $href,
]);
$message = $message ? $message : new FormattableMarkup('No link containing href %href found.', [
'%href' => $href,
]);
$this->assertEmpty($links, $message);
return TRUE;
}
/**
* Passes if the raw text IS found on the loaded page, fail otherwise.
*
* Raw text refers to the raw HTML that the page generated.
*
* @param string $raw
* Raw (HTML) string to look for.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*/
protected function assertRaw($raw, $message = '') : void {
if (!$message) {
$message = 'Raw "' . Html::escape($raw) . '" found';
}
$this->assertStringContainsString((string) $raw, $this->getRawContent(), $message);
}
/**
* Passes if the raw text is NOT found on the loaded page, fail otherwise.
*
* Raw text refers to the raw HTML that the page generated.
*
* @param string $raw
* Raw (HTML) string to look for.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*/
protected function assertNoRaw($raw, $message = '') : void {
if (!$message) {
$message = 'Raw "' . Html::escape($raw) . '" not found';
}
$this->assertStringNotContainsString((string) $raw, $this->getRawContent(), $message);
}
/**
* Passes if the raw text IS found escaped on the loaded page, fail otherwise.
*
* Raw text refers to the raw HTML that the page generated.
*
* @param string $raw
* Raw (HTML) string to look for.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*/
protected function assertEscaped($raw, $message = '') : void {
if (!$message) {
$message = 'Escaped "' . Html::escape($raw) . '" found';
}
$this->assertStringContainsString(Html::escape($raw), $this->getRawContent(), $message);
}
/**
* Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
*
* Raw text refers to the raw HTML that the page generated.
*
* @param string $raw
* Raw (HTML) string to look for.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*/
protected function assertNoEscaped($raw, $message = '') : void {
if (!$message) {
$message = 'Escaped "' . Html::escape($raw) . '" not found';
}
$this->assertStringNotContainsString(Html::escape($raw), $this->getRawContent(), $message);
}
/**
* Passes if the page (with HTML stripped) contains the text.
*
* Note that stripping HTML tags also removes their attributes, such as
* the values of text fields.
*
* @param string $text
* Plain text to look for.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @see \Drupal\KernelTests\AssertContentTrait::assertRaw()
*/
protected function assertText($text, $message = '') : void {
$this->assertTextHelper($text, $message, NULL, FALSE);
}
/**
* Passes if the page (with HTML stripped) does not contains the text.
*
* Note that stripping HTML tags also removes their attributes, such as
* the values of text fields.
*
* @param string $text
* Plain text to look for.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @see \Drupal\KernelTests\AssertContentTrait::assertNoRaw()
*/
protected function assertNoText($text, $message = '') : void {
$this->assertTextHelper($text, $message, NULL, TRUE);
}
/**
* Helper for assertText and assertNoText.
*
* It is not recommended to call this function directly.
*
* @param string $text
* Plain text to look for.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
* @param string $group
* Deprecated.
* @param bool $not_exists
* (optional) TRUE if this text should not exist, FALSE if it should.
* Defaults to TRUE.
*/
protected function assertTextHelper($text, $message = '', $group = NULL, $not_exists = TRUE) : void {
if (!$message) {
$message = !$not_exists ? new FormattableMarkup('"@text" found', [
'@text' => $text,
]) : new FormattableMarkup('"@text" not found', [
'@text' => $text,
]);
}
if ($not_exists) {
$this->assertStringNotContainsString((string) $text, $this->getTextContent(), $message);
}
else {
$this->assertStringContainsString((string) $text, $this->getTextContent(), $message);
}
}
/**
* Passes if the text is found ONLY ONCE on the text version of the page.
*
* The text version is the equivalent of what a user would see when viewing
* through a web browser. In other words the HTML has been filtered out of
* the contents.
*
* @param string|\Drupal\Component\Render\MarkupInterface $text
* Plain text to look for.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass, FALSE on fail.
*/
protected function assertUniqueText($text, $message = '') {
return $this->assertUniqueTextHelper($text, $message, NULL, TRUE);
}
/**
* Passes if the text is found MORE THAN ONCE on the text version of the page.
*
* The text version is the equivalent of what a user would see when viewing
* through a web browser. In other words the HTML has been filtered out of
* the contents.
*
* @param string|\Drupal\Component\Render\MarkupInterface $text
* Plain text to look for.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass, FALSE on fail.
*/
protected function assertNoUniqueText($text, $message = '') {
return $this->assertUniqueTextHelper($text, $message, NULL, FALSE);
}
/**
* Helper for assertUniqueText and assertNoUniqueText.
*
* It is not recommended to call this function directly.
*
* @param string|\Drupal\Component\Render\MarkupInterface $text
* Plain text to look for.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
* @param string $group
* Deprecated.
* @param bool $be_unique
* (optional) TRUE if this text should be found only once, FALSE if it
* should be found more than once. Defaults to FALSE.
*
* @return bool
* TRUE on pass.
*/
protected function assertUniqueTextHelper($text, $message = '', $group = NULL, $be_unique = FALSE) {
// Cast MarkupInterface objects to string.
$text = (string) $text;
if (!$message) {
$message = '"' . $text . '"' . ($be_unique ? ' found only once' : ' found more than once');
}
$first_occurrence = strpos($this->getTextContent(), $text);
if ($first_occurrence === FALSE) {
$this->fail($message);
}
$offset = $first_occurrence + strlen($text);
$second_occurrence = strpos($this->getTextContent(), $text, $offset);
$this->assertEquals($be_unique, $second_occurrence === FALSE, $message);
return TRUE;
}
/**
* Triggers a pass if the Perl regex pattern is found in the raw content.
*
* @param string $pattern
* Perl regex to look for including the regex delimiters.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass.
*/
protected function assertPattern($pattern, $message = '') {
if (!$message) {
$message = new FormattableMarkup('Pattern "@pattern" found', [
'@pattern' => $pattern,
]);
}
$this->assertMatchesRegularExpression($pattern, $this->getRawContent(), $message);
return TRUE;
}
/**
* Triggers a pass if the perl regex pattern is not found in raw content.
*
* @param string $pattern
* Perl regex to look for including the regex delimiters.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass.
*/
protected function assertNoPattern($pattern, $message = '') {
if (!$message) {
$message = new FormattableMarkup('Pattern "@pattern" not found', [
'@pattern' => $pattern,
]);
}
$this->assertDoesNotMatchRegularExpression($pattern, $this->getRawContent(), $message);
return TRUE;
}
/**
* Asserts that a Perl regex pattern is found in the plain-text content.
*
* @param string $pattern
* Perl regex to look for including the regex delimiters.
* @param string $message
* (optional) A message to display with the assertion.
*
* @return bool
* TRUE on pass.
*/
protected function assertTextPattern($pattern, $message = NULL) {
if (!isset($message)) {
$message = new FormattableMarkup('Pattern "@pattern" found', [
'@pattern' => $pattern,
]);
}
$this->assertMatchesRegularExpression($pattern, $this->getTextContent(), $message);
return TRUE;
}
/**
* Pass if the page title is the given string.
*
* @param string $title
* The string the title should be.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*/
protected function assertTitle($title, $message = '') {
// Don't use xpath as it messes with HTML escaping.
preg_match('@<title>(.*)</title>@', $this->getRawContent(), $matches);
if (isset($matches[1])) {
$actual = $matches[1];
if (!$message) {
$message = new FormattableMarkup('Page title @actual is equal to @expected.', [
'@actual' => var_export($actual, TRUE),
'@expected' => var_export($title, TRUE),
]);
}
$this->assertEquals($title, $actual, $message);
}
else {
$this->fail('No title element found on the page.');
}
}
/**
* Pass if the page title is not the given string.
*
* @param string $title
* The string the title should not be.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*/
protected function assertNoTitle($title, $message = '') {
$actual = (string) current($this->xpath('//title'));
if (!$message) {
$message = new FormattableMarkup('Page title @actual is not equal to @unexpected.', [
'@actual' => var_export($actual, TRUE),
'@unexpected' => var_export($title, TRUE),
]);
}
$this->assertNotEquals($title, $actual, $message);
}
/**
* Asserts themed output.
*
* @param string $callback
* The name of the theme hook to invoke; e.g. 'links' for links.html.twig.
* @param array $variables
* An array of variables to pass to the theme function.
* @param string $expected
* The expected themed output string.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*/
protected function assertThemeOutput($callback, array $variables = [], $expected = '', $message = '') {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
// The string cast is necessary because theme functions return
// MarkupInterface objects. This means we can assert that $expected
// matches the theme output without having to worry about 0 == ''.
$output = (string) $renderer->executeInRenderContext(new RenderContext(), function () use ($callback, $variables) {
return \Drupal::theme()->render($callback, $variables);
});
if (!$message) {
$message = '%callback rendered correctly.';
}
$message = new FormattableMarkup($message, [
'%callback' => 'theme_' . $callback . '()',
]);
$this->assertSame($expected, $output, $message);
}
/**
* Asserts that a field exists in the current page with a given Xpath result.
*
* @param \SimpleXmlElement[] $fields
* Xml elements.
* @param string $value
* (optional) Value of the field to assert. You may pass in NULL (default) to skip
* checking the actual value, while still checking that the field exists.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass.
*/
protected function assertFieldsByValue($fields, $value = NULL, $message = '') {
// If value specified then check array for match.
$found = TRUE;
if (isset($value)) {
$found = FALSE;
if ($fields) {
foreach ($fields as $field) {
if (isset($field['value']) && $field['value'] == $value) {
// Input element with correct value.
$found = TRUE;
}
elseif (isset($field->option) || isset($field->optgroup)) {
// Select element found.
$selected = $this->getSelectedItem($field);
if ($selected === FALSE) {
// No item selected so use first item.
$items = $this->getAllOptions($field);
if (!empty($items) && $items[0]['value'] == $value) {
$found = TRUE;
}
}
elseif ($selected == $value) {
$found = TRUE;
}
}
elseif ((string) $field == $value) {
// Text area with correct text.
$found = TRUE;
}
}
}
}
$this->assertNotEmpty($fields);
$this->assertTrue($found, $message);
return TRUE;
}
/**
* Asserts that a field exists in the current page by the given XPath.
*
* @param string $xpath
* XPath used to find the field.
* @param string $value
* (optional) Value of the field to assert. You may pass in NULL (default)
* to skip checking the actual value, while still checking that the field
* exists.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass, FALSE on fail.
*/
protected function assertFieldByXPath($xpath, $value = NULL, $message = '') {
$fields = $this->xpath($xpath);
return $this->assertFieldsByValue($fields, $value, $message);
}
/**
* Get the selected value from a select field.
*
* @param \SimpleXMLElement $element
* SimpleXMLElement select element.
*
* @return bool
* The selected value or FALSE.
*/
protected function getSelectedItem(\SimpleXMLElement $element) {
foreach ($element->children() as $item) {
if (isset($item['selected'])) {
return $item['value'];
}
elseif ($item->getName() == 'optgroup') {
if ($value = $this->getSelectedItem($item)) {
return $value;
}
}
}
return FALSE;
}
/**
* Asserts that a field does not exist or its value does not match, by XPath.
*
* @param string $xpath
* XPath used to find the field.
* @param string $value
* (optional) Value of the field, to assert that the field's value on the
* page does not match it.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass.
*/
protected function assertNoFieldByXPath($xpath, $value = NULL, $message = '') {
$fields = $this->xpath($xpath);
// If value specified then check array for match.
$found = TRUE;
if (isset($value)) {
$found = FALSE;
if ($fields) {
foreach ($fields as $field) {
if ($field['value'] == $value) {
$found = TRUE;
}
}
}
}
$this->assertNotEmpty($fields);
$this->assertTrue($found, $message);
return TRUE;
}
/**
* Asserts that a field exists with the given name and value.
*
* @param string $name
* Name of field to assert.
* @param string $value
* (optional) Value of the field to assert. You may pass in NULL (default)
* to skip checking the actual value, while still checking that the field
* exists.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass, FALSE on fail.
*/
protected function assertFieldByName($name, $value = NULL, $message = NULL) {
if (!isset($message)) {
if (!isset($value)) {
$message = new FormattableMarkup('Found field with name @name', [
'@name' => var_export($name, TRUE),
]);
}
else {
$message = new FormattableMarkup('Found field with name @name and value @value', [
'@name' => var_export($name, TRUE),
'@value' => var_export($value, TRUE),
]);
}
}
return $this->assertFieldByXPath($this->constructFieldXpath('name', $name), $value, $message);
}
/**
* Asserts that a field does not exist with the given name and value.
*
* @param string $name
* Name of field to assert.
* @param string $value
* (optional) Value for the field, to assert that the field's value on the
* page doesn't match it. You may pass in NULL to skip checking the
* value, while still checking that the field doesn't exist. However, the
* default value ('') asserts that the field value is not an empty string.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass, FALSE on fail.
*/
protected function assertNoFieldByName($name, $value = '', $message = '') {
return $this->assertNoFieldByXPath($this->constructFieldXpath('name', $name), $value, $message ? $message : new FormattableMarkup('Did not find field by name @name', [
'@name' => $name,
]));
}
/**
* Asserts that a field exists with the given ID and value.
*
* @param string $id
* ID of field to assert.
* @param string|\Drupal\Component\Render\MarkupInterface $value
* (optional) Value for the field to assert. You may pass in NULL to skip
* checking the value, while still checking that the field exists.
* However, the default value ('') asserts that the field value is an empty
* string.
* @param string|\Drupal\Component\Render\MarkupInterface $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass, FALSE on fail.
*/
protected function assertFieldById($id, $value = '', $message = '') {
// Cast MarkupInterface objects to string.
if (isset($value)) {
$value = (string) $value;
}
$message = (string) $message;
return $this->assertFieldByXPath($this->constructFieldXpath('id', $id), $value, $message ? $message : new FormattableMarkup('Found field by id @id', [
'@id' => $id,
]));
}
/**
* Asserts that a field does not exist with the given ID and value.
*
* @param string $id
* ID of field to assert.
* @param string $value
* (optional) Value for the field, to assert that the field's value on the
* page doesn't match it. You may pass in NULL to skip checking the value,
* while still checking that the field doesn't exist. However, the default
* value ('') asserts that the field value is not an empty string.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass, FALSE on fail.
*/
protected function assertNoFieldById($id, $value = '', $message = '') {
return $this->assertNoFieldByXPath($this->constructFieldXpath('id', $id), $value, $message ? $message : new FormattableMarkup('Did not find field by id @id', [
'@id' => $id,
]));
}
/**
* Asserts that a checkbox field in the current page is checked.
*
* @param string $id
* ID of field to assert.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass.
*/
protected function assertFieldChecked($id, $message = '') {
$message = $message ? $message : new FormattableMarkup('Checkbox field @id is checked.', [
'@id' => $id,
]);
$elements = $this->xpath('//input[@id=:id]', [
':id' => $id,
]);
$this->assertNotEmpty($elements, $message);
$this->assertNotEmpty($elements[0]['checked'], $message);
return TRUE;
}
/**
* Asserts that a checkbox field in the current page is not checked.
*
* @param string $id
* ID of field to assert.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass.
*/
protected function assertNoFieldChecked($id, $message = '') {
$message = $message ? $message : new FormattableMarkup('Checkbox field @id is not checked.', [
'@id' => $id,
]);
$elements = $this->xpath('//input[@id=:id]', [
':id' => $id,
]);
$this->assertNotEmpty($elements, $message);
$this->assertEmpty($elements[0]['checked'], $message);
return TRUE;
}
/**
* Asserts that a select option in the current page exists.
*
* @param string $id
* ID of select field to assert.
* @param string $option
* Option to assert.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*/
protected function assertOption($id, $option, $message = '') {
$options = $this->xpath('//select[@id=:id]//option[@value=:option]', [
':id' => $id,
':option' => $option,
]);
$this->assertTrue(isset($options[0]), $message ? $message : new FormattableMarkup('Option @option for field @id exists.', [
'@option' => $option,
'@id' => $id,
]));
}
/**
* Asserts that a select option with the visible text exists.
*
* @param string $id
* The ID of the select field to assert.
* @param string $text
* The text for the option tag to assert.
* @param string $message
* (optional) A message to display with the assertion.
*/
protected function assertOptionByText($id, $text, $message = '') {
$options = $this->xpath('//select[@id=:id]//option[normalize-space(text())=:text]', [
':id' => $id,
':text' => $text,
]);
$this->assertTrue(isset($options[0]), $message ?: 'Option with text label ' . $text . ' for select field ' . $id . ' exits.');
}
/**
* Asserts that a select option in the current page exists.
*
* @param string $drupal_selector
* The data drupal selector of select field to assert.
* @param string $option
* Option to assert.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*/
protected function assertOptionWithDrupalSelector($drupal_selector, $option, $message = '') {
$options = $this->xpath('//select[@data-drupal-selector=:data_drupal_selector]//option[@value=:option]', [
':data_drupal_selector' => $drupal_selector,
':option' => $option,
]);
$this->assertTrue(isset($options[0]), $message ? $message : new FormattableMarkup('Option @option for field @data_drupal_selector exists.', [
'@option' => $option,
'@data_drupal_selector' => $drupal_selector,
]));
}
/**
* Asserts that a select option in the current page does not exist.
*
* @param string $id
* ID of select field to assert.
* @param string $option
* Option to assert.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass.
*/
protected function assertNoOption($id, $option, $message = '') {
$message = $message ? $message : new FormattableMarkup('Option @option for field @id does not exist.', [
'@option' => $option,
'@id' => $id,
]);
$selects = $this->xpath('//select[@id=:id]', [
':id' => $id,
]);
$options = $this->xpath('//select[@id=:id]//option[@value=:option]', [
':id' => $id,
':option' => $option,
]);
$this->assertArrayHasKey(0, $selects, $message);
$this->assertEmpty($options, $message);
return TRUE;
}
/**
* Asserts that a select option in the current page is checked.
*
* @param string $id
* ID of select field to assert.
* @param string $option
* Option to assert.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass.
*
* @todo $id is unusable. Replace with $name.
*/
protected function assertOptionSelected($id, $option, $message = '') {
$message = $message ? $message : new FormattableMarkup('Option @option for field @id is selected.', [
'@option' => $option,
'@id' => $id,
]);
$elements = $this->xpath('//select[@id=:id]//option[@value=:option]', [
':id' => $id,
':option' => $option,
]);
$this->assertNotEmpty($elements, $message);
$this->assertNotEmpty($elements[0]['selected'], $message);
return TRUE;
}
/**
* Asserts that a select option in the current page is checked.
*
* @param string $drupal_selector
* The data drupal selector of select field to assert.
* @param string $option
* Option to assert.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass, FALSE on fail.
*
* @todo $id is unusable. Replace with $name.
*/
protected function assertOptionSelectedWithDrupalSelector($drupal_selector, $option, $message = '') {
$message = $message ? $message : new FormattableMarkup('Option @option for field @data_drupal_selector is selected.', [
'@option' => $option,
'@data_drupal_selector' => $drupal_selector,
]);
$elements = $this->xpath('//select[@data-drupal-selector=:data_drupal_selector]//option[@value=:option]', [
':data_drupal_selector' => $drupal_selector,
':option' => $option,
]);
$this->assertNotEmpty($elements, $message);
$this->assertNotEmpty($elements[0]['selected'], $message);
return TRUE;
}
/**
* Asserts that a select option in the current page is not checked.
*
* @param string $id
* ID of select field to assert.
* @param string $option
* Option to assert.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass.
*/
protected function assertNoOptionSelected($id, $option, $message = '') {
$message = $message ? $message : new FormattableMarkup('Option @option for field @id is not selected.', [
'@option' => $option,
'@id' => $id,
]);
$elements = $this->xpath('//select[@id=:id]//option[@value=:option]', [
':id' => $id,
':option' => $option,
]);
$this->assertNotEmpty($elements, $message);
$this->assertEmpty($elements[0]['selected'], $message);
return TRUE;
}
/**
* Asserts that a field exists with the given name or ID.
*
* @param string $field
* Name or ID of field to assert.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass, FALSE on fail.
*/
protected function assertField($field, $message = '') {
return $this->assertFieldByXPath($this->constructFieldXpath('name', $field) . '|' . $this->constructFieldXpath('id', $field), NULL, $message);
}
/**
* Asserts that a field does not exist with the given name or ID.
*
* @param string $field
* Name or ID of field to assert.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
*
* @return bool
* TRUE on pass, FALSE on fail.
*/
protected function assertNoField($field, $message = '') {
return $this->assertNoFieldByXPath($this->constructFieldXpath('name', $field) . '|' . $this->constructFieldXpath('id', $field), NULL, $message);
}
/**
* Asserts that each HTML ID is used for just a single element.
*
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). Use double quotes and embed variables directly in
* message text, or use sprintf() if necessary. Avoid the use of
* \Drupal\Component\Render\FormattableMarkup unless you cast the object to
* a string. If left blank, a default message will be displayed.
* @param string $group
* Deprecated.
* @param array $ids_to_skip
* An optional array of ids to skip when checking for duplicates. It is
* always a bug to have duplicate HTML IDs, so this parameter is to enable
* incremental fixing of core code. Whenever a test passes this parameter,
* it should add a "todo" comment above the call to this function explaining
* the legacy bug that the test wishes to ignore and including a link to an
* issue that is working to fix that legacy bug.
*
* @return bool
* TRUE on pass.
*/
protected function assertNoDuplicateIds($message = '', $group = NULL, $ids_to_skip = []) {
$status = TRUE;
foreach ($this->xpath('//*[@id]') as $element) {
$id = (string) $element['id'];
if (isset($seen_ids[$id]) && !in_array($id, $ids_to_skip)) {
$this->fail(new FormattableMarkup('The HTML ID %id is unique.', [
'%id' => $id,
]));
$status = FALSE;
}
$seen_ids[$id] = TRUE;
}
$this->assertTrue($status, $message);
return TRUE;
}
/**
* Helper: Constructs an XPath for the given set of attributes and value.
*
* @param string $attribute
* Field attributes.
* @param string $value
* Value of field.
*
* @return string
* XPath for specified values.
*/
protected function constructFieldXpath($attribute, $value) {
$xpath = '//textarea[@' . $attribute . '=:value]|//input[@' . $attribute . '=:value]|//select[@' . $attribute . '=:value]';
return $this->buildXPathQuery($xpath, [
':value' => $value,
]);
}
}Traits
| Title | Deprecated | Summary |
|---|---|---|
| AssertContentTrait | Provides test methods to assert content. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.