MCLOUD-6660: Add possibility to disable MailHog (#274)

Author: oshmyheliuk

autoload.php

@@ -10,10 +10,6 @@
     define('BP', dirname(__DIR__, 3));
 }
 
-if (!defined('ECE_BP')) {
-    define('ECE_BP', BP);
-}
-
 foreach ([__DIR__ . '/../../autoload.php', __DIR__ . '/vendor/autoload.php'] as $file) {
     if (file_exists($file)) {
         return require $file;

bootstrap.php

@@ -7,4 +7,4 @@
 
 use Magento\CloudDocker\App\Container;
 
-return new Container(__DIR__, BP, ECE_BP);
+return new Container(__DIR__, BP);

src/App/Container.php

@@ -27,20 +27,18 @@ class Container implements ContainerInterface
     /**
      * @param string $root
      * @param string $magentoRoot
-     * @param string|null $eceToolsRoot
      * @throws ContainerException
      */
-    public function __construct(string $root, string $magentoRoot, string $eceToolsRoot = null)
+    public function __construct(string $root, string $magentoRoot)
     {
         $containerBuilder = new ContainerBuilder();
         $containerBuilder->set('container', $this);
         $containerBuilder->setDefinition('container', new Definition(__CLASS__))
-            ->setArguments([$root, $magentoRoot, $eceToolsRoot]);
+            ->setArguments([$root, $magentoRoot]);
 
         $containerBuilder->set(DirectoryList::class, new DirectoryList(
             $root,
-            $magentoRoot,
-            $eceToolsRoot
+            $magentoRoot
         ));
 
         try {

src/Command/BuildCompose.php

@@ -166,6 +166,11 @@ protected function configure(): void
                 null,
                 InputOption::VALUE_NONE,
                 'Disable Elasticsearch'
+            )->addOption(
+                Source\CliSource::OPTION_NO_MAILHOG,
+                null,
+                InputOption::VALUE_NONE,
+                'Disable mailhog'
             );
 
         $this->addOption(

src/Compose/ProductionBuilder.php

@@ -423,15 +423,17 @@ public function build(Config $config): Manager
             );
         }
 
-        $manager->addService(
-            self::SERVICE_MAILHOG,
-            $this->serviceFactory->create(
-                ServiceInterface::SERVICE_MAILHOG,
-                $this->serviceFactory->getDefaultVersion(ServiceInterface::SERVICE_MAILHOG)
-            ),
-            [self::NETWORK_MAGENTO],
-            []
-        );
+        if ($config->hasServiceEnabled(self::SERVICE_MAILHOG)) {
+            $manager->addService(
+                self::SERVICE_MAILHOG,
+                $this->serviceFactory->create(
+                    ServiceInterface::SERVICE_MAILHOG,
+                    $this->serviceFactory->getDefaultVersion(ServiceInterface::SERVICE_MAILHOG)
+                ),
+                [self::NETWORK_MAGENTO],
+                []
+            );
+        }
 
         return $manager;
     }

src/Config/Source/CliSource.php

@@ -32,6 +32,7 @@ class CliSource implements SourceInterface
     public const OPTION_SELENIUM_IMAGE = 'selenium-image';
     public const OPTION_INSTALLATION_TYPE = 'installation-type';
     public const OPTION_NO_ES = 'no-es';
+    public const OPTION_NO_MAILHOG = 'no-mailhog';
 
     /**
      * State modifiers.
@@ -103,7 +104,8 @@ class CliSource implements SourceInterface
      * @var array
      */
     private static $disableOptionsMap = [
-        self::OPTION_NO_ES => self::SERVICES_ES
+        self::OPTION_NO_ES => self::SERVICES_ES,
+        self::OPTION_NO_MAILHOG => self::SERVICES_MAILHOG,
     ];
 
     /**

src/Config/Source/CloudSource.php

@@ -120,6 +120,7 @@ public function read(): Repository
             $repository,
             $version
         );
+        $repository = $this->addMailhog($repository);
         $repository = $this->addCronJobs(
             $repository,
             $appConfig['crons'] ?? []
@@ -331,4 +332,19 @@ private function addName(Repository $repository, string $name): Repository
 
         return $repository;
     }
+
+    /**
+     * Adds mailhog configuration
+     *
+     * @param Repository $repository
+     * @return Repository
+     */
+    private function addMailhog(Repository $repository): Repository
+    {
+        $repository->set([
+            self::SERVICES_MAILHOG . '.enabled' => true
+        ]);
+
+        return $repository;
+    }
 }

src/Config/Source/SourceInterface.php

@@ -75,6 +75,11 @@ interface SourceInterface
      */
     public const SERVICES_ES = self::SERVICES . '.' . ServiceInterface::SERVICE_ELASTICSEARCH;
 
+    /**
+     * Mailhog
+     */
+    public const SERVICES_MAILHOG = self::SERVICES . '.' . ServiceInterface::SERVICE_MAILHOG;
+
     /**
      * ES environment variables
      */

src/Filesystem/DirectoryList.php

@@ -22,21 +22,14 @@ class DirectoryList
      */
     private $magentoRoot;
 
-    /**
-     * @var string
-     */
-    private $eceRoot;
-
     /**
      * @param string $root
      * @param string $magentoRoot
-     * @param string $eceRoot
      */
-    public function __construct(string $root, string $magentoRoot, string $eceRoot = null)
+    public function __construct(string $root, string $magentoRoot)
     {
         $this->root = realpath($root);
         $this->magentoRoot = realpath($magentoRoot);
-        $this->eceRoot = $eceRoot ? realpath($eceRoot) : null;
     }
 
     /**
@@ -55,27 +48,6 @@ public function getMagentoRoot(): string
         return $this->magentoRoot;
     }
 
-    /**
-     * @return bool
-     */
-    public function hasEceToolsRoot(): bool
-    {
-        return $this->eceRoot !== null;
-    }
-
-    /**
-     * @return string
-     * @throws FilesystemException
-     */
-    public function getEceToolsRoot(): string
-    {
-        if (null === $this->eceRoot) {
-            throw new FilesystemException('No ECE-Tools root defined');
-        }
-
-        return $this->eceRoot;
-    }
-
     /**
      * @return string
      */

src/Test/Integration/BuildCustomComposeTest.php

@@ -60,8 +60,8 @@ public function testBuild(string $directory, array $arguments): void
         $command->execute($inputMock, $outputMock);
 
         $this->assertSame(
-            $filesystem->get($directory . '/docker-compose.yml'),
-            $filesystem->get($directory . '/docker-compose.exp.yml')
+            $filesystem->get($directory . '/docker-compose.exp.yml'),
+            $filesystem->get($directory . '/docker-compose.yml')
         );
     }
 
@@ -100,6 +100,9 @@ public function buildDataProvider(): array
                                     'image' => 'mariadb',
                                     'enabled' => true,
                                 ],
+                                'mailhog' => [
+                                    'enabled' => true,
+                                ]
                             ],
                             'hooks' => [
                                 'build' => 'set -e' . PHP_EOL