package_manager/tests/src/Kernel/PackageManagerKernelTestBase.php

@@ -245,6 +245,12 @@ abstract class PackageManagerKernelTestBase extends KernelTestBase {
     $this->assertTrue(mkdir($active_dir));
     static::copyFixtureFilesTo($source_dir, $active_dir);
 
+    // Make sure that the path repositories exist in the test project too.
+    (new Filesystem())->mirror(__DIR__ . '/../../fixtures/path_repos', $root . DIRECTORY_SEPARATOR . 'path_repos', NULL, [
+      'override' => TRUE,
+      'delete' => FALSE,
+    ]);
+
     // Removing 'vfs://root/' from site path set in
     // \Drupal\KernelTests\KernelTestBase::setUpFilesystem as we don't use vfs.
     $test_site_path = str_replace('vfs://root/', '', $this->siteDirectory);
@@ -267,7 +273,7 @@ abstract class PackageManagerKernelTestBase extends KernelTestBase {
 
     // Ensure the path locator points to the test project. We assume that is its
     // own web root and the vendor directory is at its top level.
-    /** @var \Drupal\package_manager_bypass\PathLocator $path_locator */
+    /** @var \Drupal\package_manager_bypass\MockPathLocator $path_locator */
     $path_locator = $this->container->get('package_manager.path_locator');
     $path_locator->setPaths($active_dir, $active_dir . '/vendor', '', $staging_root);
 

package_manager/tests/src/Kernel/PathExcluder/UnknownPathExcluderTest.php

+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\Tests\package_manager\Kernel\PathExcluder;
+
+use Drupal\Component\FileSystem\FileSystem as DrupalFileSystem;
+use Drupal\Tests\package_manager\Kernel\PackageManagerKernelTestBase;
+use Symfony\Component\Filesystem\Filesystem;
+
+/**
+ * @covers \Drupal\package_manager\PathExcluder\UnknownPathExcluder
+ * @group package_manager
+ * @internal
+ */
+class UnknownPathExcluderTest extends PackageManagerKernelTestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function createTestProject(?string $source_dir = NULL): void {
+    // This class needs the test project to be varied for different test
+    // methods, so it cannot be called in the setup.
+    // @see ::createTestProjectForTemplate()
+  }
+
+  /**
+   * Creates a test project with or without a nested webroot.
+   *
+   * @param bool $use_nested_webroot
+   *   Whether to use a nested webroot.
+   */
+  protected function createTestProjectForTemplate(bool $use_nested_webroot): void {
+    if (!$use_nested_webroot) {
+      // We are not using a nested webroot: the parent test project can be used.
+      parent::createTestProject();
+    }
+    else {
+      // Create another directory and copy its contents from fake_site fixture.
+      $fake_site_with_nested_webroot = DrupalFileSystem::getOsTemporaryDirectory() . DIRECTORY_SEPARATOR . 'fake_site_with_nested_webroot';
+      $fs = new Filesystem();
+      if (is_dir($fake_site_with_nested_webroot)) {
+        $fs->remove($fake_site_with_nested_webroot);
+      }
+      $fs->mkdir($fake_site_with_nested_webroot);
+      $fs->mirror(__DIR__ . '/../../../fixtures/fake_site', $fake_site_with_nested_webroot);
+
+      // Create a webroot directory in our new directory and copy all folders
+      // and files except composer.json, composer.lock and vendor into the
+      // webroot.
+      $fs->mkdir($fake_site_with_nested_webroot . DIRECTORY_SEPARATOR . 'webroot');
+      $paths_in_project_root = glob("$fake_site_with_nested_webroot/*");
+      $root_paths = [
+        $fake_site_with_nested_webroot . '/vendor',
+        $fake_site_with_nested_webroot . '/webroot',
+        $fake_site_with_nested_webroot . '/composer.json',
+        $fake_site_with_nested_webroot . '/composer.lock',
+      ];
+      foreach ($paths_in_project_root as $path_in_project_root) {
+        if (!in_array($path_in_project_root, $root_paths, TRUE)) {
+          $fs->rename($path_in_project_root, $fake_site_with_nested_webroot . '/webroot' . str_replace($fake_site_with_nested_webroot, '', $path_in_project_root));
+        }
+      }
+      parent::createTestProject($fake_site_with_nested_webroot);
+
+      // We need to reset the test paths with our new webroot.
+      /** @var \Drupal\package_manager_bypass\MockPathLocator $path_locator */
+      $path_locator = $this->container->get('package_manager.path_locator');
+
+      $path_locator->setPaths(
+        $path_locator->getProjectRoot(),
+        $path_locator->getVendorDirectory(),
+        'webroot',
+        $path_locator->getStagingRoot()
+      );
+    }
+  }
+
+  /**
+   * Data provider for testUnknownPath().
+   *
+   * @return mixed[][]
+   *   The test cases.
+   */
+  public function providerTestUnknownPath() {
+    return [
+      'unknown file where web and project root same' => [
+        FALSE,
+        NULL,
+        ['unknown_file.txt'],
+      ],
+      'unknown file where web and project root different' => [
+        TRUE,
+        NULL,
+        ['unknown_file.txt'],
+      ],
+      'unknown directory where web and project root same' => [
+        FALSE,
+        'unknown_dir',
+        ['unknown_dir/unknown_dir.README.md', 'unknown_dir/unknown_file.txt'],
+      ],
+      'unknown directory where web and project root different' => [
+        TRUE,
+        'unknown_dir',
+        ['unknown_dir/unknown_dir.README.md', 'unknown_dir/unknown_file.txt'],
+      ],
+    ];
+  }
+
+  /**
+   * Tests that the unknown files and directories are excluded.
+   *
+   * @param bool $use_nested_webroot
+   *   Whether to create test project with a nested webroot.
+   * @param string|null $unknown_dir
+   *   The path of unknown directory to test or NULL none should be tested.
+   * @param string[] $unknown_files
+   *   The list of unknown files.
+   *
+   * @dataProvider providerTestUnknownPath()
+   */
+  public function testUnknownPath(bool $use_nested_webroot, ?string $unknown_dir, array $unknown_files): void {
+    $this->createTestProjectForTemplate($use_nested_webroot);
+
+    $active_dir = $this->container->get('package_manager.path_locator')
+      ->getProjectRoot();
+    if ($unknown_dir) {
+      mkdir("$active_dir/$unknown_dir");
+    }
+    foreach ($unknown_files as $unknown_file) {
+      file_put_contents("$active_dir/$unknown_file", "Unknown File");
+    }
+
+    $stage = $this->createStage();
+    $stage->create();
+    $stage->require(['ext-json:*']);
+    $stage_dir = $stage->getStageDirectory();
+
+    foreach ($unknown_files as $path) {
+      $this->assertFileExists("$active_dir/$path");
+      if ($use_nested_webroot) {
+        // It will not exist in stage as it will be excluded because web and
+        // project root are different.
+        $this->assertFileDoesNotExist("$stage_dir/$path");
+      }
+      else {
+        // If the project root and web root are the same, unknown files will not
+        // be excluded, so this path should exist in the stage directory.
+        $this->assertFileExists("$stage_dir/$path");
+      }
+    }
+
+    $stage->apply();
+    // The ignored files should still be in the active directory.
+    foreach ($unknown_files as $path) {
+      $this->assertFileExists("$active_dir/$path");
+    }
+  }
+
+}

package_manager/tests/src/Kernel/StageTest.php

@@ -18,7 +18,7 @@ use Drupal\package_manager\Event\StageEvent;
 use Drupal\package_manager\Exception\ApplyFailedException;
 use Drupal\package_manager\Exception\StageException;
 use Drupal\package_manager\Stage;
-use Drupal\package_manager_bypass\Committer;
+use Drupal\package_manager_bypass\LoggingCommitter;
 use PhpTuf\ComposerStager\Domain\Exception\InvalidArgumentException;
 use PhpTuf\ComposerStager\Domain\Exception\PreconditionException;
 use PhpTuf\ComposerStager\Domain\Service\Precondition\PreconditionInterface;
@@ -63,7 +63,7 @@ class StageTest extends PackageManagerKernelTestBase {
     $validator = $this->container->get('package_manager.validator.file_system');
     $this->container->get('event_dispatcher')->removeSubscriber($validator);
 
-    /** @var \Drupal\package_manager_bypass\PathLocator $path_locator */
+    /** @var \Drupal\package_manager_bypass\MockPathLocator $path_locator */
     $path_locator = $this->container->get('package_manager.path_locator');
 
     $stage = $this->createStage();
@@ -188,7 +188,7 @@ class StageTest extends PackageManagerKernelTestBase {
       // testing purposes.
       $event->getStage()->destroy($force);
       // @see \PhpTuf\ComposerStager\Infrastructure\Service\Precondition\StagingDirDoesNotExist
-      Committer::setException(
+      LoggingCommitter::setException(
         new PreconditionException(
           $this->prophesize(PreconditionInterface::class)->reveal(),
           'Stage directory does not exist',
@@ -327,7 +327,7 @@ class StageTest extends PackageManagerKernelTestBase {
     else {
       $throwable = new $thrown_class($thrown_message, 123);
     }
-    Committer::setException($throwable);
+    LoggingCommitter::setException($throwable);
 
     try {
       $stage->apply();
@@ -360,7 +360,7 @@ class StageTest extends PackageManagerKernelTestBase {
     // Make the committer throw an exception, which should cause the failure
     // marker to be present.
     $thrown = new \Exception('Disastrous catastrophe!');
-    Committer::setException($thrown);
+    LoggingCommitter::setException($thrown);
     try {
       $stage->apply();
       $this->fail('Expected an exception.');

package_manager/tests/src/Traits/ValidationTestTrait.php

@@ -28,14 +28,16 @@ trait ValidationTestTrait {
    *   The actual validation results.
    * @param \Drupal\package_manager\PathLocator|null $path_locator
    *   (optional) The path locator (when this trait is used in unit tests).
+   * @param string|null $stage_dir
+   *   (optional) The stage directory.
    */
-  protected function assertValidationResultsEqual(array $expected_results, array $actual_results, ?PathLocator $path_locator = NULL): void {
+  protected function assertValidationResultsEqual(array $expected_results, array $actual_results, ?PathLocator $path_locator = NULL, ?string $stage_dir = NULL): void {
     if ($path_locator) {
       assert(is_a(get_called_class(), UnitTestCase::class, TRUE));
     }
     $expected_results = array_map(
-      function (array $result) use ($path_locator): array {
-        $result['messages'] = $this->resolvePlaceholdersInArrayValuesWithRealPaths($result['messages'], $path_locator);
+      function (array $result) use ($path_locator, $stage_dir): array {
+        $result['messages'] = $this->resolvePlaceholdersInArrayValuesWithRealPaths($result['messages'], $path_locator, $stage_dir);
         return $result;
       },
       $this->getValidationResultsAsArray($expected_results)
@@ -54,19 +56,30 @@ trait ValidationTestTrait {
    *   <STAGE_ROOT_PARENT>.
    * @param \Drupal\package_manager\PathLocator|null $path_locator
    *   (optional) The path locator (when this trait is used in unit tests).
+   * @param string|null $stage_dir
+   *   (optional) The stage directory.
    *
    * @return array
    *   The same array, with unchanged keys, and with the placeholders resolved.
    */
-  protected function resolvePlaceholdersInArrayValuesWithRealPaths(array $subject, ?PathLocator $path_locator = NULL): array {
+  protected function resolvePlaceholdersInArrayValuesWithRealPaths(array $subject, ?PathLocator $path_locator = NULL, ?string $stage_dir = NULL): array {
     if (!$path_locator) {
       $path_locator = $this->container->get('package_manager.path_locator');
     }
-    return str_replace(
+    $subject = str_replace(
       ['<PROJECT_ROOT>', '<VENDOR_DIR>', '<STAGE_ROOT>', '<STAGE_ROOT_PARENT>'],
       [$path_locator->getProjectRoot(), $path_locator->getVendorDirectory(), $path_locator->getStagingRoot(), dirname($path_locator->getStagingRoot())],
       $subject
     );
+    if ($stage_dir) {
+      $subject = str_replace(['<STAGE_DIR>'], [$stage_dir], $subject);
+    }
+    foreach ($subject as $message) {
+      if (str_contains($message, '<STAGE_DIR>')) {
+        throw new \LogicException("No stage directory passed to replace '<STAGE_DIR>' in message '$message'");
+      }
+    }
+    return $subject;
   }
 
   /**

tests/src/Functional/UpdateFailedTest.php

@@ -4,7 +4,7 @@ declare(strict_types = 1);
 
 namespace Drupal\Tests\automatic_updates\Functional;
 
-use Drupal\package_manager_bypass\Committer;
+use Drupal\package_manager_bypass\LoggingCommitter;
 
 /**
  * @covers \Drupal\automatic_updates\Form\UpdaterForm
@@ -31,7 +31,7 @@ class UpdateFailedTest extends UpdaterFormTestBase {
     $this->checkForMetaRefresh();
     $this->assertUpdateStagedTimes(1);
 
-    Committer::setException(new \Exception('failed at committer'));
+    LoggingCommitter::setException(new \Exception('failed at committer'));
     $page->pressButton('Continue');
     $this->checkForMetaRefresh();
     $assert_session->pageTextContainsOnce('An error has occurred.');

tests/src/Kernel/CronUpdaterTest.php

@@ -20,7 +20,7 @@ use Drupal\package_manager\Event\PreCreateEvent;
 use Drupal\package_manager\Exception\StageOwnershipException;
 use Drupal\package_manager\Exception\StageValidationException;
 use Drupal\package_manager\ValidationResult;
-use Drupal\package_manager_bypass\Committer;
+use Drupal\package_manager_bypass\LoggingCommitter;
 use Drupal\Tests\automatic_updates\Traits\EmailNotificationsTestTrait;
 use Drupal\Tests\package_manager\Kernel\TestStage;
 use Drupal\Tests\package_manager\Traits\PackageManagerBypassTestTrait;
@@ -577,7 +577,7 @@ END;
   public function testApplyFailureEmail(): void {
     $this->getStageFixtureManipulator()->setCorePackageVersion('9.8.1');
     $error = new \Exception('I drink your milkshake!');
-    Committer::setException($error);
+    LoggingCommitter::setException($error);
 
     $this->container->get('cron')->run();
     $expected_body = <<<END

tests/src/Kernel/StatusCheck/ScaffoldFilePermissionsValidatorTest.php

@@ -42,7 +42,7 @@ class ScaffoldFilePermissionsValidatorTest extends AutomaticUpdatesKernelTestBas
   /**
    * {@inheritdoc}
    */
-  protected function assertValidationResultsEqual(array $expected_results, array $actual_results, ?PathLocator $path_locator = NULL): void {
+  protected function assertValidationResultsEqual(array $expected_results, array $actual_results, ?PathLocator $path_locator = NULL, ?string $stage_dir = NULL): void {
     $map = function (string $path): string {
       return $this->activeDir . '/' . $path;
     };

tests/src/Kernel/UpdaterTest.php

@@ -11,7 +11,7 @@ use Drupal\package_manager\Event\PreCreateEvent;
 use Drupal\package_manager\Event\PreRequireEvent;
 use Drupal\package_manager\Exception\StageException;
 use Drupal\package_manager\ValidationResult;
-use Drupal\package_manager_bypass\Committer;
+use Drupal\package_manager_bypass\LoggingCommitter;
 use Drupal\Tests\package_manager\Kernel\TestStageValidationException;
 use Drupal\Tests\user\Traits\UserCreationTrait;
 use PhpTuf\ComposerStager\Domain\Exception\InvalidArgumentException;
@@ -188,7 +188,7 @@ class UpdaterTest extends AutomaticUpdatesKernelTestBase {
     ]);
     $updater->stage();
     $thrown_message = 'A very bad thing happened';
-    Committer::setException(new $thrown_class($thrown_message, 123));
+    LoggingCommitter::setException(new $thrown_class($thrown_message, 123));
     $this->expectException($expected_class);
     $expected_message = $expected_class === UpdateException::class ?
       "The update operation failed to apply completely. All the files necessary to run Drupal correctly and securely are probably not present. It is strongly recommended to restore your site's code and database from a backup."