ComposeManager - Code Metrics - Inspection of "added support for config command" - omauger/docker-compose-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#17)

by Tobias

created 2017-02-03 22:05 UTC

ComposeManager A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	307
Duplicated Lines	12.38 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	5
Bugs	0	Features	1

Metric	Value
wmc	32
c	5
b	0
f	1
lcom	1
cbo	6
dl	38
loc	307
rs	9.6

15 Methods

Rating	Name	Duplication	Size	Complexity
A	start()	0	8	1
A	stop()	0	8	1
A	remove()	0	14	2
A	kill()	14	14	2
B	build()	0	22	4
A	pull()	0	10	1
A	restart()	14	14	2
A	run()	0	13	3
A	ps()	0	8	1
A	config()	0	8	1
A	ips()	10	10	1
B	processResult()	0	20	5
A	createComposeFileCollection()	0	12	3
A	formatCommand()	0	22	3
A	execute()	0	13	2

How to fix Duplicated Code

<?php

namespace DockerCompose\Manager;

use DockerCompose\Exception\ComposeFileNotFoundException;
use DockerCompose\Exception\DockerHostConnexionErrorException;
use DockerCompose\Exception\DockerInstallationMissingException;
use DockerCompose\Exception\NoSuchServiceException;
use DockerCompose\ComposeFileCollection;
use mikehaertl\shellcommand\Command;
use Exception;

/**
 * DockerCompose\Manager\ComposeManager
 */
class ComposeManager
{

    /**
     * Start service containers
     *
     * @param mixed $composeFiles The compose files names
     */
    public function start($composeFiles = array())
    {
        return $this->processResult(
            $this->execute(
                $this->formatCommand('up -d', $this->createComposeFileCollection($composeFiles))
            )
        );
    }

    /**
     * Stop service containers
     *
     * @param mixed $composeFiles The compose files names
     */
    public function stop($composeFiles = array())
    {
        return $this->processResult(
            $this->execute(
                $this->formatCommand('stop', $this->createComposeFileCollection($composeFiles))
            )
        );
    }

    /**
     * Stop service containers
     *
     * @param mixed   $composeFiles  The compose files names
     * @param boolean $force         If the remove need to be force (default=false)
     * @param boolean $removeVolumes If we need to remove the volumes (default=false)
     */
    public function remove($composeFiles = array(), $force = false, $removeVolumes = false)

    {
        $command = 'rm --force';

        if ($removeVolumes) {
            $command .= ' -v';
        }

        return $this->processResult(
            $this->execute(
                $this->formatCommand($command, $this->createComposeFileCollection($composeFiles))
            )
        );
    }

     /**
     * Stop service containers
     *
     * @param mixed   $composeFiles  The compose files names
     * @param string  $signal        Optionnal to precise SIGNAL to send to the container for SIGKILL replacement.
     */
    public function kill($composeFiles = array(), $signal = 'SIGKILL')

    {
        $command = 'kill';

        if ($signal !== 'SIGKILL') {
            $command .= ' -s ' . $signal;
        }

        return $this->processResult(
            $this->execute(
                $this->formatCommand($command, $this->createComposeFileCollection($composeFiles))
            )
        );
    }

    /**
     * Build service images
     *
     * @param mixed   $composeFiles  The compose files names
     * @param boolean $pull          If we want attempt to pull a newer version of the from image
     * @param boolean $forceRemove   If we want remove the intermediate containers
     * @param bollean $cache         If we can use the cache when building the image
     */
    public function build($composeFiles = array(), $pull = true, $forceRemove = false, $cache = true)
    {
        $command = 'build';

        if ($pull) {
            $command .= ' --pull';
        }

        if ($forceRemove) {
            $command .= ' --force-rm';
        }

        if (!$cache) {
            $command .= ' --no-cache';
        }

        return $this->processResult(
            $this->execute(
                $this->formatCommand($command, $this->createComposeFileCollection($composeFiles))
            )
        );
    }

    /**
     * Pull service images
     *
     * @param mixed   $composeFiles  The compose files names
     */
    public function pull($composeFiles = array())
    {
        $command = 'pull';

        return $this->processResult(
            $this->execute(
                $this->formatCommand($command, $this->createComposeFileCollection($composeFiles))
            )
        );
    }


    /**
     * Restart running containers
     *
     * @param mixed   $composeFiles  The compose files names
     * @param integer $timeout       If we want attempt to pull a newer version of the from image
     */
    public function restart($composeFiles = array(), $timeout = 10)

    {
        $command = 'restart';

        if ($timeout != 10) {
            $command .= ' --timeout='.$timeout;
        }

        return $this->processResult(
            $this->execute(
                $this->formatCommand($command, $this->createComposeFileCollection($composeFiles))
            )
        );
    }

    /**
     * Run service with command
     *
     * @param string $service Service name
     * @param string $command Command to pass to service
     * @param mixed   $composeFiles  The compose files names
     */
    public function run($service, $command, $composeFiles = array())
    {
        $command = 'run --rm ' . $service . ' ' . $command;
        $result = $this->execute(
            $this->formatCommand($command, $this->createComposeFileCollection($composeFiles))
        );

        if ($result['code'] == 1 && strpos($result['output'], 'service') != false) {

            throw new NoSuchServiceException($result['output']);
        }

        return $this->processResult($result);
    }

    /**
     * List containers
     *
     * @param mixed $composeFiles The compose files names
     */
    public function ps($composeFiles = array())
    {
        return $this->processResult(
            $this->execute(
                $this->formatCommand('ps', $this->createComposeFileCollection($composeFiles))
            )
        );
    }

    /**
     * Show configuration (yaml)
     *
     * @param mixed $composeFiles The compose files names
     */
    public function config($composeFiles = array())
    {
        return $this->processResult(
            $this->execute(
                $this->formatCommand('config', $this->createComposeFileCollection($composeFiles))
            )
        );
    }

    /**
     * List IP containers
     *
     * @param mixed $composeFiles The compose files names
     */
    public function ips($composeFiles = array())

    {
        $command = $this->formatCommand('ps', $this->createComposeFileCollection($composeFiles));

        $command = 'for CONTAINER in $(' . $command . ' -q); ';
        $command .= 'do echo "$(docker inspect --format \' {{ .Name }} \' $CONTAINER)\t';
        $command .= '$(docker inspect --format \' {{ .NetworkSettings.IPAddress }} \' $CONTAINER)"; done';

        return $this->processResult($this->execute($command));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Process result with returned code and output
     *
     * @param array $result The result of command with output and returnCode
     *
     * @throws DockerInstallationMissingException When returned code is 127
     * @throws ComposeFileNotFoundException When no compose file precise and docker-compose.yml not found
     * @throws DockerHostConnexionErrorException When we can't connect to docker host
     * @throws \Exception When an unknown error is returned
     */
    private function processResult($result)
    {
        if ($result['code'] === 127) {
            throw new DockerInstallationMissingException();
        }

        if ($result['code'] === 1) {
            if (!strpos($result['output'], 'DOCKER_HOST')) {
                if (!strpos($result['output'], 'docker-compose.yml')) {
                    throw new Exception($result['output']);
                } else {
                    throw new ComposeFileNotFoundException();
                }
            } else {
                throw new DockerHostConnexionErrorException();
            }
        }

        return $result['output'];
    }

    /**
     * Create the composeFileCollection from the type of value given
     *
     * @param mixed $composeFiles The docker-compose files (can be array, string or ComposeFile)
     *
     * @return ComposeFileCollection
     */
    private function createComposeFileCollection($composeFiles)
    {
        if (!$composeFiles instanceof ComposeFileCollection) {
            if (!is_array($composeFiles)) {
                return new ComposeFileCollection([$composeFiles]);
            } else {
                return new ComposeFileCollection($composeFiles);
            }
        } else {
            return $composeFiles;
        }
    }

    /**
     * Format the command to execute
     *
     * @param string                $subcommand   The subcommand to pass to docker-compose command
     * @param ComposeFileCollection $composeFiles The compose files to precise in the command
     */
    private function formatCommand($subcommand, ComposeFileCollection $composeFiles)
    {
        $command = new Command("docker-compose");
        $project = '';
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        # Add files names
        $preciseFiles = '';
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        foreach ($composeFiles->getAll() as $composeFile) {
            $command->addArg('-f', $composeFile->getFileName());
            #$preciseFiles .= ' -f ' . $composeFile->getFileName();

        }

        # Add project name
        if ($composeFiles->getProjectName() != null) {
            $command->addArg('--project-name', $composeFiles->getProjectName());
            #$project = ' --project-name ' . $composeFiles->getProjectName();

        }

        $command->addArg($subcommand);

        return $command;
    }

    /**
     * Execute docker-compose commande
     * @codeCoverageIgnore
     * @param Command $command The command to execute.
     */
    protected function execute($command)
    {
        if ($command->execute()) {
            $output = $command->getOutput();
        } else {
            $output = $command->getError();
        }

        return array(
            'output' => $output,
            'code' => $command->getExitCode()
        );
    }
}


1		<?php
2
3		namespace DockerCompose\Manager;
4
5		use DockerCompose\Exception\ComposeFileNotFoundException;
6		use DockerCompose\Exception\DockerHostConnexionErrorException;
7		use DockerCompose\Exception\DockerInstallationMissingException;
8		use DockerCompose\Exception\NoSuchServiceException;
9		use DockerCompose\ComposeFileCollection;
10		use mikehaertl\shellcommand\Command;
11		use Exception;
12
13		/**
14		* DockerCompose\Manager\ComposeManager
15		*/
16		class ComposeManager
17		{
18
19		/**
20		* Start service containers
21		*
22		* @param mixed $composeFiles The compose files names
23		*/
24		public function start($composeFiles = array())
25		{
26		return $this->processResult(
27		$this->execute(
28		$this->formatCommand('up -d', $this->createComposeFileCollection($composeFiles))
29		)
30		);
31		}
32
33		/**
34		* Stop service containers
35		*
36		* @param mixed $composeFiles The compose files names
37		*/
38		public function stop($composeFiles = array())
39		{
40		return $this->processResult(
41		$this->execute(
42		$this->formatCommand('stop', $this->createComposeFileCollection($composeFiles))
43		)
44		);
45		}
46
47		/**
48		* Stop service containers
49		*
50		* @param mixed $composeFiles The compose files names
51		* @param boolean $force If the remove need to be force (default=false)
52		* @param boolean $removeVolumes If we need to remove the volumes (default=false)
53		*/
54		public function remove($composeFiles = array(), $force = false, $removeVolumes = false)
		0 ignored issues – show Unused Code introduced 2016-04-21 12:35 UTC by Report Bug Copy Issue Report The parameter `$force` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
55		{
56		$command = 'rm --force';
57
58		if ($removeVolumes) {
59		$command .= ' -v';
60		}
61
62		return $this->processResult(
63		$this->execute(
64		$this->formatCommand($command, $this->createComposeFileCollection($composeFiles))
65		)
66		);
67		}
68
69		/**
70		* Stop service containers
71		*
72		* @param mixed $composeFiles The compose files names
73		* @param string $signal Optionnal to precise SIGNAL to send to the container for SIGKILL replacement.
74		*/
75	View Code Duplication	public function kill($composeFiles = array(), $signal = 'SIGKILL')
		0 ignored issues – show Duplication introduced 2016-02-02 15:09 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
76		{
77		$command = 'kill';
78
79		if ($signal !== 'SIGKILL') {
80		$command .= ' -s ' . $signal;
81		}
82
83		return $this->processResult(
84		$this->execute(
85		$this->formatCommand($command, $this->createComposeFileCollection($composeFiles))
86		)
87		);
88		}
89
90		/**
91		* Build service images
92		*
93		* @param mixed $composeFiles The compose files names
94		* @param boolean $pull If we want attempt to pull a newer version of the from image
95		* @param boolean $forceRemove If we want remove the intermediate containers
96		* @param bollean $cache If we can use the cache when building the image
97		*/
98		public function build($composeFiles = array(), $pull = true, $forceRemove = false, $cache = true)
99		{
100		$command = 'build';
101
102		if ($pull) {
103		$command .= ' --pull';
104		}
105
106		if ($forceRemove) {
107		$command .= ' --force-rm';
108		}
109
110		if (!$cache) {
111		$command .= ' --no-cache';
112		}
113
114		return $this->processResult(
115		$this->execute(
116		$this->formatCommand($command, $this->createComposeFileCollection($composeFiles))
117		)
118		);
119		}
120
121		/**
122		* Pull service images
123		*
124		* @param mixed $composeFiles The compose files names
125		*/
126		public function pull($composeFiles = array())
127		{
128		$command = 'pull';
129
130		return $this->processResult(
131		$this->execute(
132		$this->formatCommand($command, $this->createComposeFileCollection($composeFiles))
133		)
134		);
135		}
136
137
138		/**
139		* Restart running containers
140		*
141		* @param mixed $composeFiles The compose files names
142		* @param integer $timeout If we want attempt to pull a newer version of the from image
143		*/
144	View Code Duplication	public function restart($composeFiles = array(), $timeout = 10)
		0 ignored issues – show Duplication introduced 2016-02-02 15:09 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
145		{
146		$command = 'restart';
147
148		if ($timeout != 10) {
149		$command .= ' --timeout='.$timeout;
150		}
151
152		return $this->processResult(
153		$this->execute(
154		$this->formatCommand($command, $this->createComposeFileCollection($composeFiles))
155		)
156		);
157		}
158
159		/**
160		* Run service with command
161		*
162		* @param string $service Service name
163		* @param string $command Command to pass to service
164		* @param mixed $composeFiles The compose files names
165		*/
166		public function run($service, $command, $composeFiles = array())
167		{
168		$command = 'run --rm ' . $service . ' ' . $command;
169		$result = $this->execute(
170		$this->formatCommand($command, $this->createComposeFileCollection($composeFiles))
171		);
172
173		if ($result['code'] == 1 && strpos($result['output'], 'service') != false) {
		0 ignored issues – show Bug Best Practice introduced 2016-04-21 12:35 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `strpos($result['output'], 'service')` of type `integer` to the boolean `false`. If you are specifically checking for non-zero, consider using something more explicit like `> 0` or `!== 0` instead. Loading history...
174		throw new NoSuchServiceException($result['output']);
175		}
176
177		return $this->processResult($result);
178		}
179
180		/**
181		* List containers
182		*
183		* @param mixed $composeFiles The compose files names
184		*/
185		public function ps($composeFiles = array())
186		{
187		return $this->processResult(
188		$this->execute(
189		$this->formatCommand('ps', $this->createComposeFileCollection($composeFiles))
190		)
191		);
192		}
193
194		/**
195		* Show configuration (yaml)
196		*
197		* @param mixed $composeFiles The compose files names
198		*/
199		public function config($composeFiles = array())
200		{
201		return $this->processResult(
202		$this->execute(
203		$this->formatCommand('config', $this->createComposeFileCollection($composeFiles))
204		)
205		);
206		}
207
208		/**
209		* List IP containers
210		*
211		* @param mixed $composeFiles The compose files names
212		*/
213	View Code Duplication	public function ips($composeFiles = array())
		0 ignored issues – show Duplication introduced 2016-02-02 17:03 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
214		{
215		$command = $this->formatCommand('ps', $this->createComposeFileCollection($composeFiles));
216
217		$command = 'for CONTAINER in $(' . $command . ' -q); ';
218		$command .= 'do echo "$(docker inspect --format \' {{ .Name }} \' $CONTAINER)\t';
219		$command .= '$(docker inspect --format \' {{ .NetworkSettings.IPAddress }} \' $CONTAINER)"; done';
220
221		return $this->processResult($this->execute($command));
		0 ignored issues – show Documentation introduced 2016-04-21 12:35 UTC by Report Bug Copy Issue Report `$command` is of type `string`, but the function expects a `object<mikehaertl\shellcommand\Command>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
222		}
223
224		/**
225		* Process result with returned code and output
226		*
227		* @param array $result The result of command with output and returnCode
228		*
229		* @throws DockerInstallationMissingException When returned code is 127
230		* @throws ComposeFileNotFoundException When no compose file precise and docker-compose.yml not found
231		* @throws DockerHostConnexionErrorException When we can't connect to docker host
232		* @throws \Exception When an unknown error is returned
233		*/
234		private function processResult($result)
235		{
236		if ($result['code'] === 127) {
237		throw new DockerInstallationMissingException();
238		}
239
240		if ($result['code'] === 1) {
241		if (!strpos($result['output'], 'DOCKER_HOST')) {
242		if (!strpos($result['output'], 'docker-compose.yml')) {
243		throw new Exception($result['output']);
244		} else {
245		throw new ComposeFileNotFoundException();
246		}
247		} else {
248		throw new DockerHostConnexionErrorException();
249		}
250		}
251
252		return $result['output'];
253		}
254
255		/**
256		* Create the composeFileCollection from the type of value given
257		*
258		* @param mixed $composeFiles The docker-compose files (can be array, string or ComposeFile)
259		*
260		* @return ComposeFileCollection
261		*/
262		private function createComposeFileCollection($composeFiles)
263		{
264		if (!$composeFiles instanceof ComposeFileCollection) {
265		if (!is_array($composeFiles)) {
266		return new ComposeFileCollection([$composeFiles]);
267		} else {
268		return new ComposeFileCollection($composeFiles);
269		}
270		} else {
271		return $composeFiles;
272		}
273		}
274
275		/**
276		* Format the command to execute
277		*
278		* @param string $subcommand The subcommand to pass to docker-compose command
279		* @param ComposeFileCollection $composeFiles The compose files to precise in the command
280		*/
281		private function formatCommand($subcommand, ComposeFileCollection $composeFiles)
282		{
283		$command = new Command("docker-compose");
284		$project = '';
		0 ignored issues – show Unused Code introduced 2016-04-21 12:35 UTC by Report Bug Copy Issue Report `$project` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
285
286		# Add files names
287		$preciseFiles = '';
		0 ignored issues – show Unused Code introduced 2016-04-21 12:35 UTC by Report Bug Copy Issue Report `$preciseFiles` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
288		foreach ($composeFiles->getAll() as $composeFile) {
289		$command->addArg('-f', $composeFile->getFileName());
290		#$preciseFiles .= ' -f ' . $composeFile->getFileName();
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-21 12:35 UTC by Report Bug Copy Issue Report `47%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
291		}
292
293		# Add project name
294		if ($composeFiles->getProjectName() != null) {
295		$command->addArg('--project-name', $composeFiles->getProjectName());
296		#$project = ' --project-name ' . $composeFiles->getProjectName();
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-21 12:35 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
297		}
298
299		$command->addArg($subcommand);
300
301		return $command;
302		}
303
304		/**
305		* Execute docker-compose commande
306		* @codeCoverageIgnore
307		* @param Command $command The command to execute.
308		*/
309		protected function execute($command)
310		{
311		if ($command->execute()) {
312		$output = $command->getOutput();
313		} else {
314		$output = $command->getError();
315		}
316
317		return array(
318		'output' => $output,
319		'code' => $command->getExitCode()
320		);
321		}
322		}
323

omauger / docker-compose-php

Pull Request — master (#17)

ComposeManager A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like