Issue #3230249 by tedbow: Set the project versions to be updated in begin() instead of stage()

src/BatchProcessor.php

@@ -57,14 +57,16 @@ class BatchProcessor {
   /**
    * Calls the updater's begin() method.
    *
+   * @param string[] $project_versions
+   *   The project versions to be staged in the update, keyed by package name.
    * @param array $context
    *   The current context of the batch job.
    *
    * @see \Drupal\automatic_updates\Updater::begin()
    */
-  public static function begin(array &$context): void {
+  public static function begin(array $project_versions, array &$context): void {
     try {
-      static::getUpdater()->begin();
+      static::getUpdater()->begin($project_versions);
     }
     catch (\Throwable $e) {
       static::handleException($e, $context);
@@ -74,16 +76,14 @@ class BatchProcessor {
   /**
    * Calls the updater's stageVersions() method.
    *
-   * @param string[] $project_versions
-   *   The project versions to be staged in the update, keyed by package name.
    * @param array $context
    *   The current context of the batch job.
    *
-   * @see \Drupal\automatic_updates\Updater::stageVersions()
+   * @see \Drupal\automatic_updates\Updater::stage()
    */
-  public static function stageProjectVersions(array $project_versions, array &$context): void {
+  public static function stage(array &$context): void {
     try {
-      static::getUpdater()->stageVersions($project_versions);
+      static::getUpdater()->stage();
     }
     catch (\Throwable $e) {
       static::handleException($e, $context);

src/Form/UpdaterForm.php

@@ -235,10 +235,11 @@ class UpdaterForm extends FormBase {
     $batch = (new BatchBuilder())
       ->setTitle($this->t('Downloading updates'))
       ->setInitMessage($this->t('Preparing to download updates'))
-      ->addOperation([BatchProcessor::class, 'begin'])
-      ->addOperation([BatchProcessor::class, 'stageProjectVersions'], [
-        $form_state->getValue('update_version'),
-      ])
+      ->addOperation(
+        [BatchProcessor::class, 'begin'],
+        [$form_state->getValue('update_version')]
+      )
+      ->addOperation([BatchProcessor::class, 'stage'])
       ->setFinishCallback([BatchProcessor::class, 'finishStage'])
       ->toArray();
 

src/Updater.php

@@ -163,11 +163,21 @@ class Updater {
   /**
    * Begins the update.
    *
+   * @param string[] $project_versions
+   *   The versions of the packages to update to, keyed by package name.
+   *
    * @return string
    *   A key for this stage update process.
+   *
+   * @throws \InvalidArgumentException
+   *   Thrown if no project version for Drupal core is provided.
    */
-  public function begin(): string {
-    $stage_key = $this->createActiveStage();
+  public function begin(array $project_versions): string {
+    if (count($project_versions) !== 1 || !array_key_exists('drupal', $project_versions)) {
+      throw new \InvalidArgumentException("Currently only updates to Drupal core are supported.");
+    }
+    $packages[] = 'drupal/core:' . $project_versions['drupal'];
+    $stage_key = $this->createActiveStage($packages);
     $event = $this->dispatchUpdateEvent(AutomaticUpdatesEvents::PRE_START);
     $this->beginner->begin(static::getActiveDirectory(), static::getStageDirectory(), $this->getExclusions($event));
     return $stage_key;
@@ -190,24 +200,11 @@ class Updater {
   }
 
   /**
-   * Adds specific project versions to the staging area.
-   *
-   * @param string[] $project_versions
-   *   The project versions to add to the staging area, keyed by package name.
+   * Stages the update.
    */
-  public function stageVersions(array $project_versions): void {
-    $packages = [];
-    foreach ($project_versions as $project => $project_version) {
-      if ($project === 'drupal') {
-        // @todo Determine when to use drupal/core-recommended and when to use
-        //   drupal/core
-        $packages[] = "drupal/core:$project_version";
-      }
-      else {
-        $packages[] = "drupal/$project:$project_version";
-      }
-    }
-    $this->stagePackages($packages);
+  public function stage(): void {
+    $current = $this->state->get(static::STATE_KEY);
+    $this->stagePackages($current['package_versions']);
   }
 
   /**
@@ -220,11 +217,6 @@ class Updater {
     $command = array_merge(['require'], $packages);
     $command[] = '--update-with-all-dependencies';
     $this->stageCommand($command);
-    // Store the expected packages to confirm no other Drupal packages were
-    // updated.
-    $current = $this->state->get(static::STATE_KEY);
-    $current['packages'] = $packages;
-    $this->state->set(self::STATE_KEY, $current);
   }
 
   /**
@@ -265,12 +257,21 @@ class Updater {
   /**
    * Initializes an active update and returns its ID.
    *
+   * @param string[] $package_versions
+   *   The versions of the packages to stage, keyed by package name.
+   *
    * @return string
    *   The active update ID.
    */
-  private function createActiveStage(): string {
+  private function createActiveStage(array $package_versions): string {
     $value = static::STATE_KEY . microtime();
-    $this->state->set(static::STATE_KEY, ['id' => $value]);
+    $this->state->set(
+      static::STATE_KEY,
+      [
+        'id' => $value,
+        'package_versions' => $package_versions,
+      ]
+    );
     return $value;
   }
 

tests/src/Functional/ExclusionsTest.php

@@ -40,7 +40,7 @@ class ExclusionsTest extends BrowserTestBase {
     $settings['file_private_path'] = 'files/private';
     new Settings($settings);
 
-    $updater->begin();
+    $updater->begin(['drupal' => '9.8.1']);
     $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");

tests/src/Kernel/UpdaterTest.php

+<?php
+
+namespace Drupal\Tests\automatic_updates\Kernel;
+
+use Drupal\KernelTests\KernelTestBase;
+use Prophecy\Argument;
+
+/**
+ * @coversDefaultClass \Drupal\automatic_updates\Updater
+ *
+ * @group automatic_updates
+ */
+class UpdaterTest extends KernelTestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $modules = [
+    'automatic_updates',
+    'update',
+    'composer_stager_bypass',
+  ];
+
+  /**
+   * Tests that correct versions are staged after calling ::begin().
+   */
+  public function testCorrectVersionsStaged() {
+    $this->container->get('automatic_updates.updater')->begin([
+      'drupal' => '9.8.1',
+    ]);
+    // Rebuild the container to ensure the project versions are kept in state.
+    /** @var \Drupal\Core\DrupalKernel $kernel */
+    $kernel = $this->container->get('kernel');
+    $kernel->rebuildContainer();
+    $this->container = $kernel->getContainer();
+    $stager = $this->prophesize('\PhpTuf\ComposerStager\Domain\StagerInterface');
+    $command = [
+      'require',
+      'drupal/core:9.8.1',
+      '--update-with-all-dependencies',
+    ];
+    $stager->stage($command, Argument::cetera())->shouldBeCalled();
+    $this->container->set('automatic_updates.stager', $stager->reveal());
+    $this->container->get('automatic_updates.updater')->stage();
+  }
+
+  /**
+   * @covers ::begin
+   *
+   * @dataProvider providerInvalidProjectVersions
+   */
+  public function testInvalidProjectVersions(array $project_versions): void {
+    $this->expectException(\InvalidArgumentException::class);
+    $this->expectExceptionMessage('Currently only updates to Drupal core are supported.');
+    $this->container->get('automatic_updates.updater')->begin($project_versions);
+  }
+
+  /**
+   * Data provider for testInvalidProjectVersions().
+   *
+   * @return array
+   *   The test cases for testInvalidProjectVersions().
+   */
+  public function providerInvalidProjectVersions(): array {
+    return [
+      'only not drupal' => [['not_drupal' => '1.1.3']],
+      'not drupal and drupal' => [['drupal' => '9.8.0', 'not_drupal' => '1.2.3']],
+      'empty' => [[]],
+    ];
+  }
+
+}