PHPUnit::getRunnerOptions() - Code Metrics - Inspection of "Fix some documentation issues found in Scrutinizer" - brianium/paratest - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#203)

unknown

created 2016-05-07 17:45 UTC

PHPUnit::getRunnerOptions() A

↳ Parent: PHPUnit

Complexity

Conditions	3
Paths	4

Size

Total Lines	17
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	3

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
c	2
b	1
f	0
dl	0
loc	17
ccs	12
cts	12
cp	1
rs	9.4285
cc	3
eloc	10
nc	4
nop	1
crap	3

<?php 
namespace ParaTest\Console\Testers;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use ParaTest\Runners\PHPUnit\Configuration;
use ParaTest\Runners\PHPUnit\Runner;
use ParaTest\Runners\PHPUnit\WrapperRunner;

/**
 * Class PHPUnit
 *
 * Creates the interface for PHPUnit testing
 *
 * @package ParaTest\Console\Testers
 */
class PHPUnit extends Tester
{
    /**
     * @var \ParaTest\Console\Commands\ParaTestCommand
     */
    protected $command;

    /**
     * Configures the ParaTestCommand with PHPUnit specific
     * definitions
     *
     * @param Command $command
     * @return mixed
     */
    public function configure(Command $command)
    {
        $command
            ->addOption('phpunit', null, InputOption::VALUE_REQUIRED, 'The PHPUnit binary to execute. <comment>(default: vendor/bin/phpunit)</comment>')
            ->addOption('runner', null, InputOption::VALUE_REQUIRED, 'Runner or WrapperRunner. <comment>(default: Runner)</comment>')
            ->addOption('bootstrap', null, InputOption::VALUE_REQUIRED, 'The bootstrap file to be used by PHPUnit.')
            ->addOption('configuration', 'c', InputOption::VALUE_REQUIRED, 'The PHPUnit configuration file to use.')
            ->addOption('group', 'g', InputOption::VALUE_REQUIRED, 'Only runs tests from the specified group(s).')
            ->addOption('exclude-group', null, InputOption::VALUE_REQUIRED, 'Don\'t run tests from the specified group(s).')
            ->addOption('stop-on-failure', null, InputOption::VALUE_NONE, 'Don\'t start any more processes after a failure.')
            ->addOption('log-junit', null, InputOption::VALUE_REQUIRED, 'Log test execution in JUnit XML format to file.')
            ->addOption('colors', null, InputOption::VALUE_NONE, 'Displays a colored bar as a test result.')
            ->addOption('testsuite', null, InputOption::VALUE_OPTIONAL, 'Filter which testsuite to run')
            ->addArgument('path', InputArgument::OPTIONAL, 'The path to a directory or file containing tests. <comment>(default: current directory)</comment>')
            ->addOption('path', null, InputOption::VALUE_REQUIRED, 'An alias for the path argument.');
        $this->command = $command;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
    }

    /**
     * Executes the PHPUnit Runner. Will Display help if no config and no path
     * supplied
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     * @return int|mixed
     */
    public function execute(InputInterface $input, OutputInterface $output)
    {
        if (!$this->hasConfig($input) && !$this->hasPath($input)) {
            $this->displayHelp($input, $output);
        }

        if ($input->getOption('runner') === 'WrapperRunner') {
            $runner = new WrapperRunner($this->getRunnerOptions($input));
        } else {
            if ($input->getOption('runner') !== '') {
                // because we want to have to bootstrap script inherited before check/initialization
                $runnerOption = $this->getRunnerOptions($input);
                $runnerClass = $input->getOption('runner');
                if (class_exists($runnerClass)) {
                    $runner = new $runnerClass($runnerOption);
                }
            }
        }

        if (!isset($runner)) {
            $runner = new Runner($this->getRunnerOptions($input));
        }

        $runner->run();
        return $runner->getExitCode();
    }

    /**
     * Returns whether or not a test path has been supplied
     * via option or regular input
     *
     * @param InputInterface $input
     * @return bool
     */
    protected function hasPath(InputInterface $input)
    {
        $argument = $input->getArgument('path');
        $option = $input->getOption('path');
        return $argument || $option;
    }

    /**
     * Is there a PHPUnit xml configuration present
     *
     * @param InputInterface $input
     * @return bool
     */
    protected function hasConfig(InputInterface $input)
    {
        return (false !== $this->getConfig($input));
    }

    /**
     * @param \Symfony\Component\Console\Input\InputInterface $input
     * @return \ParaTest\Runners\PHPUnit\Configuration|boolean
     */
    protected function getConfig(InputInterface $input)
    {
        $cwd = getcwd() . DIRECTORY_SEPARATOR;

        if ($input->getOption('configuration')) {
            $configFilename = $input->getOption('configuration');
        } elseif (file_exists($cwd . 'phpunit.xml.dist')) {
            $configFilename = $cwd . 'phpunit.xml.dist';
        } elseif (file_exists($cwd . 'phpunit.xml')) {
            $configFilename = $cwd . 'phpunit.xml';
        } else {
            return false;
        }

        return new Configuration($configFilename);
    }

    /**
     * @param \Symfony\Component\Console\Input\InputInterface $input
     * @return array
     * @throws \RuntimeException
     */
    public function getRunnerOptions(InputInterface $input)
    {
        $path = $input->getArgument('path');
        $options = $this->getOptions($input);
        $bootstrap = $this->getBootstrapFile($input, $options);
        $this->requireBootstrap($bootstrap);

        if ($this->hasCoverage($options)) {
            $options['coverage-php'] = sys_get_temp_dir() . '/will_be_overwritten.php';
        }

        if ($path) {
            $options = array_merge(array('path' => $path), $options);
        }

        return $options;
    }

    /**
     * Require the bootstrap. If the file is specified, but does not exist
     * then an exception will be raised.
     *
     * @param $file
     * @throws \RuntimeException
     */
    public function requireBootstrap($file)
    {
        if (! $file) {
            return;
        }

        if (! file_exists($file)) {
            $message = sprintf('Bootstrap specified but could not be found (%s)', $file);
            throw new \RuntimeException($message);
        }

        $this->scopedRequire($file);
    }

    /**
     * This function limits the scope of a required file
     * so that variables defined in it do not break
     * this object's configuration.
     */
    protected function scopedRequire($file)
    {
        $cwd = getcwd();
        require_once $file;
        chdir($cwd);
    }

    /**
     * Return whether or not code coverage information should be collected.
     *
     * @param $options
     * @return bool
     */
    protected function hasCoverage($options)
    {
        $isFileFormat = isset($options['coverage-html']) || isset($options['coverage-clover']);
        $isPHP = isset($options['coverage-php']);
        return $isFileFormat && ! $isPHP;
    }

    /**
     * Fetch the path to the bootstrap file.
     *
     * @param InputInterface $input
     * @param array $options
     * @return string
     */
    protected function getBootstrapFile(InputInterface $input, array $options)
    {
        if (isset($options['bootstrap'])) {
            return $options['bootstrap'];
        }

        if (! $this->hasConfig($input)) {
            return '';
        }

        $config = $this->getConfig($input);
        $bootstrap = $config->getBootstrap();

        return ($bootstrap) ? $config->getConfigDir() . $bootstrap : '';
    }
}


1		<?php
2		namespace ParaTest\Console\Testers;
3
4		use Symfony\Component\Console\Command\Command;
5		use Symfony\Component\Console\Input\InputOption;
6		use Symfony\Component\Console\Input\InputArgument;
7		use Symfony\Component\Console\Input\InputInterface;
8		use Symfony\Component\Console\Output\OutputInterface;
9		use ParaTest\Runners\PHPUnit\Configuration;
10		use ParaTest\Runners\PHPUnit\Runner;
11		use ParaTest\Runners\PHPUnit\WrapperRunner;
12
13		/**
14		* Class PHPUnit
15		*
16		* Creates the interface for PHPUnit testing
17		*
18		* @package ParaTest\Console\Testers
19		*/
20		class PHPUnit extends Tester
21		{
22		/**
23		* @var \ParaTest\Console\Commands\ParaTestCommand
24		*/
25		protected $command;
26
27		/**
28		* Configures the ParaTestCommand with PHPUnit specific
29		* definitions
30		*
31		* @param Command $command
32		* @return mixed
33		*/
34	8	public function configure(Command $command)
35		{
36		$command
37	8	->addOption('phpunit', null, InputOption::VALUE_REQUIRED, 'The PHPUnit binary to execute. <comment>(default: vendor/bin/phpunit)</comment>')
38	8	->addOption('runner', null, InputOption::VALUE_REQUIRED, 'Runner or WrapperRunner. <comment>(default: Runner)</comment>')
39	8	->addOption('bootstrap', null, InputOption::VALUE_REQUIRED, 'The bootstrap file to be used by PHPUnit.')
40	8	->addOption('configuration', 'c', InputOption::VALUE_REQUIRED, 'The PHPUnit configuration file to use.')
41	8	->addOption('group', 'g', InputOption::VALUE_REQUIRED, 'Only runs tests from the specified group(s).')
42	8	->addOption('exclude-group', null, InputOption::VALUE_REQUIRED, 'Don\'t run tests from the specified group(s).')
43	8	->addOption('stop-on-failure', null, InputOption::VALUE_NONE, 'Don\'t start any more processes after a failure.')
44	8	->addOption('log-junit', null, InputOption::VALUE_REQUIRED, 'Log test execution in JUnit XML format to file.')
45	8	->addOption('colors', null, InputOption::VALUE_NONE, 'Displays a colored bar as a test result.')
46	8	->addOption('testsuite', null, InputOption::VALUE_OPTIONAL, 'Filter which testsuite to run')
47	8	->addArgument('path', InputArgument::OPTIONAL, 'The path to a directory or file containing tests. <comment>(default: current directory)</comment>')
48	8	->addOption('path', null, InputOption::VALUE_REQUIRED, 'An alias for the path argument.');
49	8	$this->command = $command;
		0 ignored issues – show Documentation Bug introduced 2015-12-02 18:19 UTC by Report Bug Copy Issue Report `$command` is of type `object<Symfony\Component\Console\Command\Command>`, but the property `$command` was declared to be of type `object<ParaTest\Console\Commands\ParaTestCommand>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
50	8	}
51
52		/**
53		* Executes the PHPUnit Runner. Will Display help if no config and no path
54		* supplied
55		*
56		* @param InputInterface $input
57		* @param OutputInterface $output
58		* @return int\|mixed
59		*/
60		public function execute(InputInterface $input, OutputInterface $output)
61		{
62		if (!$this->hasConfig($input) && !$this->hasPath($input)) {
63		$this->displayHelp($input, $output);
64		}
65
66		if ($input->getOption('runner') === 'WrapperRunner') {
67		$runner = new WrapperRunner($this->getRunnerOptions($input));
68		} else {
69		if ($input->getOption('runner') !== '') {
70		// because we want to have to bootstrap script inherited before check/initialization
71		$runnerOption = $this->getRunnerOptions($input);
72		$runnerClass = $input->getOption('runner');
73		if (class_exists($runnerClass)) {
74		$runner = new $runnerClass($runnerOption);
75		}
76		}
77		}
78
79		if (!isset($runner)) {
80		$runner = new Runner($this->getRunnerOptions($input));
81		}
82
83		$runner->run();
84		return $runner->getExitCode();
85		}
86
87		/**
88		* Returns whether or not a test path has been supplied
89		* via option or regular input
90		*
91		* @param InputInterface $input
92		* @return bool
93		*/
94		protected function hasPath(InputInterface $input)
95		{
96		$argument = $input->getArgument('path');
97		$option = $input->getOption('path');
98		return $argument \|\| $option;
99		}
100
101		/**
102		* Is there a PHPUnit xml configuration present
103		*
104		* @param InputInterface $input
105		* @return bool
106		*/
107	4	protected function hasConfig(InputInterface $input)
108		{
109	4	return (false !== $this->getConfig($input));
110		}
111
112		/**
113		* @param \Symfony\Component\Console\Input\InputInterface $input
114		* @return \ParaTest\Runners\PHPUnit\Configuration\|boolean
115		*/
116	4	protected function getConfig(InputInterface $input)
117		{
118	4	$cwd = getcwd() . DIRECTORY_SEPARATOR;
119
120	4	if ($input->getOption('configuration')) {
121		$configFilename = $input->getOption('configuration');
122	4	} elseif (file_exists($cwd . 'phpunit.xml.dist')) {
123	4	$configFilename = $cwd . 'phpunit.xml.dist';
124	4	} elseif (file_exists($cwd . 'phpunit.xml')) {
125		$configFilename = $cwd . 'phpunit.xml';
126		} else {
127		return false;
128		}
129
130	4	return new Configuration($configFilename);
131		}
132
133		/**
134		* @param \Symfony\Component\Console\Input\InputInterface $input
135		* @return array
136		* @throws \RuntimeException
137		*/
138	4	public function getRunnerOptions(InputInterface $input)
139		{
140	4	$path = $input->getArgument('path');
141	4	$options = $this->getOptions($input);
142	4	$bootstrap = $this->getBootstrapFile($input, $options);
143	4	$this->requireBootstrap($bootstrap);
144
145	4	if ($this->hasCoverage($options)) {
146	2	$options['coverage-php'] = sys_get_temp_dir() . '/will_be_overwritten.php';
147	2	}
148
149	4	if ($path) {
150	4	$options = array_merge(array('path' => $path), $options);
151	4	}
152
153	4	return $options;
154		}
155
156		/**
157		* Require the bootstrap. If the file is specified, but does not exist
158		* then an exception will be raised.
159		*
160		* @param $file
161		* @throws \RuntimeException
162		*/
163	5	public function requireBootstrap($file)
164		{
165	5	if (! $file) {
166		return;
167		}
168
169	5	if (! file_exists($file)) {
170		$message = sprintf('Bootstrap specified but could not be found (%s)', $file);
171		throw new \RuntimeException($message);
172		}
173
174	5	$this->scopedRequire($file);
175	5	}
176
177		/**
178		* This function limits the scope of a required file
179		* so that variables defined in it do not break
180		* this object's configuration.
181		*/
182	5	protected function scopedRequire($file)
183		{
184	5	$cwd = getcwd();
185	5	require_once $file;
186	5	chdir($cwd);
187	5	}
188
189		/**
190		* Return whether or not code coverage information should be collected.
191		*
192		* @param $options
193		* @return bool
194		*/
195	4	protected function hasCoverage($options)
196		{
197	4	$isFileFormat = isset($options['coverage-html']) \|\| isset($options['coverage-clover']);
198	4	$isPHP = isset($options['coverage-php']);
199	4	return $isFileFormat && ! $isPHP;
200		}
201
202		/**
203		* Fetch the path to the bootstrap file.
204		*
205		* @param InputInterface $input
206		* @param array $options
207		* @return string
208		*/
209	4	protected function getBootstrapFile(InputInterface $input, array $options)
210		{
211	4	if (isset($options['bootstrap'])) {
212		return $options['bootstrap'];
213		}
214
215	4	if (! $this->hasConfig($input)) {
216		return '';
217		}
218
219	4	$config = $this->getConfig($input);
220	4	$bootstrap = $config->getBootstrap();
221
222	4	return ($bootstrap) ? $config->getConfigDir() . $bootstrap : '';
223		}
224		}
225

brianium / paratest

Pull Request — master (#203)

PHPUnit::getRunnerOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like