tests/PHPUnit/Extensions/RepeatedTest.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/Extensions/TestDecorator.php';
  49 require_once 'PHPUnit/Util/Filter.php';
  50
  51 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  52
  53 /**
  54  * A Decorator that runs a test repeatedly.
  55  *
  56  * @category   Testing
  57  * @package    PHPUnit
  58  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  59  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  60  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  61  * @version    Release: 3.3.17
  62  * @link       http://www.phpunit.de/
  63  * @since      Class available since Release 2.0.0
  64  */
  65 class PHPUnit_Extensions_RepeatedTest extends PHPUnit_Extensions_TestDecorator
  66 {
  67     /**
  68      * @var    mixed
  69      */
  70     protected $filter = FALSE;
  71
  72     /**
  73      * @var    array
  74      */
  75     protected $groups = array();
  76
  77     /**
  78      * @var    array
  79      */
  80     protected $excludeGroups = array();
  81
  82     /**
  83      * @var    integer
  84      */
  85     protected $timesRepeat = 1;
  86
  87     /**
  88      * Constructor.
  89      *
  90      * @param  PHPUnit_Framework_Test $test
  91      * @param  integer                $timesRepeat
  92      * @param  mixed                  $filter
  93      * @param  array                  $groups
  94      * @param  array                  $excludeGroups
  95      * @throws InvalidArgumentException
  96      */
  97     public function __construct(PHPUnit_Framework_Test $test, $timesRepeat = 1, $filter = FALSE, array $groups = array(), array $excludeGroups = array())
  98     {
  99         parent::__construct($test);
 100
 101         if (is_integer($timesRepeat) &&
 102             $timesRepeat >= 0) {
 103             $this->timesRepeat = $timesRepeat;
 104         } else {
 105             throw new InvalidArgumentException(
 106               'Argument 2 must be a positive integer.'
 107             );
 108         }
 109
 110         $this->filter        = $filter;
 111         $this->groups        = $groups;
 112         $this->excludeGroups = $excludeGroups;
 113     }
 114
 115     /**
 116      * Counts the number of test cases that
 117      * will be run by this test.
 118      *
 119      * @return integer
 120      */
 121     public function count()
 122     {
 123         return $this->timesRepeat * count($this->test);
 124     }
 125
 126     /**
 127      * Runs the decorated test and collects the
 128      * result in a TestResult.
 129      *
 130      * @param  PHPUnit_Framework_TestResult $result
 131      * @return PHPUnit_Framework_TestResult
 132      * @throws InvalidArgumentException
 133      */
 134     public function run(PHPUnit_Framework_TestResult $result = NULL)
 135     {
 136         if ($result === NULL) {
 137             $result = $this->createResult();
 138         }
 139
 140         for ($i = 0; $i < $this->timesRepeat && !$result->shouldStop(); $i++) {
 141             if ($this->test instanceof PHPUnit_Framework_TestSuite) {
 142                 $this->test->run(
 143                   $result, $this->filter, $this->groups, $this->excludeGroups
 144                 );
 145             } else {
 146                 $this->test->run($result);
 147             }
 148         }
 149
 150         return $result;
 151     }
 152 }
 153 ?>