abstract class TestSuiteBase in Drupal driver for SQL Server and SQL Azure 4.1.x

Base class for Drupal test suites.

Hierarchy

• class \Drupal\Tests\sqlsrv\TestSuites\TestSuiteBase extends \PHPUnit\Framework\TestSuite

File

dev/TestSuites/TestSuiteBase.php, line 11

Namespace

Drupal\Tests\sqlsrv\TestSuites

abstract class TestSuiteBase extends TestSuite {

  /**
   * The failing test files.
   *
   * @var array
   */
  protected $failingClasses = [
    // Kernel Test Failures.
    '/core/tests/Drupal/KernelTests/Core/Database/SelectSubqueryTest.php',
    '/core/tests/Drupal/KernelTests/Core/Database/SchemaTest.php',
    '/core/modules/aggregator/tests/src/Kernel/Migrate/MigrateAggregatorStubTest.php',
    '/core/modules/migrate_drupal/tests/src/Kernel/d7/FieldDiscoveryTest.php',
    '/core/modules/field_ui/tests/src/Kernel/EntityDisplayTest.php',
    // Functional Test Failures.
    '/core/tests/Drupal/FunctionalTests/Installer/InstallerTranslationTest.php',
    '/core/modules/datetime/tests/src/Functional/Views/FilterDateTest.php',
    '/core/modules/language/tests/src/Functional/ConfigurableLanguageManagerTest.php',
    '/core/modules/locale/tests/src/Functional/LocaleLocaleLookupTest.php',
    '/core/modules/path/tests/src/Functional/PathAliasTest.php',
    '/core/modules/search/tests/src/Functional/SearchConfigSettingsFormTest.php',
    '/core/modules/system/tests/src/Functional/Module/InstallUninstallTest.php',
    '/core/modules/views_ui/tests/src/Functional/UnsavedPreviewTest.php',
  ];

  /**
   * Finds extensions in a Drupal installation.
   *
   * An extension is defined as a directory with an *.info.yml file in it.
   *
   * @param string $root
   *   Path to the root of the Drupal installation.
   *
   * @return string[]
   *   Associative array of extension paths, with extension name as keys.
   */
  protected function findExtensionDirectories($root) {
    $extension_roots = \drupal_phpunit_contrib_extension_directory_roots($root);
    $extension_directories = array_map('drupal_phpunit_find_extension_directories', $extension_roots);
    return array_reduce($extension_directories, 'array_merge', []);
  }

  /**
   * Find and add tests to the suite for core and any extensions.
   *
   * @param string $root
   *   Path to the root of the Drupal installation.
   * @param string $pattern
   *   Regex pattern to match to the test class name.
   */
  protected function addCoreKernelTestsByName($root, $pattern) {
    $failing_classes = [];
    foreach ($this->failingClasses as $failing_class) {
      $failing_classes[] = $root . $failing_class;
    }

    // Core's Kernel tests are in the namespace Drupal\KernelTests\ and are
    // always inside of core/tests/Drupal/KernelTests.
    $passing_tests = [];
    $tests = TestDiscovery::scanDirectory("Drupal\\KernelTests\\", "{$root}/core/tests/Drupal/KernelTests");
    foreach ($tests as $test) {
      if (!in_array($test, $failing_classes) && preg_match("#.*\\/{$pattern}[a-zA-z]*\\.php\$#i", $test) !== 0) {
        $passing_tests[] = $test;
      }
    }
    $this
      ->addTestFiles($passing_tests);
  }

  /**
   * Find and add tests to the suite for core and any extensions.
   *
   * @param string $root
   *   Path to the root of the Drupal installation.
   * @param string $suite_namespace
   *   SubNamespace used to separate test suite. Examples: Unit, Functional.
   * @param string $pattern
   *   REGEXP pattern to apply to file name.
   */
  protected function addExtensionTestsBySuiteNamespace($root, $suite_namespace, $pattern) {
    $failing_classes = [];
    foreach ($this->failingClasses as $failing_class) {
      $failing_classes[] = $root . $failing_class;
    }

    // Extensions' tests will always be in the namespace
    // Drupal\Tests\$extension_name\$suite_namespace\ and be in the
    // $extension_path/tests/src/$suite_namespace directory. Not all extensions
    // will have all kinds of tests.
    foreach ($this
      ->findExtensionDirectories($root) as $extension_name => $dir) {
      if (preg_match("#^{$pattern}(.*)\$#i", $extension_name) !== 0) {
        $test_path = "{$dir}/tests/src/{$suite_namespace}";
        if (is_dir($test_path)) {
          $passing_tests = [];
          $tests = TestDiscovery::scanDirectory("Drupal\\Tests\\{$extension_name}\\{$suite_namespace}\\", $test_path);
          foreach ($tests as $test) {
            if (!in_array($test, $failing_classes)) {
              $passing_tests[] = $test;
            }
          }
          $this
            ->addTestFiles($passing_tests);
        }
      }
    }
  }

  /**
   * Find and add tests to the suite for core and any extensions.
   *
   * @param string $root
   *   Path to the root of the Drupal installation.
   * @param string $suite_namespace
   *   SubNamespace used to separate test suite. Examples: Unit, Functional.
   * @param int $index
   *   The chunk number to test.
   */
  protected function addExtensionTestsBySuiteNamespaceAndChunk($root, $suite_namespace, $index = -1) {
    $failing_classes = [];
    foreach ($this->failingClasses as $failing_class) {
      $failing_classes[] = $root . $failing_class;
    }

    // Extensions' tests will always be in the namespace
    // Drupal\Tests\$extension_name\$suite_namespace\ and be in the
    // $extension_path/tests/src/$suite_namespace directory. Not all extensions
    // will have all kinds of tests.
    $passing_tests = [];
    foreach ($this
      ->findExtensionDirectories($root) as $extension_name => $dir) {
      $test_path = "{$dir}/tests/src/{$suite_namespace}";
      if (is_dir($test_path)) {
        $tests = TestDiscovery::scanDirectory("Drupal\\Tests\\{$extension_name}\\{$suite_namespace}\\", $test_path);
        foreach ($tests as $test) {
          if (!in_array($test, $failing_classes)) {
            $passing_tests[] = $test;
          }
        }
      }
    }
    $sizes = static::$functionalSizes;
    $total_size = array_sum($sizes);
    $total_tests = count($passing_tests);
    if ($index == -1) {
      $index = rand(0, count($sizes) - 1);
    }
    $length = $sizes[$index];
    $offset = $index == 0 ? 0 : array_sum(array_splice($sizes, 0, $index));
    $subset = array_splice($passing_tests, $offset, $length);
    $extend = max(0, $total_tests - $total_size);
    $message = "  SPLICE:" . $index . "  EXTEND:" . $extend . "  ";
    fwrite(STDOUT, $message);
    $this
      ->addTestFiles($subset);
  }

  /**
   * Get the path to webroot.
   *
   * @return string
   *   Path to webroot.
   */
  protected static function getDrupalRoot() {
    return dirname(__DIR__, 5);
  }

  /**
   * Fetch a subset of the Core Extension tests.
   *
   * @return static
   *   The test suite.
   */
  public static function getCoreExtensionSuite($index) {
    $root = static::getDrupalRoot();
    $suite = new static('kernel');
    $suite
      ->addExtensionTestsBySuiteNamespace($root, 'Kernel', static::$coreExtensionPatterns[$index]);
    return $suite;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
TestSuiteBase::$failingClasses	protected	property	The failing test files.
TestSuiteBase::addCoreKernelTestsByName	protected	function	Find and add tests to the suite for core and any extensions.
TestSuiteBase::addExtensionTestsBySuiteNamespace	protected	function	Find and add tests to the suite for core and any extensions.	1
TestSuiteBase::addExtensionTestsBySuiteNamespaceAndChunk	protected	function	Find and add tests to the suite for core and any extensions.
TestSuiteBase::findExtensionDirectories	protected	function	Finds extensions in a Drupal installation.
TestSuiteBase::getCoreExtensionSuite	public static	function	Fetch a subset of the Core Extension tests.
TestSuiteBase::getDrupalRoot	protected static	function	Get the path to webroot.