You are here

class PHPUnit_Util_Log_JSON in Zircon Profile 8.0

Same name and namespace in other branches
  1. 8 vendor/phpunit/phpunit/src/Util/Log/JSON.php \PHPUnit_Util_Log_JSON

A TestListener that generates JSON messages.

@since Class available since Release 3.0.0

Hierarchy

Expanded class hierarchy of PHPUnit_Util_Log_JSON

File

vendor/phpunit/phpunit/src/Util/Log/JSON.php, line 16

View source
class PHPUnit_Util_Log_JSON extends PHPUnit_Util_Printer implements PHPUnit_Framework_TestListener {

  /**
   * @var string
   */
  protected $currentTestSuiteName = '';

  /**
   * @var string
   */
  protected $currentTestName = '';

  /**
   * @var bool
   */
  protected $currentTestPass = true;

  /**
   * 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
      ->writeCase('error', $time, PHPUnit_Util_Filter::getFilteredStacktrace($e, false), $e
      ->getMessage(), $test);
    $this->currentTestPass = false;
  }

  /**
   * 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
      ->writeCase('fail', $time, PHPUnit_Util_Filter::getFilteredStacktrace($e, false), $e
      ->getMessage(), $test);
    $this->currentTestPass = false;
  }

  /**
   * Incomplete test.
   *
   * @param PHPUnit_Framework_Test $test
   * @param Exception              $e
   * @param float                  $time
   */
  public function addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, $time) {
    $this
      ->writeCase('error', $time, PHPUnit_Util_Filter::getFilteredStacktrace($e, false), 'Incomplete Test: ' . $e
      ->getMessage(), $test);
    $this->currentTestPass = false;
  }

  /**
   * 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
      ->writeCase('error', $time, PHPUnit_Util_Filter::getFilteredStacktrace($e, false), 'Risky Test: ' . $e
      ->getMessage(), $test);
    $this->currentTestPass = false;
  }

  /**
   * Skipped test.
   *
   * @param PHPUnit_Framework_Test $test
   * @param Exception              $e
   * @param float                  $time
   */
  public function addSkippedTest(PHPUnit_Framework_Test $test, Exception $e, $time) {
    $this
      ->writeCase('error', $time, PHPUnit_Util_Filter::getFilteredStacktrace($e, false), 'Skipped Test: ' . $e
      ->getMessage(), $test);
    $this->currentTestPass = false;
  }

  /**
   * A testsuite started.
   *
   * @param PHPUnit_Framework_TestSuite $suite
   */
  public function startTestSuite(PHPUnit_Framework_TestSuite $suite) {
    $this->currentTestSuiteName = $suite
      ->getName();
    $this->currentTestName = '';
    $this
      ->write(array(
      'event' => 'suiteStart',
      'suite' => $this->currentTestSuiteName,
      'tests' => count($suite),
    ));
  }

  /**
   * A testsuite ended.
   *
   * @param PHPUnit_Framework_TestSuite $suite
   */
  public function endTestSuite(PHPUnit_Framework_TestSuite $suite) {
    $this->currentTestSuiteName = '';
    $this->currentTestName = '';
  }

  /**
   * A test started.
   *
   * @param PHPUnit_Framework_Test $test
   */
  public function startTest(PHPUnit_Framework_Test $test) {
    $this->currentTestName = PHPUnit_Util_Test::describe($test);
    $this->currentTestPass = true;
    $this
      ->write(array(
      'event' => 'testStart',
      'suite' => $this->currentTestSuiteName,
      'test' => $this->currentTestName,
    ));
  }

  /**
   * A test ended.
   *
   * @param PHPUnit_Framework_Test $test
   * @param float                  $time
   */
  public function endTest(PHPUnit_Framework_Test $test, $time) {
    if ($this->currentTestPass) {
      $this
        ->writeCase('pass', $time, array(), '', $test);
    }
  }

  /**
   * @param string                          $status
   * @param float                           $time
   * @param array                           $trace
   * @param string                          $message
   * @param PHPUnit_Framework_TestCase|null $test
   */
  protected function writeCase($status, $time, array $trace = array(), $message = '', $test = null) {
    $output = '';

    // take care of TestSuite producing error (e.g. by running into exception) as TestSuite doesn't have hasOutput
    if ($test !== null && method_exists($test, 'hasOutput') && $test
      ->hasOutput()) {
      $output = $test
        ->getActualOutput();
    }
    $this
      ->write(array(
      'event' => 'test',
      'suite' => $this->currentTestSuiteName,
      'test' => $this->currentTestName,
      'status' => $status,
      'time' => $time,
      'trace' => $trace,
      'message' => PHPUnit_Util_String::convertToUtf8($message),
      'output' => $output,
    ));
  }

  /**
   * @param string $buffer
   */
  public function write($buffer) {
    array_walk_recursive($buffer, function (&$input) {
      if (is_string($input)) {
        $input = PHPUnit_Util_String::convertToUtf8($input);
      }
    });
    $flags = 0;
    if (defined('JSON_PRETTY_PRINT')) {
      $flags |= JSON_PRETTY_PRINT;
    }
    parent::write(json_encode($buffer, $flags));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PHPUnit_Util_Log_JSON::$currentTestName protected property
PHPUnit_Util_Log_JSON::$currentTestPass protected property
PHPUnit_Util_Log_JSON::$currentTestSuiteName protected property
PHPUnit_Util_Log_JSON::addError public function An error occurred. Overrides PHPUnit_Framework_TestListener::addError
PHPUnit_Util_Log_JSON::addFailure public function A failure occurred. Overrides PHPUnit_Framework_TestListener::addFailure
PHPUnit_Util_Log_JSON::addIncompleteTest public function Incomplete test. Overrides PHPUnit_Framework_TestListener::addIncompleteTest
PHPUnit_Util_Log_JSON::addRiskyTest public function Risky test. Overrides PHPUnit_Framework_TestListener::addRiskyTest
PHPUnit_Util_Log_JSON::addSkippedTest public function Skipped test. Overrides PHPUnit_Framework_TestListener::addSkippedTest
PHPUnit_Util_Log_JSON::endTest public function A test ended. Overrides PHPUnit_Framework_TestListener::endTest
PHPUnit_Util_Log_JSON::endTestSuite public function A testsuite ended. Overrides PHPUnit_Framework_TestListener::endTestSuite
PHPUnit_Util_Log_JSON::startTest public function A test started. Overrides PHPUnit_Framework_TestListener::startTest
PHPUnit_Util_Log_JSON::startTestSuite public function A testsuite started. Overrides PHPUnit_Framework_TestListener::startTestSuite
PHPUnit_Util_Log_JSON::write public function Overrides PHPUnit_Util_Printer::write
PHPUnit_Util_Log_JSON::writeCase protected function
PHPUnit_Util_Printer::$autoFlush protected property If true, flush output after every write.
PHPUnit_Util_Printer::$out protected property
PHPUnit_Util_Printer::$outTarget protected property
PHPUnit_Util_Printer::$printsHTML protected property 1
PHPUnit_Util_Printer::flush public function Flush buffer, optionally tidy up HTML, and close output if it's not to a php stream 2
PHPUnit_Util_Printer::getAutoFlush public function Check auto-flush mode.
PHPUnit_Util_Printer::incrementalFlush public function Performs a safe, incremental flush.
PHPUnit_Util_Printer::setAutoFlush public function Set auto-flushing mode.
PHPUnit_Util_Printer::__construct public function Constructor. 4