tests/PHPUnit/Extensions/PerformanceTestCase.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.1.0
  45  */
  46
  47 require_once 'PHPUnit/Framework.php';
  48 require_once 'PHPUnit/Util/Filter.php';
  49 require_once 'PHPUnit/Util/Timer.php';
  50
  51 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  52
  53 /**
  54  * A TestCase that expects a TestCase to be executed
  55  * meeting a given time limit.
  56  *
  57  * @category   Testing
  58  * @package    PHPUnit
  59  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  60  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  61  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  62  * @version    Release: 3.3.17
  63  * @link       http://www.phpunit.de/
  64  * @since      Class available since Release 2.1.0
  65  */
  66 abstract class PHPUnit_Extensions_PerformanceTestCase extends PHPUnit_Framework_TestCase
  67 {
  68     /**
  69      * @var    integer
  70      */
  71     protected $maxRunningTime = 0;
  72
  73     /**
  74      */
  75     protected function runTest()
  76     {
  77         PHPUnit_Util_Timer::start();
  78         parent::runTest();
  79         $time = PHPUnit_Util_Timer::stop();
  80
  81         if ($this->maxRunningTime != 0 &&
  82             $time > $this->maxRunningTime) {
  83             $this->fail(
  84               sprintf(
  85                 'expected running time: <= %s but was: %s',
  86
  87                 $this->maxRunningTime,
  88                 $time
  89               )
  90             );
  91         }
  92     }
  93
  94     /**
  95      * @param  integer $maxRunningTime
  96      * @throws InvalidArgumentException
  97      * @since  Method available since Release 2.3.0
  98      */
  99     public function setMaxRunningTime($maxRunningTime)
 100     {
 101         if (is_integer($maxRunningTime) &&
 102             $maxRunningTime >= 0) {
 103             $this->maxRunningTime = $maxRunningTime;
 104         } else {
 105             throw new InvalidArgumentException;
 106         }
 107     }
 108
 109     /**
 110      * @return integer
 111      * @since  Method available since Release 2.3.0
 112      */
 113     public function getMaxRunningTime()
 114     {
 115         return $this->maxRunningTime;
 116     }
 117 }
 118 ?>