MCLOUD-5442: Error is not displayed for extended scenario on deploy phase (magento#712)

Author: shiftedreality

config/services.xml

@@ -5,7 +5,6 @@
 
     <services>
         <defaults autowire="true" autoconfigure="true" public="true" />
-        <!-- ... -->
 
         <prototype namespace="Magento\MagentoCloud\" resource="../src/*" exclude="../src/{Test}"/>
 
@@ -30,13 +29,6 @@
         <service id="Magento\MagentoCloud\Filesystem\FileSystemException" autowire="false" />
         <service id="Magento\MagentoCloud\Filesystem\Flag\ConfigurationMismatchException" autowire="false" />
         <service id="Magento\MagentoCloud\Shell\UtilityException" autowire="false" />
-        <service id="Magento\MagentoCloud\Filesystem\Flag\Pool">
-            <argument type="collection">
-                <argument key="regenerate">var/.regenerate</argument>
-                <argument key="scd_in_build">.static_content_deploy</argument>
-                <argument key="deploy_is_failed">var/.deploy_is_failed</argument>
-            </argument>
-        </service>
         <service id="Magento\MagentoCloud\Filesystem\SystemList" autowire="false" />
         <service id="Magento\MagentoCloud\Package\UndefinedPackageException" autowire="false" />
         <service id="Magento\MagentoCloud\Scenario\Exception\ProcessorException" autowire="false" />
@@ -61,6 +53,7 @@
         <service id="Magento\MagentoCloud\Shell\ProcessException" autowire="false" />
         <service id="Symfony\Component\Yaml\Parser" autowire="false" />
         <service id="Symfony\Component\Yaml\Dumper" autowire="false" />
+        <!-- Service argument configuration -->
         <service id="Magento\MagentoCloud\Filesystem\Flag\Pool">
             <argument type="collection">
                 <argument key="regenerate">var/.regenerate</argument>

src/App/Container.php

@@ -89,13 +89,19 @@ private function createComposerInstance(SystemList $systemList): Composer
     }
 
     /**
-     * {@inheritdoc}
-     *
-     * @see create() For factory-like usage
+     * @inheritDoc
      */
     public function get($id)
     {
-        return $this->container->get($id);
+        try {
+            return $this->container->get($id);
+        } catch (Exception $exception) {
+            throw new ContainerException(
+                $exception->getMessage(),
+                $exception->getCode(),
+                $exception
+            );
+        }
     }
 
     /**

src/App/ContainerInterface.php

@@ -18,6 +18,8 @@ interface ContainerInterface extends \Psr\Container\ContainerInterface
      * @param string $abstract
      * @param array $params
      * @return mixed
+     *
+     * @throws ContainerException
      */
     public function create(string $abstract, array $params = []);
 
@@ -29,4 +31,13 @@ public function create(string $abstract, array $params = []);
      * @return void
      */
     public function set(string $id, $service): void;
+
+    /**
+     * {@inheritDoc}
+     *
+     * @throws ContainerException
+     *
+     * @see create() For factory-like usage
+     */
+    public function get($id);
 }

src/App/ErrorHandler.php

@@ -7,6 +7,8 @@
 
 namespace Magento\MagentoCloud\App;
 
+use RuntimeException;
+
 /**
  * An error handler that converts runtime errors into exceptions.
  */
@@ -43,7 +45,7 @@ class ErrorHandler
      * @param string $errorFile
      * @param int $errorLine
      * @return bool
-     * @throws \RuntimeException
+     * @throws RuntimeException
      */
     public function handle(int $errorNo, string $errorStr, string $errorFile, int $errorLine): bool
     {

src/App/GenericException.php

@@ -7,6 +7,8 @@
 
 namespace Magento\MagentoCloud\App;
 
+use Throwable;
+
 /**
  * Base exception for general purposes.
  */
@@ -15,7 +17,7 @@ class GenericException extends \Exception
     /**
      * @inheritDoc
      */
-    public function __construct(string $message, int $code = 0, \Throwable $previous = null)
+    public function __construct(string $message, int $code = 0, Throwable $previous = null)
     {
         parent::__construct($message, $code, $previous);
     }

src/Scenario/Processor.php

@@ -7,11 +7,12 @@
 
 namespace Magento\MagentoCloud\Scenario;
 
-use Magento\MagentoCloud\App\GenericException;
 use Magento\MagentoCloud\Package\Manager;
+use Magento\MagentoCloud\Step\StepException;
 use Magento\MagentoCloud\Step\StepInterface;
 use Magento\MagentoCloud\Scenario\Exception\ProcessorException;
 use Psr\Log\LoggerInterface;
+use Throwable;
 
 /**
  * Process given scenarios.
@@ -67,14 +68,24 @@ public function execute(array $scenarios): void
 
                 $this->logger->debug(sprintf('Step "%s" finished', $name));
             });
-        } catch (GenericException $exception) {
+        } catch (StepException $exception) {
             $this->logger->error($exception->getMessage());
 
             throw new ProcessorException(
                 $exception->getMessage(),
                 $exception->getCode(),
                 $exception
             );
+        } catch (Throwable $exception) {
+            $message = 'Unhandled error: ' . $exception->getMessage();
+
+            $this->logger->error($message);
+
+            throw new ProcessorException(
+                $message,
+                $exception->getCode(),
+                $exception
+            );
         }
 
         $this->logger->info('Scenario(s) finished');

src/Shell/Process.php

@@ -11,6 +11,7 @@
 
 /**
  * Runs console commands.
+ *
  * @codeCoverageIgnore
  */
 class Process extends \Symfony\Component\Process\Process implements ProcessInterface
@@ -20,18 +21,18 @@ class Process extends \Symfony\Component\Process\Process implements ProcessInter
      *
      * {@inheritdoc}
      */
-    public function getOutput()
+    public function getOutput(): string
     {
         return trim(parent::getOutput(), PHP_EOL);
     }
 
     /**
      * @inheritdoc
      */
-    public function execute()
+    public function execute(): void
     {
         try {
-            parent::mustRun();
+            $this->mustRun();
         } catch (ProcessFailedException $e) {
             $process = $e->getProcess();
 

src/Shell/ProcessFactory.php

@@ -17,7 +17,6 @@ class ProcessFactory
      *
      * @param array $params
      * @return Process|ProcessInterface
-     * @throws \RuntimeException if Process can't be created
      */
     public function create(array $params): ProcessInterface
     {

src/Test/Unit/Scenario/ProcessorTest.php

@@ -8,6 +8,7 @@
 namespace Magento\MagentoCloud\Test\Unit\Scenario;
 
 use Magento\MagentoCloud\Package\Manager;
+use Magento\MagentoCloud\Step\StepException;
 use Magento\MagentoCloud\Step\StepInterface;
 use Magento\MagentoCloud\Scenario\Exception\ProcessorException;
 use Magento\MagentoCloud\Scenario\Merger;
@@ -111,7 +112,7 @@ public function testExecute(): void
     /**
      * @throws ProcessorException
      */
-    public function testExeceuteWithException(): void
+    public function testExecuteWithException(): void
     {
         $this->expectException(ProcessorException::class);
         $this->expectExceptionMessage('Some error');
@@ -124,7 +125,7 @@ public function testExeceuteWithException(): void
 
         $step1->expects($this->once())
             ->method('execute')
-            ->willThrowException(new ProcessorException('Some error'));
+            ->willThrowException(new StepException('Some error'));
 
         $steps = [
             'step1' => $step1
@@ -155,4 +156,52 @@ public function testExeceuteWithException(): void
 
         $this->processor->execute($scenarios);
     }
+
+    /**
+     * @throws ProcessorException
+     */
+    public function testExecuteWithRuntimeException(): void
+    {
+        $this->expectException(ProcessorException::class);
+        $this->expectExceptionMessage('Unhandled error: Some error');
+
+        $scenarios = [
+            'some/scenario.xml'
+        ];
+
+        $step1 = $this->getMockForAbstractClass(StepInterface::class);
+
+        $step1->expects($this->once())
+            ->method('execute')
+            ->willThrowException(new \RuntimeException('Some error'));
+
+        $steps = [
+            'step1' => $step1
+        ];
+
+        $this->packageManagerMock->expects($this->once())
+            ->method('getPrettyInfo')
+            ->willReturn('1.0.0');
+        $this->mergerMock->expects($this->once())
+            ->method('merge')
+            ->with($scenarios)
+            ->willReturn($steps);
+        $this->loggerMock->method('info')
+            ->withConsecutive(
+                [
+                    sprintf(
+                        'Starting scenario(s): %s 1.0.0',
+                        implode(', ', $scenarios)
+                    )
+                ]
+            );
+        $this->loggerMock->method('debug')
+            ->withConsecutive(
+                ['Running step: step1']
+            );
+        $this->loggerMock->method('error')
+            ->withConsecutive(['Unhandled error: Some error']);
+
+        $this->processor->execute($scenarios);
+    }
 }