Dont use magic numbers for success code either.

cakephp · Dec 16, 2016 · 2bcfe5c · 2bcfe5c
1 parent 4c545b9
commit 2bcfe5c
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 11 deletions.
diff --git a/src/Console/Shell.php b/src/Console/Shell.php
@@ -48,6 +48,13 @@ class Shell
      */
     const CODE_ERROR = 1;
 
+    /**
+     * Default success code
+     *
+     * @var int
+     */
+    const CODE_SUCCESS = 0;
+
     /**
      * Output constant making verbose shells.
      *
@@ -881,7 +888,7 @@ public function helper($name, array $settings = [])
      * @throws \Cake\Console\Exception\StopException
      * @return void
      */
-    protected function _stop($status = 0)
+    protected function _stop($status = self::CODE_SUCCESS)
     {
         throw new StopException('Halting error reached', $status);
     }

diff --git a/src/Console/ShellDispatcher.php b/src/Console/ShellDispatcher.php
@@ -184,10 +184,10 @@ public function dispatch($extra = [])
             return $e->getCode();
         }
         if ($result === null || $result === true) {
-            return 0;
+            return Shell::CODE_SUCCESS;
         }
 
-        return 1;
+        return Shell::CODE_ERROR;
     }
 
     /**

diff --git a/tests/TestCase/Console/ShellDispatcherTest.php b/tests/TestCase/Console/ShellDispatcherTest.php
@@ -14,6 +14,7 @@
  */
 namespace Cake\Test\TestCase\Console;
 
+use Cake\Console\Shell;
 use Cake\Console\ShellDispatcher;
 use Cake\Core\Configure;
 use Cake\Core\Plugin;
@@ -204,12 +205,12 @@ public function testDispatchShellWithMain()
 
         $dispatcher->args = ['mock_with_main'];
         $result = $dispatcher->dispatch();
-        $this->assertSame(0, $result);
+        $this->assertSame(Shell::CODE_SUCCESS, $result);
         $this->assertEquals([], $dispatcher->args);
 
         $dispatcher->args = ['mock_with_main'];
         $result = $dispatcher->dispatch();
-        $this->assertSame(0, $result);
+        $this->assertSame(Shell::CODE_SUCCESS, $result);
         $this->assertEquals([], $dispatcher->args);
     }
 
@@ -237,7 +238,7 @@ public function testDispatchShellWithoutMain()
 
         $dispatcher->args = ['mock_without_main', 'initdb'];
         $result = $dispatcher->dispatch();
-        $this->assertEquals(0, $result);
+        $this->assertEquals(Shell::CODE_SUCCESS, $result);
     }
 
     /**
@@ -264,7 +265,7 @@ public function testDispatchShortPluginAlias()
 
         $dispatcher->args = ['example'];
         $result = $dispatcher->dispatch();
-        $this->assertEquals(0, $result);
+        $this->assertEquals(Shell::CODE_SUCCESS, $result);
     }
 
     /**
@@ -291,7 +292,7 @@ public function testDispatchShortPluginAliasCamelized()
 
         $dispatcher->args = ['Example'];
         $result = $dispatcher->dispatch();
-        $this->assertEquals(0, $result);
+        $this->assertEquals(Shell::CODE_SUCCESS, $result);
     }
 
     /**
@@ -318,7 +319,7 @@ public function testDispatchShortPluginAliasConflict()
 
         $dispatcher->args = ['sample'];
         $result = $dispatcher->dispatch();
-        $this->assertEquals(0, $result);
+        $this->assertEquals(Shell::CODE_SUCCESS, $result);
     }
 
     /**

diff --git a/tests/TestCase/Console/ShellTest.php b/tests/TestCase/Console/ShellTest.php
@@ -67,7 +67,7 @@ class ShellTestShell extends Shell
      * @param int $status
      * @return void
      */
-    protected function _stop($status = 0)
+    protected function _stop($status = Shell::CODE_SUCCESS)
     {
         $this->stopped = $status;
     }
@@ -991,7 +991,7 @@ public function testRunCommandWithMissingMethodInSubcommands()
      *
      * @return void
      */
-    public function testRunCommandBaseclassMethod()
+    public function testRunCommandBaseClassMethod()
     {
         $shell = $this->getMockBuilder('Cake\Console\Shell')
             ->setMethods(['startup', 'getOptionParser', 'out', 'hr'])