refactor: minor refactor on messages + add isWindows() method using DIRECTORY_SEPARATOR check to set pipes

Author: Sushil Gupta

src/Helper/Shell.php

@@ -64,23 +64,23 @@ class Shell
     /** @var resource The actual process resource returned from proc_open */
     protected $process = null;
 
-    /** @var array Status of the process as returned from proc_get_status */
-    protected $processStatus = null;
-
     /** @var int Process starting time in unix timestamp */
     protected $processStartTime;
 
-    /** @var string Current state of the shell execution */
-    protected $state = self::STATE_READY;
+    /** @var array Status of the process as returned from proc_get_status */
+    protected $processStatus = null;
 
     /** @var float Default timeout for the process in seconds with microseconds */
     protected $processTimeout = null;
 
+    /** @var string Current state of the shell execution, set from this class, NOT for proc_get_status */
+    protected $state = self::STATE_READY;
+
     public function __construct(string $command, string $input = null)
     {
         // @codeCoverageIgnoreStart
         if (!\function_exists('proc_open')) {
-            throw new RuntimeException('Required proc_open could not be found in your PHP setup');
+            throw new RuntimeException('Required proc_open could not be found in your PHP setup.');
         }
         // @codeCoverageIgnoreEnd
 
@@ -90,7 +90,7 @@ public function __construct(string $command, string $input = null)
 
     protected function getDescriptors(): array
     {
-        $out = '\\' === \DIRECTORY_SEPARATOR ? ['file', 'NUL', 'w'] : ['pipe', 'w'];
+        $out = $this->isWindows() ? ['file', 'NUL', 'w'] : ['pipe', 'w'];
 
         return [
             self::STDIN_DESCRIPTOR_KEY  => ['pipe', 'r'],
@@ -99,6 +99,11 @@ protected function getDescriptors(): array
         ];
     }
 
+    protected function isWindows(): bool
+    {
+        return '\\' === \DIRECTORY_SEPARATOR;
+    }
+
     protected function setInput()
     {
         \fwrite($this->pipes[self::STDIN_DESCRIPTOR_KEY], $this->input);
@@ -145,7 +150,7 @@ protected function checkTimeout()
         if ($executionDuration > $this->processTimeout) {
             $this->kill();
 
-            throw new RuntimeException('Process timeout occurred, terminated');
+            throw new RuntimeException('Timeout occurred, process terminated.');
         }
 
         // @codeCoverageIgnoreStart
@@ -166,7 +171,7 @@ public function setOptions(string $cwd = null, array $env = null, float $timeout
     public function execute(bool $async = false): self
     {
         if ($this->isRunning()) {
-            throw new RuntimeException('Process is already running');
+            throw new RuntimeException('Process is already running.');
         }
 
         $this->descriptors      = $this->getDescriptors();
@@ -264,6 +269,6 @@ public function kill()
     public function __destruct()
     {
         // If async (run in background) => we don't care if it ever closes
-        // Otherwise, waited already till it runs or timeout occurs, in which case kill it
+        // Otherwise, waited already till it ends itself or timeout occurs, in which case kill it
     }
 }

tests/Helper/ShellTest.php

@@ -53,7 +53,7 @@ public function test_async_stop()
 
     /**
      * @expectedException \RuntimeException
-     * @expectedExceptionMessage Process timeout occurred
+     * @expectedExceptionMessage Timeout occurred, process terminated.
      */
     public function test_timeout()
     {