/library/PHPUnit/Runner/IncludePathTestCollector.php

https://github.com/grjones/qframe · PHP · 166 lines · 57 code · 15 blank · 94 comment · 7 complexity · 021121b1d27c17192f07b93e84f0e183 MD5 · raw file

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