Drupal 8.0.0 beta 12. More info: https://www.drupal.org/node/2514176
This commit is contained in:
Pantheon Automation
Greg Anderson
commit
9921556621
13277 changed files with 1459781 additions and 0 deletions
455
core/modules/simpletest/src/TestDiscovery.php
Normal file
455
core/modules/simpletest/src/TestDiscovery.php
Normal file
|
|
@ -0,0 +1,455 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* Contains \Drupal\simpletest\TestDiscovery.
|
||||
*/
|
||||
|
||||
namespace Drupal\simpletest;
|
||||
|
||||
use Doctrine\Common\Annotations\SimpleAnnotationReader;
|
||||
use Doctrine\Common\Reflection\StaticReflectionParser;
|
||||
use Drupal\Component\Annotation\Reflection\MockFileFinder;
|
||||
use Drupal\Component\Utility\Unicode;
|
||||
use Drupal\Core\Cache\CacheBackendInterface;
|
||||
use Drupal\Core\Extension\ExtensionDiscovery;
|
||||
use Drupal\simpletest\Exception\MissingGroupException;
|
||||
use PHPUnit_Util_Test;
|
||||
|
||||
/**
|
||||
* Discovers available tests.
|
||||
*/
|
||||
class TestDiscovery {
|
||||
|
||||
/**
|
||||
* The class loader.
|
||||
*
|
||||
* @var \Composer\Autoload\ClassLoader
|
||||
*/
|
||||
protected $classLoader;
|
||||
|
||||
/**
|
||||
* Backend for caching discovery results.
|
||||
*
|
||||
* @var \Drupal\Core\Cache\CacheBackendInterface
|
||||
*/
|
||||
protected $cacheBackend;
|
||||
|
||||
/**
|
||||
* Cached map of all test namespaces to respective directories.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $testNamespaces;
|
||||
|
||||
/**
|
||||
* Cached list of all available extension names, keyed by extension type.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $availableExtensions;
|
||||
|
||||
/**
|
||||
* Constructs a new test discovery.
|
||||
*
|
||||
* @param $class_loader
|
||||
* The class loader. Normally Composer's ClassLoader, as included by the
|
||||
* front controller, but may also be decorated; e.g.,
|
||||
* \Symfony\Component\ClassLoader\ApcClassLoader.
|
||||
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
|
||||
* (optional) Backend for caching discovery results.
|
||||
*/
|
||||
public function __construct($class_loader, CacheBackendInterface $cache_backend = NULL) {
|
||||
$this->classLoader = $class_loader;
|
||||
$this->cacheBackend = $cache_backend;
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers test namespaces of all available extensions.
|
||||
*
|
||||
* @return array
|
||||
* An associative array whose keys are PSR-4 namespace prefixes and whose
|
||||
* values are directory names.
|
||||
*/
|
||||
public function registerTestNamespaces() {
|
||||
if (isset($this->testNamespaces)) {
|
||||
return $this->testNamespaces;
|
||||
}
|
||||
$this->testNamespaces = array();
|
||||
|
||||
$existing = $this->classLoader->getPrefixesPsr4();
|
||||
|
||||
// Add PHPUnit test namespaces of Drupal core.
|
||||
$this->testNamespaces['Drupal\\Tests\\'] = [DRUPAL_ROOT . '/core/tests/Drupal/Tests'];
|
||||
$this->testNamespaces['Drupal\\FunctionalTests\\'] = [DRUPAL_ROOT . '/core/tests/Drupal/FunctionalTests'];
|
||||
|
||||
$this->availableExtensions = array();
|
||||
foreach ($this->getExtensions() as $name => $extension) {
|
||||
$this->availableExtensions[$extension->getType()][$name] = $name;
|
||||
|
||||
$base_path = DRUPAL_ROOT . '/' . $extension->getPath();
|
||||
|
||||
// Add namespace of disabled/uninstalled extensions.
|
||||
if (!isset($existing["Drupal\\$name\\"])) {
|
||||
$this->classLoader->addPsr4("Drupal\\$name\\", "$base_path/src");
|
||||
}
|
||||
// Add Simpletest test namespace.
|
||||
$this->testNamespaces["Drupal\\$name\\Tests\\"][] = "$base_path/src/Tests";
|
||||
|
||||
// Add PHPUnit test namespaces.
|
||||
$this->testNamespaces["Drupal\\Tests\\$name\\Unit\\"][] = "$base_path/tests/src/Unit";
|
||||
$this->testNamespaces["Drupal\\Tests\\$name\\Functional\\"][] = "$base_path/tests/src/Functional";
|
||||
}
|
||||
|
||||
foreach ($this->testNamespaces as $prefix => $paths) {
|
||||
$this->classLoader->addPsr4($prefix, $paths);
|
||||
}
|
||||
|
||||
return $this->testNamespaces;
|
||||
}
|
||||
|
||||
/**
|
||||
* Discovers all available tests in all extensions.
|
||||
*
|
||||
* @param string $extension
|
||||
* (optional) The name of an extension to limit discovery to; e.g., 'node'.
|
||||
*
|
||||
* @return array
|
||||
* An array of tests keyed by the first @group specified in each test's
|
||||
* PHPDoc comment block, and then keyed by class names. For example:
|
||||
* @code
|
||||
* $groups['block'] => array(
|
||||
* 'Drupal\block\Tests\BlockTest' => array(
|
||||
* 'name' => 'Drupal\block\Tests\BlockTest',
|
||||
* 'description' => 'Tests block UI CRUD functionality.',
|
||||
* 'group' => 'block',
|
||||
* ),
|
||||
* );
|
||||
* @endcode
|
||||
*
|
||||
* @throws \ReflectionException
|
||||
* If a discovered test class does not match the expected class name.
|
||||
*
|
||||
* @todo Remove singular grouping; retain list of groups in 'group' key.
|
||||
* @see https://www.drupal.org/node/2296615
|
||||
* @todo Add base class groups 'Kernel' + 'Web', complementing 'PHPUnit'.
|
||||
*/
|
||||
public function getTestClasses($extension = NULL) {
|
||||
$reader = new SimpleAnnotationReader();
|
||||
$reader->addNamespace('Drupal\\simpletest\\Annotation');
|
||||
|
||||
if (!isset($extension)) {
|
||||
if ($this->cacheBackend && $cache = $this->cacheBackend->get('simpletest:discovery:classes')) {
|
||||
return $cache->data;
|
||||
}
|
||||
}
|
||||
$list = array();
|
||||
|
||||
$classmap = $this->findAllClassFiles($extension);
|
||||
|
||||
// Prevent expensive class loader lookups for each reflected test class by
|
||||
// registering the complete classmap of test classes to the class loader.
|
||||
// This also ensures that test classes are loaded from the discovered
|
||||
// pathnames; a namespace/classname mismatch will throw an exception.
|
||||
$this->classLoader->addClassMap($classmap);
|
||||
|
||||
foreach ($classmap as $classname => $pathname) {
|
||||
$finder = MockFileFinder::create($pathname);
|
||||
$parser = new StaticReflectionParser($classname, $finder, TRUE);
|
||||
try {
|
||||
$info = static::getTestInfo($classname, $parser->getDocComment());
|
||||
}
|
||||
catch (MissingGroupException $e) {
|
||||
// If the class name ends in Test and is not a migrate table dump.
|
||||
if (preg_match('/Test$/', $classname) && strpos($classname, 'migrate_drupal\Tests\Table') === FALSE) {
|
||||
throw $e;
|
||||
}
|
||||
// If the class is @group annotation just skip it. Most likely it is an
|
||||
// abstract class, trait or test fixture.
|
||||
continue;
|
||||
}
|
||||
// Skip this test class if it requires unavailable modules.
|
||||
// @todo PHPUnit skips tests with unmet requirements when executing a test
|
||||
// (instead of excluding them upfront). Refactor test runner to follow
|
||||
// that approach.
|
||||
// @see https://www.drupal.org/node/1273478
|
||||
if (!empty($info['requires']['module'])) {
|
||||
if (array_diff($info['requires']['module'], $this->availableExtensions['module'])) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
$list[$info['group']][$classname] = $info;
|
||||
}
|
||||
|
||||
// Sort the groups and tests within the groups by name.
|
||||
uksort($list, 'strnatcasecmp');
|
||||
foreach ($list as &$tests) {
|
||||
uksort($tests, 'strnatcasecmp');
|
||||
}
|
||||
|
||||
// Allow modules extending core tests to disable originals.
|
||||
\Drupal::moduleHandler()->alter('simpletest', $list);
|
||||
|
||||
if (!isset($extension)) {
|
||||
if ($this->cacheBackend) {
|
||||
$this->cacheBackend->set('simpletest:discovery:classes', $list);
|
||||
}
|
||||
}
|
||||
return $list;
|
||||
}
|
||||
|
||||
/**
|
||||
* Discovers all class files in all available extensions.
|
||||
*
|
||||
* @param string $extension
|
||||
* (optional) The name of an extension to limit discovery to; e.g., 'node'.
|
||||
*
|
||||
* @return array
|
||||
* A classmap containing all discovered class files; i.e., a map of
|
||||
* fully-qualified classnames to pathnames.
|
||||
*/
|
||||
public function findAllClassFiles($extension = NULL) {
|
||||
$classmap = array();
|
||||
$namespaces = $this->registerTestNamespaces();
|
||||
if (isset($extension)) {
|
||||
// Include tests in the \Drupal\Tests\{$extension} namespace.
|
||||
$pattern = "/Drupal\\\(Tests\\\)?$extension\\\/";
|
||||
$namespaces = array_intersect_key($namespaces, array_flip(preg_grep($pattern, array_keys($namespaces))));
|
||||
}
|
||||
foreach ($namespaces as $namespace => $paths) {
|
||||
foreach ($paths as $path) {
|
||||
if (!is_dir($path)) {
|
||||
continue;
|
||||
}
|
||||
$classmap += static::scanDirectory($namespace, $path);
|
||||
}
|
||||
}
|
||||
return $classmap;
|
||||
}
|
||||
|
||||
/**
|
||||
* Scans a given directory for class files.
|
||||
*
|
||||
* @param string $namespace_prefix
|
||||
* The namespace prefix to use for discovered classes. Must contain a
|
||||
* trailing namespace separator (backslash).
|
||||
* For example: 'Drupal\\node\\Tests\\'
|
||||
* @param string $path
|
||||
* The directory path to scan.
|
||||
* For example: '/path/to/drupal/core/modules/node/tests/src'
|
||||
*
|
||||
* @return array
|
||||
* An associative array whose keys are fully-qualified class names and whose
|
||||
* values are corresponding filesystem pathnames.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* If $namespace_prefix does not end in a namespace separator (backslash).
|
||||
*
|
||||
* @todo Limit to '*Test.php' files (~10% less files to reflect/introspect).
|
||||
* @see https://www.drupal.org/node/2296635
|
||||
*/
|
||||
public static function scanDirectory($namespace_prefix, $path) {
|
||||
if (substr($namespace_prefix, -1) !== '\\') {
|
||||
throw new \InvalidArgumentException("Namespace prefix for $path must contain a trailing namespace separator.");
|
||||
}
|
||||
$flags = \FilesystemIterator::UNIX_PATHS;
|
||||
$flags |= \FilesystemIterator::SKIP_DOTS;
|
||||
$flags |= \FilesystemIterator::FOLLOW_SYMLINKS;
|
||||
$flags |= \FilesystemIterator::CURRENT_AS_SELF;
|
||||
|
||||
$iterator = new \RecursiveDirectoryIterator($path, $flags);
|
||||
$filter = new \RecursiveCallbackFilterIterator($iterator, function ($current, $key, $iterator) {
|
||||
if ($iterator->hasChildren()) {
|
||||
return TRUE;
|
||||
}
|
||||
return $current->isFile() && $current->getExtension() === 'php';
|
||||
});
|
||||
$files = new \RecursiveIteratorIterator($filter);
|
||||
$classes = array();
|
||||
foreach ($files as $fileinfo) {
|
||||
$class = $namespace_prefix;
|
||||
if ('' !== $subpath = $fileinfo->getSubPath()) {
|
||||
$class .= strtr($subpath, '/', '\\') . '\\';
|
||||
}
|
||||
$class .= $fileinfo->getBasename('.php');
|
||||
$classes[$class] = $fileinfo->getPathname();
|
||||
}
|
||||
return $classes;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves information about a test class for UI purposes.
|
||||
*
|
||||
* @param string $class
|
||||
* The test classname.
|
||||
* @param string $doc_comment
|
||||
* (optional) The class PHPDoc comment. If not passed in reflection will be
|
||||
* used but this is very expensive when parsing all the test classes.
|
||||
*
|
||||
* @return array
|
||||
* An associative array containing:
|
||||
* - name: The test class name.
|
||||
* - description: The test (PHPDoc) summary.
|
||||
* - group: The test's first @group (parsed from PHPDoc annotations).
|
||||
* - requires: An associative array containing test requirements parsed from
|
||||
* PHPDoc annotations:
|
||||
* - module: List of Drupal module extension names the test depends on.
|
||||
*
|
||||
* @throws \Drupal\simpletest\Exception\MissingGroupException
|
||||
* If the class does not have a @group annotation.
|
||||
*/
|
||||
public static function getTestInfo($classname, $doc_comment = NULL) {
|
||||
if (!$doc_comment) {
|
||||
$reflection = new \ReflectionClass($classname);
|
||||
$doc_comment = $reflection->getDocComment();
|
||||
}
|
||||
$info = array(
|
||||
'name' => $classname,
|
||||
);
|
||||
$annotations = array();
|
||||
// Look for annotations, allow an arbitrary amount of spaces before the
|
||||
// * but nothing else.
|
||||
preg_match_all('/^[ ]*\* \@([^\s]*) (.*$)/m', $doc_comment, $matches);
|
||||
if (isset($matches[1])) {
|
||||
foreach ($matches[1] as $key => $annotation) {
|
||||
if (!empty($annotations[$annotation])) {
|
||||
// Only have the first match per annotation. This deals with
|
||||
// multiple @group annotations.
|
||||
continue;
|
||||
}
|
||||
$annotations[$annotation] = $matches[2][$key];
|
||||
}
|
||||
}
|
||||
|
||||
if (empty($annotations['group'])) {
|
||||
// Concrete tests must have a group.
|
||||
throw new MissingGroupException(sprintf('Missing @group annotation in %s', $classname));
|
||||
}
|
||||
// Force all PHPUnit tests into the same group.
|
||||
if (static::isUnitTest($classname)) {
|
||||
$info['group'] = 'PHPUnit';
|
||||
}
|
||||
else {
|
||||
$info['group'] = $annotations['group'];
|
||||
}
|
||||
|
||||
if (!empty($annotations['coversDefaultClass'])) {
|
||||
$info['description'] = 'Tests ' . $annotations['coversDefaultClass'] . '.';
|
||||
}
|
||||
else {
|
||||
$info['description'] = static::parseTestClassSummary($doc_comment);
|
||||
}
|
||||
if (isset($annotations['dependencies'])) {
|
||||
$info['requires']['module'] = array_map('trim', explode(',', $annotations['dependencies']));
|
||||
}
|
||||
|
||||
return $info;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses the phpDoc summary line of a test class.
|
||||
*
|
||||
* @param string $doc_comment.
|
||||
*
|
||||
* @return string
|
||||
* The parsed phpDoc summary line. An empty string is returned if no summary
|
||||
* line can be parsed.
|
||||
*/
|
||||
public static function parseTestClassSummary($doc_comment) {
|
||||
// Normalize line endings.
|
||||
$doc_comment = preg_replace('/\r\n|\r/', '\n', $doc_comment);
|
||||
// Strip leading and trailing doc block lines.
|
||||
$doc_comment = substr($doc_comment, 4, -4);
|
||||
|
||||
$lines = explode("\n", $doc_comment);
|
||||
$summary = [];
|
||||
// Add every line to the summary until the first empty line or annotation
|
||||
// is found.
|
||||
foreach ($lines as $line) {
|
||||
if (preg_match('/^[ ]*\*$/', $line) || preg_match('/^[ ]*\* \@/', $line)) {
|
||||
break;
|
||||
}
|
||||
$summary[] = trim($line, ' *');
|
||||
}
|
||||
return implode(' ', $summary);
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses annotations in the phpDoc of a test class.
|
||||
*
|
||||
* @param \ReflectionClass $class
|
||||
* The reflected test class.
|
||||
*
|
||||
* @return array
|
||||
* An associative array that contains all annotations on the test class;
|
||||
* typically including:
|
||||
* - group: A list of @group values.
|
||||
* - requires: An associative array of @requires values; e.g.:
|
||||
* - module: A list of Drupal module dependencies that are required to
|
||||
* exist.
|
||||
*
|
||||
* @see PHPUnit_Util_Test::parseTestMethodAnnotations()
|
||||
* @see http://phpunit.de/manual/current/en/incomplete-and-skipped-tests.html#incomplete-and-skipped-tests.skipping-tests-using-requires
|
||||
*/
|
||||
public static function parseTestClassAnnotations(\ReflectionClass $class) {
|
||||
$annotations = PHPUnit_Util_Test::parseTestMethodAnnotations($class->getName())['class'];
|
||||
|
||||
// @todo Enhance PHPUnit upstream to allow for custom @requires identifiers.
|
||||
// @see PHPUnit_Util_Test::getRequirements()
|
||||
// @todo Add support for 'PHP', 'OS', 'function', 'extension'.
|
||||
// @see https://www.drupal.org/node/1273478
|
||||
if (isset($annotations['requires'])) {
|
||||
foreach ($annotations['requires'] as $i => $value) {
|
||||
list($type, $value) = explode(' ', $value, 2);
|
||||
if ($type === 'module') {
|
||||
$annotations['requires']['module'][$value] = $value;
|
||||
unset($annotations['requires'][$i]);
|
||||
}
|
||||
}
|
||||
}
|
||||
return $annotations;
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines if the provided classname is a unit test.
|
||||
*
|
||||
* @param $classname
|
||||
* The test classname.
|
||||
*
|
||||
* @return bool
|
||||
* TRUE if the class is a unit test. FALSE if not.
|
||||
*/
|
||||
public static function isUnitTest($classname) {
|
||||
if (strpos($classname, 'Drupal\\Tests\\') === 0) {
|
||||
$namespace = explode('\\', $classname);
|
||||
$first_letter = Unicode::substr($namespace[2], 0, 1);
|
||||
if (Unicode::strtoupper($first_letter) === $first_letter) {
|
||||
// A core unit test.
|
||||
return TRUE;
|
||||
}
|
||||
elseif ($namespace[3] == 'Unit') {
|
||||
// A module unit test.
|
||||
return TRUE;
|
||||
}
|
||||
}
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns all available extensions.
|
||||
*
|
||||
* @return \Drupal\Core\Extension\Extension[]
|
||||
* An array of Extension objects, keyed by extension name.
|
||||
*/
|
||||
protected function getExtensions() {
|
||||
$listing = new ExtensionDiscovery(DRUPAL_ROOT);
|
||||
// Ensure that tests in all profiles are discovered.
|
||||
$listing->setProfileDirectories(array());
|
||||
$extensions = $listing->scan('module', TRUE);
|
||||
$extensions += $listing->scan('profile', TRUE);
|
||||
$extensions += $listing->scan('theme', TRUE);
|
||||
return $extensions;
|
||||
}
|
||||
|
||||
}
|
||||
Reference in a new issue