Merge pull request #7946 from michalsn/feat/domparser-seeXPath

feat: domparser - ability to write more advanced expressions
codeigniter4 · Sep 20, 2023 · 0280297 · 0280297
2 parents 5ef7fa2 + 60dc155
commit 0280297
Show file tree

Hide file tree

Showing 6 changed files with 104 additions and 0 deletions.
diff --git a/system/Test/DOMParser.php b/system/Test/DOMParser.php
@@ -175,6 +175,24 @@ public function seeCheckboxIsChecked(string $element): bool
         return (bool) $result->length;
     }
 
+    /**
+     * Checks to see if the XPath can be found.
+     */
+    public function seeXPath(string $path): bool
+    {
+        $xpath = new DOMXPath($this->dom);
+
+        return (bool) $xpath->query($path)->length;
+    }
+
+    /**
+     * Checks to see if the XPath can't be found.
+     */
+    public function dontSeeXPath(string $path): bool
+    {
+        return ! $this->seeXPath($path);
+    }
+
     /**
      * Search the DOM using an XPath expression.
      *

diff --git a/tests/system/Test/DOMParserTest.php b/tests/system/Test/DOMParserTest.php
@@ -416,4 +416,48 @@ public function testSeeAttribute(): void
         $this->assertTrue($dom->see(null, '*[ name = user ]'));
         $this->assertFalse($dom->see(null, '*[ name = notthere ]'));
     }
+
+    public function testSeeXPathSuccess(): void
+    {
+        $dom = new DOMParser();
+
+        $html = '<html><body><h1 class="heading gap-2">Hello World Wide Web</h1></body></html>';
+        $dom->withString($html);
+
+        $this->assertTrue($dom->seeXPath('//h1[contains(@class, "heading")]'));
+        $this->assertTrue($dom->seeXPath('//h1[contains(@class, "heading")][contains(.,"Hello World")]'));
+    }
+
+    public function testSeeXPathFail(): void
+    {
+        $dom = new DOMParser();
+
+        $html = '<html><body><h1 class="heading gap-2">Hello World Wide Web</h1></body></html>';
+        $dom->withString($html);
+
+        $this->assertFalse($dom->seeXPath('//h1[contains(@class, "heading123")]'));
+        $this->assertFalse($dom->seeXPath('//h1[contains(@class, "heading")][contains(.,"Hello World 123")]'));
+    }
+
+    public function testDontSeeXPathSuccess(): void
+    {
+        $dom = new DOMParser();
+
+        $html = '<html><body><h1 class="heading gap-2">Hello World Wide Web</h1></body></html>';
+        $dom->withString($html);
+
+        $this->assertTrue($dom->dontSeeXPath('//h1[contains(@class, "heading123")]'));
+        $this->assertTrue($dom->dontSeeXPath('//h1[contains(@class, "heading")][contains(.,"Hello World 123")]'));
+    }
+
+    public function testDontSeeXPathFail(): void
+    {
+        $dom = new DOMParser();
+
+        $html = '<html><body><h1 class="heading gap-2">Hello World Wide Web</h1></body></html>';
+        $dom->withString($html);
+
+        $this->assertFalse($dom->dontSeeXPath('//h1[contains(@class, "heading")]'));
+        $this->assertFalse($dom->dontSeeXPath('//h1[contains(@class, "heading")][contains(.,"Hello World")]'));
+    }
 }
diff --git a/user_guide_src/source/changelogs/v4.5.0.rst b/user_guide_src/source/changelogs/v4.5.0.rst
@@ -52,6 +52,9 @@ Commands
 Testing
 =======
 
+- **DomParser:** The new methods were added ``seeXPath()`` and ``dontSeeXPath()``
+  which allows users to work directly with DOMXPath object, using complex expressions.
+
 Database
 ========
 

diff --git a/user_guide_src/source/testing/response.rst b/user_guide_src/source/testing/response.rst
@@ -223,6 +223,23 @@ Finally, you can check if a checkbox exists and is checked with the ``seeCheckbo
 .. literalinclude:: response/023.php
    :lines: 2-
 
+seeXPath()
+----------
+
+.. versionadded:: 4.5.0
+
+You can use ``seeXPath()`` to take advantage of the full power that xpath gives you.
+This method is aimed at more advanced users who want to write a more complex expressions
+using the DOMXPath object directly:
+
+.. literalinclude:: response/033.php
+   :lines: 2-
+
+The ``dontSeeXPath()`` method is the exact opposite:
+
+.. literalinclude:: response/034.php
+   :lines: 2-
+
 DOM Assertions
 ==============
 

diff --git a/user_guide_src/source/testing/response/033.php b/user_guide_src/source/testing/response/033.php
@@ -0,0 +1,11 @@
+<?php
+
+// Check that h1 element which contains class "heading" is on the page
+if ($results->seeXPath('//h1[contains(@class, "heading")]')) {
+    // ...
+}
+
+// Check that h1 element which contains class "heading" have a text "Hello World"
+if ($results->seeXPath('//h1[contains(@class, "heading")][contains(.,"Hello world")]')) {
+    // ...
+}
diff --git a/user_guide_src/source/testing/response/034.php b/user_guide_src/source/testing/response/034.php
@@ -0,0 +1,11 @@
+<?php
+
+// Check that h1 element which contains class "heading" does NOT exist on the page
+if ($results->dontSeeXPath('//h1[contains(@class, "heading")]')) {
+    // ...
+}
+
+// Check that h1 element which contains class "heading" and text "Hello World" does NOT exist on the page
+if ($results->dontSeeXPath('//h1[contains(@class, "heading")][contains(.,"Hello world")]')) {
+    // ...
+}