[#413] Added assertion for the element after element. (#419)

Co-authored-by: Nikita Sineok <[email protected]>
Co-authored-by: Alex Skrypnyk <[email protected]>

Author: 3 people

STEPS.md

@@ -319,6 +319,34 @@ When I scroll to the element "#footer"
 
 </details>
 
+<details>
+  <summary><code>@Then the element :selector1 should appear after the element :selector2</code></summary>
+
+<br/>
+Assert that one element appears after another on the page
+<br/><br/>
+
+```gherkin
+Then the element "body" should appear after the element "head"
+
+```
+
+</details>
+
+<details>
+  <summary><code>@Then the text :text1 should appear after the text :text2</code></summary>
+
+<br/>
+Assert that one text string appears after another on the page
+<br/><br/>
+
+```gherkin
+Then the text "Welcome" should appear after the text "Home"
+
+```
+
+</details>
+
 <details>
   <summary><code>@Then the element :selector with the attribute :attribute and the value :value should exist</code></summary>
 

src/ElementTrait.php

@@ -13,6 +13,75 @@
  */
 trait ElementTrait {
 
+  /**
+   * Assert that one element appears after another on the page.
+   *
+   * @code
+   * Then the element "body" should appear after the element "head"
+   * @endcode
+   *
+   * @Then the element :selector1 should appear after the element :selector2
+   */
+  public function elementAssertAfterElement(string $selector1, string $selector2): void {
+    $session = $this->getSession();
+    $page = $session->getPage();
+
+    $element1 = $page->find('css', $selector1);
+    $element2 = $page->find('css', $selector2);
+
+    if (!$element1) {
+      throw new \Exception(sprintf("Element with selector '%s' not found.", $selector1));
+    }
+    if (!$element2) {
+      throw new \Exception(sprintf("Element with selector '%s' not found.", $selector2));
+    }
+
+    $text1 = $element1->getOuterHtml();
+    $text2 = $element2->getOuterHtml();
+    $content = $this->getSession()->getPage()->getOuterHtml();
+
+    $pos1 = strpos((string) $content, (string) $text1);
+    $pos2 = strpos((string) $content, (string) $text2);
+
+    if ($pos1 === FALSE) {
+      throw new \Exception(sprintf("Element with selector '%s' not found.", $selector1));
+    }
+    if ($pos2 === FALSE) {
+      throw new \Exception(sprintf("Element with selector '%s' not found.", $selector2));
+    }
+
+    if ($pos1 <= $pos2) {
+      throw new \Exception(sprintf("Element '%s' appears before '%s'", $selector1, $selector2));
+    }
+  }
+
+  /**
+   * Assert that one text string appears after another on the page.
+   *
+   * @code
+   * Then the text "Welcome" should appear after the text "Home"
+   * @endcode
+   *
+   * @Then the text :text1 should appear after the text :text2
+   */
+  public function elementAssertTextAfterText(string $text1, string $text2): void {
+    $content = $this->getSession()->getPage()->getText();
+
+    $pos1 = strpos((string) $content, $text1);
+    $pos2 = strpos((string) $content, $text2);
+
+    if ($pos1 === FALSE) {
+      throw new \Exception(sprintf("Text was not found: '%s'.", $text1));
+    }
+    if ($pos2 === FALSE) {
+      throw new \Exception(sprintf("Text was not found: '%s'.", $text2));
+    }
+
+    if ($pos1 <= $pos2) {
+      throw new \Exception(sprintf("Text '%s' appears before '%s'", $text1, $text2));
+    }
+  }
+
   /**
    * Assert an element with selector and attribute with a value exists.
    *

tests/behat/features/element.feature

@@ -341,3 +341,41 @@ Feature: Check that ElementTrait works
       """
       Element(s) defined by "#top" selector is displayed within a viewport, but should not be.
       """
+
+  @api
+  Scenario: Text appears after another text
+    When I go to the homepage
+    Then the text "Powered by Drupal" should appear after the text "Welcome"
+
+  @api
+  Scenario: Assert "Then the element :selector1 should appear after the element :selector2" works as expected
+    When I go to the homepage
+    Then the element "body" should appear after the element "head"
+
+  @trait:ElementTrait
+  Scenario: Assert element order fails when first element is before second
+    Given some behat configuration
+    And scenario steps:
+      """
+      When I go to the homepage
+      Then the element "head" should appear after the element "body"
+      """
+    When I run "behat --no-colors"
+    Then it should fail with an error:
+      """
+      Element 'head' appears before 'body'
+      """
+
+  @trait:ElementTrait
+  Scenario: Assert text order fails when first text is before second
+    Given some behat configuration
+    And scenario steps:
+      """
+      When I go to the homepage
+      Then the text "Welcome" should appear after the text "Powered by Drupal"
+      """
+    When I run "behat --no-colors"
+    Then it should fail with an error:
+      """
+      Text 'Welcome' appears before 'Powered by Drupal'
+      """