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