Allow clients to specify a display-error function.

consolidation · Sep 13, 2016 · c2dc246 · c2dc246
1 parent e8b6e18
commit c2dc246
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 6 deletions.
diff --git a/src/CommandProcessor.php b/src/CommandProcessor.php
@@ -22,6 +22,8 @@ class CommandProcessor
     protected $hookManager;
     /** var FormatterManager */
     protected $formatterManager;
+    /** var callable */
+    protected $displayErrorFunction;
 
     public function __construct(HookManager $hookManager)
     {
@@ -42,6 +44,11 @@ public function setFormatterManager(FormatterManager $formatterManager)
         $this->formatterManager = $formatterManager;
     }
 
+    public function setDisplayErrorFunction(callable $fn)
+    {
+        $this->displayErrorFunction = $fn;
+    }
+
     /**
      * Return the formatter manager
      * @return FormatterManager
@@ -70,7 +77,7 @@ public function process(
             );
             return $this->handleResults($output, $names, $result, $annotationData, $options);
         } catch (\Exception $e) {
-            $result = new CommandError($e->getCode(), $e->getMessage());
+            $result = new CommandError($e->getMessage(), $e->getCode());
             return $this->handleResults($output, $names, $result, $annotationData, $options);
         }
     }
@@ -116,12 +123,13 @@ public function handleResults(OutputInterface $output, $names, $result, Annotati
         // Get the structured output, the output stream and the formatter
         $structuredOutput = $this->hookManager()->extractOutput($names, $result);
         $output = $this->chooseOutputStream($output, $status);
-        if (($status == 0) && isset($this->formatterManager)) {
-            $this->writeUsingFormatter($output, $structuredOutput, $annotationData, $options);
-        } else {
-            $this->writeCommandOutput($output, $structuredOutput);
+        if ($status != 0) {
+            return $this->writeErrorMessage($output, $status, $structuredOutput, $result);
         }
-        return $status;
+        if (isset($this->formatterManager)) {
+            return $this->writeUsingFormatter($output, $structuredOutput, $annotationData, $options);
+        }
+        return $this->writeCommandOutput($output, $structuredOutput);
     }
 
     /**
@@ -198,6 +206,24 @@ protected function writeUsingFormatter(OutputInterface $output, $structuredOutpu
             $structuredOutput,
             $formatterOptions
         );
+        return 0;
+    }
+
+    /**
+     * Description
+     * @param type $output
+     * @param type $status
+     * @param type $structuredOutput
+     * @return type
+     */
+    protected function writeErrorMessage($output, $status, $structuredOutput, $originalResult)
+    {
+        if (isset($this->displayErrorFunction)) {
+            call_user_func($this->displayErrorFunction, $output, $structuredOutput, $status, $originalResult);
+        } else {
+            $this->writeCommandOutput($output, $structuredOutput);
+        }
+        return $status;
     }
 
     /**
@@ -212,6 +238,7 @@ protected function writeCommandOutput(
         if (is_string($structuredOutput)) {
             $output->writeln($structuredOutput);
         }
+        return 0;
     }
 
     /**

diff --git a/tests/src/ExampleCommandFile.php b/tests/src/ExampleCommandFile.php
@@ -191,6 +191,11 @@ public function testHello($who)
         return "Hello, $who.";
     }
 
+    public function testException($what)
+    {
+        throw new \Exception($what);
+    }
+
     /**
      * @hook validate test:hello
      */
@@ -199,6 +204,9 @@ public function validateTestHello($args)
         if ($args['who'] == 'Donald Duck') {
             return new CommandError("I won't say hello to Donald Duck.");
         }
+        if ($args['who'] == 'Drumph') {
+            throw new \Exception('Irrational value error.');
+        }
     }
 
     /**

diff --git a/tests/testAnnotatedCommandFactory.php b/tests/testAnnotatedCommandFactory.php
@@ -331,6 +331,19 @@ function testValidate()
 
         $input = new StringInput('test:hello "Donald Duck"');
         $this->assertRunCommandViaApplicationEquals($command, $input, "I won't say hello to Donald Duck.", 1);
+
+        $input = new StringInput('test:hello "Drumph"');
+        $this->assertRunCommandViaApplicationEquals($command, $input, "Irrational value error.", 1);
+
+        // Try the last test again with a display error function installed.
+        $commandFactory->commandProcessor()->setDisplayErrorFunction(
+            function ($output, $message) {
+                $output->writeln("*** $message ****");
+            }
+        );
+
+        $input = new StringInput('test:hello "Drumph"');
+        $this->assertRunCommandViaApplicationEquals($command, $input, "*** Irrational value error. ****", 1);
     }
 
     function assertRunCommandViaApplicationEquals($command, $input, $expectedOutput, $expectedStatusCode = 0)