JSON.php in Zircon Profile 8

File

vendor/phpunit/phpunit/src/Util/Log/JSON.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.
 */

/**
 * A TestListener that generates JSON messages.
 *
 * @since Class available since Release 3.0.0
 */
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));
  }

}

Classes

Name	Description
PHPUnit_Util_Log_JSON	A TestListener that generates JSON messages.