Implement command loader

Fix test failures

Author: ihor-sviziev

app/code/Magento/Backend/Console/Command/MaintenanceAllowIpsCommand.php

@@ -22,10 +22,10 @@ class MaintenanceAllowIpsCommand extends AbstractSetupCommand
     /**
      * Names of input arguments or options
      */
-    const INPUT_KEY_IP = 'ip';
-    const INPUT_KEY_NONE = 'none';
-    const INPUT_KEY_ADD = 'add';
-    const NAME = 'maintenance:allow-ips';
+    public const INPUT_KEY_IP = 'ip';
+    public const INPUT_KEY_NONE = 'none';
+    public const INPUT_KEY_ADD = 'add';
+    public const NAME = 'maintenance:allow-ips';
 
     /**
      * @var MaintenanceMode

app/code/Magento/Backend/Console/Command/MaintenanceDisableCommand.php

@@ -10,7 +10,7 @@
  */
 class MaintenanceDisableCommand extends AbstractMaintenanceCommand
 {
-    const NAME = 'maintenance:disable';
+    public const NAME = 'maintenance:disable';
 
     /**
      * Initialization of the command

app/code/Magento/Backend/Console/Command/MaintenanceEnableCommand.php

@@ -10,7 +10,7 @@
  */
 class MaintenanceEnableCommand extends AbstractMaintenanceCommand
 {
-    const NAME = 'maintenance:enable';
+    public const NAME = 'maintenance:enable';
 
     /**
      * Initialization of the command

app/code/Magento/Backend/Console/Command/MaintenanceStatusCommand.php

@@ -16,7 +16,7 @@
  */
 class MaintenanceStatusCommand extends AbstractSetupCommand
 {
-    const NAME = 'maintenance:status';
+    public const NAME = 'maintenance:status';
 
     /**
      * @var MaintenanceMode $maintenanceMode

lib/internal/Magento/Framework/App/Test/Unit/Console/CommandLoader/AggregateTest.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /**
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
@@ -18,14 +19,14 @@
  */
 class AggregateTest extends TestCase
 {
-    /** @var MockObject */
-    private $firstMockCommandLoader;
+    /** @var CommandLoaderInterface|MockObject */
+    private MockObject|CommandLoaderInterface $firstMockCommandLoader;
 
-    /** @var MockObject */
-    private $secondMockCommandLoader;
+    /** @var CommandLoaderInterface|MockObject */
+    private MockObject|CommandLoaderInterface $secondMockCommandLoader;
 
     /** @var Aggregate */
-    private $aggregateCommandLoader;
+    private Aggregate $aggregateCommandLoader;
 
     protected function setUp(): void
     {
@@ -41,15 +42,15 @@ protected function setUp(): void
      *
      * @dataProvider provideTestCasesForHas
      */
-    public function testHas(bool $firstResult, bool $secondResult, bool $overallResult)
+    public function testHas(bool $firstResult, bool $secondResult, bool $overallResult): void
     {
         $this->firstMockCommandLoader->method('has')->with('foo')->willReturn($firstResult);
         $this->secondMockCommandLoader->method('has')->with('foo')->willReturn($secondResult);
 
         $this->assertEquals($overallResult, $this->aggregateCommandLoader->has('foo'));
     }
 
-    public function provideTestCasesForHas()
+    public function provideTestCasesForHas(): array
     {
         return [
             [true, false, true],
@@ -66,7 +67,7 @@ public function provideTestCasesForHas()
      *
      * @dataProvider provideTestCasesForGet
      */
-    public function testGet(?Command $firstCmd, ?Command $secondCmd)
+    public function testGet(?Command $firstCmd, ?Command $secondCmd): void
     {
         $firstHas = (bool)$firstCmd;
         $secondHas = (bool)$secondCmd;
@@ -78,7 +79,7 @@ public function testGet(?Command $firstCmd, ?Command $secondCmd)
         $this->assertInstanceOf(Command::class, $this->aggregateCommandLoader->get('foo'));
     }
 
-    public function provideTestCasesForGet()
+    public function provideTestCasesForGet(): array
     {
         return [
             [
@@ -96,7 +97,7 @@ public function provideTestCasesForGet()
      * When none of the internal command loaders have matching commands, the aggregate command loader
      * will throw an exception. @see CommandNotFoundException
      */
-    public function testGetThrow()
+    public function testGetThrow(): void
     {
         $this->firstMockCommandLoader->method('has')->with('foo')->willReturn(false);
         $this->secondMockCommandLoader->method('has')->with('foo')->willReturn(false);
@@ -109,7 +110,7 @@ public function testGetThrow()
      * An aggregate command loader's `getNames` method returns the merged array of the `getNames`
      * return values of all its internal command loaders
      */
-    public function testGetNames()
+    public function testGetNames(): void
     {
         $this->firstMockCommandLoader->method('getNames')->willReturn(['foo', 'bar']);
         $this->secondMockCommandLoader->method('getNames')->willReturn(['baz', 'qux']);

lib/internal/Magento/Framework/App/Test/Unit/Console/CommandLoaderTest.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /**
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
@@ -7,14 +8,15 @@
 
 use Magento\Framework\Console\CommandLoader;
 use Magento\Framework\ObjectManagerInterface;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Exception\CommandNotFoundException;
 
 class CommandLoaderTest extends TestCase
 {
-    /** @var \PHPUnit\Framework\MockObject\MockObject|ObjectManagerInterface */
-    private $objectManagerMock;
+    /** @var MockObject|ObjectManagerInterface */
+    private ObjectManagerInterface|MockObject $objectManagerMock;
 
     protected function setUp(): void
     {
@@ -24,7 +26,7 @@ protected function setUp(): void
     /**
      * Test that the command loader, when provided zero commands, does not have a command named "foo"
      */
-    public function testHasWithZeroCommands()
+    public function testHasWithZeroCommands(): void
     {
         $subj = new CommandLoader($this->objectManagerMock, []);
 
@@ -34,7 +36,7 @@ public function testHasWithZeroCommands()
     /**
      * Test that the command loader will return true when provided with a command "foo"
      */
-    public function testHasWithAtLeastOneCommand()
+    public function testHasWithAtLeastOneCommand(): void
     {
         $subj = new CommandLoader($this->objectManagerMock, [
             [
@@ -49,7 +51,7 @@ public function testHasWithAtLeastOneCommand()
     /**
      * Test that the command loader will throw a CommandNotFoundException when it does not have the requested command
      */
-    public function testGetWithZeroCommands()
+    public function testGetWithZeroCommands(): void
     {
         $subj = new CommandLoader($this->objectManagerMock, []);
 
@@ -61,7 +63,7 @@ public function testGetWithZeroCommands()
     /**
      * Test that the command loader returns a command when one it has is requested
      */
-    public function testGetWithAtLeastOneCommand()
+    public function testGetWithAtLeastOneCommand(): void
     {
         $this->objectManagerMock
             ->method('create')
@@ -81,7 +83,7 @@ public function testGetWithAtLeastOneCommand()
     /**
      * Test that the command loader will return an empty "names" array when it has none
      */
-    public function testGetNamesWithZeroCommands()
+    public function testGetNamesWithZeroCommands(): void
     {
         $subj = new CommandLoader($this->objectManagerMock, []);
 
@@ -91,7 +93,7 @@ public function testGetNamesWithZeroCommands()
     /**
      * Test that the command loader returns an array of its command names when `getNames` is called
      */
-    public function testGetNames()
+    public function testGetNames(): void
     {
         $subj = new CommandLoader($this->objectManagerMock, [
             [

lib/internal/Magento/Framework/Console/Cli.php

@@ -7,6 +7,7 @@
 
 namespace Magento\Framework\Console;
 
+use Laminas\ServiceManager\ServiceManager;
 use Magento\Framework\App\Bootstrap;
 use Magento\Framework\App\DeploymentConfig;
 use Magento\Framework\App\Filesystem\DirectoryList;
@@ -39,16 +40,18 @@ class Cli extends Console\Application
     /**
      * Name of input option.
      */
-    const INPUT_KEY_BOOTSTRAP = 'bootstrap';
+    public const INPUT_KEY_BOOTSTRAP = 'bootstrap';
 
     /**#@+
      * Cli exit codes.
      */
-    const RETURN_SUCCESS = 0;
-    const RETURN_FAILURE = 1;
+    public const RETURN_SUCCESS = 0;
+    public const RETURN_FAILURE = 1;
     /**#@-*/
 
-    /**#@-*/
+    /**
+     * @var ServiceManager
+     */
     private $serviceManager;
 
     /**
@@ -59,8 +62,6 @@ class Cli extends Console\Application
     private $initException;
 
     /**
-     * Object Manager.
-     *
      * @var ObjectManagerInterface
      */
     private $objectManager;

lib/internal/Magento/Framework/Console/CommandLoader.php

@@ -9,6 +9,7 @@
 namespace Magento\Framework\Console;
 
 use Magento\Framework\ObjectManagerInterface;
+use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\CommandLoader\CommandLoaderInterface;
 use Symfony\Component\Console\Exception\CommandNotFoundException;
 
@@ -17,15 +18,14 @@
  */
 class CommandLoader implements CommandLoaderInterface
 {
-
     /**
      * List of commands in the format [ 'command:name' => 'Fully\Qualified\ClassName' ]
      * @var array
      */
-    private $commands;
+    private array $commands;
 
     /** @var ObjectManagerInterface */
-    private $objectManager;
+    private ObjectManagerInterface $objectManager;
 
     /**
      * @param ObjectManagerInterface $objectManager
@@ -43,10 +43,10 @@ public function __construct(ObjectManagerInterface $objectManager, array $comman
      * If the command name is not configured, throw a CommandNotFoundException.
      *
      * @param string $name
-     * @return \Symfony\Component\Console\Command\Command
+     * @return Command
      * @throws CommandNotFoundException
      */
-    public function get($name): \Symfony\Component\Console\Command\Command
+    public function get(string $name): Command
     {
         if ($this->has($name)) {
             return $this->objectManager->create($this->commands[$name]);
@@ -60,7 +60,7 @@ public function get($name): \Symfony\Component\Console\Command\Command
      * @param string $name
      * @return bool
      */
-    public function has($name): bool
+    public function has(string $name): bool
     {
         return isset($this->commands[$name]);
     }

lib/internal/Magento/Framework/Console/CommandLoader/Aggregate.php

@@ -8,6 +8,7 @@
 
 namespace Magento\Framework\Console\CommandLoader;
 
+use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\CommandLoader\CommandLoaderInterface;
 use Symfony\Component\Console\Exception\CommandNotFoundException;
 
@@ -17,7 +18,7 @@
 class Aggregate implements CommandLoaderInterface
 {
     /** @var CommandLoaderInterface[] */
-    private $commandLoaders;
+    private array $commandLoaders;
 
     /**
      * @param array $commandLoaders
@@ -33,10 +34,10 @@ public function __construct(array $commandLoaders = [])
      * If $name does not refer to a command, throw a CommandNotFoundException.
      *
      * @param string $name
-     * @return \Symfony\Component\Console\Command\Command
+     * @return Command
      * @throws CommandNotFoundException
      */
-    public function get($name): \Symfony\Component\Console\Command\Command
+    public function get(string $name): Command
     {
         foreach ($this->commandLoaders as $commandLoader) {
             if ($commandLoader->has($name)) {
@@ -53,7 +54,7 @@ public function get($name): \Symfony\Component\Console\Command\Command
      * @param string $name
      * @return bool
      */
-    public function has($name): bool
+    public function has(string $name): bool
     {
         foreach ($this->commandLoaders as $commandLoader) {
             if ($commandLoader->has($name)) {
@@ -71,7 +72,7 @@ public function has($name): bool
      */
     public function getNames(): array
     {
-        return array_merge([], ...array_map(function (CommandLoaderInterface $commandLoader) {
+        return array_merge([], ...array_map(static function (CommandLoaderInterface $commandLoader) {
             return $commandLoader->getNames();
         }, $this->commandLoaders));
     }

setup/src/Magento/Setup/Console/Command/AdminUserCreateCommand.php

@@ -21,7 +21,7 @@
  */
 class AdminUserCreateCommand extends AbstractSetupCommand
 {
-    const NAME = 'admin:user:create';
+    public const NAME = 'admin:user:create';
     /**
      * @var InstallerFactory
      */