1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159 |
- <?php
- /*
- * This file is part of the php-code-coverage package.
- *
- * (c) Sebastian Bergmann <sebastian@phpunit.de>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace SebastianBergmann\CodeCoverage;
- use PHPUnit\Framework\TestCase;
- use PHPUnit\Runner\PhptTestCase;
- use SebastianBergmann\CodeCoverage\Driver\Driver;
- use SebastianBergmann\CodeCoverage\Driver\Xdebug;
- use SebastianBergmann\CodeCoverage\Driver\HHVM;
- use SebastianBergmann\CodeCoverage\Driver\PHPDBG;
- use SebastianBergmann\CodeCoverage\Node\Builder;
- use SebastianBergmann\CodeCoverage\Node\Directory;
- use SebastianBergmann\CodeUnitReverseLookup\Wizard;
- use SebastianBergmann\Environment\Runtime;
- /**
- * Provides collection functionality for PHP code coverage information.
- */
- class CodeCoverage
- {
- /**
- * @var Driver
- */
- private $driver;
- /**
- * @var Filter
- */
- private $filter;
- /**
- * @var Wizard
- */
- private $wizard;
- /**
- * @var bool
- */
- private $cacheTokens = false;
- /**
- * @var bool
- */
- private $checkForUnintentionallyCoveredCode = false;
- /**
- * @var bool
- */
- private $forceCoversAnnotation = false;
- /**
- * @var bool
- */
- private $checkForUnexecutedCoveredCode = false;
- /**
- * @var bool
- */
- private $checkForMissingCoversAnnotation = false;
- /**
- * @var bool
- */
- private $addUncoveredFilesFromWhitelist = true;
- /**
- * @var bool
- */
- private $processUncoveredFilesFromWhitelist = false;
- /**
- * @var bool
- */
- private $ignoreDeprecatedCode = false;
- /**
- * @var mixed
- */
- private $currentId;
- /**
- * Code coverage data.
- *
- * @var array
- */
- private $data = [];
- /**
- * @var array
- */
- private $ignoredLines = [];
- /**
- * @var bool
- */
- private $disableIgnoredLines = false;
- /**
- * Test data.
- *
- * @var array
- */
- private $tests = [];
- /**
- * @var string[]
- */
- private $unintentionallyCoveredSubclassesWhitelist = [];
- /**
- * Determine if the data has been initialized or not
- *
- * @var bool
- */
- private $isInitialized = false;
- /**
- * Determine whether we need to check for dead and unused code on each test
- *
- * @var bool
- */
- private $shouldCheckForDeadAndUnused = true;
- /**
- * @var Directory
- */
- private $report;
- /**
- * Constructor.
- *
- * @param Driver $driver
- * @param Filter $filter
- *
- * @throws RuntimeException
- */
- public function __construct(Driver $driver = null, Filter $filter = null)
- {
- if ($driver === null) {
- $driver = $this->selectDriver();
- }
- if ($filter === null) {
- $filter = new Filter;
- }
- $this->driver = $driver;
- $this->filter = $filter;
- $this->wizard = new Wizard;
- }
- /**
- * Returns the code coverage information as a graph of node objects.
- *
- * @return Directory
- */
- public function getReport()
- {
- if ($this->report === null) {
- $builder = new Builder;
- $this->report = $builder->build($this);
- }
- return $this->report;
- }
- /**
- * Clears collected code coverage data.
- */
- public function clear()
- {
- $this->isInitialized = false;
- $this->currentId = null;
- $this->data = [];
- $this->tests = [];
- $this->report = null;
- }
- /**
- * Returns the filter object used.
- *
- * @return Filter
- */
- public function filter()
- {
- return $this->filter;
- }
- /**
- * Returns the collected code coverage data.
- * Set $raw = true to bypass all filters.
- *
- * @param bool $raw
- *
- * @return array
- */
- public function getData($raw = false)
- {
- if (!$raw && $this->addUncoveredFilesFromWhitelist) {
- $this->addUncoveredFilesFromWhitelist();
- }
- return $this->data;
- }
- /**
- * Sets the coverage data.
- *
- * @param array $data
- */
- public function setData(array $data)
- {
- $this->data = $data;
- $this->report = null;
- }
- /**
- * Returns the test data.
- *
- * @return array
- */
- public function getTests()
- {
- return $this->tests;
- }
- /**
- * Sets the test data.
- *
- * @param array $tests
- */
- public function setTests(array $tests)
- {
- $this->tests = $tests;
- }
- /**
- * Start collection of code coverage information.
- *
- * @param mixed $id
- * @param bool $clear
- *
- * @throws InvalidArgumentException
- */
- public function start($id, $clear = false)
- {
- if (!is_bool($clear)) {
- throw InvalidArgumentException::create(
- 1,
- 'boolean'
- );
- }
- if ($clear) {
- $this->clear();
- }
- if ($this->isInitialized === false) {
- $this->initializeData();
- }
- $this->currentId = $id;
- $this->driver->start($this->shouldCheckForDeadAndUnused);
- }
- /**
- * Stop collection of code coverage information.
- *
- * @param bool $append
- * @param mixed $linesToBeCovered
- * @param array $linesToBeUsed
- *
- * @return array
- *
- * @throws InvalidArgumentException
- */
- public function stop($append = true, $linesToBeCovered = [], array $linesToBeUsed = [])
- {
- if (!is_bool($append)) {
- throw InvalidArgumentException::create(
- 1,
- 'boolean'
- );
- }
- if (!is_array($linesToBeCovered) && $linesToBeCovered !== false) {
- throw InvalidArgumentException::create(
- 2,
- 'array or false'
- );
- }
- $data = $this->driver->stop();
- $this->append($data, null, $append, $linesToBeCovered, $linesToBeUsed);
- $this->currentId = null;
- return $data;
- }
- /**
- * Appends code coverage data.
- *
- * @param array $data
- * @param mixed $id
- * @param bool $append
- * @param mixed $linesToBeCovered
- * @param array $linesToBeUsed
- *
- * @throws RuntimeException
- */
- public function append(array $data, $id = null, $append = true, $linesToBeCovered = [], array $linesToBeUsed = [])
- {
- if ($id === null) {
- $id = $this->currentId;
- }
- if ($id === null) {
- throw new RuntimeException;
- }
- $this->applyListsFilter($data);
- $this->applyIgnoredLinesFilter($data);
- $this->initializeFilesThatAreSeenTheFirstTime($data);
- if (!$append) {
- return;
- }
- if ($id != 'UNCOVERED_FILES_FROM_WHITELIST') {
- $this->applyCoversAnnotationFilter(
- $data,
- $linesToBeCovered,
- $linesToBeUsed
- );
- }
- if (empty($data)) {
- return;
- }
- $size = 'unknown';
- $status = null;
- if ($id instanceof TestCase) {
- $_size = $id->getSize();
- if ($_size == \PHPUnit\Util\Test::SMALL) {
- $size = 'small';
- } elseif ($_size == \PHPUnit\Util\Test::MEDIUM) {
- $size = 'medium';
- } elseif ($_size == \PHPUnit\Util\Test::LARGE) {
- $size = 'large';
- }
- $status = $id->getStatus();
- $id = get_class($id) . '::' . $id->getName();
- } elseif ($id instanceof PhptTestCase) {
- $size = 'large';
- $id = $id->getName();
- }
- $this->tests[$id] = ['size' => $size, 'status' => $status];
- foreach ($data as $file => $lines) {
- if (!$this->filter->isFile($file)) {
- continue;
- }
- foreach ($lines as $k => $v) {
- if ($v == Driver::LINE_EXECUTED) {
- if (empty($this->data[$file][$k]) || !in_array($id, $this->data[$file][$k])) {
- $this->data[$file][$k][] = $id;
- }
- }
- }
- }
- $this->report = null;
- }
- /**
- * Merges the data from another instance.
- *
- * @param CodeCoverage $that
- */
- public function merge(CodeCoverage $that)
- {
- $this->filter->setWhitelistedFiles(
- array_merge($this->filter->getWhitelistedFiles(), $that->filter()->getWhitelistedFiles())
- );
- foreach ($that->data as $file => $lines) {
- if (!isset($this->data[$file])) {
- if (!$this->filter->isFiltered($file)) {
- $this->data[$file] = $lines;
- }
- continue;
- }
- foreach ($lines as $line => $data) {
- if ($data !== null) {
- if (!isset($this->data[$file][$line])) {
- $this->data[$file][$line] = $data;
- } else {
- $this->data[$file][$line] = array_unique(
- array_merge($this->data[$file][$line], $data)
- );
- }
- }
- }
- }
- $this->tests = array_merge($this->tests, $that->getTests());
- $this->report = null;
- }
- /**
- * @param bool $flag
- *
- * @throws InvalidArgumentException
- */
- public function setCacheTokens($flag)
- {
- if (!is_bool($flag)) {
- throw InvalidArgumentException::create(
- 1,
- 'boolean'
- );
- }
- $this->cacheTokens = $flag;
- }
- /**
- * @return bool
- */
- public function getCacheTokens()
- {
- return $this->cacheTokens;
- }
- /**
- * @param bool $flag
- *
- * @throws InvalidArgumentException
- */
- public function setCheckForUnintentionallyCoveredCode($flag)
- {
- if (!is_bool($flag)) {
- throw InvalidArgumentException::create(
- 1,
- 'boolean'
- );
- }
- $this->checkForUnintentionallyCoveredCode = $flag;
- }
- /**
- * @param bool $flag
- *
- * @throws InvalidArgumentException
- */
- public function setForceCoversAnnotation($flag)
- {
- if (!is_bool($flag)) {
- throw InvalidArgumentException::create(
- 1,
- 'boolean'
- );
- }
- $this->forceCoversAnnotation = $flag;
- }
- /**
- * @param bool $flag
- *
- * @throws InvalidArgumentException
- */
- public function setCheckForMissingCoversAnnotation($flag)
- {
- if (!is_bool($flag)) {
- throw InvalidArgumentException::create(
- 1,
- 'boolean'
- );
- }
- $this->checkForMissingCoversAnnotation = $flag;
- }
- /**
- * @param bool $flag
- *
- * @throws InvalidArgumentException
- */
- public function setCheckForUnexecutedCoveredCode($flag)
- {
- if (!is_bool($flag)) {
- throw InvalidArgumentException::create(
- 1,
- 'boolean'
- );
- }
- $this->checkForUnexecutedCoveredCode = $flag;
- }
- /**
- * @deprecated
- *
- * @param bool $flag
- *
- * @throws InvalidArgumentException
- */
- public function setMapTestClassNameToCoveredClassName($flag)
- {
- }
- /**
- * @param bool $flag
- *
- * @throws InvalidArgumentException
- */
- public function setAddUncoveredFilesFromWhitelist($flag)
- {
- if (!is_bool($flag)) {
- throw InvalidArgumentException::create(
- 1,
- 'boolean'
- );
- }
- $this->addUncoveredFilesFromWhitelist = $flag;
- }
- /**
- * @param bool $flag
- *
- * @throws InvalidArgumentException
- */
- public function setProcessUncoveredFilesFromWhitelist($flag)
- {
- if (!is_bool($flag)) {
- throw InvalidArgumentException::create(
- 1,
- 'boolean'
- );
- }
- $this->processUncoveredFilesFromWhitelist = $flag;
- }
- /**
- * @param bool $flag
- *
- * @throws InvalidArgumentException
- */
- public function setDisableIgnoredLines($flag)
- {
- if (!is_bool($flag)) {
- throw InvalidArgumentException::create(
- 1,
- 'boolean'
- );
- }
- $this->disableIgnoredLines = $flag;
- }
- /**
- * @param bool $flag
- *
- * @throws InvalidArgumentException
- */
- public function setIgnoreDeprecatedCode($flag)
- {
- if (!is_bool($flag)) {
- throw InvalidArgumentException::create(
- 1,
- 'boolean'
- );
- }
- $this->ignoreDeprecatedCode = $flag;
- }
- /**
- * @param array $whitelist
- */
- public function setUnintentionallyCoveredSubclassesWhitelist(array $whitelist)
- {
- $this->unintentionallyCoveredSubclassesWhitelist = $whitelist;
- }
- /**
- * Applies the @covers annotation filtering.
- *
- * @param array $data
- * @param mixed $linesToBeCovered
- * @param array $linesToBeUsed
- *
- * @throws MissingCoversAnnotationException
- * @throws UnintentionallyCoveredCodeException
- */
- private function applyCoversAnnotationFilter(array &$data, $linesToBeCovered, array $linesToBeUsed)
- {
- if ($linesToBeCovered === false ||
- ($this->forceCoversAnnotation && empty($linesToBeCovered))) {
- if ($this->checkForMissingCoversAnnotation) {
- throw new MissingCoversAnnotationException;
- }
- $data = [];
- return;
- }
- if (empty($linesToBeCovered)) {
- return;
- }
- if ($this->checkForUnintentionallyCoveredCode &&
- (!$this->currentId instanceof TestCase ||
- (!$this->currentId->isMedium() && !$this->currentId->isLarge()))) {
- $this->performUnintentionallyCoveredCodeCheck(
- $data,
- $linesToBeCovered,
- $linesToBeUsed
- );
- }
- if ($this->checkForUnexecutedCoveredCode) {
- $this->performUnexecutedCoveredCodeCheck($data, $linesToBeCovered, $linesToBeUsed);
- }
- $data = array_intersect_key($data, $linesToBeCovered);
- foreach (array_keys($data) as $filename) {
- $_linesToBeCovered = array_flip($linesToBeCovered[$filename]);
- $data[$filename] = array_intersect_key(
- $data[$filename],
- $_linesToBeCovered
- );
- }
- }
- /**
- * Applies the whitelist filtering.
- *
- * @param array $data
- */
- private function applyListsFilter(array &$data)
- {
- foreach (array_keys($data) as $filename) {
- if ($this->filter->isFiltered($filename)) {
- unset($data[$filename]);
- }
- }
- }
- /**
- * Applies the "ignored lines" filtering.
- *
- * @param array $data
- */
- private function applyIgnoredLinesFilter(array &$data)
- {
- foreach (array_keys($data) as $filename) {
- if (!$this->filter->isFile($filename)) {
- continue;
- }
- foreach ($this->getLinesToBeIgnored($filename) as $line) {
- unset($data[$filename][$line]);
- }
- }
- }
- /**
- * @param array $data
- */
- private function initializeFilesThatAreSeenTheFirstTime(array $data)
- {
- foreach ($data as $file => $lines) {
- if ($this->filter->isFile($file) && !isset($this->data[$file])) {
- $this->data[$file] = [];
- foreach ($lines as $k => $v) {
- $this->data[$file][$k] = $v == -2 ? null : [];
- }
- }
- }
- }
- /**
- * Processes whitelisted files that are not covered.
- */
- private function addUncoveredFilesFromWhitelist()
- {
- $data = [];
- $uncoveredFiles = array_diff(
- $this->filter->getWhitelist(),
- array_keys($this->data)
- );
- foreach ($uncoveredFiles as $uncoveredFile) {
- if (!file_exists($uncoveredFile)) {
- continue;
- }
- if (!$this->processUncoveredFilesFromWhitelist) {
- $data[$uncoveredFile] = [];
- $lines = count(file($uncoveredFile));
- for ($i = 1; $i <= $lines; $i++) {
- $data[$uncoveredFile][$i] = Driver::LINE_NOT_EXECUTED;
- }
- }
- }
- $this->append($data, 'UNCOVERED_FILES_FROM_WHITELIST');
- }
- /**
- * Returns the lines of a source file that should be ignored.
- *
- * @param string $filename
- *
- * @return array
- *
- * @throws InvalidArgumentException
- */
- private function getLinesToBeIgnored($filename)
- {
- if (!is_string($filename)) {
- throw InvalidArgumentException::create(
- 1,
- 'string'
- );
- }
- if (!isset($this->ignoredLines[$filename])) {
- $this->ignoredLines[$filename] = [];
- if ($this->disableIgnoredLines) {
- return $this->ignoredLines[$filename];
- }
- $ignore = false;
- $stop = false;
- $lines = file($filename);
- $numLines = count($lines);
- foreach ($lines as $index => $line) {
- if (!trim($line)) {
- $this->ignoredLines[$filename][] = $index + 1;
- }
- }
- if ($this->cacheTokens) {
- $tokens = \PHP_Token_Stream_CachingFactory::get($filename);
- } else {
- $tokens = new \PHP_Token_Stream($filename);
- }
- $classes = array_merge($tokens->getClasses(), $tokens->getTraits());
- $tokens = $tokens->tokens();
- foreach ($tokens as $token) {
- switch (get_class($token)) {
- case \PHP_Token_COMMENT::class:
- case \PHP_Token_DOC_COMMENT::class:
- $_token = trim($token);
- $_line = trim($lines[$token->getLine() - 1]);
- if ($_token == '// @codeCoverageIgnore' ||
- $_token == '//@codeCoverageIgnore') {
- $ignore = true;
- $stop = true;
- } elseif ($_token == '// @codeCoverageIgnoreStart' ||
- $_token == '//@codeCoverageIgnoreStart') {
- $ignore = true;
- } elseif ($_token == '// @codeCoverageIgnoreEnd' ||
- $_token == '//@codeCoverageIgnoreEnd') {
- $stop = true;
- }
- if (!$ignore) {
- $start = $token->getLine();
- $end = $start + substr_count($token, "\n");
- // Do not ignore the first line when there is a token
- // before the comment
- if (0 !== strpos($_token, $_line)) {
- $start++;
- }
- for ($i = $start; $i < $end; $i++) {
- $this->ignoredLines[$filename][] = $i;
- }
- // A DOC_COMMENT token or a COMMENT token starting with "/*"
- // does not contain the final \n character in its text
- if (isset($lines[$i - 1]) && 0 === strpos($_token, '/*') && '*/' === substr(trim($lines[$i - 1]), -2)) {
- $this->ignoredLines[$filename][] = $i;
- }
- }
- break;
- case \PHP_Token_INTERFACE::class:
- case \PHP_Token_TRAIT::class:
- case \PHP_Token_CLASS::class:
- case \PHP_Token_FUNCTION::class:
- /* @var \PHP_Token_Interface $token */
- $docblock = $token->getDocblock();
- $this->ignoredLines[$filename][] = $token->getLine();
- if (strpos($docblock, '@codeCoverageIgnore') || ($this->ignoreDeprecatedCode && strpos($docblock, '@deprecated'))) {
- $endLine = $token->getEndLine();
- for ($i = $token->getLine(); $i <= $endLine; $i++) {
- $this->ignoredLines[$filename][] = $i;
- }
- } elseif ($token instanceof \PHP_Token_INTERFACE ||
- $token instanceof \PHP_Token_TRAIT ||
- $token instanceof \PHP_Token_CLASS) {
- if (empty($classes[$token->getName()]['methods'])) {
- for ($i = $token->getLine();
- $i <= $token->getEndLine();
- $i++) {
- $this->ignoredLines[$filename][] = $i;
- }
- } else {
- $firstMethod = array_shift(
- $classes[$token->getName()]['methods']
- );
- do {
- $lastMethod = array_pop(
- $classes[$token->getName()]['methods']
- );
- } while ($lastMethod !== null &&
- substr($lastMethod['signature'], 0, 18) == 'anonymous function');
- if ($lastMethod === null) {
- $lastMethod = $firstMethod;
- }
- for ($i = $token->getLine();
- $i < $firstMethod['startLine'];
- $i++) {
- $this->ignoredLines[$filename][] = $i;
- }
- for ($i = $token->getEndLine();
- $i > $lastMethod['endLine'];
- $i--) {
- $this->ignoredLines[$filename][] = $i;
- }
- }
- }
- break;
- case \PHP_Token_ENUM::class:
- $this->ignoredLines[$filename][] = $token->getLine();
- break;
- case \PHP_Token_NAMESPACE::class:
- $this->ignoredLines[$filename][] = $token->getEndLine();
- // Intentional fallthrough
- case \PHP_Token_DECLARE::class:
- case \PHP_Token_OPEN_TAG::class:
- case \PHP_Token_CLOSE_TAG::class:
- case \PHP_Token_USE::class:
- $this->ignoredLines[$filename][] = $token->getLine();
- break;
- }
- if ($ignore) {
- $this->ignoredLines[$filename][] = $token->getLine();
- if ($stop) {
- $ignore = false;
- $stop = false;
- }
- }
- }
- $this->ignoredLines[$filename][] = $numLines + 1;
- $this->ignoredLines[$filename] = array_unique(
- $this->ignoredLines[$filename]
- );
- sort($this->ignoredLines[$filename]);
- }
- return $this->ignoredLines[$filename];
- }
- /**
- * @param array $data
- * @param array $linesToBeCovered
- * @param array $linesToBeUsed
- *
- * @throws UnintentionallyCoveredCodeException
- */
- private function performUnintentionallyCoveredCodeCheck(array &$data, array $linesToBeCovered, array $linesToBeUsed)
- {
- $allowedLines = $this->getAllowedLines(
- $linesToBeCovered,
- $linesToBeUsed
- );
- $unintentionallyCoveredUnits = [];
- foreach ($data as $file => $_data) {
- foreach ($_data as $line => $flag) {
- if ($flag == 1 && !isset($allowedLines[$file][$line])) {
- $unintentionallyCoveredUnits[] = $this->wizard->lookup($file, $line);
- }
- }
- }
- $unintentionallyCoveredUnits = $this->processUnintentionallyCoveredUnits($unintentionallyCoveredUnits);
- if (!empty($unintentionallyCoveredUnits)) {
- throw new UnintentionallyCoveredCodeException(
- $unintentionallyCoveredUnits
- );
- }
- }
- /**
- * @param array $data
- * @param array $linesToBeCovered
- * @param array $linesToBeUsed
- *
- * @throws CoveredCodeNotExecutedException
- */
- private function performUnexecutedCoveredCodeCheck(array &$data, array $linesToBeCovered, array $linesToBeUsed)
- {
- $executedCodeUnits = $this->coverageToCodeUnits($data);
- $message = '';
- foreach ($this->linesToCodeUnits($linesToBeCovered) as $codeUnit) {
- if (!in_array($codeUnit, $executedCodeUnits)) {
- $message .= sprintf(
- '- %s is expected to be executed (@covers) but was not executed' . "\n",
- $codeUnit
- );
- }
- }
- foreach ($this->linesToCodeUnits($linesToBeUsed) as $codeUnit) {
- if (!in_array($codeUnit, $executedCodeUnits)) {
- $message .= sprintf(
- '- %s is expected to be executed (@uses) but was not executed' . "\n",
- $codeUnit
- );
- }
- }
- if (!empty($message)) {
- throw new CoveredCodeNotExecutedException($message);
- }
- }
- /**
- * @param array $linesToBeCovered
- * @param array $linesToBeUsed
- *
- * @return array
- */
- private function getAllowedLines(array $linesToBeCovered, array $linesToBeUsed)
- {
- $allowedLines = [];
- foreach (array_keys($linesToBeCovered) as $file) {
- if (!isset($allowedLines[$file])) {
- $allowedLines[$file] = [];
- }
- $allowedLines[$file] = array_merge(
- $allowedLines[$file],
- $linesToBeCovered[$file]
- );
- }
- foreach (array_keys($linesToBeUsed) as $file) {
- if (!isset($allowedLines[$file])) {
- $allowedLines[$file] = [];
- }
- $allowedLines[$file] = array_merge(
- $allowedLines[$file],
- $linesToBeUsed[$file]
- );
- }
- foreach (array_keys($allowedLines) as $file) {
- $allowedLines[$file] = array_flip(
- array_unique($allowedLines[$file])
- );
- }
- return $allowedLines;
- }
- /**
- * @return Driver
- *
- * @throws RuntimeException
- */
- private function selectDriver()
- {
- $runtime = new Runtime;
- if (!$runtime->canCollectCodeCoverage()) {
- throw new RuntimeException('No code coverage driver available');
- }
- if ($runtime->isHHVM()) {
- return new HHVM;
- } elseif ($runtime->isPHPDBG()) {
- return new PHPDBG;
- } else {
- return new Xdebug;
- }
- }
- /**
- * @param array $unintentionallyCoveredUnits
- *
- * @return array
- */
- private function processUnintentionallyCoveredUnits(array $unintentionallyCoveredUnits)
- {
- $unintentionallyCoveredUnits = array_unique($unintentionallyCoveredUnits);
- sort($unintentionallyCoveredUnits);
- foreach (array_keys($unintentionallyCoveredUnits) as $k => $v) {
- $unit = explode('::', $unintentionallyCoveredUnits[$k]);
- if (count($unit) != 2) {
- continue;
- }
- $class = new \ReflectionClass($unit[0]);
- foreach ($this->unintentionallyCoveredSubclassesWhitelist as $whitelisted) {
- if ($class->isSubclassOf($whitelisted)) {
- unset($unintentionallyCoveredUnits[$k]);
- break;
- }
- }
- }
- return array_values($unintentionallyCoveredUnits);
- }
- /**
- * If we are processing uncovered files from whitelist,
- * we can initialize the data before we start to speed up the tests
- */
- protected function initializeData()
- {
- $this->isInitialized = true;
- if ($this->processUncoveredFilesFromWhitelist) {
- $this->shouldCheckForDeadAndUnused = false;
- $this->driver->start(true);
- foreach ($this->filter->getWhitelist() as $file) {
- if ($this->filter->isFile($file)) {
- include_once($file);
- }
- }
- $data = [];
- $coverage = $this->driver->stop();
- foreach ($coverage as $file => $fileCoverage) {
- if ($this->filter->isFiltered($file)) {
- continue;
- }
- foreach (array_keys($fileCoverage) as $key) {
- if ($fileCoverage[$key] == Driver::LINE_EXECUTED) {
- $fileCoverage[$key] = Driver::LINE_NOT_EXECUTED;
- }
- }
- $data[$file] = $fileCoverage;
- }
- $this->append($data, 'UNCOVERED_FILES_FROM_WHITELIST');
- }
- }
- /**
- * @param array $data
- *
- * @return array
- */
- private function coverageToCodeUnits(array $data)
- {
- $codeUnits = [];
- foreach ($data as $filename => $lines) {
- foreach ($lines as $line => $flag) {
- if ($flag == 1) {
- $codeUnits[] = $this->wizard->lookup($filename, $line);
- }
- }
- }
- return array_unique($codeUnits);
- }
- /**
- * @param array $data
- *
- * @return array
- */
- private function linesToCodeUnits(array $data)
- {
- $codeUnits = [];
- foreach ($data as $filename => $lines) {
- foreach ($lines as $line) {
- $codeUnits[] = $this->wizard->lookup($filename, $line);
- }
- }
- return array_unique($codeUnits);
- }
- }
|