Application::validateConfig() - Code Metrics - Inspection of "Add import of other psh configs" - shopwareLabs/psh - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#109)

by Jan Philipp

created 2020-10-20 13:04 UTC

Application::validateConfig() A

↳ Parent: Application

Complexity

Conditions	4
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	17
rs	9.7
c	0
b	0
f	0
cc	4
nc	6
nop	2

<?php declare(strict_types=1);

namespace Shopware\Psh\Application;

use InvalidArgumentException;
use Khill\Duration\Duration;
use League\CLImate\CLImate;
use Shopware\Psh\Config\Config;
use Shopware\Psh\Config\RequiredValue;
use Shopware\Psh\Listing\Script;
use Shopware\Psh\Listing\ScriptFinder;
use Shopware\Psh\Listing\ScriptNotFoundException;
use Shopware\Psh\ScriptRuntime\Execution\ExecutionErrorException;
use function array_key_exists;
use function array_map;
use function array_merge;
use function count;
use function explode;
use function implode;
use function mb_strlen;
use function sprintf;
use function str_replace;

/**
 * Main application entry point. moves the requested data around and outputs user information.
 */
class Application
{
    const MIN_PADDING_SIZE = 30;

    /**
     * @var CLImate
     */
    public $cliMate;

    /**
     * @var string
     */
    private $rootDirectory;

    /**
     * @var ApplicationFactory
     */
    private $applicationFactory;

    /**
     * @var Duration
     */
    private $duration;

    public function __construct(string $rootDirectory)
    {
        $this->rootDirectory = $rootDirectory;
        $this->applicationFactory = new ApplicationFactory();
        $this->cliMate = new CLImate();
        $this->duration = new Duration();
    }

    /**
     * Main entry point to execute the application.
     *
     * @return int exit code
     */
    public function run(array $inputArgs): int
    {
        try {
            $config = $this->prepare($inputArgs);

            $scriptFinder = $this->applicationFactory->createScriptFinder($config);

            $this->executeScript($inputArgs, $scriptFinder, $config);

            $this->showListing($scriptFinder->getAllVisibleScripts());

            throw ExitSignal::success();
        } catch (ExitSignal $signal) {
            return $signal->signal();
        }
    }

    /**
     * @param Script[] $scripts
     */
    public function showListing(array $scripts): void
    {
        $this->cliMate->green()->bold('Available commands:')->br();

        if (!count($scripts)) {
            $this->cliMate->yellow()->bold('-> Currently no scripts available');
        }

        $paddingSize = $this->getPaddingSize($scripts);
        $padding = $this->cliMate->padding($paddingSize)->char(' ');

        $scriptEnvironment = false;

        foreach ($scripts as $script) {
            if ($scriptEnvironment !== $script->getEnvironment()) {
                $scriptEnvironment = $script->getEnvironment();
                $this->cliMate->green()->br()->bold(($scriptEnvironment ?? 'default') . ':');
            }

            $padding
                ->label('<bold> - ' . $script->getName() . '</bold>')
                ->result('<dim>' . $script->getDescription() . '</dim>');
        }

        $this->cliMate->green()->bold("\n" . count($scripts) . " script(s) available\n");
    }

    protected function extractScriptNames(array $inputArgs): array
    {
        if (!isset($inputArgs[1])) {
            return [];
        }

        return explode(',', $inputArgs[1]);
    }

    protected function execute(Script $script, Config $config, ScriptFinder $scriptFinder): void
    {
        $commands = $this->applicationFactory
            ->createCommands($script, $scriptFinder);

        $logger = new ClimateLogger($this->cliMate, $this->duration);
        $executor = $this->applicationFactory
            ->createProcessExecutor($script, $config, $logger, $this->rootDirectory);

        try {
            $executor->execute($script, $commands);
        } catch (ExecutionErrorException $e) {
            $this->notifyError("\nExecution aborted, a subcommand failed!\n");

            throw ExitSignal::error();
        }

        $this->notifySuccess("All commands successfully executed!\n");
    }

    /**
     * @param $string
     */
    public function notifySuccess(string $string): void
    {
        $this->cliMate->bold()->green($string);
    }

    /**
     * @param $string
     */
    public function notifyError(string $string): void
    {
        $this->cliMate->bold()->red($string);
    }

    /**
     * @param $config
     */
    protected function printHeader(Config $config): void
    {
        $this->cliMate->green()->bold()->out("\n###################");

        if ($config->getHeader()) {
            $this->cliMate->out("\n" . $config->getHeader());
        }
    }

    protected function printConfigFiles(array $configFiles): void
    {
        $countConfigFiles = count($configFiles);
        for ($i = 0; $i < $countConfigFiles; $i++) {
            $configFiles[$i] = str_replace($this->rootDirectory . '/', '', $configFiles[$i]);
        }

        if (count($configFiles) === 1) {
            $this->cliMate->yellow()->out(sprintf("Using %s \n", $configFiles[0]));

            return;
        }

        $this->cliMate->yellow()->out(sprintf("Using %s extended by %s \n", $configFiles[0], $configFiles[1]));
    }

    private function getPaddingSize(array $scripts): int
    {
        $maxScriptNameLength = 0;
        foreach ($scripts as $script) {
            if (mb_strlen($script->getName()) > $maxScriptNameLength) {
                $maxScriptNameLength = mb_strlen($script->getName());
            }
        }

        return $maxScriptNameLength + self::MIN_PADDING_SIZE;
    }

    private function showAutocompleteListing(Config $config): void
    {
        $scriptFinder = $this->applicationFactory
            ->createScriptFinder($config);

        $scripts = $scriptFinder->getAllVisibleScripts();

        $commands = array_map(function (Script $script) {
            return $script->getName();
        }, $scripts);

        $this->cliMate->out(implode(' ', $commands));
    }

    private function showScriptNotFoundListing(ScriptNotFoundException $ex, array $scriptNames, ScriptFinder $scriptFinder): void
    {
        $this->notifyError("Script with name {$ex->getScriptName()} not found\n");

        $scripts = [];
        foreach ($scriptNames as $scriptName) {
            $newScripts = $scriptFinder->findScriptsByPartialName($scriptName);
            $scripts = array_merge($scripts, $newScripts);
        }

        if (count($scripts) > 0) {
            $this->cliMate->yellow()->bold('Have you been looking for this?');
            $this->showListing($scripts);
        }
    }

    private function printHead(Config $config): void
    {
        $this->printHeader($config);

        $configFiles = $this->applicationFactory->getConfigFiles($this->rootDirectory);
        $this->printConfigFiles($configFiles);
    }

    private function validateConfig(Config $config, string $environment = null): void
    {
        $allPlaceholders = $config->getAllPlaceholders($environment);

        $missing = [];
        foreach ($config->getRequiredVariables($environment) as $requiredVariable) {
            if (!array_key_exists($requiredVariable->getName(), $allPlaceholders)) {
                $missing[] = $requiredVariable;
                $this->printMissingRequiredVariable($requiredVariable);
            }
        }

        if (count($missing)) {
            $this->cliMate->error("\n<bold>Please define the missing value(s) first</bold>\n");
            throw ExitSignal::error();
        }
    }

    private function printMissingRequiredVariable(RequiredValue $requiredVariable): void
    {
        if ($requiredVariable->hasDescription()) {
            $this->cliMate->error(sprintf(
                "\t - <bold>Missing required const or var named <underline>%s</underline></bold> <dim>(%s)</dim>",
                $requiredVariable->getName(),
                $requiredVariable->getDescription()
            ));
        } else {
            $this->cliMate->error(sprintf(
                "\t - <bold>Missing required const or var named <underline>%s</underline></bold>",
                $requiredVariable->getName()
            ));
        }
    }

    private function prepare(array $inputArgs): Config
    {
        try {
            $config = $this->applicationFactory
                ->createConfig($this->rootDirectory, $inputArgs);
        } catch (InvalidParameterException $e) {
            $this->notifyError($e->getMessage() . "\n");

            throw ExitSignal::error();
        } catch (InvalidArgumentException $e) {
            $this->notifyError("\n" . $e->getMessage() . "\n");

            throw ExitSignal::error();
        }

        if (count($inputArgs) > 1 && $inputArgs[1] === 'bash_autocompletion_dump') {
            $this->showAutocompleteListing($config);

            throw ExitSignal::success();
        }

        $this->printHead($config);
        $this->validateConfig($config);

        return $config;
    }

    private function executeScript(array $inputArgs, ScriptFinder $scriptFinder, Config $config): void
    {
        $scriptNames = $this->extractScriptNames($inputArgs);

        if (!count($scriptNames)) {
            return;
        }

        try {
            foreach ($scriptNames as $scriptName) {
                $this->execute($scriptFinder->findScriptByName($scriptName), $config, $scriptFinder);
            }
        } catch (ScriptNotFoundException $e) {
            $this->showScriptNotFoundListing($e, $scriptNames, $scriptFinder);

            throw ExitSignal::error();
        }

        throw ExitSignal::success();
    }
}


1			<?php declare(strict_types=1);
2
3			namespace Shopware\Psh\Application;
4
5			use InvalidArgumentException;
6			use Khill\Duration\Duration;
7			use League\CLImate\CLImate;
8			use Shopware\Psh\Config\Config;
9			use Shopware\Psh\Config\RequiredValue;
10			use Shopware\Psh\Listing\Script;
11			use Shopware\Psh\Listing\ScriptFinder;
12			use Shopware\Psh\Listing\ScriptNotFoundException;
13			use Shopware\Psh\ScriptRuntime\Execution\ExecutionErrorException;
14			use function array_key_exists;
15			use function array_map;
16			use function array_merge;
17			use function count;
18			use function explode;
19			use function implode;
20			use function mb_strlen;
21			use function sprintf;
22			use function str_replace;
23
24			/**
25			* Main application entry point. moves the requested data around and outputs user information.
26			*/
27			class Application
28			{
29			const MIN_PADDING_SIZE = 30;
30
31			/**
32			* @var CLImate
33			*/
34			public $cliMate;
35
36			/**
37			* @var string
38			*/
39			private $rootDirectory;
40
41			/**
42			* @var ApplicationFactory
43			*/
44			private $applicationFactory;
45
46			/**
47			* @var Duration
48			*/
49			private $duration;
50
51			public function __construct(string $rootDirectory)
52			{
53			$this->rootDirectory = $rootDirectory;
54			$this->applicationFactory = new ApplicationFactory();
55			$this->cliMate = new CLImate();
56			$this->duration = new Duration();
57			}
58
59			/**
60			* Main entry point to execute the application.
61			*
62			* @return int exit code
63			*/
64			public function run(array $inputArgs): int
65			{
66			try {
67			$config = $this->prepare($inputArgs);
68
69			$scriptFinder = $this->applicationFactory->createScriptFinder($config);
70
71			$this->executeScript($inputArgs, $scriptFinder, $config);
72
73			$this->showListing($scriptFinder->getAllVisibleScripts());
74
75			throw ExitSignal::success();
76			} catch (ExitSignal $signal) {
77			return $signal->signal();
78			}
79			}
80
81			/**
82			* @param Script[] $scripts
83			*/
84			public function showListing(array $scripts): void
85			{
86			$this->cliMate->green()->bold('Available commands:')->br();
87
88			if (!count($scripts)) {
89			$this->cliMate->yellow()->bold('-> Currently no scripts available');
90			}
91
92			$paddingSize = $this->getPaddingSize($scripts);
93			$padding = $this->cliMate->padding($paddingSize)->char(' ');
94
95			$scriptEnvironment = false;
96
97			foreach ($scripts as $script) {
98			if ($scriptEnvironment !== $script->getEnvironment()) {
99			$scriptEnvironment = $script->getEnvironment();
100			$this->cliMate->green()->br()->bold(($scriptEnvironment ?? 'default') . ':');
101			}
102
103			$padding
104			->label('<bold> - ' . $script->getName() . '</bold>')
105			->result('<dim>' . $script->getDescription() . '</dim>');
106			}
107
108			$this->cliMate->green()->bold("\n" . count($scripts) . " script(s) available\n");
109			}
110
111			protected function extractScriptNames(array $inputArgs): array
112			{
113			if (!isset($inputArgs[1])) {
114			return [];
115			}
116
117			return explode(',', $inputArgs[1]);
118			}
119
120			protected function execute(Script $script, Config $config, ScriptFinder $scriptFinder): void
121			{
122			$commands = $this->applicationFactory
123			->createCommands($script, $scriptFinder);
124
125			$logger = new ClimateLogger($this->cliMate, $this->duration);
126			$executor = $this->applicationFactory
127			->createProcessExecutor($script, $config, $logger, $this->rootDirectory);
128
129			try {
130			$executor->execute($script, $commands);
131			} catch (ExecutionErrorException $e) {
132			$this->notifyError("\nExecution aborted, a subcommand failed!\n");
133
134			throw ExitSignal::error();
135			}
136
137			$this->notifySuccess("All commands successfully executed!\n");
138			}
139
140			/**
141			* @param $string
142			*/
143			public function notifySuccess(string $string): void
144			{
145			$this->cliMate->bold()->green($string);
146			}
147
148			/**
149			* @param $string
150			*/
151			public function notifyError(string $string): void
152			{
153			$this->cliMate->bold()->red($string);
154			}
155
156			/**
157			* @param $config
158			*/
159			protected function printHeader(Config $config): void
160			{
161			$this->cliMate->green()->bold()->out("\n###################");
162
163			if ($config->getHeader()) {
164			$this->cliMate->out("\n" . $config->getHeader());
165			}
166			}
167
168			protected function printConfigFiles(array $configFiles): void
169			{
170			$countConfigFiles = count($configFiles);
171			for ($i = 0; $i < $countConfigFiles; $i++) {
172			$configFiles[$i] = str_replace($this->rootDirectory . '/', '', $configFiles[$i]);
173			}
174
175			if (count($configFiles) === 1) {
176			$this->cliMate->yellow()->out(sprintf("Using %s \n", $configFiles[0]));
177
178			return;
179			}
180
181			$this->cliMate->yellow()->out(sprintf("Using %s extended by %s \n", $configFiles[0], $configFiles[1]));
182			}
183
184			private function getPaddingSize(array $scripts): int
185			{
186			$maxScriptNameLength = 0;
187			foreach ($scripts as $script) {
188			if (mb_strlen($script->getName()) > $maxScriptNameLength) {
189			$maxScriptNameLength = mb_strlen($script->getName());
190			}
191			}
192
193			return $maxScriptNameLength + self::MIN_PADDING_SIZE;
194			}
195
196			private function showAutocompleteListing(Config $config): void
197			{
198			$scriptFinder = $this->applicationFactory
199			->createScriptFinder($config);
200
201			$scripts = $scriptFinder->getAllVisibleScripts();
202
203			$commands = array_map(function (Script $script) {
204			return $script->getName();
205			}, $scripts);
206
207			$this->cliMate->out(implode(' ', $commands));
208			}
209
210			private function showScriptNotFoundListing(ScriptNotFoundException $ex, array $scriptNames, ScriptFinder $scriptFinder): void
211			{
212			$this->notifyError("Script with name {$ex->getScriptName()} not found\n");
213
214			$scripts = [];
215			foreach ($scriptNames as $scriptName) {
216			$newScripts = $scriptFinder->findScriptsByPartialName($scriptName);
217			$scripts = array_merge($scripts, $newScripts);
218			}
219
220			if (count($scripts) > 0) {
221			$this->cliMate->yellow()->bold('Have you been looking for this?');
222			$this->showListing($scripts);
223			}
224			}
225
226			private function printHead(Config $config): void
227			{
228			$this->printHeader($config);
229
230			$configFiles = $this->applicationFactory->getConfigFiles($this->rootDirectory);
231			$this->printConfigFiles($configFiles);
232			}
233
234			private function validateConfig(Config $config, string $environment = null): void
235			{
236			$allPlaceholders = $config->getAllPlaceholders($environment);
237
238			$missing = [];
239			foreach ($config->getRequiredVariables($environment) as $requiredVariable) {
240			if (!array_key_exists($requiredVariable->getName(), $allPlaceholders)) {
241			$missing[] = $requiredVariable;
242			$this->printMissingRequiredVariable($requiredVariable);
243			}
244			}
245
246			if (count($missing)) {
247			$this->cliMate->error("\n<bold>Please define the missing value(s) first</bold>\n");
248			throw ExitSignal::error();
249			}
250			}
251
252			private function printMissingRequiredVariable(RequiredValue $requiredVariable): void
253			{
254			if ($requiredVariable->hasDescription()) {
255			$this->cliMate->error(sprintf(
256			"\t - <bold>Missing required const or var named <underline>%s</underline></bold> <dim>(%s)</dim>",
257			$requiredVariable->getName(),
258			$requiredVariable->getDescription()
259			));
260			} else {
261			$this->cliMate->error(sprintf(
262			"\t - <bold>Missing required const or var named <underline>%s</underline></bold>",
263			$requiredVariable->getName()
264			));
265			}
266			}
267
268			private function prepare(array $inputArgs): Config
269			{
270			try {
271			$config = $this->applicationFactory
272			->createConfig($this->rootDirectory, $inputArgs);
273			} catch (InvalidParameterException $e) {
274			$this->notifyError($e->getMessage() . "\n");
275
276			throw ExitSignal::error();
277			} catch (InvalidArgumentException $e) {
278			$this->notifyError("\n" . $e->getMessage() . "\n");
279
280			throw ExitSignal::error();
281			}
282
283			if (count($inputArgs) > 1 && $inputArgs[1] === 'bash_autocompletion_dump') {
284			$this->showAutocompleteListing($config);
285
286			throw ExitSignal::success();
287			}
288
289			$this->printHead($config);
290			$this->validateConfig($config);
291
292			return $config;
293			}
294
295			private function executeScript(array $inputArgs, ScriptFinder $scriptFinder, Config $config): void
296			{
297			$scriptNames = $this->extractScriptNames($inputArgs);
298
299			if (!count($scriptNames)) {
300			return;
301			}
302
303			try {
304			foreach ($scriptNames as $scriptName) {
305			$this->execute($scriptFinder->findScriptByName($scriptName), $config, $scriptFinder);
306			}
307			} catch (ScriptNotFoundException $e) {
308			$this->showScriptNotFoundListing($e, $scriptNames, $scriptFinder);
309
310			throw ExitSignal::error();
311			}
312
313			throw ExitSignal::success();
314			}
315			}
316

shopwareLabs / psh

Pull Request — master (#109)

Application::validateConfig() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like