Deployer\Console\TaskCommand

Complexity

Total Complexity

19

Size/Duplication

Total Lines	167
Duplicated Lines	4.19 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

72.92%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	2
A	configure()	0	50	1
C	execute()	7	62	11
A	parseOptions()	0	8	2
A	castValueToPhpType()	0	11	3

<?php
/* (c) Anton Medvedev <anton@medv.io>
 *
 * 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);

It seems like $stage defined by $input->hasArgument('stage') ? $input->getArgument('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 (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;
        }
    }
}