Issue #3344127: Composer validate all fixture manipulation changes

package_manager/tests/modules/fixture_manipulator/src/FixtureManipulator.php

@@ -5,6 +5,7 @@ namespace Drupal\fixture_manipulator;
 use Composer\Semver\VersionParser;
 use Drupal\Component\Utility\NestedArray;
 use Drupal\Core\Serialization\Yaml;
+use PhpTuf\ComposerStager\Domain\Service\ProcessRunner\ComposerRunnerInterface;
 use Symfony\Component\Filesystem\Filesystem;
 
 /**
@@ -40,6 +41,25 @@ class FixtureManipulator {
    */
   private string $dir;
 
+  /**
+   * Validate the fixtures still passes `composer validate`.
+   */
+  private function validateComposer(): void {
+    /** @var \PhpTuf\ComposerStager\Domain\Service\ProcessRunner\ComposerRunnerInterface $runner */
+    $runner = \Drupal::service(ComposerRunnerInterface::class);
+    $runner->run([
+      'validate',
+      // @todo Check the lock file in https://drupal.org/i/3343827.
+      '--no-check-lock',
+      '--no-check-publish',
+      '--with-dependencies',
+      '--no-interaction',
+      '--ansi',
+      '--no-cache',
+      "--working-dir={$this->dir}",
+    ]);
+  }
+
   /**
    * Adds a package.
    *
@@ -60,7 +80,11 @@ class FixtureManipulator {
    */
   public function addPackage(array $package, bool $is_dev_requirement = FALSE, bool $create_project = TRUE): self {
     if (!$this->committingChanges) {
-      $this->queueManipulation('addPackage', func_get_args());
+      // To pass Composer validation all packages must have a version specified.
+      if (!isset($package['version'])) {
+        $package['version'] = '1.2.3';
+      }
+      $this->queueManipulation('addPackage', [$package, $is_dev_requirement, $create_project]);
       return $this;
     }
     foreach (['name', 'type'] as $required_key) {
@@ -357,7 +381,7 @@ class FixtureManipulator {
    * @param string $dir
    *   The directory to commit the changes to.
    */
-  protected function doCommitChanges(string $dir): void {
+  final protected function doCommitChanges(string $dir): void {
     if ($this->committed) {
       throw new \BadMethodCallException('Already committed.');
     }
@@ -372,6 +396,7 @@ class FixtureManipulator {
     }
     $this->committed = TRUE;
     $this->committingChanges = FALSE;
+    $this->validateComposer();
   }
 
   /**

[Ted Bowman]

In that issue we will be update the lock file when we manipulate the fixtures

[Ted Bowman]

This means errors for packages you will publish. We don't need to worry about that type

[Wim Leers]

The composer help validate info is worthless.

https://getcomposer.org/doc/03-cli.md#validate is better:

--no-check-publish: Do not emit an error if composer.json is unsuitable for publishing as a package on Packagist but is otherwise valid.

[Wim Leers]

Turns out this works thanks to Magic 🪄

(Symfony's Process already does this for us: \Symfony\Component\Process\Process::escapeArgument() )

[Wim Leers]

In order to keep the tests simple, I think this is a reasonable default to set It's also easy to grep for

[Ted Bowman]

making final we don't extend this. and it someone extended this and didn't call validateComposer() that would be a big problem

[Wim Leers]

I didn't know you could mark just methods final!

[Adam G-H]

Final is great! Methods, classes, and class constants (as of 8.1) can all be final. https://www.php.net/manual/en/language.oop5.final.php