Merge pull request #163 from Bellangelo/add-question-option-helper-set

Allow composer to ask for credentials

Author: asgrim

src/ComposerIntegration/MinimalHelperSet.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Php\Pie\ComposerIntegration;
+
+use Symfony\Component\Console\Helper\HelperSet;
+use Symfony\Component\Console\Helper\QuestionHelper;
+use Webmozart\Assert\Assert;
+
+/** @internal This is not public API for PIE, so should not be depended upon unless you accept the risk of BC breaks */
+class MinimalHelperSet extends HelperSet
+{
+    /** @param array{question: QuestionHelper} $helpers */
+    public function __construct(array $helpers)
+    {
+        Assert::isInstanceOf(
+            $helpers['question'] ?? null,
+            QuestionHelper::class,
+            'The question option must be an instance of %2$s, got %s',
+        );
+
+        parent::__construct($helpers);
+    }
+}

src/ComposerIntegration/QuieterConsoleIO.php

@@ -7,7 +7,6 @@
 use Closure;
 use Composer\IO\ConsoleIO;
 use Composer\IO\IOInterface;
-use Symfony\Component\Console\Helper\HelperSet;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
@@ -21,7 +20,7 @@ class QuieterConsoleIO extends ConsoleIO
     /** @var string[] */
     public array $errors = [];
 
-    public function __construct(InputInterface $input, OutputInterface $output, HelperSet $helperSet)
+    public function __construct(InputInterface $input, OutputInterface $output, MinimalHelperSet $helperSet)
     {
         parent::__construct($input, $output, $helperSet);
 

src/Container.php

@@ -14,6 +14,7 @@
 use Php\Pie\Command\InfoCommand;
 use Php\Pie\Command\InstallCommand;
 use Php\Pie\Command\ShowCommand;
+use Php\Pie\ComposerIntegration\MinimalHelperSet;
 use Php\Pie\ComposerIntegration\QuieterConsoleIO;
 use Php\Pie\DependencyResolver\DependencyResolver;
 use Php\Pie\DependencyResolver\ResolveDependencyWithComposer;
@@ -24,7 +25,7 @@
 use Php\Pie\Installing\UnixInstall;
 use Php\Pie\Installing\WindowsInstall;
 use Psr\Container\ContainerInterface;
-use Symfony\Component\Console\Helper\HelperSet;
+use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Input\ArgvInput;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\ConsoleOutput;
@@ -50,7 +51,11 @@ public static function factory(): ContainerInterface
             return new QuieterConsoleIO(
                 $container->get(InputInterface::class),
                 $container->get(OutputInterface::class),
-                new HelperSet(),
+                new MinimalHelperSet(
+                    [
+                        'question' => new QuestionHelper(),
+                    ],
+                ),
             );
         });
 

test/unit/ComposerIntegration/MinimalHelperSetTest.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Php\PieUnitTest\ComposerIntegration;
+
+use Php\Pie\ComposerIntegration\MinimalHelperSet;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Helper\QuestionHelper;
+
+#[CoversClass(MinimalHelperSet::class)]
+class MinimalHelperSetTest extends TestCase
+{
+    public function testHappyPath(): void
+    {
+        $this->expectNotToPerformAssertions();
+        new MinimalHelperSet(['question' => $this->createMock(QuestionHelper::class)]);
+    }
+}

test/unit/ComposerIntegration/QuieterConsoleIOTest.php

@@ -5,11 +5,11 @@
 namespace Php\PieUnitTest\ComposerIntegration;
 
 use Composer\IO\IOInterface;
+use Php\Pie\ComposerIntegration\MinimalHelperSet;
 use Php\Pie\ComposerIntegration\QuieterConsoleIO;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\Console\Helper\HelperSet;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\Output;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -29,7 +29,7 @@ public function testErrorsAreLoggedAndWrittenWhenVerbose(): void
             ->method('write')
             ->with('Oh no');
 
-        $io = new QuieterConsoleIO($symfonyInput, $symfonyOutput, new HelperSet([]));
+        $io = new QuieterConsoleIO($symfonyInput, $symfonyOutput, $this->createMock(MinimalHelperSet::class));
         $io->writeError('Oh no');
 
         self::assertSame(['Oh no'], $io->errors);
@@ -47,7 +47,7 @@ public function testArrayOfErrorsAreLoggedAndWrittenWhenVerbose(): void
             ->method('write')
             ->with(['Oh no', 'Bad things']);
 
-        $io = new QuieterConsoleIO($symfonyInput, $symfonyOutput, new HelperSet([]));
+        $io = new QuieterConsoleIO($symfonyInput, $symfonyOutput, $this->createMock(MinimalHelperSet::class));
         $io->writeError(['Oh no', 'Bad things']);
 
         self::assertSame(['Oh no', 'Bad things'], $io->errors);
@@ -64,7 +64,7 @@ public function testErrorsAreLoggedButNotWritten(): void
             ->expects(self::never())
             ->method('write');
 
-        $io = new QuieterConsoleIO($symfonyInput, $symfonyOutput, new HelperSet([]));
+        $io = new QuieterConsoleIO($symfonyInput, $symfonyOutput, $this->createMock(MinimalHelperSet::class));
         $io->writeError('Oh no');
 
         self::assertSame(['Oh no'], $io->errors);
@@ -105,7 +105,7 @@ protected function doWrite(string $message, bool $newline): void
         };
         $symfonyOutput->setVerbosity($symfonyVerbosity);
 
-        $io = new QuieterConsoleIO($symfonyInput, $symfonyOutput, new HelperSet([]));
+        $io = new QuieterConsoleIO($symfonyInput, $symfonyOutput, $this->createMock(MinimalHelperSet::class));
 
         $io->write('Quiet', verbosity: IOInterface::QUIET);
         $io->write('Normal', verbosity: IOInterface::NORMAL);

test/unit/DependencyResolver/UnableToResolveRequirementTest.php

@@ -5,12 +5,12 @@
 namespace Php\PieUnitTest\DependencyResolver;
 
 use Composer\Package\PackageInterface;
+use Php\Pie\ComposerIntegration\MinimalHelperSet;
 use Php\Pie\ComposerIntegration\QuieterConsoleIO;
 use Php\Pie\DependencyResolver\RequestedPackageAndVersion;
 use Php\Pie\DependencyResolver\UnableToResolveRequirement;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\Console\Helper\HelperSet;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
@@ -42,7 +42,7 @@ public function testFromRequirementWithVersion(): void
         $io = new QuieterConsoleIO(
             $this->createMock(InputInterface::class),
             $this->createMock(OutputInterface::class),
-            $this->createMock(HelperSet::class),
+            $this->createMock(MinimalHelperSet::class),
         );
         $io->writeError('message1');
         $io->writeError('message2', true, QuieterConsoleIO::VERY_VERBOSE);
@@ -58,7 +58,7 @@ public function testFromRequirementWithoutVersion(): void
         $io = new QuieterConsoleIO(
             $this->createMock(InputInterface::class),
             $this->createMock(OutputInterface::class),
-            $this->createMock(HelperSet::class),
+            $this->createMock(MinimalHelperSet::class),
         );
         $io->writeError('message1');
         $io->writeError('message2', true, QuieterConsoleIO::VERY_VERBOSE);