MCLOUD-5688: Replace usages of PHPUnit_Framework_MockObject_MockObject with MockObject (magento#713)

Author: shiftedreality

config/services.xml

@@ -51,6 +51,7 @@
         <service id="Magento\MagentoCloud\Service\ServiceMismatchException" autowire="false" />
         <service id="Magento\MagentoCloud\Shell\Process" autowire="false" />
         <service id="Magento\MagentoCloud\Shell\ProcessException" autowire="false" />
+        <service id="Magento\MagentoCloud\App\LoggerException" autowire="false" />
         <service id="Symfony\Component\Yaml\Parser" autowire="false" />
         <service id="Symfony\Component\Yaml\Dumper" autowire="false" />
         <!-- Service argument configuration -->

src/App/Logger.php

@@ -12,6 +12,8 @@
 use Magento\MagentoCloud\Filesystem\Driver\File;
 use Magento\MagentoCloud\App\Logger\Pool;
 use Magento\MagentoCloud\App\Logger\Processor\SanitizeProcessor;
+use Magento\MagentoCloud\Filesystem\FileSystemException;
+use Magento\MagentoCloud\Package\UndefinedPackageException;
 
 /**
  * @inheritdoc
@@ -39,6 +41,8 @@ class Logger extends \Monolog\Logger
      * @param FileList $fileList
      * @param Pool $pool
      * @param SanitizeProcessor $sanitizeProcessor
+     *
+     * @throws LoggerException
      */
     public function __construct(
         File $file,
@@ -59,25 +63,32 @@ public function __construct(
     /**
      * Prepares the deploy log for further use.
      *
-     * @return void
+     * @throws LoggerException
      */
-    private function prepare()
+    private function prepare(): void
     {
-        $deployLogPath = $this->fileList->getCloudLog();
-        $buildPhaseLogPath = $this->fileList->getInitCloudLog();
-        $deployLogFileExists = $this->file->isExists($deployLogPath);
-        $buildLogFileExists = $this->file->isExists($buildPhaseLogPath);
-        $buildPhaseLogContent = $buildLogFileExists ? $this->file->fileGetContents($buildPhaseLogPath) : '';
-
-        $this->file->createDirectory($this->directoryList->getLog());
+        try {
+            $deployLogPath = $this->fileList->getCloudLog();
+            $buildPhaseLogPath = $this->fileList->getInitCloudLog();
+            $deployLogFileExists = $this->file->isExists($deployLogPath);
+            $buildLogFileExists = $this->file->isExists($buildPhaseLogPath);
+            $buildPhaseLogContent = $buildLogFileExists ? $this->file->fileGetContents($buildPhaseLogPath) : '';
 
-        if ($deployLogFileExists
-            && $buildPhaseLogContent
-            && !$this->isBuildLogApplied($deployLogPath, $buildPhaseLogContent)
-        ) {
-            $this->file->filePutContents($deployLogPath, $buildPhaseLogContent, FILE_APPEND);
-        } elseif (!$deployLogFileExists && $buildLogFileExists) {
-            $this->file->copy($buildPhaseLogPath, $deployLogPath);
+            $this->file->createDirectory($this->directoryList->getLog());
+            if ($deployLogFileExists
+                && $buildPhaseLogContent
+                && !$this->isBuildLogApplied($deployLogPath, $buildPhaseLogContent)
+            ) {
+                $this->file->filePutContents($deployLogPath, $buildPhaseLogContent, FILE_APPEND);
+            } elseif (!$deployLogFileExists && $buildLogFileExists) {
+                $this->file->copy($buildPhaseLogPath, $deployLogPath);
+            }
+        } catch (FileSystemException | UndefinedPackageException $exception) {
+            throw new LoggerException(
+                $exception->getMessage(),
+                $exception->getCode(),
+                $exception
+            );
         }
     }
 
@@ -87,6 +98,8 @@ private function prepare()
      * @param string $deployLogPath deploy log path
      * @param string $buildPhaseLogContent build log content
      * @return bool
+     *
+     * @throws FileSystemException
      */
     private function isBuildLogApplied(string $deployLogPath, string $buildPhaseLogContent): bool
     {

src/App/Logger/Gelf/HandlerFactory.php

@@ -9,6 +9,7 @@
 
 use Illuminate\Contracts\Config\Repository;
 use Gelf\Publisher;
+use Magento\MagentoCloud\App\LoggerException;
 
 /**
  * Creates instance of Gelf handler.
@@ -34,13 +35,14 @@ public function __construct(TransportFactory $transportFactory)
      * @param Repository $configuration
      * @param int $minLevel
      * @return Handler
-     * @throws \Exception
+     * @throws LoggerException
      */
     public function create(Repository $configuration, int $minLevel): Handler
     {
         $this->increaseSocketTimeout();
 
         $publisher = new Publisher();
+
         foreach ($configuration->get('transport') as $transportType => $transportConfig) {
             $publisher->addTransport(
                 $this->transportFactory->create($transportType, $transportConfig)
@@ -64,7 +66,7 @@ public function create(Repository $configuration, int $minLevel): Handler
      *
      * @return void
      */
-    private function increaseSocketTimeout()
+    private function increaseSocketTimeout(): void
     {
         ini_set('default_socket_timeout', '3600');
     }

src/App/Logger/Gelf/TransportFactory.php

@@ -11,21 +11,23 @@
 use Gelf\Transport\HttpTransport;
 use Gelf\Transport\TcpTransport;
 use Gelf\Transport\UdpTransport;
+use Magento\MagentoCloud\App\LoggerException;
 
 /**
  * Factory for creating gelf transport instances.
  */
 class TransportFactory
 {
-    const TRANSPORT_HTTP = 'http';
-    const TRANSPORT_UDP = 'udp';
-    const TRANSPORT_TCP = 'tcp';
+    public const TRANSPORT_HTTP = 'http';
+    public const TRANSPORT_UDP = 'udp';
+    public const TRANSPORT_TCP = 'tcp';
 
     /**
      * @param string $type
      * @param array $config
      * @return AbstractTransport
-     * @throws \Exception
+     *
+     * @throws LoggerException
      */
     public function create(string $type, array $config): AbstractTransport
     {
@@ -57,7 +59,7 @@ public function create(string $type, array $config): AbstractTransport
                 );
                 break;
             default:
-                throw new \Exception('Unknown transport type: ' . $type);
+                throw new LoggerException('Unknown transport type: ' . $type);
         }
 
         return $transport;

src/App/Logger/Pool.php

@@ -7,8 +7,10 @@
 
 namespace Magento\MagentoCloud\App\Logger;
 
+use Magento\MagentoCloud\App\LoggerException;
 use Monolog\Handler\HandlerInterface;
 use Magento\MagentoCloud\Config\Log as LogConfig;
+use Exception;
 
 /**
  * The pool of handlers.
@@ -52,7 +54,7 @@ public function __construct(
 
     /**
      * @return HandlerInterface[]
-     * @throws \Exception If can't create handlers from config.
+     * @throws LoggerException If can't create handlers from config.
      */
     public function getHandlers(): array
     {
@@ -62,14 +64,22 @@ public function getHandlers(): array
 
         $this->handlers = [];
 
-        foreach ($this->logConfig->getHandlers() as $handlerName => $handlerConfig) {
-            $handler = $this->handlerFactory->create($handlerName);
+        try {
+            foreach ($this->logConfig->getHandlers() as $handlerName => $handlerConfig) {
+                $handler = $this->handlerFactory->create($handlerName);
 
-            if (empty($handlerConfig['use_default_formatter'])) {
-                $handler->setFormatter($this->lineFormatterFactory->create());
-            }
+                if (empty($handlerConfig['use_default_formatter'])) {
+                    $handler->setFormatter($this->lineFormatterFactory->create());
+                }
 
-            $this->handlers[] = $handler;
+                $this->handlers[] = $handler;
+            }
+        } catch (Exception $exception) {
+            throw new LoggerException(
+                $exception->getMessage(),
+                $exception->getCode(),
+                $exception
+            );
         }
 
         return $this->handlers;

src/App/LoggerException.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\MagentoCloud\App;
+
+/**
+ * Generic logging exception;
+ */
+class LoggerException extends GenericException
+{
+}

src/Command/Dev/UpdateComposer/ComposerGenerator.php

@@ -214,7 +214,7 @@ private function getBaseComposer(array $repoOptions): array
      * @param array $repoOptions
      * @param array $composer
      * @return array
-     * @throws FilesystemException
+     * @throws FileSystemException
      *
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      *

src/Step/Build/DeployStaticContent/Generate.php

@@ -7,6 +7,7 @@
 
 namespace Magento\MagentoCloud\Step\Build\DeployStaticContent;
 
+use Magento\MagentoCloud\Config\ConfigException;
 use Magento\MagentoCloud\Config\Stage\BuildInterface;
 use Magento\MagentoCloud\Step\StepException;
 use Magento\MagentoCloud\Step\StepInterface;
@@ -70,7 +71,7 @@ public function __construct(
     /**
      * @inheritdoc
      */
-    public function execute()
+    public function execute(): void
     {
         $locales = $this->buildOption->getLocales();
         $threadCount = $this->buildOption->getThreadCount();
@@ -83,16 +84,16 @@ public function execute()
 
         $this->logger->info($logMessage);
 
-        $commands = $this->commandFactory->matrix(
-            $this->buildOption,
-            $this->buildConfig->get(BuildInterface::VAR_SCD_MATRIX)
-        );
-
         try {
+            $commands = $this->commandFactory->matrix(
+                $this->buildOption,
+                $this->buildConfig->get(BuildInterface::VAR_SCD_MATRIX)
+            );
+
             foreach ($commands as $command) {
                 $this->shell->execute($command);
             }
-        } catch (ShellException $exception) {
+        } catch (ConfigException|ShellException $exception) {
             throw new StepException($exception->getMessage(), $exception->getCode(), $exception);
         }
     }

src/Test/Unit/App/Logger/Gelf/HandlerFactoryTest.php

@@ -10,12 +10,11 @@
 use Gelf\Transport\HttpTransport;
 use Gelf\Transport\TcpTransport;
 use Illuminate\Config\Repository;
-use Magento\MagentoCloud\App\Logger\Gelf\Handler;
 use Magento\MagentoCloud\App\Logger\Gelf\HandlerFactory;
 use Magento\MagentoCloud\App\Logger\Gelf\TransportFactory;
 use Monolog\Logger;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
-use PHPUnit_Framework_MockObject_MockObject as Mock;
 
 /**
  * @inheritdoc
@@ -28,12 +27,12 @@ class HandlerFactoryTest extends TestCase
     private $handlerFactory;
 
     /**
-     * @var TransportFactory|Mock
+     * @var TransportFactory|MockObject
      */
     private $transportFactoryMock;
 
     /**
-     * @var Repository|Mock
+     * @var Repository|MockObject
      */
     private $repositoryMock;
 
@@ -44,17 +43,20 @@ protected function setUp()
     {
         $this->transportFactoryMock = $this->createMock(TransportFactory::class);
         $this->repositoryMock = $this->createMock(Repository::class);
-        
+
         $this->handlerFactory = new HandlerFactory(
             $this->transportFactoryMock
         );
     }
 
-    public function testCreate()
+    /**
+     * @throws \Exception
+     */
+    public function testCreate(): void
     {
         $httpTransportMock = $this->createMock(HttpTransport::class);
         $tcpTransportMock = $this->createMock(TcpTransport::class);
-        
+
         $this->repositoryMock->expects($this->exactly(2))
             ->method('get')
             ->withConsecutive(
@@ -85,9 +87,6 @@ public function testCreate()
                 $tcpTransportMock
             );
 
-        $this->assertInstanceOf(
-            Handler::class,
-            $this->handlerFactory->create($this->repositoryMock, Logger::INFO)
-        );
+        $this->handlerFactory->create($this->repositoryMock, Logger::INFO);
     }
 }

src/Test/Unit/App/LoggerTest.php

@@ -8,41 +8,42 @@
 namespace Magento\MagentoCloud\Test\Unit\App;
 
 use Magento\MagentoCloud\App\Logger;
+use Magento\MagentoCloud\App\LoggerException;
 use Magento\MagentoCloud\Filesystem\DirectoryList;
 use Magento\MagentoCloud\Filesystem\FileList;
 use Magento\MagentoCloud\Filesystem\Driver\File;
 use Magento\MagentoCloud\App\Logger\Pool;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Magento\MagentoCloud\App\Logger\Processor\SanitizeProcessor;
-use PHPUnit_Framework_MockObject_MockObject as Mock;
 
 /**
  * @inheritdoc
  */
 class LoggerTest extends TestCase
 {
     /**
-     * @var File|Mock
+     * @var File|MockObject
      */
     private $fileMock;
 
     /**
-     * @var DirectoryList|Mock
+     * @var DirectoryList|MockObject
      */
     private $directoryListMock;
 
     /**
-     * @var FileList|Mock
+     * @var FileList|MockObject
      */
     private $fileListMock;
 
     /**
-     * @var Pool|Mock
+     * @var Pool|MockObject
      */
     private $poolMock;
 
     /**
-     * @var SanitizeProcessor|Mock
+     * @var SanitizeProcessor|MockObject
      */
     private $sanitizeProcessorMock;
 
@@ -67,6 +68,8 @@ protected function setUp()
      * @param int $fileMockFilePutContentsExpects
      * @param int $fileMockCopyExpects
      * @dataProvider executeDataProvider
+     *
+     * @throws LoggerException
      */
     public function testExecute(
         $fileMockFileGetContentsExpects,
@@ -76,7 +79,7 @@ public function testExecute(
         $deployLogFileExists,
         $fileMockFilePutContentsExpects,
         $fileMockCopyExpects
-    ) {
+    ): void {
         $magentoRoot = 'magento_root';
         $deployLogPath = $magentoRoot . '/var/log/cloud.log';
         $buildPhaseLogPath = $magentoRoot . '/init/var/log/cloud.log';