www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/system/tests/src/Kernel/Common/SystemListingTest.php

   1 <?php
   2
   3 namespace Drupal\Tests\system\Kernel\Common;
   4
   5 use Drupal\Core\Extension\ExtensionDiscovery;
   6 use Drupal\KernelTests\KernelTestBase;
   7
   8 /**
   9  * Tests scanning system directories in drupal_system_listing().
  10  *
  11  * @group Common
  12  */
  13 class SystemListingTest extends KernelTestBase {
  14
  15   /**
  16    * Tests that files in different directories take precedence as expected.
  17    */
  18   public function testDirectoryPrecedence() {
  19     // Define the module files we will search for, and the directory precedence
  20     // we expect.
  21     $expected_directories = [
  22       // When both copies of the module are compatible with Drupal core, the
  23       // copy in the profile directory takes precedence.
  24       'drupal_system_listing_compatible_test' => [
  25         'core/profiles/testing/modules',
  26         'core/modules/system/tests/modules',
  27       ],
  28     ];
  29
  30     // This test relies on two versions of the same module existing in
  31     // different places in the filesystem. Without that, the test has no
  32     // meaning, so assert their presence first.
  33     foreach ($expected_directories as $module => $directories) {
  34       foreach ($directories as $directory) {
  35         $filename = "$directory/$module/$module.info.yml";
  36         $this->assertTrue(file_exists($this->root . '/' . $filename), format_string('@filename exists.', ['@filename' => $filename]));
  37       }
  38     }
  39
  40     // Now scan the directories and check that the files take precedence as
  41     // expected.
  42     $listing = new ExtensionDiscovery($this->root);
  43     $listing->setProfileDirectories(['core/profiles/testing']);
  44     $files = $listing->scan('module');
  45     foreach ($expected_directories as $module => $directories) {
  46       $expected_directory = array_shift($directories);
  47       $expected_uri = "$expected_directory/$module/$module.info.yml";
  48       $this->assertEqual($files[$module]->getPathname(), $expected_uri, format_string('Module @actual was found at @expected.', [
  49         '@actual' => $files[$module]->getPathname(),
  50         '@expected' => $expected_uri,
  51       ]));
  52     }
  53   }
  54
  55   /**
  56    * Tests that directories matching file_scan_ignore_directories are ignored
  57    */
  58   public function testFileScanIgnoreDirectory() {
  59     $listing = new ExtensionDiscovery($this->root, FALSE);
  60     $listing->setProfileDirectories(['core/profiles/testing']);
  61     $files = $listing->scan('module');
  62     $this->assertArrayHasKey('drupal_system_listing_compatible_test', $files);
  63
  64     // Reset the static to force a rescan of the directories.
  65     $reflected_class = new \ReflectionClass(ExtensionDiscovery::class);
  66     $reflected_property = $reflected_class->getProperty('files');
  67     $reflected_property->setAccessible(TRUE);
  68     $reflected_property->setValue($reflected_class, []);
  69
  70     $this->setSetting('file_scan_ignore_directories', ['drupal_system_listing_compatible_test']);
  71     $listing = new ExtensionDiscovery($this->root, FALSE);
  72     $listing->setProfileDirectories(['core/profiles/testing']);
  73     $files = $listing->scan('module');
  74     $this->assertArrayNotHasKey('drupal_system_listing_compatible_test', $files);
  75   }
  76
  77 }