class PHPUnit_Util_Log_JSON

A TestListener that generates JSON messages.

@package PHPUnit @subpackage Util_Log @author Sebastian Bergmann <sebastian@phpunit.de> @copyright 2001-2013 Sebastian Bergmann <sebastian@phpunit.de> @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License @link http://www.phpunit.de/ @since Class available since Release 3.0.0

Hierarchy

Expanded class hierarchy of PHPUnit_Util_Log_JSON

File

drupal/core/vendor/phpunit/phpunit/PHPUnit/Util/Log/JSON.php, line 57

View source
class PHPUnit_Util_Log_JSON extends PHPUnit_Util_Printer implements PHPUnit_Framework_TestListener {

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

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

  /**
   * @var     boolean
   * @access  private
   */
  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;
  }

  /**
   * 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
   */
  protected function writeCase($status, $time, array $trace = array(), $message = '', $test = NULL) {
    $output = '';
    if ($test !== NULL && $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) {
    if (defined('JSON_PRETTY_PRINT')) {
      parent::write(json_encode($buffer, JSON_PRETTY_PRINT));
    }
    else {
      parent::write(json_encode($buffer));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PHPUnit_Util_Log_JSON::$currentTestName protected property
PHPUnit_Util_Log_JSON::$currentTestPass protected property @access private
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::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