tests/PHPUnit/PHPUnit/Runner/IncludePathTestCollector.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2011, Sebastian Bergmann <sebastian@phpunit.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  * @package    PHPUnit
  38  * @subpackage Runner
  39  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  40  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42  * @link       http://www.phpunit.de/
  43  * @since      File available since Release 2.1.0
  44  */
  45
  46 require_once 'File/Iterator/Factory.php';
  47
  48 /**
  49  * A test collector that collects tests from one or more directories
  50  * recursively. If no directories are specified, the include_path is searched.
  51  *
  52  * <code>
  53  * $testCollector = new PHPUnit_Runner_IncludePathTestCollector(
  54  *   array('/path/to/*Test.php files')
  55  * );
  56  *
  57  * $suite = new PHPUnit_Framework_TestSuite('My Test Suite');
  58  * $suite->addTestFiles($testCollector->collectTests());
  59  * </code>
  60  *
  61  * @package    PHPUnit
  62  * @subpackage Runner
  63  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  64  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  65  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  66  * @version    Release: 3.5.13
  67  * @link       http://www.phpunit.de/
  68  * @since      Class available since Release 2.1.0
  69  */
  70 class PHPUnit_Runner_IncludePathTestCollector implements PHPUnit_Runner_TestCollector
  71 {
  72     /**
  73      * @var string
  74      */
  75     protected $filterIterator;
  76
  77     /**
  78      * @var array
  79      */
  80     protected $paths;
  81
  82     /**
  83      * @var mixed
  84      */
  85     protected $suffixes;
  86
  87     /**
  88      * @var mixed
  89      */
  90     protected $prefixes;
  91
  92     /**
  93      * @param array $paths
  94      * @param mixed $suffixes
  95      * @param mixed $prefixes
  96      */
  97     public function __construct(array $paths = array(), $suffixes = array('Test.php', '.phpt'), $prefixes = array())
  98     {
  99         if (!empty($paths)) {
 100             $this->paths = $paths;
 101         } else {
 102             $this->paths = explode(PATH_SEPARATOR, get_include_path());
 103         }
 104
 105         $this->suffixes = $suffixes;
 106         $this->prefixes = $prefixes;
 107     }
 108
 109     /**
 110      * @return File_Iterator
 111      */
 112     public function collectTests()
 113     {
 114         $iterator = File_Iterator_Factory::getFileIterator(
 115           $this->paths, $this->suffixes, $this->prefixes
 116         );
 117
 118         if ($this->filterIterator !== NULL) {
 119             $class    = new ReflectionClass($this->filterIterator);
 120             $iterator = $class->newInstance($iterator);
 121         }
 122
 123         return $iterator;
 124     }
 125
 126     /**
 127      * Adds a FilterIterator to filter the source files to be collected.
 128      *
 129      * @param  string $filterIterator
 130      * @throws InvalidArgumentException
 131      */
 132     public function setFilterIterator($filterIterator)
 133     {
 134         if (is_string($filterIterator) && class_exists($filterIterator)) {
 135             $class = new ReflectionClass($filterIterator);
 136
 137             if ($class->isSubclassOf('FilterIterator')) {
 138                 $this->filterIterator = $filterIterator;
 139             }
 140         } else {
 141             throw PHPUnit_Util_InvalidArgumentHelper::factory(1, 'class name');
 142         }
 143     }
 144 }