ComposeManager::formatCommand() - Code Metrics - Inspection of "Merge pull request #7 from omauger/add_command_res..." - omauger/docker-compose-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f4794e...1f0a28 )

by ophelie

created 2016-02-02 14:56 UTC

ComposeManager::formatCommand() B

↳ Parent: ComposeManager

Complexity

Conditions	5
Paths	8

Size

Total Lines	27
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	0	Features	3

Metric	Value
c	4
b	0
f	3
dl	0
loc	27
rs	8.439
cc	5
eloc	15
nc	8
nop	2

<?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';
        if ($force) {
            $command .= ' --force';
        }

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

        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))
            )
        );
    }


    /**
     * 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'], 'No such 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))
            )
        );
    }

    /**
     * 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)
    {
        $project = '';
        $networking = '';
        $networkDriver = '';

        # Add project name, and network options
        if ($composeFiles->getProjectName() != null) {
            $project = ' --project-name ' . $composeFiles->getProjectName();
            if ($composeFiles->isNetworking()) {
                $networking = ' --x-networking';
                if ($composeFiles->getNetworkDriver() != null) {
                    $networkDriver = ' --x-network-driver ' . $composeFiles->getNetworkDriver();
                }
            }
        }

        # Add files names
        $preciseFiles = '';
        foreach ($composeFiles->getAll() as $composeFile) {
            $preciseFiles .= ' -f ' . $composeFile->getFileName();
        }

        $command = 'docker-compose' . $preciseFiles . $networking . $networkDriver . $project . ' ' . $subcommand;

        return $command;
    }

    /**
     * Execute docker-compose commande
     * @codeCoverageIgnore
     * @param string                $command      The command to execute
     */
    protected function execute($command)
    {
        $exec = new Command($command);

        if ($exec->execute()) {
            $output = $exec->getOutput();
        } else {
            $output = $exec->getError();
        }

        return array(
            'output' => $output,
            'code' => $exec->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)
55			{
56			$command = 'rm';
57			if ($force) {
58			$command .= ' --force';
59			}
60
61			if ($removeVolumes) {
62			$command .= ' -v';
63			}
64
65			return $this->processResult(
66			$this->execute(
67			$this->formatCommand($command, $this->createComposeFileCollection($composeFiles))
68			)
69			);
70			}
71
72			/**
73			* Build service images
74			*
75			* @param mixed $composeFiles The compose files names
76			* @param boolean $pull If we want attempt to pull a newer version of the from image
77			* @param boolean $forceRemove If we want remove the intermediate containers
78			* @param bollean $cache If we can use the cache when building the image
79			*/
80			public function build($composeFiles = array(), $pull = true, $forceRemove = false, $cache = true)
81			{
82			$command = 'build';
83
84			if ($pull) {
85			$command .= ' --pull';
86			}
87
88			if ($forceRemove) {
89			$command .= ' --force-rm';
90			}
91
92			if (!$cache) {
93			$command .= ' --no-cache';
94			}
95
96			return $this->processResult(
97			$this->execute(
98			$this->formatCommand($command, $this->createComposeFileCollection($composeFiles))
99			)
100			);
101			}
102
103
104			/**
105			* Restart running containers
106			*
107			* @param mixed $composeFiles The compose files names
108			* @param integer $timeout If we want attempt to pull a newer version of the from image
109			*/
110			public function restart($composeFiles = array(), $timeout = 10)
111			{
112			$command = 'restart';
113
114			if ($timeout != 10) {
115			$command .= ' --timeout='.$timeout;
116			}
117
118			return $this->processResult(
119			$this->execute(
120			$this->formatCommand($command, $this->createComposeFileCollection($composeFiles))
121			)
122			);
123			}
124
125			/**
126			* Run service with command
127			*
128			* @param string $service Service name
129			* @param string $command Command to pass to service
130			* @param mixed $composeFiles The compose files names
131			*/
132			public function run($service, $command, $composeFiles = array())
133			{
134			$command = 'run --rm ' . $service . ' ' . $command;
135			$result = $this->execute(
136			$this->formatCommand($command, $this->createComposeFileCollection($composeFiles))
137			);
138
139			if ($result['code'] == 1 && strpos($result['output'], 'No such service') != false) {
			0 ignored issues – show Bug Best Practice introduced 2015-12-11 09:07 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `strpos($result['output'], 'No such 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...
140			throw new NoSuchServiceException($result['output']);
141			}
142
143			return $this->processResult($result);
144			}
145
146			/**
147			* List containers
148			*
149			* @param mixed $composeFiles The compose files names
150			*/
151			public function ps($composeFiles = array())
152			{
153			return $this->processResult(
154			$this->execute(
155			$this->formatCommand('ps', $this->createComposeFileCollection($composeFiles))
156			)
157			);
158			}
159
160			/**
161			* Process result with returned code and output
162			*
163			* @param array $result The result of command with output and returnCode
164			*
165			* @throws DockerInstallationMissingException When returned code is 127
166			* @throws ComposeFileNotFoundException When no compose file precise and docker-compose.yml not found
167			* @throws DockerHostConnexionErrorException When we can't connect to docker host
168			* @throws \Exception When an unknown error is returned
169			*/
170			private function processResult($result)
171			{
172			if ($result['code'] === 127) {
173			throw new DockerInstallationMissingException();
174			}
175
176			if ($result['code'] === 1) {
177			if (!strpos($result['output'], 'DOCKER_HOST')) {
178			if (!strpos($result['output'], 'docker-compose.yml')) {
179			throw new Exception($result['output']);
180			} else {
181			throw new ComposeFileNotFoundException();
182			}
183			} else {
184			throw new DockerHostConnexionErrorException();
185			}
186			}
187
188			return $result['output'];
189			}
190
191			/**
192			* Create the composeFileCollection from the type of value given
193			*
194			* @param mixed $composeFiles The docker-compose files (can be array, string or ComposeFile)
195			*
196			* @return ComposeFileCollection
197			*/
198			private function createComposeFileCollection($composeFiles)
199			{
200			if (!$composeFiles instanceof ComposeFileCollection) {
201			if (!is_array($composeFiles)) {
202			return new ComposeFileCollection([$composeFiles]);
203			} else {
204			return new ComposeFileCollection($composeFiles);
205			}
206			} else {
207			return $composeFiles;
208			}
209			}
210
211			/**
212			* Format the command to execute
213			*
214			* @param string $subcommand The subcommand to pass to docker-compose command
215			* @param ComposeFileCollection $composeFiles The compose files to precise in the command
216			*/
217			private function formatCommand($subcommand, ComposeFileCollection $composeFiles)
218			{
219			$project = '';
220			$networking = '';
221			$networkDriver = '';
222
223			# Add project name, and network options
224			if ($composeFiles->getProjectName() != null) {
225			$project = ' --project-name ' . $composeFiles->getProjectName();
226			if ($composeFiles->isNetworking()) {
227			$networking = ' --x-networking';
228			if ($composeFiles->getNetworkDriver() != null) {
229			$networkDriver = ' --x-network-driver ' . $composeFiles->getNetworkDriver();
230			}
231			}
232			}
233
234			# Add files names
235			$preciseFiles = '';
236			foreach ($composeFiles->getAll() as $composeFile) {
237			$preciseFiles .= ' -f ' . $composeFile->getFileName();
238			}
239
240			$command = 'docker-compose' . $preciseFiles . $networking . $networkDriver . $project . ' ' . $subcommand;
241
242			return $command;
243			}
244
245			/**
246			* Execute docker-compose commande
247			* @codeCoverageIgnore
248			* @param string $command The command to execute
249			*/
250			protected function execute($command)
251			{
252			$exec = new Command($command);
253
254			if ($exec->execute()) {
255			$output = $exec->getOutput();
256			} else {
257			$output = $exec->getError();
258			}
259
260			return array(
261			'output' => $output,
262			'code' => $exec->getExitCode()
263			);
264			}
265			}
266

omauger / docker-compose-php

Push — master ( f4794e...1f0a28 )

ComposeManager::formatCommand() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like