automatic_updates.info.yml

@@ -3,6 +3,6 @@ type: module
 description: 'Experimental module to develop automatic updates. Currently the module provides checks for update readiness but does not yet provide update functionality.'
 core_version_requirement: ^9.2
 dependencies:
-  - drupal:package_manager
   - drupal:automatic_updates_9_3_shim
+  - drupal:package_manager
   - drupal:update

automatic_updates.module

@@ -20,6 +20,37 @@ function automatic_updates_page_top() {
   /** @var \Drupal\automatic_updates\Validation\AdminReadinessMessages $readiness_messages */
   $readiness_messages = \Drupal::classResolver(AdminReadinessMessages::class);
   $readiness_messages->displayAdminPageMessages();
+
+  // @todo Rely on the route option after https://www.drupal.org/i/3236497 is
+  //   committed.
+  // @todo Remove 'system.batch_page.html' after
+  //   https://www.drupal.org/i/3238311 is committed.
+  $skip_routes = [
+    'system.batch_page.html',
+    'automatic_updates.confirmation_page',
+    'automatic_updates.report_update',
+    'automatic_updates.module_update',
+  ];
+  $route_name = \Drupal::routeMatch()->getRouteName();
+  if (!in_array($route_name, $skip_routes, TRUE) && function_exists('update_page_top')) {
+    update_page_top();
+  }
+}
+
+/**
+ * Implements hook_module_implements_alter().
+ *
+ * @todo Remove after https://www.drupal.org/i/3236497 is committed.
+ */
+function automatic_updates_module_implements_alter(&$implementations, $hook) {
+  if ($hook === 'page_top') {
+    // Remove hook_page_top() implementation from the Update module. This '
+    // implementation displays error messages about security releases. We call
+    // this implementation in our own automatic_updates_page_top() except on our
+    // own routes to avoid stale messages about the security releases after an
+    // update.
+    unset($implementations['update']);
+  }
 }
 
 /**

automatic_updates_9_3_shim/automatic_updates_9_3_shim.module

-<?php
-
-/**
- * @file
- * Contains hook implementations for Automatic Updates 9.3 shim module.
- */
-
-/**
- * Implements hook_page_top().
- */
-function automatic_updates_9_3_shim_page_top() {
-  // @todo Rely on the route option after https://www.drupal.org/i/3236497 is
-  //   committed.
-  // @todo Remove 'system.batch_page.html' after
-  //   https://www.drupal.org/i/3238311 is committed.
-  $skip_routes = [
-    'system.batch_page.html',
-    'automatic_updates.confirmation_page',
-    'automatic_updates.report_update',
-    'automatic_updates.module_update',
-  ];
-  $route_name = \Drupal::routeMatch()->getRouteName();
-  if (!in_array($route_name, $skip_routes, TRUE) && function_exists('update_page_top')) {
-    update_page_top();
-  }
-}
-
-/**
- * Implements hook_module_implements_alter().
- *
- * @todo Remove after https://www.drupal.org/i/3236497 is committed.
- */
-function automatic_updates_9_3_shim_module_implements_alter(&$implementations, $hook) {
-  if ($hook === 'page_top') {
-    // Remove hook_page_top() implementation from the Update module. This '
-    // implementation displays error messages about security releases. We call
-    // this implementation in our own automatic_updates_page_top() except on our
-    // own routes to avoid stale messages about the security releases after an
-    // update.
-    unset($implementations['update']);
-  }
-
-}

package_manager/src/Event/ErrorEventInterface.php

-<?php
-
-namespace Drupal\package_manager\Event;
-
-use Drupal\Core\StringTranslation\TranslatableMarkup;
-
-/**
- * Defines an interface for events which can collect validation errors.
- */
-interface ErrorEventInterface {
-
-  /**
-   * Adds a validation error.
-   *
-   * @param \Drupal\Core\StringTranslation\TranslatableMarkup[] $messages
-   *   The error messages.
-   * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $summary
-   *   (optional) The summary.
-   */
-  public function addError(array $messages, TranslatableMarkup $summary = NULL);
-
-}

package_manager/src/Event/PostApplyEvent.php

@@ -5,5 +5,5 @@ namespace Drupal\package_manager\Event;
 /**
  * Event fired after staged changes are synced to the active directory.
  */
-class PostApplyEvent extends PostOperationStageEvent {
+class PostApplyEvent extends StageEvent {
 }

package_manager/src/Event/PostCreateEvent.php

@@ -5,5 +5,5 @@ namespace Drupal\package_manager\Event;
 /**
  * Event fired after a staging area has been created.
  */
-class PostCreateEvent extends PostOperationStageEvent {
+class PostCreateEvent extends StageEvent {
 }

package_manager/src/Event/PostDestroyEvent.php

@@ -5,5 +5,5 @@ namespace Drupal\package_manager\Event;
 /**
  * Event fired after the staging area is destroyed.
  */
-class PostDestroyEvent extends PostOperationStageEvent {
+class PostDestroyEvent extends StageEvent {
 }

package_manager/src/Event/PostOperationStageEvent.php

-<?php
-
-namespace Drupal\package_manager\Event;
-
-use Drupal\Core\StringTranslation\TranslatableMarkup;
-use Drupal\package_manager\ValidationResult;
-
-/**
- * Base class for events dispatched after a stage life cycle operation.
- */
-abstract class PostOperationStageEvent extends StageEvent implements WarningEventInterface {
-
-  /**
-   * {@inheritdoc}
-   */
-  public function addWarning(array $messages, ?TranslatableMarkup $summary = NULL) {
-    $this->results[] = ValidationResult::createWarning($messages, $summary);
-  }
-
-}

package_manager/src/Event/PostRequireEvent.php

@@ -5,5 +5,5 @@ namespace Drupal\package_manager\Event;
 /**
  * Event fired after packages are added to the staging area.
  */
-class PostRequireEvent extends PostOperationStageEvent {
+class PostRequireEvent extends StageEvent {
 }

package_manager/src/Event/PreOperationStageEvent.php

@@ -8,7 +8,7 @@ use Drupal\package_manager\ValidationResult;
 /**
  * Base class for events dispatched before a stage life cycle operation.
  */
-abstract class PreOperationStageEvent extends StageEvent implements ErrorEventInterface {
+abstract class PreOperationStageEvent extends StageEvent {
 
   /**
    * {@inheritdoc}

package_manager/src/Event/WarningEventInterface.php

-<?php
-
-namespace Drupal\package_manager\Event;
-
-use Drupal\Core\StringTranslation\TranslatableMarkup;
-
-/**
- * Defines an interface for events which can collect validation warnings.
- */
-interface WarningEventInterface {
-
-  /**
-   * Adds a warning.
-   *
-   * @param array $messages
-   *   The warning messages.
-   * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $summary
-   *   (optional) The summary.
-   */
-  public function addWarning(array $messages, TranslatableMarkup $summary = NULL);
-
-}

package_manager/src/EventSubscriber/PostOperationStageValidatorInterface.php

-<?php
-
-namespace Drupal\package_manager\EventSubscriber;
-
-use Drupal\package_manager\Event\PostOperationStageEvent;
-use Symfony\Component\EventDispatcher\EventSubscriberInterface;
-
-/**
- * Defines an interface for classes that validate a stage after an operation.
- */
-interface PostOperationStageValidatorInterface extends EventSubscriberInterface {
-
-  /**
-   * Validates a stage after an operation.
-   *
-   * @param \Drupal\package_manager\Event\PostOperationStageEvent $event
-   *   The stage event.
-   */
-  public function validateStagePostOperation(PostOperationStageEvent $event): void;
-
-}

package_manager/src/Stage.php

@@ -435,7 +435,7 @@ class Stage {
    *
    * @todo Make this method public in https://www.drupal.org/i/3251972.
    */
-  protected function getStageDirectory(): string {
+  public function getStageDirectory(): string {
     if (!$this->lock) {
       throw new \LogicException(__METHOD__ . '() cannot be called because the stage has not been created or claimed.');
     }

package_manager/tests/fixtures/fake_site/sites/default/services.yml

 # This file should never be staged.
+must_not_be: 'empty'

package_manager/tests/fixtures/fake_site/sites/example.com/services.yml

 # This file should never be staged.
+key: "value"

package_manager/tests/src/Functional/ExcludedPathsTest.php

@@ -119,21 +119,21 @@ class ExcludedPathsTest extends BrowserTestBase {
     $stage_dir = $stage::$stagingRoot . DIRECTORY_SEPARATOR . $stage->create();
 
     $this->assertDirectoryExists($stage_dir);
-    $this->assertDirectoryNotExists("$stage_dir/sites/simpletest");
-    $this->assertFileNotExists("$stage_dir/vendor/web.config");
-    $this->assertDirectoryNotExists("$stage_dir/$site_path/files");
-    $this->assertDirectoryNotExists("$stage_dir/private");
-    $this->assertFileNotExists("$stage_dir/$site_path/settings.php");
-    $this->assertFileNotExists("$stage_dir/$site_path/settings.local.php");
-    $this->assertFileNotExists("$stage_dir/$site_path/services.yml");
+    $this->assertDirectoryDoesNotExist("$stage_dir/sites/simpletest");
+    $this->assertFileDoesNotExist("$stage_dir/vendor/web.config");
+    $this->assertDirectoryDoesNotExist("$stage_dir/$site_path/files");
+    $this->assertDirectoryDoesNotExist("$stage_dir/private");
+    $this->assertFileDoesNotExist("$stage_dir/$site_path/settings.php");
+    $this->assertFileDoesNotExist("$stage_dir/$site_path/settings.local.php");
+    $this->assertFileDoesNotExist("$stage_dir/$site_path/services.yml");
     // SQLite databases and their support files should never be staged.
-    $this->assertFileNotExists("$stage_dir/$site_path/db.sqlite");
-    $this->assertFileNotExists("$stage_dir/$site_path/db.sqlite-shm");
-    $this->assertFileNotExists("$stage_dir/$site_path/db.sqlite-wal");
+    $this->assertFileDoesNotExist("$stage_dir/$site_path/db.sqlite");
+    $this->assertFileDoesNotExist("$stage_dir/$site_path/db.sqlite-shm");
+    $this->assertFileDoesNotExist("$stage_dir/$site_path/db.sqlite-wal");
     // Default site-specific settings files should never be staged.
-    $this->assertFileNotExists("$stage_dir/sites/default/settings.php");
-    $this->assertFileNotExists("$stage_dir/sites/default/settings.local.php");
-    $this->assertFileNotExists("$stage_dir/sites/default/services.yml");
+    $this->assertFileDoesNotExist("$stage_dir/sites/default/settings.php");
+    $this->assertFileDoesNotExist("$stage_dir/sites/default/settings.local.php");
+    $this->assertFileDoesNotExist("$stage_dir/sites/default/services.yml");
     // A non-excluded file in the default site directory should be staged.
     $this->assertFileExists("$stage_dir/sites/default/stage.txt");
 
@@ -148,7 +148,7 @@ class ExcludedPathsTest extends BrowserTestBase {
     }
     $stage->apply();
     foreach ($files as $file) {
-      $this->assertFileNotExists("$active_dir/$file");
+      $this->assertFileDoesNotExist("$active_dir/$file");
     }
   }
 

package_manager/tests/src/Kernel/ComposerUtilityTest.php

@@ -26,7 +26,7 @@ class ComposerUtilityTest extends KernelTestBase {
     file_put_contents($dir . '/composer.json', '{}');
 
     ComposerUtility::createForDirectory($dir);
-    $this->assertFileNotExists($dir . '/.htaccess');
+    $this->assertFileDoesNotExist($dir . '/.htaccess');
   }
 
   /**

package_manager/tests/src/Kernel/StageEventsTest.php

@@ -2,7 +2,6 @@
 
 namespace Drupal\Tests\package_manager\Kernel;
 
-use Drupal\package_manager\Event\ErrorEventInterface;
 use Drupal\package_manager\Event\PostApplyEvent;
 use Drupal\package_manager\Event\PostCreateEvent;
 use Drupal\package_manager\Event\PostDestroyEvent;
@@ -10,9 +9,9 @@ use Drupal\package_manager\Event\PostRequireEvent;
 use Drupal\package_manager\Event\PreApplyEvent;
 use Drupal\package_manager\Event\PreCreateEvent;
 use Drupal\package_manager\Event\PreDestroyEvent;
+use Drupal\package_manager\Event\PreOperationStageEvent;
 use Drupal\package_manager\Event\PreRequireEvent;
 use Drupal\package_manager\Event\StageEvent;
-use Drupal\package_manager\Event\WarningEventInterface;
 use Drupal\package_manager\Exception\StageValidationException;
 use Drupal\package_manager\Stage;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -76,7 +75,7 @@ class StageEventsTest extends PackageManagerKernelTestBase implements EventSubsc
   /**
    * Handles a staging area life cycle event.
    *
-   * @param \Drupal\package_manager\Event\PreOperationStageEvent|\Drupal\package_manager\Event\PostOperationStageEvent $event
+   * @param \Drupal\package_manager\Event\StageEvent $event
    *   The event object.
    */
   public function handleEvent(StageEvent $event): void {
@@ -118,13 +117,9 @@ class StageEventsTest extends PackageManagerKernelTestBase implements EventSubsc
   public function providerValidationResults(): array {
     return [
       [PreCreateEvent::class],
-      [PostCreateEvent::class],
       [PreRequireEvent::class],
-      [PostRequireEvent::class],
       [PreApplyEvent::class],
-      [PostApplyEvent::class],
       [PreDestroyEvent::class],
-      [PostDestroyEvent::class],
     ];
   }
 
@@ -141,12 +136,9 @@ class StageEventsTest extends PackageManagerKernelTestBase implements EventSubsc
     // class under test.
     $handler = function (StageEvent $event) use ($event_class): void {
       if (get_class($event) === $event_class) {
-        if ($event instanceof ErrorEventInterface) {
+        if ($event instanceof PreOperationStageEvent) {
           $event->addError([['Burn, baby, burn']]);
         }
-        elseif ($event instanceof WarningEventInterface) {
-          $event->addWarning(['Be careful about fires.']);
-        }
       }
     };
     $this->container->get('event_dispatcher')

package_manager/tests/src/Kernel/StageTest.php

+<?php
+
+namespace Drupal\Tests\package_manager\Kernel;
+
+/**
+ * @coversDefaultClass \Drupal\package_manager\Stage
+ *
+ * @group package_manager
+ */
+class StageTest extends PackageManagerKernelTestBase {
+
+  /**
+   * @covers ::getStageDirectory
+   */
+  public function testGetStageDirectory(): void {
+    $stage = $this->createStage();
+    $id = $stage->create();
+    $this->assertStringEndsWith("/.package_manager/$id", $stage->getStageDirectory());
+  }
+
+  /**
+   * @covers ::getStageDirectory
+   */
+  public function testUncreatedGetStageDirectory(): void {
+    $this->expectException('LogicException');
+    $this->expectExceptionMessage('Drupal\package_manager\Stage::getStageDirectory() cannot be called because the stage has not been created or claimed.');
+    $this->createStage()->getStageDirectory();
+  }
+
+}

src/BatchProcessor.php

@@ -2,8 +2,8 @@
 
 namespace Drupal\automatic_updates;
 
-use Drupal\automatic_updates\Exception\UpdateException;
 use Drupal\Core\Url;
+use Drupal\package_manager\Exception\StageValidationException;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 
 /**
@@ -38,7 +38,7 @@ class BatchProcessor {
       $error->getMessage(),
     ];
 
-    if ($error instanceof UpdateException) {
+    if ($error instanceof StageValidationException) {
       foreach ($error->getResults() as $result) {
         $messages = $result->getMessages();
         if (count($messages) > 1) {