SuiteLoader::methodDataProvider() - Code Metrics - Inspection of "Change unit test assertion depending on the versio..." - brianium/paratest - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#204)

unknown

created 2016-05-08 17:11 UTC

SuiteLoader::methodDataProvider() A

↳ Parent: SuiteLoader

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2.0625

Importance

Changes	2
Bugs	2	Features	0

Metric	Value
c	2
b	2
f	0
dl	0
loc	7
ccs	3
cts	4
cp	0.75
rs	9.4285
cc	2
eloc	4
nc	2
nop	1
crap	2.0625

<?php
namespace ParaTest\Runners\PHPUnit;

use ParaTest\Parser\NoClassInFileException;
use ParaTest\Parser\ParsedClass;
use ParaTest\Parser\ParsedObject;
use ParaTest\Parser\Parser;

class SuiteLoader
{
    /**
     * The collection of loaded files
     *
     * @var array
     */
    protected $files = array();

    /**
     * The collection of parsed test classes
     *
     * @var array
     */
    protected $loadedSuites = array();

    public function __construct($options = null)
    {
        if ($options && !$options instanceof Options) {
            throw new \InvalidArgumentException("SuiteLoader options must be null or of type Options");
        }

        $this->options = $options;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * Returns all parsed suite objects as ExecutableTest
     * instances
     *
     * @return array
     */
    public function getSuites()
    {
        return $this->loadedSuites;
    }

    /**
     * Returns a collection of TestMethod objects
     * for all loaded ExecutableTest instances
     *
     * @return array
     */
    public function getTestMethods()
    {
        $methods = array();
        foreach ($this->loadedSuites as $suite) {
            $methods = array_merge($methods, $suite->getFunctions());
        }

        return $methods;
    }

    /**
     * Populates the loaded suite collection. Will load suites
     * based off a phpunit xml configuration or a specified path
     *
     * @param string $path
     * @throws \RuntimeException
     */
    public function load($path = '')
    {
        if (is_object($this->options) && isset($this->options->filtered['configuration'])) {
            $configuration = $this->options->filtered['configuration'];
        } else {
            $configuration = new Configuration('');
        }

        if ($path) {
            $testFileLoader = new TestFileLoader($this->options);
            $this->files = array_merge($this->files, $testFileLoader->loadPath($path));
        } elseif (isset($this->options->testsuite) && $this->options->testsuite) {
            foreach ($configuration->getSuiteByName($this->options->testsuite) as $suite) {
                foreach ($suite as $suitePath) {
                    $testFileLoader = new TestFileLoader($this->options);
                    $this->files = array_merge($this->files, $testFileLoader->loadSuitePath($suitePath));
                }
            }
        } elseif ($suites = $configuration->getSuites()) {
            foreach ($suites as $suite) {
                foreach ($suite as $suitePath) {
                    $testFileLoader = new TestFileLoader($this->options);
                    $this->files = array_merge($this->files, $testFileLoader->loadSuitePath($suitePath));
                }
            }
        }


        if (!$this->files) {

            throw new \RuntimeException("No path or configuration provided (tests must end with Test.php)");
        }

        $this->files = array_unique($this->files); // remove duplicates

        $this->initSuites();
    }


    /**
     * Called after all files are loaded. Parses loaded files into
     * ExecutableTest objects - either Suite or TestMethod
     */
    private function initSuites()
    {
        foreach ($this->files as $path) {
            try {
                $parser = new Parser($path);
                if ($class = $parser->getClass()) {
                    $this->loadedSuites[$path] = $this->createSuite($path, $class);
                }
            } catch (NoClassInFileException $e) {
                continue;
            }
        }
    }

    private function executableTests($path, $class)
    {
        $executableTests = array();
        $methodBatches = $this->getMethodBatches($class);
        foreach ($methodBatches as $methodBatch) {
            $executableTest = new TestMethod($path, $methodBatch);
            $executableTests[] = $executableTest;
        }
        return $executableTests;
    }

    /**
     * Get method batches.
     *
     * Identify method dependencies, and group dependents and dependees on a single methodBatch.
     * Use max batch size to fill batches.
     *
     * @param  ParsedClass $class
     * @return array of MethodBatches. Each MethodBatch has an array of method names
     */
    private function getMethodBatches($class)
    {
        $classMethods = $class->getMethods($this->options ? $this->options->annotations : array());
        $maxBatchSize = $this->options && $this->options->functional ? $this->options->maxBatchSize : 0;
        $batches = array();
        foreach ($classMethods as $method) {
            $tests = $this->getMethodTests($class, $method, $maxBatchSize != 0);
            // if filter passed to paratest then method tests can be blank if not match to filter
            if (!$tests) {

                continue;
            }

            if (($dependsOn = $this->methodDependency($method)) != null) {

                $this->addDependentTestsToBatchSet($batches, $dependsOn, $tests);
            } else {
                $this->addTestsToBatchSet($batches, $tests, $maxBatchSize);
            }
        }
        return $batches;
    }

    private function addDependentTestsToBatchSet(&$batches, $dependsOn, $tests)
    {
        foreach ($batches as $key => $batch) {
            foreach ($batch as $methodName) {
                if ($dependsOn === $methodName) {
                    $batches[$key] = array_merge($batches[$key], $tests);
                    continue;
                }
            }
        }
    }

    private function addTestsToBatchSet(&$batches, $tests, $maxBatchSize)
    {
        foreach ($tests as $test) {
            $lastIndex = count($batches) - 1;
            if ($lastIndex != -1
                && count($batches[$lastIndex]) < $maxBatchSize
            ) {
                $batches[$lastIndex][] = $test;
            } else {
                $batches[] = array($test);
            }
        }
    }

    /**
     * Get method all available tests.
     *
     * With empty filter this method returns single test if doesnt' have data provider or
     * data provider is not used and return all test if has data provider and data provider is used.
     *
     * @param  ParsedClass  $class            Parsed class.
     * @param  ParsedObject $method           Parsed method.
     * @param  bool         $useDataProvider  Try to use data provider or not.
     * @return string[]     Array of test names.
     */
    private function getMethodTests($class, $method, $useDataProvider = false)
    {
        $result = array();

        $groups = $this->methodGroups($method);

        $dataProvider = $this->methodDataProvider($method);
        if ($useDataProvider && isset($dataProvider)) {
            $testFullClassName = "\\" . $class->getName();
            $testClass = new $testFullClassName();
            $result = array();
            $datasetKeys = array_keys($testClass->$dataProvider());
            foreach ($datasetKeys as $key) {
                $test = sprintf(
                    "%s with data set %s",
                    $method->getName(),
                    is_int($key) ? "#" . $key : "\"" . $key . "\""
                );
                if ($this->testMatchOptions($class->getName(), $test, $groups)) {
                    $result[] = $test;
                }
            }
        } elseif ($this->testMatchOptions($class->getName(), $method->getName(), $groups)) {
            $result = array($method->getName());
        }

        return $result;
    }

    private function testMatchGroupOptions($groups)
    {
        if (empty($groups)) {
            return true;
        }

        if (!empty($this->options->groups)
            && !array_intersect($groups, $this->options->groups)
        ) {
            return false;
        }

        if (!empty($this->options->excludeGroups)
            && array_intersect($groups, $this->options->excludeGroups)
        ) {
            return false;
        }

        return true;
    }

    private function testMatchFilterOptions($className, $name, $group)

    {
        if (empty($this->options->filter)) {
            return true;
        }

        $re = substr($this->options->filter, 0, 1) == "/"
            ? $this->options->filter
            : "/" . $this->options->filter . "/";
        $fullName = $className . "::" . $name;
        $result = preg_match($re, $fullName);

        return $result;
    }

    private function testMatchOptions($className, $name, $group)
    {
        $result = $this->testMatchGroupOptions($group)
                && $this->testMatchFilterOptions($className, $name, $group);

        return $result;
    }

    private function methodDataProvider($method)
    {
        if (preg_match("/@\bdataProvider\b \b(.*)\b/", $method->getDocBlock(), $matches)) {
            return $matches[1];
        }
        return null;
    }

    private function methodDependency($method)
    {
        if (preg_match("/@\bdepends\b \b(.*)\b/", $method->getDocBlock(), $matches)) {
            return $matches[1];
        }
        return null;
    }

    private function methodGroups($method)
    {
        if (preg_match_all("/@\bgroup\b \b(.*)\b/", $method->getDocBlock(), $matches)) {
            return $matches[1];
        }
        return array();
    }

    private function createSuite($path, ParsedClass $class)
    {
        return new Suite(
            $path,
            $this->executableTests(
                $path,
                $class
            ),
            $class->getName()
        );
    }
}


1		<?php
2		namespace ParaTest\Runners\PHPUnit;
3
4		use ParaTest\Parser\NoClassInFileException;
5		use ParaTest\Parser\ParsedClass;
6		use ParaTest\Parser\ParsedObject;
7		use ParaTest\Parser\Parser;
8
9		class SuiteLoader
10		{
11		/**
12		* The collection of loaded files
13		*
14		* @var array
15		*/
16		protected $files = array();
17
18		/**
19		* The collection of parsed test classes
20		*
21		* @var array
22		*/
23		protected $loadedSuites = array();
24
25	26	public function __construct($options = null)
26		{
27	26	if ($options && !$options instanceof Options) {
28	1	throw new \InvalidArgumentException("SuiteLoader options must be null or of type Options");
29		}
30
31	25	$this->options = $options;
		0 ignored issues – show Bug introduced 2015-12-02 18:19 UTC by Report Bug Copy Issue Report The property `options` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
32	25	}
33
34		/**
35		* Returns all parsed suite objects as ExecutableTest
36		* instances
37		*
38		* @return array
39		*/
40	2	public function getSuites()
41		{
42	2	return $this->loadedSuites;
43		}
44
45		/**
46		* Returns a collection of TestMethod objects
47		* for all loaded ExecutableTest instances
48		*
49		* @return array
50		*/
51	2	public function getTestMethods()
52		{
53	2	$methods = array();
54	2	foreach ($this->loadedSuites as $suite) {
55	2	$methods = array_merge($methods, $suite->getFunctions());
56	2	}
57
58	2	return $methods;
59		}
60
61		/**
62		* Populates the loaded suite collection. Will load suites
63		* based off a phpunit xml configuration or a specified path
64		*
65		* @param string $path
66		* @throws \RuntimeException
67		*/
68	23	public function load($path = '')
69		{
70	23	if (is_object($this->options) && isset($this->options->filtered['configuration'])) {
71	16	$configuration = $this->options->filtered['configuration'];
72	16	} else {
73	7	$configuration = new Configuration('');
74		}
75
76	23	if ($path) {
77	9	$testFileLoader = new TestFileLoader($this->options);
78	9	$this->files = array_merge($this->files, $testFileLoader->loadPath($path));
79	22	} elseif (isset($this->options->testsuite) && $this->options->testsuite) {
80	10	foreach ($configuration->getSuiteByName($this->options->testsuite) as $suite) {
81	10	foreach ($suite as $suitePath) {
82	10	$testFileLoader = new TestFileLoader($this->options);
83	10	$this->files = array_merge($this->files, $testFileLoader->loadSuitePath($suitePath));
84	10	}
85	13	}
86	14	} elseif ($suites = $configuration->getSuites()) {
87	2	foreach ($suites as $suite) {
88	2	foreach ($suite as $suitePath) {
89	2	$testFileLoader = new TestFileLoader($this->options);
90	2	$this->files = array_merge($this->files, $testFileLoader->loadSuitePath($suitePath));
91	2	}
92	2	}
93	2	}
94
95
96	21	if (!$this->files) {
		0 ignored issues – show Bug Best Practice introduced 2015-12-02 18:19 UTC by Report Bug Copy Issue Report The expression `$this->files` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
97	1	throw new \RuntimeException("No path or configuration provided (tests must end with Test.php)");
98		}
99
100	20	$this->files = array_unique($this->files); // remove duplicates
101
102	20	$this->initSuites();
103	20	}
104
105
106		/**
107		* Called after all files are loaded. Parses loaded files into
108		* ExecutableTest objects - either Suite or TestMethod
109		*/
110	20	private function initSuites()
111		{
112	20	foreach ($this->files as $path) {
113		try {
114	20	$parser = new Parser($path);
115	19	if ($class = $parser->getClass()) {
116	19	$this->loadedSuites[$path] = $this->createSuite($path, $class);
117	19	}
118	20	} catch (NoClassInFileException $e) {
119	8	continue;
120		}
121	20	}
122	20	}
123
124	19	private function executableTests($path, $class)
125		{
126	19	$executableTests = array();
127	19	$methodBatches = $this->getMethodBatches($class);
128	19	foreach ($methodBatches as $methodBatch) {
129	19	$executableTest = new TestMethod($path, $methodBatch);
130	19	$executableTests[] = $executableTest;
131	19	}
132	19	return $executableTests;
133		}
134
135		/**
136		* Get method batches.
137		*
138		* Identify method dependencies, and group dependents and dependees on a single methodBatch.
139		* Use max batch size to fill batches.
140		*
141		* @param ParsedClass $class
142		* @return array of MethodBatches. Each MethodBatch has an array of method names
143		*/
144	19	private function getMethodBatches($class)
145		{
146	19	$classMethods = $class->getMethods($this->options ? $this->options->annotations : array());
147	19	$maxBatchSize = $this->options && $this->options->functional ? $this->options->maxBatchSize : 0;
148	19	$batches = array();
149	19	foreach ($classMethods as $method) {
150	19	$tests = $this->getMethodTests($class, $method, $maxBatchSize != 0);
151		// if filter passed to paratest then method tests can be blank if not match to filter
152	19	if (!$tests) {
		0 ignored issues – show Bug Best Practice introduced 2015-12-02 18:19 UTC by Report Bug Copy Issue Report The expression `$tests` of type `string[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
153		continue;
154		}
155
156	19	if (($dependsOn = $this->methodDependency($method)) != null) {
		0 ignored issues – show Bug introduced 2015-12-02 18:19 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$dependsOn = $this->methodDependency($method)` of type `string\|null` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `!==` instead. Loading history...
157	1	$this->addDependentTestsToBatchSet($batches, $dependsOn, $tests);
158	1	} else {
159	19	$this->addTestsToBatchSet($batches, $tests, $maxBatchSize);
160		}
161	19	}
162	19	return $batches;
163		}
164
165	1	private function addDependentTestsToBatchSet(&$batches, $dependsOn, $tests)
166		{
167	1	foreach ($batches as $key => $batch) {
168	1	foreach ($batch as $methodName) {
169	1	if ($dependsOn === $methodName) {
170	1	$batches[$key] = array_merge($batches[$key], $tests);
171	1	continue;
172		}
173	1	}
174	1	}
175	1	}
176
177	19	private function addTestsToBatchSet(&$batches, $tests, $maxBatchSize)
178		{
179	19	foreach ($tests as $test) {
180	19	$lastIndex = count($batches) - 1;
181		if ($lastIndex != -1
182	19	&& count($batches[$lastIndex]) < $maxBatchSize
183	19	) {
184		$batches[$lastIndex][] = $test;
185		} else {
186	19	$batches[] = array($test);
187		}
188	19	}
189	19	}
190
191		/**
192		* Get method all available tests.
193		*
194		* With empty filter this method returns single test if doesnt' have data provider or
195		* data provider is not used and return all test if has data provider and data provider is used.
196		*
197		* @param ParsedClass $class Parsed class.
198		* @param ParsedObject $method Parsed method.
199		* @param bool $useDataProvider Try to use data provider or not.
200		* @return string[] Array of test names.
201		*/
202	19	private function getMethodTests($class, $method, $useDataProvider = false)
203		{
204	19	$result = array();
205
206	19	$groups = $this->methodGroups($method);
207
208	19	$dataProvider = $this->methodDataProvider($method);
209	19	if ($useDataProvider && isset($dataProvider)) {
210		$testFullClassName = "\\" . $class->getName();
211		$testClass = new $testFullClassName();
212		$result = array();
213		$datasetKeys = array_keys($testClass->$dataProvider());
214		foreach ($datasetKeys as $key) {
215		$test = sprintf(
216		"%s with data set %s",
217		$method->getName(),
218		is_int($key) ? "#" . $key : "\"" . $key . "\""
219		);
220		if ($this->testMatchOptions($class->getName(), $test, $groups)) {
221		$result[] = $test;
222		}
223		}
224	19	} elseif ($this->testMatchOptions($class->getName(), $method->getName(), $groups)) {
225	19	$result = array($method->getName());
226	19	}
227
228	19	return $result;
229		}
230
231	19	private function testMatchGroupOptions($groups)
232		{
233	19	if (empty($groups)) {
234	17	return true;
235		}
236
237	15	if (!empty($this->options->groups)
238	15	&& !array_intersect($groups, $this->options->groups)
239	15	) {
240		return false;
241		}
242
243	15	if (!empty($this->options->excludeGroups)
244	15	&& array_intersect($groups, $this->options->excludeGroups)
245	15	) {
246		return false;
247		}
248
249	15	return true;
250		}
251
252	19	private function testMatchFilterOptions($className, $name, $group)
		0 ignored issues – show Unused Code introduced 2015-12-02 18:19 UTC by Report Bug Copy Issue Report The parameter `$group` 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...
253		{
254	19	if (empty($this->options->filter)) {
255	19	return true;
256		}
257
258		$re = substr($this->options->filter, 0, 1) == "/"
259		? $this->options->filter
260		: "/" . $this->options->filter . "/";
261		$fullName = $className . "::" . $name;
262		$result = preg_match($re, $fullName);
263
264		return $result;
265		}
266
267	19	private function testMatchOptions($className, $name, $group)
268		{
269	19	$result = $this->testMatchGroupOptions($group)
270	19	&& $this->testMatchFilterOptions($className, $name, $group);
271
272	19	return $result;
273		}
274
275	19	private function methodDataProvider($method)
276		{
277	19	if (preg_match("/@\bdataProvider\b \b(.*)\b/", $method->getDocBlock(), $matches)) {
278		return $matches[1];
279		}
280	19	return null;
281		}
282
283	19	private function methodDependency($method)
284		{
285	19	if (preg_match("/@\bdepends\b \b(.*)\b/", $method->getDocBlock(), $matches)) {
286	1	return $matches[1];
287		}
288	19	return null;
289		}
290
291	19	private function methodGroups($method)
292		{
293	19	if (preg_match_all("/@\bgroup\b \b(.*)\b/", $method->getDocBlock(), $matches)) {
294	15	return $matches[1];
295		}
296	17	return array();
297		}
298
299	19	private function createSuite($path, ParsedClass $class)
300		{
301	19	return new Suite(
302	19	$path,
303	19	$this->executableTests(
304	19	$path,
305		$class
306	19	),
307	19	$class->getName()
308	19	);
309		}
310		}
311

brianium / paratest

Pull Request — master (#204)

SuiteLoader::methodDataProvider() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like