Merge pull request #54 from elbformat/fix-xpath-quotes

Fix escaping of xpath expressions with quotes

Author: hgiesenow

doc/changelog.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## v1.5.11
+* Fix: Escaping of quotes in xpath expressions.
+
 ## v1.5.10
 * Fix: Mailer deprecation warnings for implicit nullable parameter.
 * Feature: Allow mailer to fail

doc/development.md

@@ -2,7 +2,7 @@
 
 Use docker for local tasks
 ```bash
-docker-compose run php sh
+docker compose run php sh
 # Install dependencies
 composer install
 # Run unittests

src/Context/HtmlContext.php

@@ -113,7 +113,7 @@ protected function mustContainTag(string $tagName, array $attr = [], ?string $co
         $crawler = $this->getCrawler();
         $xPath = '//'.$tagName;
         foreach ($attr as $attrName => $attrVal) {
-            $xPath .= sprintf('[@%s="%s"]', $attrName, $attrVal);
+            $xPath .= sprintf('[@%s=%s]', $attrName, $this->escapeXpathValue($attrVal));
         }
         $elements = $crawler->filterXPath($xPath);
 
@@ -136,4 +136,29 @@ protected function mustContainTag(string $tagName, array $attr = [], ?string $co
 
         return null;
     }
+
+    protected function escapeXpathValue(string $value): string
+    {
+        // Inspired by https://stackoverflow.com/questions/1341847/apostrophe-in-xpath-query/1352556#1352556
+        // use "
+        if (!str_contains($value, '"')) {
+            return '"'.$value.'"';
+        }
+        // use '
+        if (!str_contains($value, "'")) {
+            return "'".$value."'";
+        }
+        // use concat
+        $parts = explode('"', $value);
+        $attrVal = 'concat("'.array_shift($parts).'"';
+        foreach ($parts as $part) {
+            $attrVal .= ",'\"'";
+            if ('' !== $part) {
+                $attrVal .= ',"'.$part.'"';
+            }
+        }
+        $attrVal .= ')';
+
+        return $attrVal;
+    }
 }

tests/Context/HtmlContextTest.php

@@ -79,6 +79,20 @@ public function testISeeBeforeFails(): void
         $this->htmlContext->iSeeBefore('World', 'Hello');
     }
 
+    public function testISeeBeforeNotFound1(): void
+    {
+        $this->setDom('<p>Hello World</p>');
+        $this->expectExceptionMessage('"Me" not found');
+        $this->htmlContext->iSeeBefore('Me', 'World');
+    }
+
+    public function testISeeBeforeNotFound2(): void
+    {
+        $this->setDom('<p>Hello World</p>');
+        $this->expectExceptionMessage('"Me" not found');
+        $this->htmlContext->iSeeBefore('Hello', 'Me');
+    }
+
     public function testISeeATag(): void
     {
         $this->setDom('<a href="/test"></a>');
@@ -103,6 +117,22 @@ public function testISeeATagWithContentComplex(): void
         $this->htmlContext->iSeeATag('a', $table, 'Hello World');
     }
 
+    public function testISeeATagWithDifferentQuotes(): void
+    {
+        $this->setDom('<span text="Hello &quot;World&apos;"></span>');
+        $table = new TableNode([0 => ['text', 'Hello "World\'']]);
+        $this->expectNotToPerformAssertions();
+        $this->htmlContext->iSeeATag('span', $table);
+    }
+
+    public function testISeeATagWithSingleQuote(): void
+    {
+        $this->setDom('<span text="Hello &quot;World&quot;"></span>');
+        $table = new TableNode([0 => ['text', 'Hello "World"']]);
+        $this->expectNotToPerformAssertions();
+        $this->htmlContext->iSeeATag('span', $table);
+    }
+
     public function testISeeATagFails(): void
     {
         $this->setDom('<a href="/test">Hello World</a>');