| Conditions | 87 |
| Paths | > 20000 |
| Total Lines | 498 |
| Code Lines | 280 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 182 | public function doRun(Test $suite, array $arguments = [], $exit = true) |
||
| 183 | { |
||
| 184 | if (isset($arguments['configuration'])) { |
||
| 185 | $GLOBALS['__PHPUNIT_CONFIGURATION_FILE'] = $arguments['configuration']; |
||
| 186 | } |
||
| 187 | |||
| 188 | $this->handleConfiguration($arguments); |
||
| 189 | |||
| 190 | $this->processSuiteFilters($suite, $arguments); |
||
| 191 | |||
| 192 | if (isset($arguments['bootstrap'])) { |
||
| 193 | $GLOBALS['__PHPUNIT_BOOTSTRAP'] = $arguments['bootstrap']; |
||
| 194 | } |
||
| 195 | |||
| 196 | if ($arguments['backupGlobals'] === true) { |
||
| 197 | $suite->setBackupGlobals(true); |
||
| 198 | } |
||
| 199 | |||
| 200 | if ($arguments['backupStaticAttributes'] === true) { |
||
| 201 | $suite->setBackupStaticAttributes(true); |
||
| 202 | } |
||
| 203 | |||
| 204 | if ($arguments['beStrictAboutChangesToGlobalState'] === true) { |
||
| 205 | $suite->setbeStrictAboutChangesToGlobalState(true); |
||
| 206 | } |
||
| 207 | |||
| 208 | if (\is_int($arguments['repeat']) && $arguments['repeat'] > 0) { |
||
| 209 | $_suite = new TestSuite; |
||
| 210 | |||
| 211 | foreach (\range(1, $arguments['repeat']) as $step) { |
||
| 212 | $_suite->addTest($suite); |
||
| 213 | } |
||
| 214 | |||
| 215 | $suite = $_suite; |
||
| 216 | unset($_suite); |
||
| 217 | } |
||
| 218 | |||
| 219 | $result = $this->createTestResult(); |
||
| 220 | |||
| 221 | if (!$arguments['convertErrorsToExceptions']) { |
||
| 222 | $result->convertErrorsToExceptions(false); |
||
| 223 | } |
||
| 224 | |||
| 225 | if (!$arguments['convertNoticesToExceptions']) { |
||
| 226 | Notice::$enabled = false; |
||
| 227 | } |
||
| 228 | |||
| 229 | if (!$arguments['convertWarningsToExceptions']) { |
||
| 230 | Warning::$enabled = false; |
||
| 231 | } |
||
| 232 | |||
| 233 | if ($arguments['stopOnError']) { |
||
| 234 | $result->stopOnError(true); |
||
| 235 | } |
||
| 236 | |||
| 237 | if ($arguments['stopOnFailure']) { |
||
| 238 | $result->stopOnFailure(true); |
||
| 239 | } |
||
| 240 | |||
| 241 | if ($arguments['stopOnWarning']) { |
||
| 242 | $result->stopOnWarning(true); |
||
| 243 | } |
||
| 244 | |||
| 245 | if ($arguments['stopOnIncomplete']) { |
||
| 246 | $result->stopOnIncomplete(true); |
||
| 247 | } |
||
| 248 | |||
| 249 | if ($arguments['stopOnRisky']) { |
||
| 250 | $result->stopOnRisky(true); |
||
| 251 | } |
||
| 252 | |||
| 253 | if ($arguments['stopOnSkipped']) { |
||
| 254 | $result->stopOnSkipped(true); |
||
| 255 | } |
||
| 256 | |||
| 257 | if ($arguments['registerMockObjectsFromTestArgumentsRecursively']) { |
||
| 258 | $result->setRegisterMockObjectsFromTestArgumentsRecursively(true); |
||
| 259 | } |
||
| 260 | |||
| 261 | if ($this->printer === null) { |
||
| 262 | if (isset($arguments['printer']) && |
||
| 263 | $arguments['printer'] instanceof Printer) { |
||
| 264 | $this->printer = $arguments['printer']; |
||
| 265 | } else { |
||
| 266 | $printerClass = ResultPrinter::class; |
||
| 267 | |||
| 268 | if (isset($arguments['printer']) && \is_string($arguments['printer']) && \class_exists($arguments['printer'], false)) { |
||
| 269 | $class = new ReflectionClass($arguments['printer']); |
||
| 270 | |||
| 271 | if ($class->isSubclassOf(ResultPrinter::class)) { |
||
| 272 | $printerClass = $arguments['printer']; |
||
| 273 | } |
||
| 274 | } |
||
| 275 | |||
| 276 | $this->printer = new $printerClass( |
||
| 277 | isset($arguments['stderr']) ? 'php://stderr' : null, |
||
| 278 | $arguments['verbose'], |
||
| 279 | $arguments['colors'], |
||
| 280 | $arguments['debug'], |
||
| 281 | $arguments['columns'], |
||
| 282 | $arguments['reverseList'] |
||
| 283 | ); |
||
| 284 | } |
||
| 285 | } |
||
| 286 | |||
| 287 | $this->printer->write( |
||
| 288 | Version::getVersionString() . "\n" |
||
| 289 | ); |
||
| 290 | |||
| 291 | self::$versionStringPrinted = true; |
||
| 292 | |||
| 293 | if ($arguments['verbose']) { |
||
| 294 | $runtime = $this->runtime->getNameWithVersion(); |
||
| 295 | |||
| 296 | if ($this->runtime->hasXdebug()) { |
||
| 297 | $runtime .= \sprintf( |
||
| 298 | ' with Xdebug %s', |
||
| 299 | \phpversion('xdebug') |
||
| 300 | ); |
||
| 301 | } |
||
| 302 | |||
| 303 | $this->writeMessage('Runtime', $runtime); |
||
| 304 | |||
| 305 | if (isset($arguments['configuration'])) { |
||
| 306 | $this->writeMessage( |
||
| 307 | 'Configuration', |
||
| 308 | $arguments['configuration']->getFilename() |
||
| 309 | ); |
||
| 310 | } |
||
| 311 | |||
| 312 | foreach ($arguments['loadedExtensions'] as $extension) { |
||
| 313 | $this->writeMessage( |
||
| 314 | 'Extension', |
||
| 315 | $extension |
||
| 316 | ); |
||
| 317 | } |
||
| 318 | |||
| 319 | foreach ($arguments['notLoadedExtensions'] as $extension) { |
||
| 320 | $this->writeMessage( |
||
| 321 | 'Extension', |
||
| 322 | $extension |
||
| 323 | ); |
||
| 324 | } |
||
| 325 | } |
||
| 326 | |||
| 327 | foreach ($arguments['listeners'] as $listener) { |
||
| 328 | $result->addListener($listener); |
||
| 329 | } |
||
| 330 | |||
| 331 | $result->addListener($this->printer); |
||
| 332 | |||
| 333 | if (isset($arguments['testdoxHTMLFile'])) { |
||
| 334 | $result->addListener( |
||
| 335 | new HtmlResultPrinter( |
||
| 336 | $arguments['testdoxHTMLFile'], |
||
| 337 | $arguments['testdoxGroups'], |
||
| 338 | $arguments['testdoxExcludeGroups'] |
||
| 339 | ) |
||
| 340 | ); |
||
| 341 | } |
||
| 342 | |||
| 343 | if (isset($arguments['testdoxTextFile'])) { |
||
| 344 | $result->addListener( |
||
| 345 | new TextResultPrinter( |
||
| 346 | $arguments['testdoxTextFile'], |
||
| 347 | $arguments['testdoxGroups'], |
||
| 348 | $arguments['testdoxExcludeGroups'] |
||
| 349 | ) |
||
| 350 | ); |
||
| 351 | } |
||
| 352 | |||
| 353 | if (isset($arguments['testdoxXMLFile'])) { |
||
| 354 | $result->addListener( |
||
| 355 | new XmlResultPrinter( |
||
| 356 | $arguments['testdoxXMLFile'] |
||
| 357 | ) |
||
| 358 | ); |
||
| 359 | } |
||
| 360 | |||
| 361 | $codeCoverageReports = 0; |
||
| 362 | |||
| 363 | if (isset($arguments['coverageClover'])) { |
||
| 364 | $codeCoverageReports++; |
||
| 365 | } |
||
| 366 | |||
| 367 | if (isset($arguments['coverageCrap4J'])) { |
||
| 368 | $codeCoverageReports++; |
||
| 369 | } |
||
| 370 | |||
| 371 | if (isset($arguments['coverageHtml'])) { |
||
| 372 | $codeCoverageReports++; |
||
| 373 | } |
||
| 374 | |||
| 375 | if (isset($arguments['coveragePHP'])) { |
||
| 376 | $codeCoverageReports++; |
||
| 377 | } |
||
| 378 | |||
| 379 | if (isset($arguments['coverageText'])) { |
||
| 380 | $codeCoverageReports++; |
||
| 381 | } |
||
| 382 | |||
| 383 | if (isset($arguments['coverageXml'])) { |
||
| 384 | $codeCoverageReports++; |
||
| 385 | } |
||
| 386 | |||
| 387 | if (isset($arguments['noCoverage'])) { |
||
| 388 | $codeCoverageReports = 0; |
||
| 389 | } |
||
| 390 | |||
| 391 | if ($codeCoverageReports > 0 && !$this->runtime->canCollectCodeCoverage()) { |
||
| 392 | $this->writeMessage('Error', 'No code coverage driver is available'); |
||
| 393 | |||
| 394 | $codeCoverageReports = 0; |
||
| 395 | } |
||
| 396 | |||
| 397 | if ($codeCoverageReports > 0) { |
||
| 398 | $codeCoverage = new CodeCoverage( |
||
| 399 | null, |
||
| 400 | $this->codeCoverageFilter |
||
| 401 | ); |
||
| 402 | |||
| 403 | $codeCoverage->setUnintentionallyCoveredSubclassesWhitelist( |
||
| 404 | [SebastianBergmann\Comparator\Comparator::class] |
||
| 405 | ); |
||
| 406 | |||
| 407 | $codeCoverage->setCheckForUnintentionallyCoveredCode( |
||
| 408 | $arguments['strictCoverage'] |
||
| 409 | ); |
||
| 410 | |||
| 411 | $codeCoverage->setCheckForMissingCoversAnnotation( |
||
| 412 | $arguments['strictCoverage'] |
||
| 413 | ); |
||
| 414 | |||
| 415 | if (isset($arguments['forceCoversAnnotation'])) { |
||
| 416 | $codeCoverage->setForceCoversAnnotation( |
||
| 417 | $arguments['forceCoversAnnotation'] |
||
| 418 | ); |
||
| 419 | } |
||
| 420 | |||
| 421 | if (isset($arguments['ignoreDeprecatedCodeUnitsFromCodeCoverage'])) { |
||
| 422 | $codeCoverage->setIgnoreDeprecatedCode( |
||
| 423 | $arguments['ignoreDeprecatedCodeUnitsFromCodeCoverage'] |
||
| 424 | ); |
||
| 425 | } |
||
| 426 | |||
| 427 | if (isset($arguments['disableCodeCoverageIgnore'])) { |
||
| 428 | $codeCoverage->setDisableIgnoredLines(true); |
||
| 429 | } |
||
| 430 | |||
| 431 | if (isset($arguments['whitelist'])) { |
||
| 432 | $this->codeCoverageFilter->addDirectoryToWhitelist($arguments['whitelist']); |
||
| 433 | } |
||
| 434 | |||
| 435 | if (isset($arguments['configuration'])) { |
||
| 436 | $filterConfiguration = $arguments['configuration']->getFilterConfiguration(); |
||
| 437 | |||
| 438 | if (empty($filterConfiguration['whitelist'])) { |
||
| 439 | $this->writeMessage('Error', 'No whitelist is configured, no code coverage will be generated.'); |
||
| 440 | |||
| 441 | $codeCoverageReports = 0; |
||
| 442 | |||
| 443 | unset($codeCoverage); |
||
| 444 | } else { |
||
| 445 | $codeCoverage->setAddUncoveredFilesFromWhitelist( |
||
| 446 | $filterConfiguration['whitelist']['addUncoveredFilesFromWhitelist'] |
||
| 447 | ); |
||
| 448 | |||
| 449 | $codeCoverage->setProcessUncoveredFilesFromWhitelist( |
||
| 450 | $filterConfiguration['whitelist']['processUncoveredFilesFromWhitelist'] |
||
| 451 | ); |
||
| 452 | |||
| 453 | foreach ($filterConfiguration['whitelist']['include']['directory'] as $dir) { |
||
| 454 | $this->codeCoverageFilter->addDirectoryToWhitelist( |
||
| 455 | $dir['path'], |
||
| 456 | $dir['suffix'], |
||
| 457 | $dir['prefix'] |
||
| 458 | ); |
||
| 459 | } |
||
| 460 | |||
| 461 | foreach ($filterConfiguration['whitelist']['include']['file'] as $file) { |
||
| 462 | $this->codeCoverageFilter->addFileToWhitelist($file); |
||
| 463 | } |
||
| 464 | |||
| 465 | foreach ($filterConfiguration['whitelist']['exclude']['directory'] as $dir) { |
||
| 466 | $this->codeCoverageFilter->removeDirectoryFromWhitelist( |
||
| 467 | $dir['path'], |
||
| 468 | $dir['suffix'], |
||
| 469 | $dir['prefix'] |
||
| 470 | ); |
||
| 471 | } |
||
| 472 | |||
| 473 | foreach ($filterConfiguration['whitelist']['exclude']['file'] as $file) { |
||
| 474 | $this->codeCoverageFilter->removeFileFromWhitelist($file); |
||
| 475 | } |
||
| 476 | } |
||
| 477 | } |
||
| 478 | |||
| 479 | if (isset($codeCoverage) && !$this->codeCoverageFilter->hasWhitelist()) { |
||
| 480 | $this->writeMessage('Error', 'Incorrect whitelist config, no code coverage will be generated.'); |
||
| 481 | |||
| 482 | $codeCoverageReports = 0; |
||
| 483 | |||
| 484 | unset($codeCoverage); |
||
| 485 | } |
||
| 486 | } |
||
| 487 | |||
| 488 | $this->printer->write("\n"); |
||
| 489 | |||
| 490 | if (isset($codeCoverage)) { |
||
| 491 | $result->setCodeCoverage($codeCoverage); |
||
| 492 | |||
| 493 | if ($codeCoverageReports > 1 && isset($arguments['cacheTokens'])) { |
||
| 494 | $codeCoverage->setCacheTokens($arguments['cacheTokens']); |
||
| 495 | } |
||
| 496 | } |
||
| 497 | |||
| 498 | if (isset($arguments['teamcityLogfile'])) { |
||
| 499 | $result->addListener( |
||
| 500 | new TeamCity($arguments['teamcityLogfile']) |
||
| 501 | ); |
||
| 502 | } |
||
| 503 | |||
| 504 | if (isset($arguments['junitLogfile'])) { |
||
| 505 | $result->addListener( |
||
| 506 | new JUnit( |
||
| 507 | $arguments['junitLogfile'], |
||
| 508 | $arguments['reportUselessTests'] |
||
| 509 | ) |
||
| 510 | ); |
||
| 511 | } |
||
| 512 | |||
| 513 | $result->beStrictAboutTestsThatDoNotTestAnything($arguments['reportUselessTests']); |
||
| 514 | $result->beStrictAboutOutputDuringTests($arguments['disallowTestOutput']); |
||
| 515 | $result->beStrictAboutTodoAnnotatedTests($arguments['disallowTodoAnnotatedTests']); |
||
| 516 | $result->beStrictAboutResourceUsageDuringSmallTests($arguments['beStrictAboutResourceUsageDuringSmallTests']); |
||
| 517 | $result->enforceTimeLimit($arguments['enforceTimeLimit']); |
||
| 518 | $result->setTimeoutForSmallTests($arguments['timeoutForSmallTests']); |
||
| 519 | $result->setTimeoutForMediumTests($arguments['timeoutForMediumTests']); |
||
| 520 | $result->setTimeoutForLargeTests($arguments['timeoutForLargeTests']); |
||
| 521 | |||
| 522 | if ($suite instanceof TestSuite) { |
||
| 523 | $suite->setRunTestInSeparateProcess($arguments['processIsolation']); |
||
| 524 | } |
||
| 525 | |||
| 526 | $suite->run($result); |
||
| 527 | |||
| 528 | unset($suite); |
||
| 529 | $result->flushListeners(); |
||
| 530 | |||
| 531 | if ($this->printer instanceof ResultPrinter) { |
||
| 532 | $this->printer->printResult($result); |
||
| 533 | } |
||
| 534 | |||
| 535 | if (isset($codeCoverage)) { |
||
| 536 | if (isset($arguments['coverageClover'])) { |
||
| 537 | $this->printer->write( |
||
| 538 | "\nGenerating code coverage report in Clover XML format ..." |
||
| 539 | ); |
||
| 540 | |||
| 541 | try { |
||
| 542 | $writer = new CloverReport; |
||
| 543 | $writer->process($codeCoverage, $arguments['coverageClover']); |
||
| 544 | |||
| 545 | $this->printer->write(" done\n"); |
||
| 546 | unset($writer); |
||
| 547 | } catch (CodeCoverageException $e) { |
||
| 548 | $this->printer->write( |
||
| 549 | " failed\n" . $e->getMessage() . "\n" |
||
| 550 | ); |
||
| 551 | } |
||
| 552 | } |
||
| 553 | |||
| 554 | if (isset($arguments['coverageCrap4J'])) { |
||
| 555 | $this->printer->write( |
||
| 556 | "\nGenerating Crap4J report XML file ..." |
||
| 557 | ); |
||
| 558 | |||
| 559 | try { |
||
| 560 | $writer = new Crap4jReport($arguments['crap4jThreshold']); |
||
| 561 | $writer->process($codeCoverage, $arguments['coverageCrap4J']); |
||
| 562 | |||
| 563 | $this->printer->write(" done\n"); |
||
| 564 | unset($writer); |
||
| 565 | } catch (CodeCoverageException $e) { |
||
| 566 | $this->printer->write( |
||
| 567 | " failed\n" . $e->getMessage() . "\n" |
||
| 568 | ); |
||
| 569 | } |
||
| 570 | } |
||
| 571 | |||
| 572 | if (isset($arguments['coverageHtml'])) { |
||
| 573 | $this->printer->write( |
||
| 574 | "\nGenerating code coverage report in HTML format ..." |
||
| 575 | ); |
||
| 576 | |||
| 577 | try { |
||
| 578 | $writer = new HtmlReport( |
||
| 579 | $arguments['reportLowUpperBound'], |
||
| 580 | $arguments['reportHighLowerBound'], |
||
| 581 | \sprintf( |
||
| 582 | ' and <a href="https://phpunit.de/">PHPUnit %s</a>', |
||
| 583 | Version::id() |
||
| 584 | ) |
||
| 585 | ); |
||
| 586 | |||
| 587 | $writer->process($codeCoverage, $arguments['coverageHtml']); |
||
| 588 | |||
| 589 | $this->printer->write(" done\n"); |
||
| 590 | unset($writer); |
||
| 591 | } catch (CodeCoverageException $e) { |
||
| 592 | $this->printer->write( |
||
| 593 | " failed\n" . $e->getMessage() . "\n" |
||
| 594 | ); |
||
| 595 | } |
||
| 596 | } |
||
| 597 | |||
| 598 | if (isset($arguments['coveragePHP'])) { |
||
| 599 | $this->printer->write( |
||
| 600 | "\nGenerating code coverage report in PHP format ..." |
||
| 601 | ); |
||
| 602 | |||
| 603 | try { |
||
| 604 | $writer = new PhpReport; |
||
| 605 | $writer->process($codeCoverage, $arguments['coveragePHP']); |
||
| 606 | |||
| 607 | $this->printer->write(" done\n"); |
||
| 608 | unset($writer); |
||
| 609 | } catch (CodeCoverageException $e) { |
||
| 610 | $this->printer->write( |
||
| 611 | " failed\n" . $e->getMessage() . "\n" |
||
| 612 | ); |
||
| 613 | } |
||
| 614 | } |
||
| 615 | |||
| 616 | if (isset($arguments['coverageText'])) { |
||
| 617 | if ($arguments['coverageText'] == 'php://stdout') { |
||
| 618 | $outputStream = $this->printer; |
||
| 619 | $colors = $arguments['colors'] && $arguments['colors'] != ResultPrinter::COLOR_NEVER; |
||
| 620 | } else { |
||
| 621 | $outputStream = new Printer($arguments['coverageText']); |
||
| 622 | $colors = false; |
||
| 623 | } |
||
| 624 | |||
| 625 | $processor = new TextReport( |
||
| 626 | $arguments['reportLowUpperBound'], |
||
| 627 | $arguments['reportHighLowerBound'], |
||
| 628 | $arguments['coverageTextShowUncoveredFiles'], |
||
| 629 | $arguments['coverageTextShowOnlySummary'] |
||
| 630 | ); |
||
| 631 | |||
| 632 | $outputStream->write( |
||
| 633 | $processor->process($codeCoverage, $colors) |
||
| 634 | ); |
||
| 635 | } |
||
| 636 | |||
| 637 | if (isset($arguments['coverageXml'])) { |
||
| 638 | $this->printer->write( |
||
| 639 | "\nGenerating code coverage report in PHPUnit XML format ..." |
||
| 640 | ); |
||
| 641 | |||
| 642 | try { |
||
| 643 | $writer = new XmlReport(Version::id()); |
||
| 644 | $writer->process($codeCoverage, $arguments['coverageXml']); |
||
| 645 | |||
| 646 | $this->printer->write(" done\n"); |
||
| 647 | unset($writer); |
||
| 648 | } catch (CodeCoverageException $e) { |
||
| 649 | $this->printer->write( |
||
| 650 | " failed\n" . $e->getMessage() . "\n" |
||
| 651 | ); |
||
| 652 | } |
||
| 653 | } |
||
| 654 | } |
||
| 655 | |||
| 656 | if ($exit) { |
||
| 657 | if ($result->wasSuccessful()) { |
||
| 658 | if ($arguments['failOnRisky'] && !$result->allHarmless()) { |
||
| 659 | exit(self::FAILURE_EXIT); |
||
| 660 | } |
||
| 661 | |||
| 662 | if ($arguments['failOnWarning'] && $result->warningCount() > 0) { |
||
| 663 | exit(self::FAILURE_EXIT); |
||
| 664 | } |
||
| 665 | |||
| 666 | exit(self::SUCCESS_EXIT); |
||
| 667 | } |
||
| 668 | |||
| 669 | if ($result->errorCount() > 0) { |
||
| 670 | exit(self::EXCEPTION_EXIT); |
||
| 671 | } |
||
| 672 | |||
| 673 | if ($result->failureCount() > 0) { |
||
| 674 | exit(self::FAILURE_EXIT); |
||
| 675 | } |
||
| 676 | } |
||
| 677 | |||
| 678 | return $result; |
||
| 679 | } |
||
| 680 | |||
| 1090 |