TaskCommand::execute() - Code Metrics - Inspection of "Fix setDescription to nil" - deployphp/deployer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 8b5091...c51706 )

by Anton

created 2019-12-15 14:43 UTC

TaskCommand::execute() C

↳ Parent: TaskCommand

Complexity

Conditions	11
Paths	120

Size

Total Lines

Duplication

Lines	7
Ratio	11.29 %

Code Coverage

Tests	29
CRAP Score	11.8889

Importance

Changes

Metric	Value
cc	11
nc	120
nop	2
dl	7
loc	62
ccs	29
cts	36
cp	0.8056
crap	11.8889
rs	6.549
c	0
b	0
f	0

How to fix Long Method Complexity

<?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);
        if ($description) {
            $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	12		public function __construct($name, $description, Deployer $deployer)
38			{
39	12		parent::__construct($name);
40	12		if ($description) {
41	8		$this->setDescription($description);
42			}
43	12		$this->deployer = $deployer;
44	12		}
45
46			/**
47			* Configures the command
48			*/
49	12		protected function configure()
50			{
51	12		$this->addArgument(
52	12		'stage',
53	12		InputArgument::OPTIONAL,
54	12		'Stage or hostname'
55			);
56	12		$this->addOption(
57	12		'parallel',
58	12		'p',
59	12		Option::VALUE_NONE,
60	12		'Run tasks in parallel'
61			);
62	12		$this->addOption(
63	12		'limit',
64	12		'l',
65	12		Option::VALUE_REQUIRED,
66	12		'How many host to run in parallel?'
67			);
68	12		$this->addOption(
69	12		'no-hooks',
70	12		null,
71	12		Option::VALUE_NONE,
72	12		'Run task without after/before hooks'
73			);
74	12		$this->addOption(
75	12		'log',
76	12		null,
77	12		Option::VALUE_REQUIRED,
78	12		'Log to file'
79			);
80	12		$this->addOption(
81	12		'roles',
82	12		null,
83	12		Option::VALUE_REQUIRED,
84	12		'Roles to deploy'
85			);
86	12		$this->addOption(
87	12		'hosts',
88	12		null,
89	12		Option::VALUE_REQUIRED,
90	12		'Host to deploy, comma separated, supports ranges [:]'
91			);
92	12		$this->addOption(
93	12		'option',
94	12		'o',
95	12		Option::VALUE_REQUIRED \| Option::VALUE_IS_ARRAY,
96	12		'Sets configuration option'
97			);
98	12		}
99
100			/**
101			* {@inheritdoc}
102			*/
103	11		protected function execute(Input $input, Output $output)
104			{
105	11		$stage = $input->hasArgument('stage') ? $input->getArgument('stage') : null;
106	11		$roles = $input->getOption('roles');
107	11		$hosts = $input->getOption('hosts');
108	11		$this->parseOptions($input->getOption('option'));
109
110	11		$hooksEnabled = !$input->getOption('no-hooks');
111	11		if (!empty($input->getOption('log'))) {
112			$this->deployer->config['log_file'] = $input->getOption('log');
113			}
114
115	11	View Code Duplication	if (!empty($hosts)) {
116			$hosts = $this->deployer->hostSelector->getByHostnames($hosts);
117	11		} elseif (!empty($roles)) {
118			$hosts = $this->deployer->hostSelector->getByRoles($roles);
119			} else {
120	11		$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 `105` 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...
121			}
122
123	11		if (empty($hosts)) {
124			throw new Exception('No host selected');
125			}
126
127	11		$tasks = $this->deployer->scriptManager->getTasks(
128	11		$this->getName(),
129	11		$hosts,
130	11		$hooksEnabled
131			);
132
133	11		if (empty($tasks)) {
134			throw new Exception('No task will be executed, because the selected hosts do not meet the conditions of the tasks');
135			}
136
137	11		if ($input->getOption('parallel')) {
138			$executor = $this->deployer->parallelExecutor;
139			} else {
140	11		$executor = $this->deployer->seriesExecutor;
141			}
142
143			try {
144	11		$executor->run($tasks, $hosts);
145	1		} catch (\Throwable $exception) {
146	1		$this->deployer->logger->log('['. get_class($exception) .'] '. $exception->getMessage());
147	1		$this->deployer->logger->log($exception->getTraceAsString());
148
149	1		if ($exception instanceof GracefulShutdownException) {
150			throw $exception;
151			} else {
152			// Check if we have tasks to execute on failure
153	1		if ($this->deployer['fail']->has($this->getName())) {
154	1		$taskName = $this->deployer['fail']->get($this->getName());
155	1		$tasks = $this->deployer->scriptManager->getTasks($taskName, $hosts, $hooksEnabled);
156
157	1		$executor->run($tasks, $hosts);
158			}
159	1		throw $exception;
160			}
161			}
162
163	10		return 0;
164			}
165
166	11		private function parseOptions(array $options)
167			{
168	11		foreach ($options as $option) {
169	1		list($name, $value) = explode('=', $option);
170	1		$value = $this->castValueToPhpType($value);
171	1		$this->deployer->config->set($name, $value);
172			}
173	11		}
174
175	1		private function castValueToPhpType($value)
176			{
177	1		switch ($value) {
178	1		case 'true':
179			return true;
180	1		case 'false':
181			return false;
182			default:
183	1		return $value;
184			}
185			}
186			}
187

deployphp / deployer

GitHub Access Token became invalid

Push — master ( 8b5091...c51706 )

TaskCommand::execute() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like