feature #37241 [Console] Fix Docblock for CommandTester::getExitCode (Jean85)

fabpot · fabpot · commit d5aa77e5e1dd · 2020-06-12T16:43:07.000+02:00
This PR was merged into the 5.2-dev branch. Discussion ---------- [Console] Fix Docblock for CommandTester::getExitCode | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | - | License | MIT While doing static analysis on my code, I found a false positive that led me to this little fix. Commits ------- 876c64e Rework to throw exception if status code is not initialized; add tests
diff --git a/src/Symfony/Component/Console/Tester/TesterTrait.php b/src/Symfony/Component/Console/Tester/TesterTrait.php
@@ -29,6 +29,8 @@ trait TesterTrait
     /**
      * Gets the display returned by the last execution of the command or application.
      *
+     * @throws \RuntimeException If it's called before the execute method
+     *
      * @return string The display
      */
     public function getDisplay(bool $normalize = false)
@@ -95,10 +97,16 @@ public function getOutput()
     /**
      * Gets the status code returned by the last execution of the command or application.
      *
+     * @throws \RuntimeException If it's called before the execute method
+     *
      * @return int The status code
      */
     public function getStatusCode()
     {
+        if (null === $this->statusCode) {
+            throw new \RuntimeException('Status code not initialized, did you execute the command before requesting the status code?');
+        }
+
         return $this->statusCode;
     }
 
diff --git a/src/Symfony/Component/Console/Tests/Tester/CommandTesterTest.php b/src/Symfony/Component/Console/Tests/Tester/CommandTesterTest.php
@@ -67,11 +67,31 @@ public function testGetDisplay()
         $this->assertEquals('foo'.PHP_EOL, $this->tester->getDisplay(), '->getDisplay() returns the display of the last execution');
     }
 
+    public function testGetDisplayWithoutCallingExecuteBefore()
+    {
+        $tester = new CommandTester(new Command());
+
+        $this->expectException(\RuntimeException::class);
+        $this->expectExceptionMessage('Output not initialized');
+
+        $tester->getDisplay();
+    }
+
     public function testGetStatusCode()
     {
         $this->assertSame(0, $this->tester->getStatusCode(), '->getStatusCode() returns the status code');
     }
 
+    public function testGetStatusCodeWithoutCallingExecuteBefore()
+    {
+        $tester = new CommandTester(new Command());
+
+        $this->expectException(\RuntimeException::class);
+        $this->expectExceptionMessage('Status code not initialized');
+
+        $tester->getStatusCode();
+    }
+
     public function testCommandFromApplication()
     {
         $application = new Application();

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,8 @@ trait TesterTrait`
`29`	`29`	`/**`
`30`	`30`	`* Gets the display returned by the last execution of the command or application.`
`31`	`31`	`*`
	`32`	`+ * @throws \RuntimeException If it's called before the execute method`
	`33`	`+ *`
`32`	`34`	`* @return string The display`
`33`	`35`	`*/`
`34`	`36`	`public function getDisplay(bool $normalize = false)`
`@@ -95,10 +97,16 @@ public function getOutput()`
`95`	`97`	`/**`
`96`	`98`	`* Gets the status code returned by the last execution of the command or application.`
`97`	`99`	`*`
	`100`	`+ * @throws \RuntimeException If it's called before the execute method`
	`101`	`+ *`
`98`	`102`	`* @return int The status code`
`99`	`103`	`*/`
`100`	`104`	`public function getStatusCode()`
`101`	`105`	`{`
	`106`	`+ if (null === $this->statusCode) {`
	`107`	`+ throw new \RuntimeException('Status code not initialized, did you execute the command before requesting the status code?');`
	`108`	`+ }`
	`109`	`+`
`102`	`110`	`return $this->statusCode;`
`103`	`111`	`}`
`104`	`112`