TaskCommand::__construct() - Code Metrics - Inspection of "Migrate to PHP 7.2.25" - deployphp/deployer - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 31f734...513d45 )

by Anton

created 2019-12-15 14:31 UTC

TaskCommand::__construct() A

↳ Parent: TaskCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
nc	1
nop	3
dl	0
loc	6
ccs	0
cts	5
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php
/* (c) Anton Medvedev <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Deployer\Console;

use Deployer\Deployer;
use Deployer\Exception\Exception;
use Deployer\Exception\GracefulShutdownException;
use Deployer\Executor\ExecutorInterface;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface as Input;
use Symfony\Component\Console\Input\InputOption as Option;
use Symfony\Component\Console\Output\OutputInterface as Output;

class TaskCommand extends Command
{
    /**
     * @var Deployer
     */
    private $deployer;

    /**
     * @var ExecutorInterface
     */
    public $executor;

    /**
     * @param string $name
     * @param string $description
     * @param Deployer $deployer
     */
    public function __construct($name, $description, Deployer $deployer)
    {
        parent::__construct($name);
        $this->setDescription($description);
        $this->deployer = $deployer;
    }

    /**
     * Configures the command
     */
    protected function configure()
    {
        $this->addArgument(
            'stage',
            InputArgument::OPTIONAL,
            'Stage or hostname'
        );
        $this->addOption(
            'parallel',
            'p',
            Option::VALUE_NONE,
            'Run tasks in parallel'
        );
        $this->addOption(
            'limit',
            'l',
            Option::VALUE_REQUIRED,
            'How many host to run in parallel?'
        );
        $this->addOption(
            'no-hooks',
            null,
            Option::VALUE_NONE,
            'Run task without after/before hooks'
        );
        $this->addOption(
            'log',
            null,
            Option::VALUE_REQUIRED,
            'Log to file'
        );
        $this->addOption(
            'roles',
            null,
            Option::VALUE_REQUIRED,
            'Roles to deploy'
        );
        $this->addOption(
            'hosts',
            null,
            Option::VALUE_REQUIRED,
            'Host to deploy, comma separated, supports ranges [:]'
        );
        $this->addOption(
            'option',
            'o',
            Option::VALUE_REQUIRED | Option::VALUE_IS_ARRAY,
            'Sets configuration option'
        );
    }

    /**
     * {@inheritdoc}
     */
    protected function execute(Input $input, Output $output)
    {
        $stage = $input->hasArgument('stage') ? $input->getArgument('stage') : null;
        $roles = $input->getOption('roles');
        $hosts = $input->getOption('hosts');
        $this->parseOptions($input->getOption('option'));

        $hooksEnabled = !$input->getOption('no-hooks');
        if (!empty($input->getOption('log'))) {
            $this->deployer->config['log_file'] = $input->getOption('log');
        }

        if (!empty($hosts)) {
            $hosts = $this->deployer->hostSelector->getByHostnames($hosts);
        } elseif (!empty($roles)) {
            $hosts = $this->deployer->hostSelector->getByRoles($roles);
        } else {
            $hosts = $this->deployer->hostSelector->getHosts($stage);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        }

        if (empty($hosts)) {
            throw new Exception('No host selected');
        }

        $tasks = $this->deployer->scriptManager->getTasks(
            $this->getName(),
            $hosts,
            $hooksEnabled
        );

        if (empty($tasks)) {
            throw new Exception('No task will be executed, because the selected hosts do not meet the conditions of the tasks');
        }

        if ($input->getOption('parallel')) {
            $executor = $this->deployer->parallelExecutor;
        } else {
            $executor = $this->deployer->seriesExecutor;
        }

        try {
            $executor->run($tasks, $hosts);
        } catch (\Throwable $exception) {
            $this->deployer->logger->log('['. get_class($exception) .'] '. $exception->getMessage());
            $this->deployer->logger->log($exception->getTraceAsString());

            if ($exception instanceof GracefulShutdownException) {
                throw $exception;
            } else {
                // Check if we have tasks to execute on failure
                if ($this->deployer['fail']->has($this->getName())) {
                    $taskName = $this->deployer['fail']->get($this->getName());
                    $tasks = $this->deployer->scriptManager->getTasks($taskName, $hosts, $hooksEnabled);

                    $executor->run($tasks, $hosts);
                }
                throw $exception;
            }
        }

        return 0;
    }

    private function parseOptions(array $options)
    {
        foreach ($options as $option) {
            list($name, $value) = explode('=', $option);
            $value = $this->castValueToPhpType($value);
            $this->deployer->config->set($name, $value);
        }
    }

    private function castValueToPhpType($value)
    {
        switch ($value) {
            case 'true':
                return true;
            case 'false':
                return false;
            default:
                return $value;
        }
    }
}


1		<?php
2		/* (c) Anton Medvedev <[email protected]>
3		*
4		* For the full copyright and license information, please view the LICENSE
5		* file that was distributed with this source code.
6		*/
7
8		namespace Deployer\Console;
9
10		use Deployer\Deployer;
11		use Deployer\Exception\Exception;
12		use Deployer\Exception\GracefulShutdownException;
13		use Deployer\Executor\ExecutorInterface;
14		use Symfony\Component\Console\Command\Command;
15		use Symfony\Component\Console\Input\InputArgument;
16		use Symfony\Component\Console\Input\InputInterface as Input;
17		use Symfony\Component\Console\Input\InputOption as Option;
18		use Symfony\Component\Console\Output\OutputInterface as Output;
19
20		class TaskCommand extends Command
21		{
22		/**
23		* @var Deployer
24		*/
25		private $deployer;
26
27		/**
28		* @var ExecutorInterface
29		*/
30		public $executor;
31
32		/**
33		* @param string $name
34		* @param string $description
35		* @param Deployer $deployer
36		*/
37		public function __construct($name, $description, Deployer $deployer)
38		{
39		parent::__construct($name);
40		$this->setDescription($description);
41		$this->deployer = $deployer;
42		}
43
44		/**
45		* Configures the command
46		*/
47		protected function configure()
48		{
49		$this->addArgument(
50		'stage',
51		InputArgument::OPTIONAL,
52		'Stage or hostname'
53		);
54		$this->addOption(
55		'parallel',
56		'p',
57		Option::VALUE_NONE,
58		'Run tasks in parallel'
59		);
60		$this->addOption(
61		'limit',
62		'l',
63		Option::VALUE_REQUIRED,
64		'How many host to run in parallel?'
65		);
66		$this->addOption(
67		'no-hooks',
68		null,
69		Option::VALUE_NONE,
70		'Run task without after/before hooks'
71		);
72		$this->addOption(
73		'log',
74		null,
75		Option::VALUE_REQUIRED,
76		'Log to file'
77		);
78		$this->addOption(
79		'roles',
80		null,
81		Option::VALUE_REQUIRED,
82		'Roles to deploy'
83		);
84		$this->addOption(
85		'hosts',
86		null,
87		Option::VALUE_REQUIRED,
88		'Host to deploy, comma separated, supports ranges [:]'
89		);
90		$this->addOption(
91		'option',
92		'o',
93		Option::VALUE_REQUIRED \| Option::VALUE_IS_ARRAY,
94		'Sets configuration option'
95		);
96		}
97
98		/**
99		* {@inheritdoc}
100		*/
101		protected function execute(Input $input, Output $output)
102		{
103		$stage = $input->hasArgument('stage') ? $input->getArgument('stage') : null;
104		$roles = $input->getOption('roles');
105		$hosts = $input->getOption('hosts');
106		$this->parseOptions($input->getOption('option'));
107
108		$hooksEnabled = !$input->getOption('no-hooks');
109		if (!empty($input->getOption('log'))) {
110		$this->deployer->config['log_file'] = $input->getOption('log');
111		}
112
113	View Code Duplication	if (!empty($hosts)) {
114		$hosts = $this->deployer->hostSelector->getByHostnames($hosts);
115		} elseif (!empty($roles)) {
116		$hosts = $this->deployer->hostSelector->getByRoles($roles);
117		} else {
118		$hosts = $this->deployer->hostSelector->getHosts($stage);
		0 ignored issues – show Bug introduced 2018-12-13 22:07 UTC by Report Bug Copy Issue Report It seems like `$stage` defined by `$input->hasArgument('sta...rgument('stage') : null` on line `103` can also be of type `array<integer,string>` or `null`; however, `Deployer\Host\HostSelector::getHosts()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
119		}
120
121		if (empty($hosts)) {
122		throw new Exception('No host selected');
123		}
124
125		$tasks = $this->deployer->scriptManager->getTasks(
126		$this->getName(),
127		$hosts,
128		$hooksEnabled
129		);
130
131		if (empty($tasks)) {
132		throw new Exception('No task will be executed, because the selected hosts do not meet the conditions of the tasks');
133		}
134
135		if ($input->getOption('parallel')) {
136		$executor = $this->deployer->parallelExecutor;
137		} else {
138		$executor = $this->deployer->seriesExecutor;
139		}
140
141		try {
142		$executor->run($tasks, $hosts);
143		} catch (\Throwable $exception) {
144		$this->deployer->logger->log('['. get_class($exception) .'] '. $exception->getMessage());
145		$this->deployer->logger->log($exception->getTraceAsString());
146
147		if ($exception instanceof GracefulShutdownException) {
148		throw $exception;
149		} else {
150		// Check if we have tasks to execute on failure
151		if ($this->deployer['fail']->has($this->getName())) {
152		$taskName = $this->deployer['fail']->get($this->getName());
153		$tasks = $this->deployer->scriptManager->getTasks($taskName, $hosts, $hooksEnabled);
154
155		$executor->run($tasks, $hosts);
156		}
157		throw $exception;
158		}
159		}
160
161		return 0;
162		}
163
164		private function parseOptions(array $options)
165		{
166		foreach ($options as $option) {
167		list($name, $value) = explode('=', $option);
168		$value = $this->castValueToPhpType($value);
169		$this->deployer->config->set($name, $value);
170		}
171		}
172
173		private function castValueToPhpType($value)
174		{
175		switch ($value) {
176		case 'true':
177		return true;
178		case 'false':
179		return false;
180		default:
181		return $value;
182		}
183		}
184		}
185

deployphp / deployer

GitHub Access Token became invalid

Push — master ( 31f734...513d45 )

TaskCommand::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like