RepeatedTest.php

<?php

/**
 * PHPUnit
 *
 * Copyright (c) 2001-2013, Sebastian Bergmann <sebastian@phpunit.de>.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the name of Sebastian Bergmann nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @package    PHPUnit
 * @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      File available since Release 2.0.0
 */

/**
 * A Decorator that runs a test repeatedly.
 *
 * @package    PHPUnit
 * @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 2.0.0
 */
class PHPUnit_Extensions_RepeatedTest extends PHPUnit_Extensions_TestDecorator {

  /**
   * @var mixed
   */
  protected $filter = FALSE;

  /**
   * @var array
   */
  protected $groups = array();

  /**
   * @var array
   */
  protected $excludeGroups = array();

  /**
   * @var boolean
   */
  protected $processIsolation = FALSE;

  /**
   * @var integer
   */
  protected $timesRepeat = 1;

  /**
   * Constructor.
   *
   * @param  PHPUnit_Framework_Test $test
   * @param  integer                $timesRepeat
   * @param  mixed                  $filter
   * @param  array                  $groups
   * @param  array                  $excludeGroups
   * @param  boolean                $processIsolation
   * @throws PHPUnit_Framework_Exception
   */
  public function __construct(PHPUnit_Framework_Test $test, $timesRepeat = 1, $filter = FALSE, array $groups = array(), array $excludeGroups = array(), $processIsolation = FALSE) {
    parent::__construct($test);
    if (is_integer($timesRepeat) && $timesRepeat >= 0) {
      $this->timesRepeat = $timesRepeat;
    }
    else {
      throw PHPUnit_Util_InvalidArgumentHelper::factory(2, 'positive integer');
    }
    $this->filter = $filter;
    $this->groups = $groups;
    $this->excludeGroups = $excludeGroups;
    $this->processIsolation = $processIsolation;
  }

  /**
   * Counts the number of test cases that
   * will be run by this test.
   *
   * @return integer
   */
  public function count() {
    return $this->timesRepeat * count($this->test);
  }

  /**
   * Runs the decorated test and collects the
   * result in a TestResult.
   *
   * @param  PHPUnit_Framework_TestResult $result
   * @return PHPUnit_Framework_TestResult
   * @throws PHPUnit_Framework_Exception
   */
  public function run(PHPUnit_Framework_TestResult $result = NULL) {
    if ($result === NULL) {
      $result = $this
        ->createResult();
    }

    //@codingStandardsIgnoreStart
    for ($i = 0; $i < $this->timesRepeat && !$result
      ->shouldStop(); $i++) {

      //@codingStandardsIgnoreEnd
      if ($this->test instanceof PHPUnit_Framework_TestSuite) {
        $this->test
          ->run($result, $this->filter, $this->groups, $this->excludeGroups, $this->processIsolation);
      }
      else {
        $this->test
          ->run($result);
      }
    }
    return $result;
  }

}