MCLOUD-5507: Improve the GitHub installation workflow (magento#710)

Author: shiftedreality

src/Command/Dev/UpdateComposer.php

@@ -9,9 +9,12 @@
 
 use Magento\MagentoCloud\Command\Dev\UpdateComposer\ClearModuleRequirements;
 use Magento\MagentoCloud\Command\Dev\UpdateComposer\ComposerGenerator;
+use Magento\MagentoCloud\Config\ConfigException;
 use Magento\MagentoCloud\Config\GlobalSection;
 use Magento\MagentoCloud\Filesystem\Driver\File;
 use Magento\MagentoCloud\Filesystem\FileList;
+use Magento\MagentoCloud\Filesystem\FileSystemException;
+use Magento\MagentoCloud\Package\UndefinedPackageException;
 use Magento\MagentoCloud\Shell\ShellInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
@@ -24,7 +27,7 @@
  */
 class UpdateComposer extends Command
 {
-    const NAME = 'dev:git:update-composer';
+    public const NAME = 'dev:git:update-composer';
 
     /**
      * @var ComposerGenerator
@@ -85,7 +88,7 @@ public function __construct(
     /**
      * @inheritdoc
      */
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName(static::NAME)
             ->setDescription('Updates composer for deployment from git.');
@@ -96,6 +99,10 @@ protected function configure()
     /**
      * {@inheritdoc}
      *
+     * @throws ConfigException
+     * @throws FileSystemException
+     * @throws UndefinedPackageException
+     *
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     protected function execute(InputInterface $input, OutputInterface $output)
@@ -116,7 +123,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         $this->file->filePutContents(
             $this->fileList->getMagentoComposer(),
-            json_encode($composer, JSON_PRETTY_PRINT)
+            json_encode($composer, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)
         );
 
         $output->writeln('Run composer update');

src/Command/Dev/UpdateComposer/ComposerGenerator.php

@@ -9,19 +9,21 @@
 
 use Magento\MagentoCloud\Filesystem\DirectoryList;
 use Magento\MagentoCloud\Filesystem\Driver\File;
+use Magento\MagentoCloud\Filesystem\FileSystemException;
 use Magento\MagentoCloud\Package\MagentoVersion;
+use Magento\MagentoCloud\Package\UndefinedPackageException;
 
 /**
  * Generates composer.json data for installation from git.
  */
 class ComposerGenerator
 {
-    const REPO_TYPE_SINGLE_PACKAGE = 'single-package';
+    public const REPO_TYPE_SINGLE_PACKAGE = 'single-package';
 
     /**
      * Type for packages with modules in the root directory such as Inventory
      */
-    const REPO_TYPE_FLAT_STRUCTURE = 'flat-structure';
+    public const REPO_TYPE_FLAT_STRUCTURE = 'flat-structure';
 
     /**
      * @var DirectoryList
@@ -58,6 +60,9 @@ public function __construct(
      *
      * @param array $repoOptions
      * @return array
+     * @throws UndefinedPackageException
+     * @throws FileSystemException
+     *
      * @codeCoverageIgnore
      */
     public function generate(array $repoOptions): array
@@ -125,6 +130,7 @@ public function getInstallFromGitScripts(array $repoOptions): array
      *
      * @param array $repoOptions
      * @return array
+     * @throws UndefinedPackageException
      */
     private function getBaseComposer(array $repoOptions): array
     {
@@ -208,8 +214,11 @@ private function getBaseComposer(array $repoOptions): array
      * @param array $repoOptions
      * @param array $composer
      * @return array
-     * @codeCoverageIgnore
+     * @throws FilesystemException
+     *
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     *
+     * @codeCoverageIgnore
      */
     private function addModules(array $repoOptions, array $composer): array
     {
@@ -252,7 +261,7 @@ private function addModules(array $repoOptions, array $composer): array
      * @param string $dir
      * @param array $composer
      * @param string|null $version
-     * @throws \Magento\MagentoCloud\Filesystem\FileSystemException
+     * @throws FileSystemException
      */
     private function addModule(string $dir, array &$composer, string $version = null): void
     {
@@ -277,7 +286,7 @@ private function addModule(string $dir, array &$composer, string $version = null
      */
     private function isSinglePackage(array $repoOptions): bool
     {
-        return isset($repoOptions['type']) && $repoOptions['type'] == self::REPO_TYPE_SINGLE_PACKAGE;
+        return isset($repoOptions['type']) && $repoOptions['type'] === self::REPO_TYPE_SINGLE_PACKAGE;
     }
 
     /**
@@ -288,6 +297,6 @@ private function isSinglePackage(array $repoOptions): bool
      */
     private function isFlatStructurePackage(array $repoOptions): bool
     {
-        return isset($repoOptions['type']) && $repoOptions['type'] == self::REPO_TYPE_FLAT_STRUCTURE;
+        return isset($repoOptions['type']) && $repoOptions['type'] === self::REPO_TYPE_FLAT_STRUCTURE;
     }
 }

src/Test/Unit/Command/Dev/UpdateComposerTest.php

@@ -12,8 +12,8 @@
 use Magento\MagentoCloud\Filesystem\Driver\File;
 use Magento\MagentoCloud\Filesystem\FileList;
 use Magento\MagentoCloud\Shell\ShellInterface;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
-use PHPUnit_Framework_MockObject_MockObject as Mock;
 use Symfony\Component\Console\Tester\CommandTester;
 
 /**
@@ -22,40 +22,43 @@
 class UpdateComposerTest extends TestCase
 {
     /**
-     * @var UpdateComposer\ComposerGenerator|Mock
+     * @var UpdateComposer
+     */
+    private $updateComposerCommand;
+
+    /**
+     * @var UpdateComposer\ComposerGenerator|MockObject
      */
     private $composerGeneratorMock;
 
     /**
-     * @var UpdateComposer\ClearModuleRequirements|Mock
+     * @var UpdateComposer\ClearModuleRequirements|MockObject
      */
     private $clearModuleRequirementsMock;
 
     /**
-     * @var ShellInterface|Mock
+     * @var ShellInterface|MockObject
      */
     private $shellMock;
 
     /**
-     * @var GlobalSection|Mock
+     * @var GlobalSection|MockObject
      */
     private $globalSectionMock;
 
     /**
-     * @var FileList|Mock
+     * @var FileList|MockObject
      */
     private $fileListMock;
 
     /**
-     * @var File|Mock
+     * @var File|MockObject
      */
     private $fileMock;
 
     /**
-     * @var UpdateComposer
+     * @inheritDoc
      */
-    private $updateComposerCommand;
-
     protected function setUp()
     {
         $this->composerGeneratorMock = $this->createMock(UpdateComposer\ComposerGenerator::class);
@@ -75,7 +78,7 @@ protected function setUp()
         );
     }
 
-    public function testExecute()
+    public function testExecute(): void
     {
         $gitOptions = [
             'clear_magento_module_requirements' => true,