bug #39856 [DomCrawler] improve failure messages of the CrawlerSelectorTextContains constraint (xabbuh)

fabpot · fabpot · commit 6ae338abc77b · 2021-08-26T08:52:27.000+02:00
This PR was merged into the 4.4 branch.

Discussion
----------

[DomCrawler] improve failure messages of the CrawlerSelectorTextContains constraint

| Q             | A
| ------------- | ---
| Branch?       | 5.x
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Tickets       | Fix #33551, #37757
| License       | MIT
| Doc PR        |

Commits
-------

ba451ab7b2 improve failure messages of the CrawlerSelectorTextContains constraint
diff --git a/Test/Constraint/CrawlerSelectorTextContains.php b/Test/Constraint/CrawlerSelectorTextContains.php
@@ -18,6 +18,8 @@ final class CrawlerSelectorTextContains extends Constraint
 {
     private $selector;
     private $expectedText;
+    private $hasNode = false;
+    private $nodeText;
 
     public function __construct(string $selector, string $expectedText)
     {
@@ -30,7 +32,11 @@ public function __construct(string $selector, string $expectedText)
      */
     public function toString(): string
     {
-        return sprintf('has a node matching selector "%s" with content containing "%s"', $this->selector, $this->expectedText);
+        if ($this->hasNode) {
+            return sprintf('the text "%s" of the node matching selector "%s" contains "%s"', $this->nodeText, $this->selector, $this->expectedText);
+        }
+
+        return sprintf('the Crawler has a node matching selector "%s"', $this->selector);
     }
 
     /**
@@ -42,10 +48,15 @@ protected function matches($crawler): bool
     {
         $crawler = $crawler->filter($this->selector);
         if (!\count($crawler)) {
+            $this->hasNode = false;
+
             return false;
         }
 
-        return false !== mb_strpos($crawler->text(null, true), $this->expectedText);
+        $this->hasNode = true;
+        $this->nodeText = $crawler->text(null, true);
+
+        return false !== mb_strpos($this->nodeText, $this->expectedText);
     }
 
     /**
@@ -55,6 +66,6 @@ protected function matches($crawler): bool
      */
     protected function failureDescription($crawler): string
     {
-        return 'the Crawler '.$this->toString();
+        return $this->toString();
     }
 }
diff --git a/Tests/Test/Constraint/CrawlerSelectorTextContainsTest.php b/Tests/Test/Constraint/CrawlerSelectorTextContainsTest.php
@@ -24,15 +24,22 @@ public function testConstraint()
         $constraint = new CrawlerSelectorTextContains('title', 'Foo');
         $this->assertTrue($constraint->evaluate(new Crawler('<html><head><title>Foobar'), '', true));
         $this->assertFalse($constraint->evaluate(new Crawler('<html><head><title>Bar'), '', true));
+        $this->assertFalse($constraint->evaluate(new Crawler('<html><head></head><body>Bar'), '', true));
 
         try {
             $constraint->evaluate(new Crawler('<html><head><title>Bar'));
-        } catch (ExpectationFailedException $e) {
-            $this->assertEquals("Failed asserting that the Crawler has a node matching selector \"title\" with content containing \"Foo\".\n", TestFailure::exceptionToString($e));
 
-            return;
+            $this->fail();
+        } catch (ExpectationFailedException $e) {
+            $this->assertEquals("Failed asserting that the text \"Bar\" of the node matching selector \"title\" contains \"Foo\".\n", TestFailure::exceptionToString($e));
         }
 
-        $this->fail();
+        try {
+            $constraint->evaluate(new Crawler('<html><head></head><body>Bar'));
+
+            $this->fail();
+        } catch (ExpectationFailedException $e) {
+            $this->assertEquals("Failed asserting that the Crawler has a node matching selector \"title\".\n", TestFailure::exceptionToString($e));
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,8 @@ final class CrawlerSelectorTextContains extends Constraint`
`18`	`18`	`{`
`19`	`19`	`private $selector;`
`20`	`20`	`private $expectedText;`
	`21`	`+ private $hasNode = false;`
	`22`	`+ private $nodeText;`
`21`	`23`
`22`	`24`	`public function __construct(string $selector, string $expectedText)`
`23`	`25`	`{`
`@@ -30,7 +32,11 @@ public function __construct(string $selector, string $expectedText)`
`30`	`32`	`*/`
`31`	`33`	`public function toString(): string`
`32`	`34`	`{`
`33`		`- return sprintf('has a node matching selector "%s" with content containing "%s"', $this->selector, $this->expectedText);`
	`35`	`+ if ($this->hasNode) {`
	`36`	`+ return sprintf('the text "%s" of the node matching selector "%s" contains "%s"', $this->nodeText, $this->selector, $this->expectedText);`
	`37`	`+ }`
	`38`	`+`
	`39`	`+ return sprintf('the Crawler has a node matching selector "%s"', $this->selector);`
`34`	`40`	`}`
`35`	`41`
`36`	`42`	`/**`
`@@ -42,10 +48,15 @@ protected function matches($crawler): bool`
`42`	`48`	`{`
`43`	`49`	`$crawler = $crawler->filter($this->selector);`
`44`	`50`	`if (!\count($crawler)) {`
	`51`	`+ $this->hasNode = false;`
	`52`	`+`
`45`	`53`	`return false;`
`46`	`54`	`}`
`47`	`55`
`48`		`- return false !== mb_strpos($crawler->text(null, true), $this->expectedText);`
	`56`	`+ $this->hasNode = true;`
	`57`	`+ $this->nodeText = $crawler->text(null, true);`
	`58`	`+`
	`59`	`+ return false !== mb_strpos($this->nodeText, $this->expectedText);`
`49`	`60`	`}`
`50`	`61`
`51`	`62`	`/**`
`@@ -55,6 +66,6 @@ protected function matches($crawler): bool`
`55`	`66`	`*/`
`56`	`67`	`protected function failureDescription($crawler): string`
`57`	`68`	`{`
`58`		`- return 'the Crawler '.$this->toString();`
	`69`	`+ return $this->toString();`
`59`	`70`	`}`
`60`	`71`	`}`