ResultPrinter.php in Zircon Profile 8

File

vendor/phpunit/phpunit/src/TextUI/ResultPrinter.php

<?php

/*
 * This file is part of PHPUnit.
 *
 * (c) Sebastian Bergmann <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
use SebastianBergmann\Environment\Console;

/**
 * Prints the result of a TextUI TestRunner run.
 *
 * @since Class available since Release 2.0.0
 */
class PHPUnit_TextUI_ResultPrinter extends PHPUnit_Util_Printer implements PHPUnit_Framework_TestListener {
  const EVENT_TEST_START = 0;
  const EVENT_TEST_END = 1;
  const EVENT_TESTSUITE_START = 2;
  const EVENT_TESTSUITE_END = 3;
  const COLOR_NEVER = 'never';
  const COLOR_AUTO = 'auto';
  const COLOR_ALWAYS = 'always';
  const COLOR_DEFAULT = self::COLOR_NEVER;

  /**
   * @var array
   */
  private static $ansiCodes = array(
    'bold' => 1,
    'fg-black' => 30,
    'fg-red' => 31,
    'fg-green' => 32,
    'fg-yellow' => 33,
    'fg-blue' => 34,
    'fg-magenta' => 35,
    'fg-cyan' => 36,
    'fg-white' => 37,
    'bg-black' => 40,
    'bg-red' => 41,
    'bg-green' => 42,
    'bg-yellow' => 43,
    'bg-blue' => 44,
    'bg-magenta' => 45,
    'bg-cyan' => 46,
    'bg-white' => 47,
  );

  /**
   * @var int
   */
  protected $column = 0;

  /**
   * @var int
   */
  protected $maxColumn;

  /**
   * @var bool
   */
  protected $lastTestFailed = false;

  /**
   * @var int
   */
  protected $numAssertions = 0;

  /**
   * @var int
   */
  protected $numTests = -1;

  /**
   * @var int
   */
  protected $numTestsRun = 0;

  /**
   * @var int
   */
  protected $numTestsWidth;

  /**
   * @var bool
   */
  protected $colors = false;

  /**
   * @var bool
   */
  protected $debug = false;

  /**
   * @var bool
   */
  protected $verbose = false;

  /**
   * @var int
   */
  private $numberOfColumns;

  /**
   * Constructor.
   *
   * @param  mixed                       $out
   * @param  bool                        $verbose
   * @param  string                      $colors
   * @param  bool                        $debug
   * @param  int|string                  $numberOfColumns
   * @throws PHPUnit_Framework_Exception
   * @since  Method available since Release 3.0.0
   */
  public function __construct($out = null, $verbose = false, $colors = self::COLOR_DEFAULT, $debug = false, $numberOfColumns = 80) {
    parent::__construct($out);
    if (!is_bool($verbose)) {
      throw PHPUnit_Util_InvalidArgumentHelper::factory(2, 'boolean');
    }
    $availableColors = array(
      self::COLOR_NEVER,
      self::COLOR_AUTO,
      self::COLOR_ALWAYS,
    );
    if (!in_array($colors, $availableColors)) {
      throw PHPUnit_Util_InvalidArgumentHelper::factory(3, vsprintf('value from "%s", "%s" or "%s"', $availableColors));
    }
    if (!is_bool($debug)) {
      throw PHPUnit_Util_InvalidArgumentHelper::factory(4, 'boolean');
    }
    if (!is_int($numberOfColumns) && $numberOfColumns != 'max') {
      throw PHPUnit_Util_InvalidArgumentHelper::factory(5, 'integer or "max"');
    }
    $console = new Console();
    $maxNumberOfColumns = $console
      ->getNumberOfColumns();
    if ($numberOfColumns == 'max' || $numberOfColumns > $maxNumberOfColumns) {
      $numberOfColumns = $maxNumberOfColumns;
    }
    $this->numberOfColumns = $numberOfColumns;
    $this->verbose = $verbose;
    $this->debug = $debug;
    if ($colors === self::COLOR_AUTO && $console
      ->hasColorSupport()) {
      $this->colors = true;
    }
    else {
      $this->colors = self::COLOR_ALWAYS === $colors;
    }
  }

  /**
   * @param PHPUnit_Framework_TestResult $result
   */
  public function printResult(PHPUnit_Framework_TestResult $result) {
    $this
      ->printHeader();
    $this
      ->printErrors($result);
    $printSeparator = $result
      ->errorCount() > 0;
    if ($printSeparator && $result
      ->failureCount() > 0) {
      $this
        ->write("\n--\n\n");
    }
    $printSeparator = $printSeparator || $result
      ->failureCount() > 0;
    $this
      ->printFailures($result);
    if ($this->verbose) {
      if ($printSeparator && $result
        ->riskyCount() > 0) {
        $this
          ->write("\n--\n\n");
      }
      $printSeparator = $printSeparator || $result
        ->riskyCount() > 0;
      $this
        ->printRisky($result);
      if ($printSeparator && $result
        ->notImplementedCount() > 0) {
        $this
          ->write("\n--\n\n");
      }
      $printSeparator = $printSeparator || $result
        ->notImplementedCount() > 0;
      $this
        ->printIncompletes($result);
      if ($printSeparator && $result
        ->skippedCount() > 0) {
        $this
          ->write("\n--\n\n");
      }
      $this
        ->printSkipped($result);
    }
    $this
      ->printFooter($result);
  }

  /**
   * @param array  $defects
   * @param string $type
   */
  protected function printDefects(array $defects, $type) {
    $count = count($defects);
    if ($count == 0) {
      return;
    }
    $this
      ->write(sprintf("There %s %d %s%s:\n", $count == 1 ? 'was' : 'were', $count, $type, $count == 1 ? '' : 's'));
    $i = 1;
    foreach ($defects as $defect) {
      $this
        ->printDefect($defect, $i++);
    }
  }

  /**
   * @param PHPUnit_Framework_TestFailure $defect
   * @param int                           $count
   */
  protected function printDefect(PHPUnit_Framework_TestFailure $defect, $count) {
    $this
      ->printDefectHeader($defect, $count);
    $this
      ->printDefectTrace($defect);
  }

  /**
   * @param PHPUnit_Framework_TestFailure $defect
   * @param int                           $count
   */
  protected function printDefectHeader(PHPUnit_Framework_TestFailure $defect, $count) {
    $this
      ->write(sprintf("\n%d) %s\n", $count, $defect
      ->getTestName()));
  }

  /**
   * @param PHPUnit_Framework_TestFailure $defect
   */
  protected function printDefectTrace(PHPUnit_Framework_TestFailure $defect) {
    $e = $defect
      ->thrownException();
    $this
      ->write((string) $e);
    while ($e = $e
      ->getPrevious()) {
      $this
        ->write("\nCaused by\n" . $e);
    }
  }

  /**
   * @param PHPUnit_Framework_TestResult $result
   */
  protected function printErrors(PHPUnit_Framework_TestResult $result) {
    $this
      ->printDefects($result
      ->errors(), 'error');
  }

  /**
   * @param PHPUnit_Framework_TestResult $result
   */
  protected function printFailures(PHPUnit_Framework_TestResult $result) {
    $this
      ->printDefects($result
      ->failures(), 'failure');
  }

  /**
   * @param PHPUnit_Framework_TestResult $result
   */
  protected function printIncompletes(PHPUnit_Framework_TestResult $result) {
    $this
      ->printDefects($result
      ->notImplemented(), 'incomplete test');
  }

  /**
   * @param PHPUnit_Framework_TestResult $result
   * @since  Method available since Release 4.0.0
   */
  protected function printRisky(PHPUnit_Framework_TestResult $result) {
    $this
      ->printDefects($result
      ->risky(), 'risky test');
  }

  /**
   * @param PHPUnit_Framework_TestResult $result
   * @since  Method available since Release 3.0.0
   */
  protected function printSkipped(PHPUnit_Framework_TestResult $result) {
    $this
      ->printDefects($result
      ->skipped(), 'skipped test');
  }
  protected function printHeader() {
    $this
      ->write("\n\n" . PHP_Timer::resourceUsage() . "\n\n");
  }

  /**
   * @param PHPUnit_Framework_TestResult $result
   */
  protected function printFooter(PHPUnit_Framework_TestResult $result) {
    if (count($result) === 0) {
      $this
        ->writeWithColor('fg-black, bg-yellow', 'No tests executed!');
    }
    elseif ($result
      ->wasSuccessful() && $result
      ->allHarmless() && $result
      ->allCompletelyImplemented() && $result
      ->noneSkipped()) {
      $this
        ->writeWithColor('fg-black, bg-green', sprintf('OK (%d test%s, %d assertion%s)', count($result), count($result) == 1 ? '' : 's', $this->numAssertions, $this->numAssertions == 1 ? '' : 's'));
    }
    else {
      if ($result
        ->wasSuccessful()) {
        $color = 'fg-black, bg-yellow';
        if ($this->verbose) {
          $this
            ->write("\n");
        }
        $this
          ->writeWithColor($color, 'OK, but incomplete, skipped, or risky tests!');
      }
      else {
        $color = 'fg-white, bg-red';
        $this
          ->write("\n");
        $this
          ->writeWithColor($color, 'FAILURES!');
      }
      $this
        ->writeCountString(count($result), 'Tests', $color, true);
      $this
        ->writeCountString($this->numAssertions, 'Assertions', $color, true);
      $this
        ->writeCountString($result
        ->errorCount(), 'Errors', $color);
      $this
        ->writeCountString($result
        ->failureCount(), 'Failures', $color);
      $this
        ->writeCountString($result
        ->skippedCount(), 'Skipped', $color);
      $this
        ->writeCountString($result
        ->notImplementedCount(), 'Incomplete', $color);
      $this
        ->writeCountString($result
        ->riskyCount(), 'Risky', $color);
      $this
        ->writeWithColor($color, '.', true);
    }
  }

  /**
   */
  public function printWaitPrompt() {
    $this
      ->write("\n<RETURN> to continue\n");
  }

  /**
   * An error occurred.
   *
   * @param PHPUnit_Framework_Test $test
   * @param Exception              $e
   * @param float                  $time
   */
  public function addError(PHPUnit_Framework_Test $test, Exception $e, $time) {
    $this
      ->writeProgressWithColor('fg-red, bold', 'E');
    $this->lastTestFailed = true;
  }

  /**
   * A failure occurred.
   *
   * @param PHPUnit_Framework_Test                 $test
   * @param PHPUnit_Framework_AssertionFailedError $e
   * @param float                                  $time
   */
  public function addFailure(PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e, $time) {
    $this
      ->writeProgressWithColor('bg-red, fg-white', 'F');
    $this->lastTestFailed = true;
  }

  /**
   * Incomplete test.
   *
   * @param PHPUnit_Framework_Test $test
   * @param Exception              $e
   * @param float                  $time
   */
  public function addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, $time) {
    $this
      ->writeProgressWithColor('fg-yellow, bold', 'I');
    $this->lastTestFailed = true;
  }

  /**
   * Risky test.
   *
   * @param PHPUnit_Framework_Test $test
   * @param Exception              $e
   * @param float                  $time
   * @since  Method available since Release 4.0.0
   */
  public function addRiskyTest(PHPUnit_Framework_Test $test, Exception $e, $time) {
    $this
      ->writeProgressWithColor('fg-yellow, bold', 'R');
    $this->lastTestFailed = true;
  }

  /**
   * Skipped test.
   *
   * @param PHPUnit_Framework_Test $test
   * @param Exception              $e
   * @param float                  $time
   * @since  Method available since Release 3.0.0
   */
  public function addSkippedTest(PHPUnit_Framework_Test $test, Exception $e, $time) {
    $this
      ->writeProgressWithColor('fg-cyan, bold', 'S');
    $this->lastTestFailed = true;
  }

  /**
   * A testsuite started.
   *
   * @param PHPUnit_Framework_TestSuite $suite
   * @since  Method available since Release 2.2.0
   */
  public function startTestSuite(PHPUnit_Framework_TestSuite $suite) {
    if ($this->numTests == -1) {
      $this->numTests = count($suite);
      $this->numTestsWidth = strlen((string) $this->numTests);
      $this->maxColumn = $this->numberOfColumns - strlen('  /  (XXX%)') - 2 * $this->numTestsWidth;
    }
  }

  /**
   * A testsuite ended.
   *
   * @param PHPUnit_Framework_TestSuite $suite
   * @since  Method available since Release 2.2.0
   */
  public function endTestSuite(PHPUnit_Framework_TestSuite $suite) {
  }

  /**
   * A test started.
   *
   * @param PHPUnit_Framework_Test $test
   */
  public function startTest(PHPUnit_Framework_Test $test) {
    if ($this->debug) {
      $this
        ->write(sprintf("\nStarting test '%s'.\n", PHPUnit_Util_Test::describe($test)));
    }
  }

  /**
   * A test ended.
   *
   * @param PHPUnit_Framework_Test $test
   * @param float                  $time
   */
  public function endTest(PHPUnit_Framework_Test $test, $time) {
    if (!$this->lastTestFailed) {
      $this
        ->writeProgress('.');
    }
    if ($test instanceof PHPUnit_Framework_TestCase) {
      $this->numAssertions += $test
        ->getNumAssertions();
    }
    elseif ($test instanceof PHPUnit_Extensions_PhptTestCase) {
      $this->numAssertions++;
    }
    $this->lastTestFailed = false;
    if ($test instanceof PHPUnit_Framework_TestCase) {
      if (!$test
        ->hasExpectationOnOutput()) {
        $this
          ->write($test
          ->getActualOutput());
      }
    }
  }

  /**
   * @param string $progress
   */
  protected function writeProgress($progress) {
    $this
      ->write($progress);
    $this->column++;
    $this->numTestsRun++;
    if ($this->column == $this->maxColumn) {
      $this
        ->write(sprintf(' %' . $this->numTestsWidth . 'd / %' . $this->numTestsWidth . 'd (%3s%%)', $this->numTestsRun, $this->numTests, floor($this->numTestsRun / $this->numTests * 100)));
      $this
        ->writeNewLine();
    }
  }
  protected function writeNewLine() {
    $this->column = 0;
    $this
      ->write("\n");
  }

  /**
   * Formats a buffer with a specified ANSI color sequence if colors are
   * enabled.
   *
   * @param  string $color
   * @param  string $buffer
   * @return string
   * @since  Method available since Release 4.0.0
   */
  protected function formatWithColor($color, $buffer) {
    if (!$this->colors) {
      return $buffer;
    }
    $codes = array_map('trim', explode(',', $color));
    $lines = explode("\n", $buffer);
    $padding = max(array_map('strlen', $lines));
    $styles = array();
    foreach ($codes as $code) {
      $styles[] = self::$ansiCodes[$code];
    }
    $style = sprintf("\33[%sm", implode(';', $styles));
    $styledLines = array();
    foreach ($lines as $line) {
      $styledLines[] = $style . str_pad($line, $padding) . "\33[0m";
    }
    return implode("\n", $styledLines);
  }

  /**
   * Writes a buffer out with a color sequence if colors are enabled.
   *
   * @param string $color
   * @param string $buffer
   * @param bool   $lf
   * @since  Method available since Release 4.0.0
   */
  protected function writeWithColor($color, $buffer, $lf = true) {
    $this
      ->write($this
      ->formatWithColor($color, $buffer));
    if ($lf) {
      $this
        ->write("\n");
    }
  }

  /**
   * Writes progress with a color sequence if colors are enabled.
   *
   * @param string $color
   * @param string $buffer
   * @since  Method available since Release 4.0.0
   */
  protected function writeProgressWithColor($color, $buffer) {
    $buffer = $this
      ->formatWithColor($color, $buffer);
    $this
      ->writeProgress($buffer);
  }

  /**
   * @param int    $count
   * @param string $name
   * @param string $color
   * @param bool   $always
   * @since  Method available since Release 4.6.5
   */
  private function writeCountString($count, $name, $color, $always = false) {
    static $first = true;
    if ($always || $count > 0) {
      $this
        ->writeWithColor($color, sprintf('%s%s: %d', !$first ? ', ' : '', $name, $count), false);
      $first = false;
    }
  }

}

Classes

Name	Description
PHPUnit_TextUI_ResultPrinter	Prints the result of a TextUI TestRunner run.