tests/PHPUnit/Runner/IncludePathTestCollector.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/Util/Filter.php';
  48 require_once 'PHPUnit/Runner/TestCollector.php';
  49 require_once 'PHPUnit/Util/FilterIterator.php';
  50
  51 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  52
  53 /**
  54  * A test collector that collects tests from one or more directories
  55  * recursively. If no directories are specified, the include_path is searched.
  56  *
  57  * <code>
  58  * $testCollector = new PHPUnit_Runner_IncludePathTestCollector(
  59  *   array('/path/to/*Test.php files')
  60  * );
  61  *
  62  * $suite = new PHPUnit_Framework_TestSuite('My Test Suite');
  63  * $suite->addTestFiles($testCollector->collectTests());
  64  * </code>
  65  *
  66  * @category   Testing
  67  * @package    PHPUnit
  68  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  69  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  70  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  71  * @version    Release: 3.3.17
  72  * @link       http://www.phpunit.de/
  73  * @since      Class available since Release 2.1.0
  74  */
  75 class PHPUnit_Runner_IncludePathTestCollector implements PHPUnit_Runner_TestCollector
  76 {
  77     /**
  78      * @var    string
  79      */
  80     protected $filterIterator;
  81
  82     /**
  83      * @var    array
  84      */
  85     protected $paths;
  86
  87     /**
  88      * @var    string
  89      */
  90     protected $suffix;
  91
  92     /**
  93      * @param  array  $paths
  94      * @param  string $suffix
  95      */
  96     public function __construct(array $paths = array(), $suffix = 'Test.php')
  97     {
  98         if (!empty($paths)) {
  99             $this->paths = $paths;
 100         } else {
 101             $this->paths = explode(PATH_SEPARATOR, get_include_path());
 102         }
 103
 104         $this->suffix = $suffix;
 105     }
 106
 107     /**
 108      * @return array
 109      */
 110     public function collectTests()
 111     {
 112         $pathIterator = new AppendIterator;
 113         $result       = array();
 114
 115         foreach ($this->paths as $path) {
 116             $pathIterator->append(
 117               new RecursiveIteratorIterator(
 118                 new RecursiveDirectoryIterator($path)
 119               )
 120             );
 121         }
 122
 123         $filterIterator = new PHPUnit_Util_FilterIterator(
 124           $pathIterator, $this->suffix
 125         );
 126
 127         if ($this->filterIterator !== NULL) {
 128             $class          = new ReflectionClass($this->filterIterator);
 129             $filterIterator = $class->newInstance($filterIterator);
 130         }
 131
 132         return $filterIterator;
 133     }
 134
 135     /**
 136      * Adds a FilterIterator to filter the source files to be collected.
 137      *
 138      * @param  string $filterIterator
 139      * @throws InvalidArgumentException
 140      */
 141     public function setFilterIterator($filterIterator)
 142     {
 143         if (is_string($filterIterator) && class_exists($filterIterator)) {
 144             try {
 145                 $class = new ReflectionClass($filterIterator);
 146
 147                 if ($class->isSubclassOf('FilterIterator')) {
 148                     $this->filterIterator = $filterIterator;
 149                 }
 150             }
 151
 152             catch (ReflectionException $e) {
 153                 throw new InvalidArgumentException;
 154             }
 155         } else {
 156             throw new InvalidArgumentException;
 157         }
 158     }
 159 }
 160 ?>