tests/PHPUnit/Extensions/TestDecorator.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.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  * @category   Testing
  38  * @package    PHPUnit
  39  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 2.0.0
  45  */
  46
  47 require_once 'PHPUnit/Framework.php';
  48 require_once 'PHPUnit/Util/Filter.php';
  49
  50 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  51
  52 /**
  53  * A Decorator for Tests.
  54  *
  55  * Use TestDecorator as the base class for defining new
  56  * test decorators. Test decorator subclasses can be introduced
  57  * to add behaviour before or after a test is run.
  58  *
  59  * @category   Testing
  60  * @package    PHPUnit
  61  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  62  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  63  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  64  * @version    Release: 3.3.17
  65  * @link       http://www.phpunit.de/
  66  * @since      Class available since Release 2.0.0
  67  */
  68 class PHPUnit_Extensions_TestDecorator extends PHPUnit_Framework_Assert implements PHPUnit_Framework_Test, PHPUnit_Framework_SelfDescribing
  69 {
  70     /**
  71      * The Test to be decorated.
  72      *
  73      * @var    object
  74      */
  75     protected $test = NULL;
  76
  77     /**
  78      * Constructor.
  79      *
  80      * @param  PHPUnit_Framework_Test $test
  81      */
  82     public function __construct(PHPUnit_Framework_Test $test)
  83     {
  84         $this->test = $test;
  85     }
  86
  87     /**
  88      * Returns a string representation of the test.
  89      *
  90      * @return string
  91      */
  92     public function toString()
  93     {
  94         return $this->test->toString();
  95     }
  96
  97     /**
  98      * Runs the test and collects the
  99      * result in a TestResult.
 100      *
 101      * @param  PHPUnit_Framework_TestResult $result
 102      */
 103     public function basicRun(PHPUnit_Framework_TestResult $result)
 104     {
 105         $this->test->run($result);
 106     }
 107
 108     /**
 109      * Counts the number of test cases that
 110      * will be run by this test.
 111      *
 112      * @return integer
 113      */
 114     public function count()
 115     {
 116         return count($this->test);
 117     }
 118
 119     /**
 120      * Creates a default TestResult object.
 121      *
 122      * @return PHPUnit_Framework_TestResult
 123      */
 124     protected function createResult()
 125     {
 126         return new PHPUnit_Framework_TestResult;
 127     }
 128
 129     /**
 130      * Returns the test to be run.
 131      *
 132      * @return PHPUnit_Framework_Test
 133      */
 134     public function getTest()
 135     {
 136         return $this->test;
 137     }
 138
 139     /**
 140      * Runs the decorated test and collects the
 141      * result in a TestResult.
 142      *
 143      * @param  PHPUnit_Framework_TestResult $result
 144      * @return PHPUnit_Framework_TestResult
 145      * @throws InvalidArgumentException
 146      */
 147     public function run(PHPUnit_Framework_TestResult $result = NULL)
 148     {
 149         if ($result === NULL) {
 150             $result = $this->createResult();
 151         }
 152
 153         $this->basicRun($result);
 154
 155         return $result;
 156     }
 157 }
 158 ?>