tests/PHPUnit/PHPUnit/Framework/TestListener.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2011, Sebastian Bergmann <sebastian@phpunit.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @package    PHPUnit
  38  * @subpackage Framework
  39  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  40  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42  * @link       http://www.phpunit.de/
  43  * @since      File available since Release 2.0.0
  44  */
  45
  46 /**
  47  * A Listener for test progress.
  48  *
  49  * @package    PHPUnit
  50  * @subpackage Framework
  51  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  52  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  53  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  54  * @version    Release: 3.5.13
  55  * @link       http://www.phpunit.de/
  56  * @since      Interface available since Release 2.0.0
  57  */
  58 interface PHPUnit_Framework_TestListener
  59 {
  60     /**
  61      * An error occurred.
  62      *
  63      * @param  PHPUnit_Framework_Test $test
  64      * @param  Exception              $e
  65      * @param  float                  $time
  66      */
  67     public function addError(PHPUnit_Framework_Test $test, Exception $e, $time);
  68
  69     /**
  70      * A failure occurred.
  71      *
  72      * @param  PHPUnit_Framework_Test                 $test
  73      * @param  PHPUnit_Framework_AssertionFailedError $e
  74      * @param  float                                  $time
  75      */
  76     public function addFailure(PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e, $time);
  77
  78     /**
  79      * Incomplete test.
  80      *
  81      * @param  PHPUnit_Framework_Test $test
  82      * @param  Exception              $e
  83      * @param  float                  $time
  84      */
  85     public function addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, $time);
  86
  87     /**
  88      * Skipped test.
  89      *
  90      * @param  PHPUnit_Framework_Test $test
  91      * @param  Exception              $e
  92      * @param  float                  $time
  93      * @since  Method available since Release 3.0.0
  94      */
  95     public function addSkippedTest(PHPUnit_Framework_Test $test, Exception $e, $time);
  96
  97     /**
  98      * A test suite started.
  99      *
 100      * @param  PHPUnit_Framework_TestSuite $suite
 101      * @since  Method available since Release 2.2.0
 102      */
 103     public function startTestSuite(PHPUnit_Framework_TestSuite $suite);
 104
 105     /**
 106      * A test suite ended.
 107      *
 108      * @param  PHPUnit_Framework_TestSuite $suite
 109      * @since  Method available since Release 2.2.0
 110      */
 111     public function endTestSuite(PHPUnit_Framework_TestSuite $suite);
 112
 113     /**
 114      * A test started.
 115      *
 116      * @param  PHPUnit_Framework_Test $test
 117      */
 118     public function startTest(PHPUnit_Framework_Test $test);
 119
 120     /**
 121      * A test ended.
 122      *
 123      * @param  PHPUnit_Framework_Test $test
 124      * @param  float                  $time
 125      */
 126     public function endTest(PHPUnit_Framework_Test $test, $time);
 127 }