Issue #3241105 by phenaproxima, tedbow: Ensure core package is validated in...

Issue #3241105 by phenaproxima, tedbow: Ensure core package is validated in readiness check and pre-start

automatic_updates.services.yml

@@ -74,6 +74,10 @@ services:
       - '%app.root%'
     tags:
       - { name: event_subscriber }
+  automatic_updates.validator.core_composer:
+    class: Drupal\automatic_updates\Validator\CoreComposerValidator
+    tags:
+      - { name: event_subscriber }
   automatic_updates.path_locator:
     class: Drupal\automatic_updates\PathLocator
     arguments:

package_manager/src/ComposerUtility.php

@@ -99,18 +99,6 @@ class ComposerUtility {
    */
   public function getCorePackageNames(): array {
     $requirements = array_keys($this->composer->getPackage()->getRequires());
-
-    // Ensure that either drupal/core or drupal/core-recommended are required.
-    // If neither is, then core cannot be updated, which we consider an error
-    // condition.
-    // @todo Move this check to an update validator as part of
-    //   https://www.drupal.org/project/automatic_updates/issues/3241105
-    $core_requirements = array_intersect(['drupal/core', 'drupal/core-recommended'], $requirements);
-    if (empty($core_requirements)) {
-      $file = $this->composer->getConfig()->getConfigSource()->getName();
-      throw new \LogicException("Drupal core does not appear to be required in $file.");
-    }
-
     return array_intersect(static::getCorePackageList(), $requirements);
   }
 

src/Validator/CoreComposerValidator.php

+<?php
+
+namespace Drupal\automatic_updates\Validator;
+
+use Drupal\automatic_updates\AutomaticUpdatesEvents;
+use Drupal\automatic_updates\Event\ReadinessCheckEvent;
+use Drupal\automatic_updates\Validation\ValidationResult;
+use Drupal\Core\StringTranslation\StringTranslationTrait;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * Validates the Drupal core requirements defined in composer.json.
+ */
+class CoreComposerValidator implements EventSubscriberInterface {
+
+  use StringTranslationTrait;
+
+  /**
+   * Validates the Drupal core requirements in composer.json.
+   *
+   * @param \Drupal\automatic_updates\Event\ReadinessCheckEvent $event
+   *   The event object.
+   */
+  public function checkCoreRequirements(ReadinessCheckEvent $event): void {
+    // Ensure that either drupal/core or drupal/core-recommended is required.
+    // If neither is, then core cannot be updated, which we consider an error
+    // condition.
+    $core_requirements = array_intersect(
+      $event->getActiveComposer()->getCorePackageNames(),
+      ['drupal/core', 'drupal/core-recommended']
+    );
+    if (empty($core_requirements)) {
+      $error = ValidationResult::createError([
+        $this->t('Drupal core does not appear to be required in the project-level composer.json.'),
+      ]);
+      $event->addValidationResult($error);
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function getSubscribedEvents() {
+    return [
+      AutomaticUpdatesEvents::READINESS_CHECK => ['checkCoreRequirements', 1000],
+    ];
+  }
+
+}

tests/fixtures/project_staged_validation/no_core_requirements/composer.json

+{
+    "require": {
+        "drupal/core-composer-scaffold": "*",
+        "drupal/core-vendor-hardening": "*",
+        "drupal/core-project-message": "*",
+        "drupal/core-dev": "*",
+        "drupal/core-dev-pinned": "*"
+    },
+    "extra": {
+        "_comment": [
+            "This is an example composer.json that does not require Drupal core.",
+            "@see \\Drupal\\Tests\\automatic_updates\\Kernel\\ReadinessValidation\\RequirementsValidatorTest"
+        ]
+    }
+}

tests/src/Kernel/ReadinessValidation/CoreComposerValidatorTest.php

+<?php
+
+namespace Drupal\Tests\automatic_updates\Kernel\ReadinessValidation;
+
+use Drupal\automatic_updates\PathLocator;
+use Drupal\automatic_updates\Validation\ValidationResult;
+use Drupal\Core\DependencyInjection\ContainerBuilder;
+use Drupal\Tests\automatic_updates\Kernel\AutomaticUpdatesKernelTestBase;
+use Drupal\Tests\automatic_updates\Traits\ValidationTestTrait;
+
+/**
+ * @covers \Drupal\automatic_updates\Validator\CoreComposerValidator
+ *
+ * @group automatic_updates
+ */
+class CoreComposerValidatorTest extends AutomaticUpdatesKernelTestBase {
+
+  use ValidationTestTrait;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $modules = [
+    'automatic_updates',
+    'package_manager',
+  ];
+
+  /**
+   * {@inheritdoc}
+   */
+  public function register(ContainerBuilder $container) {
+    parent::register($container);
+    // Disable validators which interfere with the validator under test.
+    $container->removeDefinition('automatic_updates.disk_space_validator');
+  }
+
+  /**
+   * Tests that an error is raised if core is not required in composer.json.
+   */
+  public function testCoreNotRequired(): void {
+    $this->installConfig('update');
+    $this->setCoreVersion('9.8.0');
+    $this->setReleaseMetadata(__DIR__ . '/../../../fixtures/release-history/drupal.9.8.1.xml');
+
+    // Point to a valid composer.json with no requirements.
+    $locator = $this->prophesize(PathLocator::class);
+    $locator->getActiveDirectory()->willReturn(__DIR__ . '/../../../fixtures/project_staged_validation/no_core_requirements');
+    $this->container->set('automatic_updates.path_locator', $locator->reveal());
+
+    $results = $this->container->get('automatic_updates.readiness_validation_manager')
+      ->run()
+      ->getResults();
+
+    $error = ValidationResult::createError([
+      'Drupal core does not appear to be required in the project-level composer.json.',
+    ]);
+    $this->assertValidationResultsEqual([$error], $results);
+  }
+
+}