Shell::getDescriptors() - Code Metrics - Inspection of "Shell wrapper" - adhocore/php-cli - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#39)

unknown

created 2018-09-01 16:48 UTC

Shell::getDescriptors() A

↳ Parent: Shell

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	5
nc	2
nop	0
dl	0
loc	8
rs	10
c	0
b	0
f	0

<?php

/*
 * This file is part of the PHP-CLI package.
 * <https://github.com/adhocore/php-cli>
 *
 * (c) Sushil Gupta <[email protected]>
 * <https://github.com/sushilgupta>
 *
 * Licensed under MIT license.
 */

namespace Ahc\Cli\Helper;

use Ahc\Cli\Exception\RuntimeException;

/*
 * A thin proc_open wrapper to execute shell commands.
 * @author Sushil Gupta <[email protected]>
 * @license MIT
 */
class Shell
{
    const STDIN_DESCRIPTOR_KEY  = 0;
    const STDOUT_DESCRIPTOR_KEY = 1;
    const STDERR_DESCRIPTOR_KEY = 2;

    /** @var string Command to be executed */
    protected $command;

    /** @var array Descriptor to be passed for proc_open */
    protected $descriptors;

    /** @var int Exit code of the process once it has been terminated */
    protected $exitCode;

    /** @var string Input for stdin */
    protected $input;

    /** @var array Pointers to stdin, stdout & stderr */
    protected $pipes;

    /** @var resource The actual process resource returned from proc_open */
    protected $process;

    /** @var string Status of the process as returned from proc_get_status */
    protected $status;

    public function __construct(string $command, string $input = null)
    {
        if (!\function_exists('proc_open')) {
            throw new RuntimeException('Required proc_open could not be found in your PHP setup');
        }

        $this->command  = $command;
        $this->input    = $input;
        $this->status   = null;
        $this->exitCode = null;
    }

    protected function getDescriptors()
    {
        $out = '\\' === \DIRECTORY_SEPARATOR ? ['file', 'NUL', 'w'] : ['pipe', 'w'];

        return [
            self::STDIN_DESCRIPTOR_KEY  => ['pipe', 'r'],
            self::STDOUT_DESCRIPTOR_KEY => $out,
            self::STDERR_DESCRIPTOR_KEY => $out,
        ];
    }

    protected function setInput()
    {
        \fwrite($this->pipes[self::STDIN_DESCRIPTOR_KEY], $this->input);
    }

    protected function updateStatus()
    {
        $this->status   = \proc_get_status($this->process);

        $this->exitCode = $this->status['exitcode'];
    }

    protected function closePipes()
    {
        \fclose($this->pipes[self::STDIN_DESCRIPTOR_KEY]);
        \fclose($this->pipes[self::STDOUT_DESCRIPTOR_KEY]);
        \fclose($this->pipes[self::STDERR_DESCRIPTOR_KEY]);
    }

    public function execute()
    {
        if ($this->isRunning()) {
            throw new RuntimeException('Process is already running');
        }

        $this->descriptors = $this->getDescriptors();

        $this->process = proc_open($this->command, $this->descriptors, $this->pipes);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        if (!\is_resource($this->process)) {
            throw new RuntimeException('Bad program could not be started.');
        }

        $this->setInput();
        $this->updateStatus();
    }

    public function getStatus()
    {
        $this->updateStatus();

        return $this->status;
    }

    public function getOutput()
    {
        return \stream_get_contents($this->pipes[self::STDOUT_DESCRIPTOR_KEY]);
    }

    public function getErrorOutput()
    {
        return \stream_get_contents($this->pipes[self::STDERR_DESCRIPTOR_KEY]);
    }

    public function getExitCode()
    {
        $this->updateStatus();

        return $this->exitCode;
    }

    public function isRunning()
    {
        $this->updateStatus();

        return $this->status['running'];
    }

    public function getProcessId()
    {
        return $this->isRunning() ? $this->status['pid'] : null;
    }

    public function stop()
    {
        $this->closePipes();

        if (\is_resource($this->process)) {
            \proc_close($this->process);
        }

        $this->exitCode = $this->status['exitcode'];

        return $this->exitCode;
    }

    public function kill()
    {
        return \proc_terminate($this->process);
    }

    public function __destruct()
    {
        $this->stop();
    }
}

1			<?php
2
3			/*
4			* This file is part of the PHP-CLI package.
5			* <https://github.com/adhocore/php-cli>
6			*
7			* (c) Sushil Gupta <[email protected]>
8			* <https://github.com/sushilgupta>
9			*
10			* Licensed under MIT license.
11			*/
12
13			namespace Ahc\Cli\Helper;
14
15			use Ahc\Cli\Exception\RuntimeException;
16
17			/*
18			* A thin proc_open wrapper to execute shell commands.
19			* @author Sushil Gupta <[email protected]>
20			* @license MIT
21			*/
22			class Shell
23			{
24			const STDIN_DESCRIPTOR_KEY = 0;
25			const STDOUT_DESCRIPTOR_KEY = 1;
26			const STDERR_DESCRIPTOR_KEY = 2;
27
28			/** @var string Command to be executed */
29			protected $command;
30
31			/** @var array Descriptor to be passed for proc_open */
32			protected $descriptors;
33
34			/** @var int Exit code of the process once it has been terminated */
35			protected $exitCode;
36
37			/** @var string Input for stdin */
38			protected $input;
39
40			/** @var array Pointers to stdin, stdout & stderr */
41			protected $pipes;
42
43			/** @var resource The actual process resource returned from proc_open */
44			protected $process;
45
46			/** @var string Status of the process as returned from proc_get_status */
47			protected $status;
48
49			public function __construct(string $command, string $input = null)
50			{
51			if (!\function_exists('proc_open')) {
52			throw new RuntimeException('Required proc_open could not be found in your PHP setup');
53			}
54
55			$this->command = $command;
56			$this->input = $input;
57			$this->status = null;
58			$this->exitCode = null;
59			}
60
61			protected function getDescriptors()
62			{
63			$out = '\\' === \DIRECTORY_SEPARATOR ? ['file', 'NUL', 'w'] : ['pipe', 'w'];
64
65			return [
66			self::STDIN_DESCRIPTOR_KEY => ['pipe', 'r'],
67			self::STDOUT_DESCRIPTOR_KEY => $out,
68			self::STDERR_DESCRIPTOR_KEY => $out,
69			];
70			}
71
72			protected function setInput()
73			{
74			\fwrite($this->pipes[self::STDIN_DESCRIPTOR_KEY], $this->input);
75			}
76
77			protected function updateStatus()
78			{
79			$this->status = \proc_get_status($this->process);
			0 ignored issues – show Documentation Bug introduced 2018-09-01 16:49 UTC by Report Bug Copy Issue Report It seems like `proc_get_status($this->process)` of type `false` or `array` is incompatible with the declared type `string` of property `$status`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
80			$this->exitCode = $this->status['exitcode'];
81			}
82
83			protected function closePipes()
84			{
85			\fclose($this->pipes[self::STDIN_DESCRIPTOR_KEY]);
86			\fclose($this->pipes[self::STDOUT_DESCRIPTOR_KEY]);
87			\fclose($this->pipes[self::STDERR_DESCRIPTOR_KEY]);
88			}
89
90			public function execute()
91			{
92			if ($this->isRunning()) {
93			throw new RuntimeException('Process is already running');
94			}
95
96			$this->descriptors = $this->getDescriptors();
97
98			$this->process = proc_open($this->command, $this->descriptors, $this->pipes);
			0 ignored issues – show Documentation Bug introduced 2018-09-01 16:49 UTC by Report Bug Copy Issue Report It seems like `proc_open($this->command...criptors, $this->pipes)` can also be of type `false`. However, the property `$process` is declared as type `resource`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
99
100			if (!\is_resource($this->process)) {
101			throw new RuntimeException('Bad program could not be started.');
102			}
103
104			$this->setInput();
105			$this->updateStatus();
106			}
107
108			public function getStatus()
109			{
110			$this->updateStatus();
111
112			return $this->status;
113			}
114
115			public function getOutput()
116			{
117			return \stream_get_contents($this->pipes[self::STDOUT_DESCRIPTOR_KEY]);
118			}
119
120			public function getErrorOutput()
121			{
122			return \stream_get_contents($this->pipes[self::STDERR_DESCRIPTOR_KEY]);
123			}
124
125			public function getExitCode()
126			{
127			$this->updateStatus();
128
129			return $this->exitCode;
130			}
131
132			public function isRunning()
133			{
134			$this->updateStatus();
135
136			return $this->status['running'];
137			}
138
139			public function getProcessId()
140			{
141			return $this->isRunning() ? $this->status['pid'] : null;
142			}
143
144			public function stop()
145			{
146			$this->closePipes();
147
148			if (\is_resource($this->process)) {
149			\proc_close($this->process);
150			}
151
152			$this->exitCode = $this->status['exitcode'];
153
154			return $this->exitCode;
155			}
156
157			public function kill()
158			{
159			return \proc_terminate($this->process);
160			}
161
162			public function __destruct()
163			{
164			$this->stop();
165			}
166			}

adhocore / php-cli

Pull Request — master (#39)

Shell::getDescriptors() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like