Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests\TestSuites;
Chris@0: 
Chris@0: use Drupal\simpletest\TestDiscovery;
Chris@14: use PHPUnit\Framework\TestSuite;
Chris@0: 
Chris@0: /**
Chris@0:  * Base class for Drupal test suites.
Chris@0:  */
Chris@14: abstract class TestSuiteBase extends TestSuite {
Chris@0: 
Chris@0:   /**
Chris@0:    * Finds extensions in a Drupal installation.
Chris@0:    *
Chris@0:    * An extension is defined as a directory with an *.info.yml file in it.
Chris@0:    *
Chris@0:    * @param string $root
Chris@0:    *   Path to the root of the Drupal installation.
Chris@0:    *
Chris@0:    * @return string[]
Chris@0:    *   Associative array of extension paths, with extension name as keys.
Chris@0:    */
Chris@0:   protected function findExtensionDirectories($root) {
Chris@0:     $extension_roots = \drupal_phpunit_contrib_extension_directory_roots($root);
Chris@0: 
Chris@0:     $extension_directories = array_map('drupal_phpunit_find_extension_directories', $extension_roots);
Chris@0:     return array_reduce($extension_directories, 'array_merge', []);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Find and add tests to the suite for core and any extensions.
Chris@0:    *
Chris@0:    * @param string $root
Chris@0:    *   Path to the root of the Drupal installation.
Chris@0:    * @param string $suite_namespace
Chris@0:    *   SubNamespace used to separate test suite. Examples: Unit, Functional.
Chris@0:    */
Chris@0:   protected function addTestsBySuiteNamespace($root, $suite_namespace) {
Chris@0:     // Core's tests are in the namespace Drupal\${suite_namespace}Tests\ and are
Chris@0:     // always inside of core/tests/Drupal/${suite_namespace}Tests. The exception
Chris@0:     // to this is Unit tests for historical reasons.
Chris@0:     if ($suite_namespace == 'Unit') {
Chris@14:       $tests = TestDiscovery::scanDirectory("Drupal\\Tests\\", "$root/core/tests/Drupal/Tests");
Chris@14:       $tests = array_flip(array_filter(array_flip($tests), function ($test_class) {
Chris@14:         // The Listeners directory does not contain tests. Use the class name
Chris@14:         // to be compatible with all operating systems.
Chris@14:         return !preg_match('/^Drupal\\\\Tests\\\\Listeners\\\\/', $test_class);
Chris@14:       }));
Chris@14:       $this->addTestFiles($tests);
Chris@0:     }
Chris@0:     else {
Chris@0:       $this->addTestFiles(TestDiscovery::scanDirectory("Drupal\\${suite_namespace}Tests\\", "$root/core/tests/Drupal/${suite_namespace}Tests"));
Chris@0:     }
Chris@0: 
Chris@0:     // Extensions' tests will always be in the namespace
Chris@0:     // Drupal\Tests\$extension_name\$suite_namespace\ and be in the
Chris@0:     // $extension_path/tests/src/$suite_namespace directory. Not all extensions
Chris@0:     // will have all kinds of tests.
Chris@0:     foreach ($this->findExtensionDirectories($root) as $extension_name => $dir) {
Chris@0:       $test_path = "$dir/tests/src/$suite_namespace";
Chris@0:       if (is_dir($test_path)) {
Chris@0:         $this->addTestFiles(TestDiscovery::scanDirectory("Drupal\\Tests\\$extension_name\\$suite_namespace\\", $test_path));
Chris@0:       }
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0: }