RoboFile::startPHP() - Code Metrics - Inspection of "Bump version v3.0.0-beta3" - edyan/neuralyzer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f0d93b...12af13 )

by Emmanuel

created 2018-04-02 17:55 UTC

RoboFile::startPHP() B

↳ Parent: RoboFile

Complexity

Conditions	4
Paths	4

Size

Total Lines	22
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	8.9197
c	0
b	0
f	0
cc	4
eloc	16
nc	4
nop	2

<?php
/**
 * This is project's console commands configuration for Robo task runner.
 *
 * @see http://robo.li/
 */

class RoboFile extends \Robo\Tasks
namespace YourVendor;

class YourClass { }
{
    /**
     * A test command just to make sure robo works on that computer
     */
    public function dockertest()
    {
        $this->stopOnFail(true);

        $this->taskDockerStop('robo_test')->run();

        $this->taskDockerRun('edyan/php:7.1')
             ->name('robo_test')
             ->detached()
             ->option('--rm')
             ->run();

        $this->taskDockerExec('robo_test')
             ->interactive()
             ->exec($this->taskExec('php -v'))
             ->run();

        $this->taskDockerStop('robo_test')->run();
    }


    /**
     * Run All Unit Test
     * @param  array  $opts
     */
    public function test(
        $opts = ['php' => '7.1', 'db' => 'mysql', 'keep-cts' => false, 'wait' => 5]
    ) {
        $this->stopOnFail(true);

        $this->setupDocker($opts['php'], $opts['db'], $opts['wait']);

        // Run the tests
        $this->taskDockerExec('robo_php')
            ->interactive()
            ->option('--user', 'www-data')
            ->exec($this->taskExec('/bin/bash -c "cd /var/www/html ; vendor/bin/phpunit"'))
            ->run();

        if ($opts['keep-cts'] === false) {
            $this->destroyDocker();
        }
    }


    /**
     * Build an executable phar
     */
    public function phar()
    {
        if ((int)ini_get('phar.readonly') === 1) {
            throw new \RuntimeException(
                'You must have phar.readonly = 1 or run' . PHP_EOL .
                'php -d phar.readonly=0 vendor/bin/robo release'
            );
        }
        // Create a collection builder to hold the temporary
        // directory until the pack phar task runs.
        $collection = $this->collectionBuilder();
        $workDir = $collection->tmpDir();
        $buildDir = "$workDir/neuralyzer";

        $prepTasks = $this->collectionBuilder();
        $preparationResult = $prepTasks
            ->taskFilesystemStack()
                ->mkdir($workDir)
                ->taskCopyDir([__DIR__ . '/src' => $buildDir . '/src'])
            ->taskFilesystemStack()
                ->copy(__DIR__ . '/bin/neuralyzer', $buildDir . '/bin/neuralyzer')
                ->copy(__DIR__ . '/composer.json', $buildDir . '/composer.json')
                ->copy(__DIR__ . '/composer.lock', $buildDir . '/composer.lock')
                ->copy(__DIR__ . '/LICENSE', $buildDir . '/LICENSE')
                ->copy(__DIR__ . '/README.md', $buildDir . '/README.md')

            ->taskComposerInstall()
                ->dir($buildDir)
                ->noDev()
                ->noScripts()
                ->printOutput(true)
                ->optimizeAutoloader()
                ->run();

        // Exit if the preparation step failed
        if (!$preparationResult->wasSuccessful()) {
            return $preparationResult;
        }

        // Decide which files we're going to pack
        $files = \Symfony\Component\Finder\Finder::create()->ignoreVCS(true)
            ->files()
            ->name('*.php')
            ->name('*.exe') // for 1symfony/console/Resources/bin/hiddeninput.exe
            ->path('src')
            ->path('vendor')
            ->notPath('docs')
            ->notPath('/vendor\/.*\/[Tt]est/')
            ->in(is_dir($buildDir) ? $buildDir : __DIR__);

        // Build the phar
        return $collection
            ->taskPackPhar('neuralyzer.phar')
                ->compress()
                ->addFile('bin/neuralyzer', 'bin/neuralyzer')
                ->addFiles($files)
                ->executable('bin/neuralyzer')
            ->taskFilesystemStack()
                ->chmod(__DIR__ . '/neuralyzer.phar', 0755)
            ->run();
    }


    public function release()
    {
        $this->stopOnFail(true);

        $this->gitVerifyEverythingIsCommited();
        $this->gitVerifyBranchIsMaster();
        $this->gitVerifyBranchIsUpToDate();

        $version = null;
        $currentVersion = \Edyan\Neuralyzer\Console\Application::VERSION;
        while (empty($version)) {
            $version = $this->ask("Whats the version number ? (current : $currentVersion)");
        }
        $versionDesc = null;
        while (empty($versionDesc)) {
            $versionDesc = $this->ask('Describe your release');
        }

        $this->say("Preparing version $version");

        // Patch the right files
        $this->taskReplaceInFile(__DIR__ . '/src/Console/Application.php')
             ->from("const VERSION = '$currentVersion';")
             ->to("const VERSION = '$version';")
             ->run();

        $this->phar();

        // Commit a bump version
        $this->taskGitStack()
             ->add(__DIR__ . '/src/Console/Application.php')
             ->add(__DIR__ . '/neuralyzer.phar')
             ->commit("Bump version $version")
             ->push('origin', 'master')
             ->tag($version)
             ->push('origin', $version)
             ->run();

        // Create a release
        $this->taskGitHubRelease($version)
             ->uri('edyan/neuralyzer')
             ->description($versionDesc)
             ->run();

         // Create a release
         $this->taskGitHubRelease($version)
              ->name($versionDesc)
              ->tag($version)
              ->description('')
              ->owner('edyan')
              ->repo('neuralyzer')
              ->accessToken(Robo::Config()->get('settings.github_token'))
              ->run();

        $this->say('Release ready, you can push');
    }


    private function setupDocker(
        string $php = '7.1',
        string $dbType = 'mysql',
        int $wait = 10
    ) {
        $this->destroyDocker();

        if (!in_array($dbType, ['mysql', 'pgsql', 'sqlsrv'])) {
            throw new \InvalidArgumentException('Database can be only mysql, pgsql or sqlsrv');
        }

        $this->startDb($dbType);
        $this->say("Waiting $wait seconds $dbType to start");
        sleep($wait);
        // Now create a DB For SQL Server as there is no option in the docker image
        if ($dbType === 'sqlsrv') {
            $this->createSQLServerDB();
        }

        $this->startPHP($php, $dbType);
    }

    private function startDb($type)
    {
        $image = $type;
        if ($type === 'sqlsrv') {
            $image = 'microsoft/mssql-server-linux:2017-latest';
        } elseif ($type === 'pgsql') {
            $image = 'postgres';
        }

        $dbCt = $this->taskDockerRun($image)->detached()->name('robo_db')->option('--rm');
        if ($type === 'mysql') {
            $dbCt = $dbCt->env('MYSQL_ROOT_PASSWORD', 'rootRoot44root')->env('MYSQL_DATABASE', 'test_db');
        } elseif ($type === 'pgsql') {
            $dbCt = $dbCt->env('POSTGRES_PASSWORD', 'rootRoot44root')->env('POSTGRES_DB', 'test_db');
        } elseif ($type === 'sqlsrv') {
            $dbCt = $dbCt->env('ACCEPT_EULA', 'Y')->env('SA_PASSWORD', 'rootRoot44root');
        }

        $dbCt->run();
    }


    private function createSQLServerDB()
    {
        $createSqlQuery = '/opt/mssql-tools/bin/sqlcmd -U sa -P rootRoot44root ';
        $createSqlQuery.= '-S localhost -Q "CREATE DATABASE test_db"';
        $this->taskDockerExec('robo_db')
             ->interactive()
             ->exec($this->taskExec($createSqlQuery))
             ->run();
    }


    private function startPHP(string $version, string $dbType)
    {
        if (!in_array($version, ['7.1', '7.2'])) {
            throw new \InvalidArgumentException('PHP Version must be 7.1 or 7.2');
        }

        $dbUser = 'root';
        if ($dbType === 'pgsql') {
            $dbUser = 'postgres';
        } elseif ($dbType === 'sqlsrv') {
            $dbUser = 'sa';
        }

        $this->taskDockerRun('edyan/php:' . $version . '-sqlsrv')
            ->detached()->name('robo_php')->option('--rm')
            ->env('FPM_UID', getmyuid())->env('FPM_GID', getmygid())
            ->env('DB_HOST', 'robo_db')->env('DB_DRIVER', 'pdo_' . $dbType)
            ->env('DB_PASSWORD', 'rootRoot44root')->env('DB_USER', $dbUser)
            ->volume(__DIR__, '/var/www/html')
            ->link('robo_db', 'robo_db')
            ->run();
    }


    private function destroyDocker()
    {
        $cts = ['robo_db', 'robo_php'];
        foreach ($cts as $ct) {
            $this->stopContainer($ct);
        }
    }


    private function stopContainer(string $ct)
    {
        $process = new \Symfony\Component\Process\Process("docker ps | grep $ct | wc -l");
        $process->run();

        if ((int)$process->getOutput() === 0) {
            return;
        }

        $this->say('Destroying container ' . $ct);
        $this->taskDockerStop($ct)->run();
    }

    private function gitVerifyBranchIsMaster()
    {
        $branch = $this->taskGitStack()
                        ->silent(true)
                        ->exec('rev-parse --abbrev-ref HEAD')
                        ->run();
        if ($branch->getMessage() !== 'master') {
            throw new \RuntimeException('You must be on the master branch');
        }
    }

    private function gitVerifyEverythingIsCommited()
    {
        $modifiedFiles = $this->taskGitStack()
                              ->silent(true)
                              ->exec('status -s')
                              ->run();
        if (!empty($modifiedFiles->getMessage())) {
            throw new \RuntimeException('Some files have not been commited yet');
        }
    }

    private function gitVerifyBranchIsUpToDate()
    {
        $modifiedFiles = $this->taskGitStack()
                              ->silent(true)
                              ->exec('fetch --dry-run')
                              ->run();
        if (!empty($modifiedFiles->getMessage())) {
            throw new \RuntimeException('Your local repo is not up to date, run "git pull"');
        }
    }
}


1			<?php
2			/**
3			* This is project's console commands configuration for Robo task runner.
4			*
5			* @see http://robo.li/
6			*/
7
8			class RoboFile extends \Robo\Tasks
			0 ignored issues – show Coding Style Compatibility introduced 2018-03-15 22:26 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
9			{
10			/**
11			* A test command just to make sure robo works on that computer
12			*/
13			public function dockertest()
14			{
15			$this->stopOnFail(true);
16
17			$this->taskDockerStop('robo_test')->run();
18
19			$this->taskDockerRun('edyan/php:7.1')
20			->name('robo_test')
21			->detached()
22			->option('--rm')
23			->run();
24
25			$this->taskDockerExec('robo_test')
26			->interactive()
27			->exec($this->taskExec('php -v'))
28			->run();
29
30			$this->taskDockerStop('robo_test')->run();
31			}
32
33
34			/**
35			* Run All Unit Test
36			* @param array $opts
37			*/
38			public function test(
39			$opts = ['php' => '7.1', 'db' => 'mysql', 'keep-cts' => false, 'wait' => 5]
40			) {
41			$this->stopOnFail(true);
42
43			$this->setupDocker($opts['php'], $opts['db'], $opts['wait']);
44
45			// Run the tests
46			$this->taskDockerExec('robo_php')
47			->interactive()
48			->option('--user', 'www-data')
49			->exec($this->taskExec('/bin/bash -c "cd /var/www/html ; vendor/bin/phpunit"'))
50			->run();
51
52			if ($opts['keep-cts'] === false) {
53			$this->destroyDocker();
54			}
55			}
56
57
58			/**
59			* Build an executable phar
60			*/
61			public function phar()
62			{
63			if ((int)ini_get('phar.readonly') === 1) {
64			throw new \RuntimeException(
65			'You must have phar.readonly = 1 or run' . PHP_EOL .
66			'php -d phar.readonly=0 vendor/bin/robo release'
67			);
68			}
69			// Create a collection builder to hold the temporary
70			// directory until the pack phar task runs.
71			$collection = $this->collectionBuilder();
72			$workDir = $collection->tmpDir();
73			$buildDir = "$workDir/neuralyzer";
74
75			$prepTasks = $this->collectionBuilder();
76			$preparationResult = $prepTasks
77			->taskFilesystemStack()
78			->mkdir($workDir)
79			->taskCopyDir([__DIR__ . '/src' => $buildDir . '/src'])
80			->taskFilesystemStack()
81			->copy(__DIR__ . '/bin/neuralyzer', $buildDir . '/bin/neuralyzer')
82			->copy(__DIR__ . '/composer.json', $buildDir . '/composer.json')
83			->copy(__DIR__ . '/composer.lock', $buildDir . '/composer.lock')
84			->copy(__DIR__ . '/LICENSE', $buildDir . '/LICENSE')
85			->copy(__DIR__ . '/README.md', $buildDir . '/README.md')
86
87			->taskComposerInstall()
88			->dir($buildDir)
89			->noDev()
90			->noScripts()
91			->printOutput(true)
92			->optimizeAutoloader()
93			->run();
94
95			// Exit if the preparation step failed
96			if (!$preparationResult->wasSuccessful()) {
97			return $preparationResult;
98			}
99
100			// Decide which files we're going to pack
101			$files = \Symfony\Component\Finder\Finder::create()->ignoreVCS(true)
102			->files()
103			->name('*.php')
104			->name('*.exe') // for 1symfony/console/Resources/bin/hiddeninput.exe
105			->path('src')
106			->path('vendor')
107			->notPath('docs')
108			->notPath('/vendor\/.*\/[Tt]est/')
109			->in(is_dir($buildDir) ? $buildDir : __DIR__);
110
111			// Build the phar
112			return $collection
113			->taskPackPhar('neuralyzer.phar')
114			->compress()
115			->addFile('bin/neuralyzer', 'bin/neuralyzer')
116			->addFiles($files)
117			->executable('bin/neuralyzer')
118			->taskFilesystemStack()
119			->chmod(__DIR__ . '/neuralyzer.phar', 0755)
120			->run();
121			}
122
123
124			public function release()
125			{
126			$this->stopOnFail(true);
127
128			$this->gitVerifyEverythingIsCommited();
129			$this->gitVerifyBranchIsMaster();
130			$this->gitVerifyBranchIsUpToDate();
131
132			$version = null;
133			$currentVersion = \Edyan\Neuralyzer\Console\Application::VERSION;
134			while (empty($version)) {
135			$version = $this->ask("Whats the version number ? (current : $currentVersion)");
136			}
137			$versionDesc = null;
138			while (empty($versionDesc)) {
139			$versionDesc = $this->ask('Describe your release');
140			}
141
142			$this->say("Preparing version $version");
143
144			// Patch the right files
145			$this->taskReplaceInFile(__DIR__ . '/src/Console/Application.php')
146			->from("const VERSION = '$currentVersion';")
147			->to("const VERSION = '$version';")
148			->run();
149
150			$this->phar();
151
152			// Commit a bump version
153			$this->taskGitStack()
154			->add(__DIR__ . '/src/Console/Application.php')
155			->add(__DIR__ . '/neuralyzer.phar')
156			->commit("Bump version $version")
157			->push('origin', 'master')
158			->tag($version)
159			->push('origin', $version)
160			->run();
161
162			// Create a release
163			$this->taskGitHubRelease($version)
164			->uri('edyan/neuralyzer')
165			->description($versionDesc)
166			->run();
167
168			// Create a release
169			$this->taskGitHubRelease($version)
170			->name($versionDesc)
171			->tag($version)
172			->description('')
173			->owner('edyan')
174			->repo('neuralyzer')
175			->accessToken(Robo::Config()->get('settings.github_token'))
176			->run();
177
178			$this->say('Release ready, you can push');
179			}
180
181
182			private function setupDocker(
183			string $php = '7.1',
184			string $dbType = 'mysql',
185			int $wait = 10
186			) {
187			$this->destroyDocker();
188
189			if (!in_array($dbType, ['mysql', 'pgsql', 'sqlsrv'])) {
190			throw new \InvalidArgumentException('Database can be only mysql, pgsql or sqlsrv');
191			}
192
193			$this->startDb($dbType);
194			$this->say("Waiting $wait seconds $dbType to start");
195			sleep($wait);
196			// Now create a DB For SQL Server as there is no option in the docker image
197			if ($dbType === 'sqlsrv') {
198			$this->createSQLServerDB();
199			}
200
201			$this->startPHP($php, $dbType);
202			}
203
204			private function startDb($type)
205			{
206			$image = $type;
207			if ($type === 'sqlsrv') {
208			$image = 'microsoft/mssql-server-linux:2017-latest';
209			} elseif ($type === 'pgsql') {
210			$image = 'postgres';
211			}
212
213			$dbCt = $this->taskDockerRun($image)->detached()->name('robo_db')->option('--rm');
214			if ($type === 'mysql') {
215			$dbCt = $dbCt->env('MYSQL_ROOT_PASSWORD', 'rootRoot44root')->env('MYSQL_DATABASE', 'test_db');
216			} elseif ($type === 'pgsql') {
217			$dbCt = $dbCt->env('POSTGRES_PASSWORD', 'rootRoot44root')->env('POSTGRES_DB', 'test_db');
218			} elseif ($type === 'sqlsrv') {
219			$dbCt = $dbCt->env('ACCEPT_EULA', 'Y')->env('SA_PASSWORD', 'rootRoot44root');
220			}
221
222			$dbCt->run();
223			}
224
225
226			private function createSQLServerDB()
227			{
228			$createSqlQuery = '/opt/mssql-tools/bin/sqlcmd -U sa -P rootRoot44root ';
229			$createSqlQuery.= '-S localhost -Q "CREATE DATABASE test_db"';
230			$this->taskDockerExec('robo_db')
231			->interactive()
232			->exec($this->taskExec($createSqlQuery))
233			->run();
234			}
235
236
237			private function startPHP(string $version, string $dbType)
238			{
239			if (!in_array($version, ['7.1', '7.2'])) {
240			throw new \InvalidArgumentException('PHP Version must be 7.1 or 7.2');
241			}
242
243			$dbUser = 'root';
244			if ($dbType === 'pgsql') {
245			$dbUser = 'postgres';
246			} elseif ($dbType === 'sqlsrv') {
247			$dbUser = 'sa';
248			}
249
250			$this->taskDockerRun('edyan/php:' . $version . '-sqlsrv')
251			->detached()->name('robo_php')->option('--rm')
252			->env('FPM_UID', getmyuid())->env('FPM_GID', getmygid())
253			->env('DB_HOST', 'robo_db')->env('DB_DRIVER', 'pdo_' . $dbType)
254			->env('DB_PASSWORD', 'rootRoot44root')->env('DB_USER', $dbUser)
255			->volume(__DIR__, '/var/www/html')
256			->link('robo_db', 'robo_db')
257			->run();
258			}
259
260
261			private function destroyDocker()
262			{
263			$cts = ['robo_db', 'robo_php'];
264			foreach ($cts as $ct) {
265			$this->stopContainer($ct);
266			}
267			}
268
269
270			private function stopContainer(string $ct)
271			{
272			$process = new \Symfony\Component\Process\Process("docker ps \| grep $ct \| wc -l");
273			$process->run();
274
275			if ((int)$process->getOutput() === 0) {
276			return;
277			}
278
279			$this->say('Destroying container ' . $ct);
280			$this->taskDockerStop($ct)->run();
281			}
282
283			private function gitVerifyBranchIsMaster()
284			{
285			$branch = $this->taskGitStack()
286			->silent(true)
287			->exec('rev-parse --abbrev-ref HEAD')
288			->run();
289			if ($branch->getMessage() !== 'master') {
290			throw new \RuntimeException('You must be on the master branch');
291			}
292			}
293
294			private function gitVerifyEverythingIsCommited()
295			{
296			$modifiedFiles = $this->taskGitStack()
297			->silent(true)
298			->exec('status -s')
299			->run();
300			if (!empty($modifiedFiles->getMessage())) {
301			throw new \RuntimeException('Some files have not been commited yet');
302			}
303			}
304
305			private function gitVerifyBranchIsUpToDate()
306			{
307			$modifiedFiles = $this->taskGitStack()
308			->silent(true)
309			->exec('fetch --dry-run')
310			->run();
311			if (!empty($modifiedFiles->getMessage())) {
312			throw new \RuntimeException('Your local repo is not up to date, run "git pull"');
313			}
314			}
315			}
316

edyan / neuralyzer

Push — master ( f0d93b...12af13 )

RoboFile::startPHP() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like