Issue #3277229 by phenaproxima: Auto-wire Composer Stager into Package Manager

package_manager/package_manager.services.yml

 services:
-  # Underlying Symfony utilities.
-  package_manager.symfony_file_system:
-    class: Symfony\Component\Filesystem\Filesystem
-  package_manager.symfony_executable_finder:
-    class: Symfony\Component\Process\ExecutableFinder
+  # Underlying Symfony utilities for Composer Stager.
+  Symfony\Component\Filesystem\Filesystem:
+    public: false
+  Symfony\Component\Process\ExecutableFinder:
+    public: false
 
-  # Basic infrastructure services.
-  package_manager.process_factory:
-    class: Drupal\package_manager\ProcessFactory
+  # Basic infrastructure services for Composer Stager.
+  Drupal\package_manager\ProcessFactory:
     arguments:
       - '@file_system'
       - '@config.factory'
-  package_manager.file_system:
-    class: PhpTuf\ComposerStager\Infrastructure\Filesystem\Filesystem
-    arguments:
-      - '@package_manager.symfony_file_system'
-  package_manager.executable_finder:
-    class: Drupal\package_manager\ExecutableFinder
-    arguments:
-      - '@package_manager.symfony_executable_finder'
-      - '@config.factory'
+    public: false
+  PhpTuf\ComposerStager\Infrastructure\Filesystem\Filesystem:
+    autowire: true
+    public: false
+  Drupal\package_manager\ExecutableFinder:
+    arguments:
+      $config_factory: '@config.factory'
+    autowire: true
+    public: false
+  PhpTuf\ComposerStager\Infrastructure\Process\ProcessFactoryInterface:
+    alias: 'Drupal\package_manager\ProcessFactory'
+  PhpTuf\ComposerStager\Domain\Filesystem\FilesystemInterface:
+    alias: 'PhpTuf\ComposerStager\Infrastructure\Filesystem\Filesystem'
+  PhpTuf\ComposerStager\Infrastructure\Process\ExecutableFinderInterface:
+    alias: 'Drupal\package_manager\ExecutableFinder'
 
-  # Executable runners.
-  package_manager.rsync_runner:
-    class: PhpTuf\ComposerStager\Infrastructure\Process\Runner\RsyncRunner
-    arguments:
-      - '@package_manager.executable_finder'
-      - '@package_manager.process_factory'
-  package_manager.composer_runner:
-    class: PhpTuf\ComposerStager\Infrastructure\Process\Runner\ComposerRunner
-    arguments:
-      - '@package_manager.executable_finder'
-      - '@package_manager.process_factory'
+  # Executable runners for Composer Stager.
+  PhpTuf\ComposerStager\Infrastructure\Process\Runner\RsyncRunner:
+    autowire: true
+    public: false
+  PhpTuf\ComposerStager\Infrastructure\Process\Runner\ComposerRunner:
+    autowire: true
+    public: false
+  PhpTuf\ComposerStager\Domain\Process\Runner\RsyncRunnerInterface:
+    alias: 'PhpTuf\ComposerStager\Infrastructure\Process\Runner\RsyncRunner'
+  PhpTuf\ComposerStager\Domain\Process\Runner\ComposerRunnerInterface:
+    alias: 'PhpTuf\ComposerStager\Infrastructure\Process\Runner\ComposerRunner'
 
-  # File syncers.
-  package_manager.file_syncer.rsync:
-    class: PhpTuf\ComposerStager\Infrastructure\FileSyncer\RsyncFileSyncer
-    arguments:
-      - '@package_manager.file_system'
-      - '@package_manager.rsync_runner'
-  package_manager.file_syncer.php:
-    class: PhpTuf\ComposerStager\Infrastructure\FileSyncer\PhpFileSyncer
-    arguments:
-      - '@package_manager.file_system'
-  package_manager.file_syncer.factory:
-    class: Drupal\package_manager\FileSyncerFactory
-    arguments:
-      - '@package_manager.symfony_executable_finder'
-      - '@package_manager.file_syncer.php'
-      - '@package_manager.file_syncer.rsync'
-      - '@config.factory'
-  package_manager.file_syncer:
-    class: PhpTuf\ComposerStager\Domain\FileSyncer\FileSyncerInterface
-    factory: ['@package_manager.file_syncer.factory', 'create']
+  # File syncers for Composer Stager.
+  PhpTuf\ComposerStager\Infrastructure\FileSyncer\RsyncFileSyncer:
+    autowire: true
+  PhpTuf\ComposerStager\Infrastructure\FileSyncer\PhpFileSyncer:
+    autowire: true
+  Drupal\package_manager\FileSyncerFactory:
+    arguments:
+      $config_factory: '@config.factory'
+    autowire: true
+    public: false
+  PhpTuf\ComposerStager\Domain\FileSyncer\FileSyncerInterface:
+    factory: ['@Drupal\package_manager\FileSyncerFactory', 'create']
 
-  # Domain services.
+  # Services provided to Drupal by Package Manager.
   package_manager.beginner:
     class: PhpTuf\ComposerStager\Domain\Beginner
-    arguments:
-      - '@package_manager.file_syncer'
-      - '@package_manager.file_system'
+    autowire: true
   package_manager.stager:
     class: PhpTuf\ComposerStager\Domain\Stager
-    arguments:
-      - '@package_manager.composer_runner'
-      - '@package_manager.file_system'
+    autowire: true
   package_manager.committer:
     class: PhpTuf\ComposerStager\Domain\Committer
-    arguments:
-      - '@package_manager.file_syncer'
-      - '@package_manager.file_system'
+    autowire: true
   package_manager.path_locator:
     class: Drupal\package_manager\PathLocator
     arguments:
@@ -79,7 +70,7 @@ services:
   package_manager.validator.composer_executable:
     class: Drupal\package_manager\Validator\ComposerExecutableValidator
     arguments:
-      - '@package_manager.composer_runner'
+      - '@PhpTuf\ComposerStager\Domain\Process\Runner\ComposerRunnerInterface'
       - '@module_handler'
       - '@string_translation'
     tags:
@@ -143,11 +134,11 @@ services:
   package_manager.site_files_excluder:
     class: Drupal\package_manager\PathExcluder\SiteFilesExcluder
     arguments:
-      - '@package_manager.path_locator'
-      - '@stream_wrapper_manager'
-      - '@package_manager.symfony_file_system'
+      $path_locator: '@package_manager.path_locator'
+      $stream_wrapper_manager: '@stream_wrapper_manager'
     tags:
       - { name: event_subscriber }
+    autowire: true
   package_manager.sqlite_excluder:
     class: Drupal\package_manager\PathExcluder\SqliteDatabaseExcluder
     arguments:

package_manager/src/FileSyncerFactory.php

@@ -6,6 +6,8 @@ use Drupal\Core\Config\ConfigFactoryInterface;
 use PhpTuf\ComposerStager\Domain\FileSyncer\FileSyncerFactoryInterface;
 use PhpTuf\ComposerStager\Domain\FileSyncer\FileSyncerInterface;
 use PhpTuf\ComposerStager\Infrastructure\FileSyncer\FileSyncerFactory as StagerFileSyncerFactory;
+use PhpTuf\ComposerStager\Infrastructure\FileSyncer\PhpFileSyncer;
+use PhpTuf\ComposerStager\Infrastructure\FileSyncer\RsyncFileSyncer;
 use Symfony\Component\Process\ExecutableFinder;
 
 /**
@@ -23,14 +25,14 @@ class FileSyncerFactory implements FileSyncerFactoryInterface {
   /**
    * The PHP file syncer service.
    *
-   * @var \PhpTuf\ComposerStager\Domain\FileSyncer\FileSyncerInterface
+   * @var \PhpTuf\ComposerStager\Infrastructure\FileSyncer\PhpFileSyncer
    */
   protected $phpFileSyncer;
 
   /**
    * The rsync file syncer service.
    *
-   * @var \PhpTuf\ComposerStager\Domain\FileSyncer\FileSyncerInterface
+   * @var \PhpTuf\ComposerStager\Infrastructure\FileSyncer\RsyncFileSyncer
    */
   protected $rsyncFileSyncer;
 
@@ -46,14 +48,14 @@ class FileSyncerFactory implements FileSyncerFactoryInterface {
    *
    * @param \Symfony\Component\Process\ExecutableFinder $executable_finder
    *   The Symfony executable finder.
-   * @param \PhpTuf\ComposerStager\Domain\FileSyncer\FileSyncerInterface $php_file_syncer
+   * @param \PhpTuf\ComposerStager\Infrastructure\FileSyncer\PhpFileSyncer $php_file_syncer
    *   The PHP file syncer service.
-   * @param \PhpTuf\ComposerStager\Domain\FileSyncer\FileSyncerInterface $rsync_file_syncer
+   * @param \PhpTuf\ComposerStager\Infrastructure\FileSyncer\RsyncFileSyncer $rsync_file_syncer
    *   The rsync file syncer service.
    * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
    *   The config factory service.
    */
-  public function __construct(ExecutableFinder $executable_finder, FileSyncerInterface $php_file_syncer, FileSyncerInterface $rsync_file_syncer, ConfigFactoryInterface $config_factory) {
+  public function __construct(ExecutableFinder $executable_finder, PhpFileSyncer $php_file_syncer, RsyncFileSyncer $rsync_file_syncer, ConfigFactoryInterface $config_factory) {
     $this->decorated = new StagerFileSyncerFactory($executable_finder, $php_file_syncer, $rsync_file_syncer);
     $this->phpFileSyncer = $php_file_syncer;
     $this->rsyncFileSyncer = $rsync_file_syncer;

package_manager/tests/modules/package_manager_bypass/src/PackageManagerBypassServiceProvider.php

@@ -18,9 +18,11 @@ class PackageManagerBypassServiceProvider extends ServiceProviderBase {
     parent::alter($container);
 
     $container->getDefinition('package_manager.beginner')
-      ->setClass(Beginner::class);
+      ->setClass(Beginner::class)
+      ->setArguments([]);
     $container->getDefinition('package_manager.stager')
-      ->setClass(Stager::class);
+      ->setClass(Stager::class)
+      ->setArguments([]);
 
     $container->register('package_manager_bypass.committer')
       ->setClass(Committer::class)

package_manager/tests/modules/package_manager_test_fixture/package_manager_test_fixture.services.yml

@@ -3,6 +3,6 @@ services:
     class: Drupal\package_manager_test_fixture\EventSubscriber\FixtureStager
     arguments:
       - '@state'
-      - '@package_manager.symfony_file_system'
+      - '@Symfony\Component\Filesystem\Filesystem'
     tags:
       - { name: event_subscriber }

package_manager/tests/src/Kernel/ComposerExecutableValidatorTest.php

@@ -2,12 +2,13 @@
 
 namespace Drupal\Tests\package_manager\Kernel;
 
+use Drupal\Core\DependencyInjection\ContainerBuilder;
 use Drupal\Core\Url;
 use Drupal\package_manager\Event\PreCreateEvent;
 use Drupal\package_manager\Validator\ComposerExecutableValidator;
 use Drupal\package_manager\ValidationResult;
+use PhpTuf\ComposerStager\Domain\Process\Runner\ComposerRunnerInterface;
 use PhpTuf\ComposerStager\Exception\IOException;
-use PhpTuf\ComposerStager\Infrastructure\Process\ExecutableFinderInterface;
 use Prophecy\Argument;
 
 /**
@@ -17,19 +18,42 @@ use Prophecy\Argument;
  */
 class ComposerExecutableValidatorTest extends PackageManagerKernelTestBase {
 
+  /**
+   * The mocked Composer runner.
+   *
+   * @var \Prophecy\Prophecy\ObjectProphecy|\PhpTuf\ComposerStager\Domain\Process\Runner\ComposerRunnerInterface
+   */
+  private $composerRunner;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp(): void {
+    $this->composerRunner = $this->prophesize(ComposerRunnerInterface::class);
+    parent::setUp();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function register(ContainerBuilder $container) {
+    parent::register($container);
+
+    $container->getDefinition('package_manager.validator.composer_executable')
+      ->setArgument('$composer', $this->composerRunner->reveal());
+  }
+
   /**
    * Tests that an error is raised if the Composer executable isn't found.
    */
   public function testErrorIfComposerNotFound(): void {
     $exception = new IOException("This is your regularly scheduled error.");
 
-    // The executable finder throws an exception if it can't find the requested
-    // executable.
-    $exec_finder = $this->prophesize(ExecutableFinderInterface::class);
-    $exec_finder->find('composer')
+    // If the Composer executable isn't found, the executable finder will throw
+    // an exception, which will not be caught by the Composer runner.
+    $this->composerRunner->run(Argument::cetera())
       ->willThrow($exception)
       ->shouldBeCalled();
-    $this->container->set('package_manager.executable_finder', $exec_finder->reveal());
 
     // The validator should translate that exception into an error.
     $error = ValidationResult::createError([
@@ -38,7 +62,6 @@ class ComposerExecutableValidatorTest extends PackageManagerKernelTestBase {
     $this->assertResults([$error], PreCreateEvent::class);
 
     $this->enableModules(['help']);
-    $this->container->set('package_manager.executable_finder', $exec_finder->reveal());
     $this->assertResultsWithHelp([$error], PreCreateEvent::class);
   }
 
@@ -122,10 +145,7 @@ class ComposerExecutableValidatorTest extends PackageManagerKernelTestBase {
     // Mock the output of `composer --version`, will be passed to the validator,
     // which is itself a callback function that gets called repeatedly as
     // Composer produces output.
-    /** @var \PhpTuf\ComposerStager\Domain\Process\Runner\ComposerRunnerInterface|\Prophecy\Prophecy\ObjectProphecy $runner */
-    $runner = $this->prophesize('\PhpTuf\ComposerStager\Domain\Process\Runner\ComposerRunnerInterface');
-
-    $runner->run(['--version'], Argument::type(ComposerExecutableValidator::class))
+    $this->composerRunner->run(['--version'], Argument::type(ComposerExecutableValidator::class))
       // Whatever is passed to ::run() will be passed to this mock callback in
       // $arguments, and we know exactly what that will contain: an array of
       // command arguments for Composer, and the validator object.
@@ -137,14 +157,12 @@ class ComposerExecutableValidatorTest extends PackageManagerKernelTestBase {
         // recognized, supported version number out of this output.
         $validator($validator::OUT, "Composer version $reported_version");
       });
-    $this->container->set('package_manager.composer_runner', $runner->reveal());
 
     // If the validator can't find a recognized, supported version of Composer,
     // it should produce errors.
     $this->assertResults($expected_results, PreCreateEvent::class);
 
     $this->enableModules(['help']);
-    $this->container->set('package_manager.composer_runner', $runner->reveal());
     $this->assertResultsWithHelp($expected_results, PreCreateEvent::class);
   }
 

package_manager/tests/src/Kernel/ExecutableFinderTest.php

@@ -2,6 +2,9 @@
 
 namespace Drupal\Tests\package_manager\Kernel;
 
+use Drupal\Core\DependencyInjection\ContainerBuilder;
+use Drupal\package_manager\ExecutableFinder;
+use PhpTuf\ComposerStager\Infrastructure\Process\ExecutableFinderInterface;
 use Symfony\Component\Process\ExecutableFinder as SymfonyExecutableFinder;
 
 /**
@@ -12,10 +15,11 @@ use Symfony\Component\Process\ExecutableFinder as SymfonyExecutableFinder;
 class ExecutableFinderTest extends PackageManagerKernelTestBase {
 
   /**
-   * Tests that the executable finder looks for paths in configuration.
+   * {@inheritdoc}
    */
-  public function testCheckConfigurationForExecutablePath(): void {
-    $symfony_executable_finder = new class () extends SymfonyExecutableFinder {
+  public function register(ContainerBuilder $container) {
+    // Mock a Symfony executable finder that always returns /dev/null.
+    $symfony_executable_finder = new class extends SymfonyExecutableFinder {
 
       /**
        * {@inheritdoc}
@@ -25,13 +29,19 @@ class ExecutableFinderTest extends PackageManagerKernelTestBase {
       }
 
     };
-    $this->container->set('package_manager.symfony_executable_finder', $symfony_executable_finder);
+    $container->getDefinition(ExecutableFinder::class)
+      ->setArgument('$symfony_executable_finder', $symfony_executable_finder);
+  }
 
+  /**
+   * Tests that the executable finder looks for paths in configuration.
+   */
+  public function testCheckConfigurationForExecutablePath(): void {
     $this->config('package_manager.settings')
       ->set('executables.composer', '/path/to/composer')
       ->save();
 
-    $executable_finder = $this->container->get('package_manager.executable_finder');
+    $executable_finder = $this->container->get(ExecutableFinderInterface::class);
     $this->assertSame('/path/to/composer', $executable_finder->find('composer'));
     $this->assertSame('/dev/null', $executable_finder->find('rsync'));
   }

package_manager/tests/src/Kernel/FileSyncerFactoryTest.php

@@ -3,6 +3,9 @@
 namespace Drupal\Tests\package_manager\Kernel;
 
 use Drupal\KernelTests\KernelTestBase;
+use PhpTuf\ComposerStager\Domain\FileSyncer\FileSyncerInterface;
+use PhpTuf\ComposerStager\Infrastructure\FileSyncer\PhpFileSyncer;
+use PhpTuf\ComposerStager\Infrastructure\FileSyncer\RsyncFileSyncer;
 
 /**
  * @covers \Drupal\package_manager\FileSyncerFactory
@@ -40,19 +43,17 @@ class FileSyncerFactoryTest extends KernelTestBase {
    * @dataProvider providerFactory
    */
   public function testFactory(?string $configured_syncer): void {
-    $factory = $this->container->get('package_manager.file_syncer.factory');
-
     switch ($configured_syncer) {
       case 'rsync':
-        $expected_syncer = $this->container->get('package_manager.file_syncer.rsync');
+        $expected_syncer = RsyncFileSyncer::class;
         break;
 
       case 'php':
-        $expected_syncer = $this->container->get('package_manager.file_syncer.php');
+        $expected_syncer = PhpFileSyncer::class;
         break;
 
       default:
-        $expected_syncer = $factory->create();
+        $expected_syncer = FileSyncerInterface::class;
         break;
     }
 
@@ -60,7 +61,7 @@ class FileSyncerFactoryTest extends KernelTestBase {
       ->set('file_syncer', $configured_syncer)
       ->save();
 
-    $this->assertSame($expected_syncer, $factory->create());
+    $this->assertInstanceOf($expected_syncer, $this->container->get(FileSyncerInterface::class));
   }
 
 }