MCLOUD-6898: Add option to customize port for MailHog

Author: BaDos

.gitignore

@@ -5,4 +5,5 @@
 /composer.lock
 /auth.json
 /_workdir
+/_workdir_cache
 .phpunit.result.cache

codeception.dist.yml

@@ -34,6 +34,10 @@ modules:
       printOutput: false
     PhpBrowser:
       url: "%Magento.docker.settings.env.url.base%"
+    REST:
+      depends: PhpBrowser
+      url: "%Magento.docker.settings.env.url.base%"
+      shortDebugResponse: 300
     Magento\CloudDocker\Test\Functional\Codeception\MagentoDb:
       dsn: "mysql:host=%Magento.docker.settings.db.host%;port=%Magento.docker.settings.db.port%;dbname=%Magento.docker.settings.db.path%"
       user: "%Magento.docker.settings.db.username%"

composer.json

@@ -23,6 +23,7 @@
         "codeception/module-asserts": "^1.2",
         "codeception/module-db": "^1.0",
         "codeception/module-phpbrowser": "^1.0",
+        "codeception/module-rest": "^1.2",
         "consolidation/robo": "^1.2",
         "phpmd/phpmd": "@stable",
         "phpstan/phpstan": "^0.11",

src/Command/BuildCompose.php

@@ -171,6 +171,16 @@ protected function configure(): void
                 null,
                 InputOption::VALUE_NONE,
                 'Disable mailhog'
+            )->addOption(
+                Source\CliSource::OPTION_MAILHOG_SMTP_PORT,
+                null,
+                InputOption::VALUE_REQUIRED,
+                'MailHog SMTP port'
+            )->addOption(
+                Source\CliSource::OPTION_MAILHOG_HTTP_PORT,
+                null,
+                InputOption::VALUE_REQUIRED,
+                'MailHog HTTP port'
             )->addOption(
                 Source\CliSource::OPTION_SET_DOCKER_HOST_XDEBUG,
                 null,

src/Compose/ProductionBuilder.php

@@ -402,7 +402,13 @@ public function build(Config $config): Manager
                 self::SERVICE_MAILHOG,
                 $this->serviceFactory->create(
                     ServiceInterface::SERVICE_MAILHOG,
-                    $this->serviceFactory->getDefaultVersion(ServiceInterface::SERVICE_MAILHOG)
+                    $this->serviceFactory->getDefaultVersion(ServiceInterface::SERVICE_MAILHOG),
+                    [
+                        'ports' => [
+                            ($config->getMailHogSmtpPort() ?: '1025').':1025',
+                            ($config->getMailHogHttpPort() ?: '8025').':8025',
+                        ]
+                    ]
                 ),
                 [self::NETWORK_MAGENTO],
                 []

src/Config/Config.php

@@ -454,4 +454,22 @@ public function getDbIncrementOffset(): int
             1
         );
     }
+
+    /**
+     * @return string|null
+     * @throws ConfigurationMismatchException
+     */
+    public function getMailHogSmtpPort(): ?string
+    {
+        return $this->all()->get(SourceInterface::SYSTEM_MAILHOG_SMTP_PORT);
+    }
+
+    /**
+     * @return string|null
+     * @throws ConfigurationMismatchException
+     */
+    public function getMailHogHttpPort(): ?string
+    {
+        return $this->all()->get(SourceInterface::SYSTEM_MAILHOG_HTTP_PORT);
+    }
 }

src/Config/Source/CliSource.php

@@ -34,6 +34,12 @@ class CliSource implements SourceInterface
     public const OPTION_NO_ES = 'no-es';
     public const OPTION_NO_MAILHOG = 'no-mailhog';
 
+    /**
+     * MailHog configuration
+     */
+    public const OPTION_MAILHOG_SMTP_PORT = 'mailhog-smtp-port';
+    public const OPTION_MAILHOG_HTTP_PORT = 'mailhog-http-port';
+
     /**
      * State modifiers.
      */
@@ -277,6 +283,14 @@ public function read(): Repository
             $repository->set(SourceInterface::SYSTEM_MARIADB_CONF, true);
         }
 
+        if ($port = $this->input->getOption(self::OPTION_MAILHOG_SMTP_PORT)) {
+            $repository->set(self::SYSTEM_MAILHOG_SMTP_PORT, $port);
+        }
+
+        if ($port = $this->input->getOption(self::OPTION_MAILHOG_HTTP_PORT)) {
+            $repository->set(self::SYSTEM_MAILHOG_HTTP_PORT, $port);
+        }
+
         return $repository;
     }
 }

src/Config/Source/SourceInterface.php

@@ -143,6 +143,8 @@ interface SourceInterface
     public const SYSTEM_DB_ENTRYPOINT = 'system.db_entrypoint';
     public const SYSTEM_MARIADB_CONF = 'system.mariadb_conf';
     public const SYSTEM_SET_DOCKER_HOST = 'system.set_docker_host';
+    public const SYSTEM_MAILHOG_SMTP_PORT = 'system.mailhog.smtp_port';
+    public const SYSTEM_MAILHOG_HTTP_PORT = 'system.mailhog.http_port';
 
     public const SYSTEM_DB_INCREMENT_INCREMENT = 'system.db.increment_increment';
     public const SYSTEM_DB_INCREMENT_OFFSET = 'system.db.increment_offset';

src/Test/Functional/Acceptance.suite.dist.yml

@@ -6,3 +6,4 @@ modules:
     - Magento\CloudDocker\Test\Functional\Codeception\MagentoDb
     - PhpBrowser
     - Asserts
+    - REST

src/Test/Functional/Acceptance/MailHogCest.php

@@ -0,0 +1,65 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CloudDocker\Test\Functional\Acceptance;
+
+/**
+ * @group php74
+ */
+class MailHogCest extends AbstractCest
+{
+    /**
+     * @param \CliTester $I
+     * @throws \Exception
+     */
+    public function testDefaultPorts(\CliTester $I): void
+    {
+        $I->updateBaseUrl('http://magento2.docker:8025/');
+        $I->assertTrue(
+            $I->runEceDockerCommand('build:compose'),
+            'Command build:compose failed'
+        );
+        $this->runAndAssert($I);
+    }
+
+    /**
+     * @param \CliTester $I
+     * @throws \Exception
+     */
+    public function testCustomPorts(\CliTester $I): void
+    {
+        $I->updateBaseUrl('http://magento2.docker:8026/');
+        $I->assertTrue(
+            $I->runEceDockerCommand('build:compose --mailhog-http-port=8026 --mailhog-smtp-port=1026'),
+            'Command build:compose failed'
+        );
+        $this->runAndAssert($I);
+    }
+
+    /**
+     * @param \CliTester $I
+     * @throws \Exception
+     */
+    private function runAndAssert(\CliTester $I): void
+    {
+        $I->replaceImagesWithGenerated();
+        $I->startEnvironment();
+        $I->amOnPage('/');
+        $I->see('MailHog');
+
+        $I->sendAjaxGetRequest('/api/v2/messages', ['limit' => 10]);
+        $I->seeResponseIsJson();
+        $I->assertSame([0], $I->grabDataFromResponseByJsonPath('$.total'));
+
+        $I->assertTrue(
+            $I->runDockerComposeCommand('run deploy bash -c "php -r \"mail(\'[email protected]\',\'test\',\'test\');\""')
+        );
+        $I->sendAjaxGetRequest('/api/v2/messages', ['limit' => 10]);
+        $I->seeResponseIsJson();
+        $I->assertSame([1], $I->grabDataFromResponseByJsonPath('$.total'));
+    }
+}