feature #42881 [Console] Add more context when CommandIsSuccessful fails (yoannrenard)

fabpot · fabpot · commit c4df3a7340c5 · 2021-09-07T13:19:02.000+02:00
This PR was squashed before being merged into the 5.4 branch. Discussion ---------- [Console] Add more context when CommandIsSuccessful fails | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | N/A | License | MIT | Doc PR | N/A Give some more context when CommandIsSuccessful::assertCommandIsSuccessful() fails Commits ------- 695cd9d [Console] Add more context when CommandIsSuccessful fails
diff --git a/src/Symfony/Component/Console/Tester/Constraint/CommandIsSuccessful.php b/src/Symfony/Component/Console/Tester/Constraint/CommandIsSuccessful.php
@@ -39,4 +39,17 @@ protected function failureDescription($other): string
     {
         return 'the command '.$this->toString();
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function additionalFailureDescription($other): string
+    {
+        $mapping = [
+            Command::FAILURE => 'Command failed.',
+            Command::INVALID => 'Command was invalid.',
+        ];
+
+        return $mapping[$other] ?? sprintf('Command returned exit status %d.', $other);
+    }
 }
diff --git a/src/Symfony/Component/Console/Tests/Tester/Constraint/CommandIsSuccessfulTest.php b/src/Symfony/Component/Console/Tests/Tester/Constraint/CommandIsSuccessfulTest.php
@@ -26,15 +26,31 @@ public function testConstraint()
         $this->assertTrue($constraint->evaluate(Command::SUCCESS, '', true));
         $this->assertFalse($constraint->evaluate(Command::FAILURE, '', true));
         $this->assertFalse($constraint->evaluate(Command::INVALID, '', true));
+    }
+
+    /**
+     * @dataProvider providesUnsuccessful
+     */
+    public function testUnsuccessfulCommand(string $expectedException, int $exitCode)
+    {
+        $constraint = new CommandIsSuccessful();
 
         try {
-            $constraint->evaluate(Command::FAILURE);
+            $constraint->evaluate($exitCode);
         } catch (ExpectationFailedException $e) {
             $this->assertStringContainsString('Failed asserting that the command is successful.', TestFailure::exceptionToString($e));
+            $this->assertStringContainsString($expectedException, TestFailure::exceptionToString($e));
 
             return;
         }
 
         $this->fail();
     }
+
+    public function providesUnsuccessful(): iterable
+    {
+        yield 'Failed' => ['Command failed.', Command::FAILURE];
+        yield 'Invalid' => ['Command was invalid.', Command::INVALID];
+        yield 'Exit code 3' => ['Command returned exit status 3.', 3];
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -39,4 +39,17 @@ protected function failureDescription($other): string`
`39`	`39`	`{`
`40`	`40`	`return 'the command '.$this->toString();`
`41`	`41`	`}`
	`42`	`+`
	`43`	`+ /**`
	`44`	`+ * {@inheritdoc}`
	`45`	`+ */`
	`46`	`+ protected function additionalFailureDescription($other): string`
	`47`	`+ {`
	`48`	`+ $mapping = [`
	`49`	`+ Command::FAILURE => 'Command failed.',`
	`50`	`+ Command::INVALID => 'Command was invalid.',`
	`51`	`+ ];`
	`52`	`+`
	`53`	`+ return $mapping[$other] ?? sprintf('Command returned exit status %d.', $other);`
	`54`	`+ }`
`42`	`55`	`}`