MAGECLOUD-4168: Provide an Option to Specify Custom URL for Magento (#163)

oshmyheliuk · web-flow · commit 4be9829406c3 · 2020-03-11T08:23:24.000-05:00
diff --git a/.travis.yml b/.travis.yml
@@ -6,6 +6,7 @@ git:
 addons:
   hosts:
     - magento2.docker
+    - magento2.test
 
 services:
   - docker
diff --git a/src/Command/BuildCompose.php b/src/Command/BuildCompose.php
@@ -204,6 +204,18 @@ protected function configure(): void
                 null,
                 InputOption::VALUE_OPTIONAL,
                 'Cloud environment variables'
+            )
+            ->addOption(
+                Source\CliSource::OPTION_HOST,
+                null,
+                InputOption::VALUE_OPTIONAL,
+                'Host name'
+            )
+            ->addOption(
+                Source\CliSource::OPTION_PORT,
+                null,
+                InputOption::VALUE_OPTIONAL,
+                'Port'
             );
 
         parent::configure();
diff --git a/src/Compose/Manager.php b/src/Compose/Manager.php
@@ -7,13 +7,13 @@
 
 namespace Magento\CloudDocker\Compose;
 
+use Magento\CloudDocker\Config\Config;
+
 /**
  * Compose configuration manager
  */
 class Manager
 {
-    public const DOMAIN = 'magento2.docker';
-
     /**
      * @var string
      */
@@ -34,6 +34,19 @@ class Manager
      */
     private $volumes = [];
 
+    /**
+     * @var Config
+     */
+    private $config;
+
+    /**
+     * @param Config $config
+     */
+    public function __construct(Config $config)
+    {
+        $this->config = $config;
+    }
+
     /**
      * @param string $name
      * @param array $extConfig
@@ -42,7 +55,7 @@ class Manager
      */
     public function addService(string $name, array $extConfig, array $networks, array $depends): void
     {
-        $hostname = $name . '.' . self::DOMAIN;
+        $hostname = $name . '.' . $this->config->getHost();
 
         $config = [
             'hostname' => $hostname,
@@ -89,16 +102,6 @@ public function addVolume(string $name, array $config): void
         $this->volumes[$name] = $config;
     }
 
-    /**
-     * @param array $volumes
-     */
-    public function addVolumes(array $volumes): void
-    {
-        foreach ($volumes as $name => $config) {
-            $this->volumes[$name] = $config;
-        }
-    }
-
     /**
      * @param array $volumes
      */
diff --git a/src/Compose/ManagerFactory.php b/src/Compose/ManagerFactory.php
@@ -7,15 +7,25 @@
 
 namespace Magento\CloudDocker\Compose;
 
+use Magento\CloudDocker\Config\Config;
+use Magento\CloudDocker\Config\Source\SourceInterface;
+
 /**
  * Creates instance of Manager
  *
  * @see Manager
  */
 class ManagerFactory
 {
-    public function create(): Manager
+    /**
+     * Creates instance of Manager
+     *
+     * @param Config $config
+     * @return Manager
+     * @throws \Magento\CloudDocker\App\ConfigurationMismatchException
+     */
+    public function create(Config $config): Manager
     {
-        return new Manager();
+        return new Manager($config);
     }
 }
diff --git a/src/Compose/ProductionBuilder.php b/src/Compose/ProductionBuilder.php
@@ -7,11 +7,11 @@
 
 namespace Magento\CloudDocker\Compose;
 
+use Magento\CloudDocker\App\ConfigurationMismatchException;
 use Magento\CloudDocker\Compose\Php\ExtensionResolver;
 use Magento\CloudDocker\Compose\ProductionBuilder\VolumeResolver;
 use Magento\CloudDocker\Config\Config;
 use Magento\CloudDocker\Config\Environment\Converter;
-use Magento\CloudDocker\App\ConfigurationMismatchException;
 use Magento\CloudDocker\Filesystem\FileList;
 use Magento\CloudDocker\Service\ServiceFactory;
 use Magento\CloudDocker\Service\ServiceInterface;
@@ -134,7 +134,7 @@ public function __construct(
      */
     public function build(Config $config): Manager
     {
-        $manager = $this->managerFactory->create();
+        $manager = $this->managerFactory->create($config);
 
         $phpVersion = $config->getServiceVersion(ServiceInterface::SERVICE_PHP);
         $dbVersion = $config->getServiceVersion(ServiceInterface::SERVICE_DB);
@@ -292,10 +292,13 @@ public function build(Config $config): Manager
                 [
                     'volumes' => $volumesRo,
                     'environment' => [
-                        'VIRTUAL_HOST=magento2.docker',
+                        'VIRTUAL_HOST=' . $config->getHost(),
                         'VIRTUAL_PORT=80',
                         'HTTPS_METHOD=noredirect',
                         'WITH_XDEBUG=' . (int)$config->hasServiceEnabled(ServiceInterface::SERVICE_FPM_XDEBUG)
+                    ],
+                    'ports' => [
+                        $config->getPort() . ':80'
                     ]
                 ]
             ),
@@ -312,7 +315,7 @@ public function build(Config $config): Manager
                     [
                         'networks' => [
                             self::NETWORK_MAGENTO => [
-                                'aliases' => [Manager::DOMAIN]
+                                'aliases' => [$config->getHost()]
                             ]
                         ]
                     ]
diff --git a/src/Config/Config.php b/src/Config/Config.php
@@ -12,7 +12,6 @@
 use Magento\CloudDocker\Compose\BuilderFactory;
 use Magento\CloudDocker\Compose\DeveloperBuilder;
 use Magento\CloudDocker\Compose\ProductionBuilder;
-use Magento\CloudDocker\Config\Source\CliSource;
 use Magento\CloudDocker\Config\Source\SourceException;
 use Magento\CloudDocker\Config\Source\SourceInterface;
 use Magento\CloudDocker\Service\ServiceInterface;
@@ -292,4 +291,24 @@ public function getVariables(): array
 
         return $config->get(SourceInterface::VARIABLES);
     }
+
+    /**
+     * Returns host value or default if host not set
+     *
+     * @return string
+     */
+    public function getHost(): string
+    {
+        return $this->get(SourceInterface::CONFIG_HOST);
+    }
+
+    /**
+     * Returns port value or default if port not set
+     *
+     * @return string
+     */
+    public function getPort(): string
+    {
+        return $this->get(SourceInterface::CONFIG_PORT);
+    }
 }
diff --git a/src/Config/Dist/Generator.php b/src/Config/Dist/Generator.php
@@ -8,8 +8,11 @@
 namespace Magento\CloudDocker\Config\Dist;
 
 use Magento\CloudDocker\App\ConfigurationMismatchException;
+use Magento\CloudDocker\Compose\Manager;
 use Magento\CloudDocker\Config\Config;
 use Magento\CloudDocker\Config\Relationship;
+use Magento\CloudDocker\Config\Source\BaseSource;
+use Magento\CloudDocker\Config\Source\SourceInterface;
 use Magento\CloudDocker\Filesystem\DirectoryList;
 use Magento\CloudDocker\Filesystem\Filesystem;
 use Magento\CloudDocker\Config\Environment\Shared\Reader as EnvReader;
@@ -51,27 +54,6 @@ class Generator
      */
     private $envCoder;
 
-    /**
-     * @var array
-     */
-    private static $baseConfig = [
-        'MAGENTO_CLOUD_ROUTES' => [
-            'http://magento2.docker/' => [
-                'type' => 'upstream',
-                'original_url' => 'http://{default}'
-            ],
-            'https://magento2.docker/' => [
-                'type' => 'upstream',
-                'original_url' => 'https://{default}'
-            ],
-        ],
-        'MAGENTO_CLOUD_VARIABLES' => [
-            'ADMIN_EMAIL' => 'admin@example.com',
-            'ADMIN_PASSWORD' => '123123q',
-            'ADMIN_URL' => 'admin'
-        ],
-    ];
-
     /**
      * @param DirectoryList $directoryList
      * @param Filesystem $filesystem
@@ -131,7 +113,7 @@ private function generateByServices(Config $config): array
     {
         return array_merge(
             ['MAGENTO_CLOUD_RELATIONSHIPS' => $this->relationship->get($config)],
-            self::$baseConfig
+            $this->getBaseConfig($config)
         );
     }
 
@@ -168,4 +150,39 @@ private function saveConfigEnv(string $filePath, array $config): void
 
         $this->filesystem->put($filePath, $result);
     }
+
+    /**
+     * Returns base configuration
+     *
+     * @param Config $config
+     * @return array
+     * @throws ConfigurationMismatchException
+     */
+    private function getBaseConfig(Config $config): array
+    {
+        $host = $config->getHost();
+        $port = $config->getPort();
+
+        if (!empty($port) && $port != BaseSource::DEFAULT_PORT) {
+            $host .= ':' . $port;
+        }
+
+        return [
+            'MAGENTO_CLOUD_ROUTES' => [
+                sprintf('http://%s/', $host) => [
+                    'type' => 'upstream',
+                    'original_url' => 'http://{default}'
+                ],
+                sprintf('https://%s/', $host) => [
+                    'type' => 'upstream',
+                    'original_url' => 'https://{default}'
+                ],
+            ],
+            'MAGENTO_CLOUD_VARIABLES' => [
+                'ADMIN_EMAIL' => 'admin@example.com',
+                'ADMIN_PASSWORD' => '123123q',
+                'ADMIN_URL' => 'admin'
+            ],
+        ];
+    }
 }
diff --git a/src/Config/Source/BaseSource.php b/src/Config/Source/BaseSource.php
@@ -17,6 +17,9 @@
  */
 class BaseSource implements SourceInterface
 {
+    public const DEFAULT_HOST = 'magento2.docker';
+    public const DEFAULT_PORT = '80';
+
     /**
      * @var EnvReader
      */
@@ -41,6 +44,8 @@ public function read(): Repository
             self::SYSTEM_MODE => BuilderFactory::BUILDER_PRODUCTION,
             self::SYSTEM_SYNC_ENGINE => null,
             self::CRON_ENABLED => false,
+            self::CONFIG_PORT => self::DEFAULT_PORT,
+            self::CONFIG_HOST => self::DEFAULT_HOST,
         ]);
 
         try {
diff --git a/src/Config/Source/CliSource.php b/src/Config/Source/CliSource.php
@@ -48,6 +48,12 @@ class CliSource implements SourceInterface
      */
     public const OPTION_ENV_VARIABLES = 'env-vars';
 
+    /**
+     * Host configuration
+     */
+    public const OPTION_HOST = 'host';
+    public const OPTION_PORT = 'port';
+
     /**
      * Option key to config name map
      *
@@ -149,8 +155,16 @@ public function read(): Repository
             $repository->set(self::VARIABLES, (array) json_decode($envs, true));
         }
 
-        if ($port = $this->input->getOption(self::OPTION_EXPOSE_DB_PORT)) {
-            $repository->set(self::SYSTEM_EXPOSE_DB_PORTS, $port);
+        if ($dbPort = $this->input->getOption(self::OPTION_EXPOSE_DB_PORT)) {
+            $repository->set(self::SYSTEM_EXPOSE_DB_PORTS, $dbPort);
+        }
+
+        if ($host = $this->input->getOption(self::OPTION_HOST)) {
+            $repository->set(self::CONFIG_HOST, $host);
+        }
+
+        if ($port = $this->input->getOption(self::OPTION_PORT)) {
+            $repository->set(self::CONFIG_PORT, $port);
         }
 
         return $repository;
diff --git a/src/Config/Source/SourceInterface.php b/src/Config/Source/SourceInterface.php
@@ -94,6 +94,8 @@ interface SourceInterface
     public const SYSTEM_SYNC_ENGINE = 'system.sync_engine';
     public const SYSTEM_TMP_MOUNTS = 'system.tmp_mounts';
     public const SYSTEM_MODE = 'system.mode';
+    public const CONFIG_HOST = 'config.host';
+    public const CONFIG_PORT = 'config.port';
     public const SYSTEM_EXPOSE_DB_PORTS = 'system.expose_db_ports';
 
     public const VARIABLES = 'variables';
diff --git a/src/Test/Functional/Acceptance/AcceptanceCest.php b/src/Test/Functional/Acceptance/AcceptanceCest.php
@@ -48,6 +48,26 @@ public function testProductionMode(\CliTester $I): void
         $I->see('CMS homepage content goes here.');
     }
 
+    /**
+     * @param \CliTester $I
+     * @throws \Robo\Exception\TaskException
+     */
+    public function testCustomHost(\CliTester $I): void
+    {
+        $I->updateBaseUrl('http://magento2.test:8080/');
+        $I->assertTrue(
+            $I->runEceDockerCommand('build:compose --mode=production --host=magento2.test --port=8080'),
+            'Command build:compose failed'
+        );
+        $I->startEnvironment();
+        $I->assertTrue($I->runDockerComposeCommand('run build cloud-build'), 'Build phase failed');
+        $I->assertTrue($I->runDockerComposeCommand('run deploy cloud-deploy'), 'Deploy phase failed');
+        $I->assertTrue($I->runDockerComposeCommand('run deploy cloud-post-deploy'), 'Post deploy phase failed');
+        $I->amOnPage('/');
+        $I->see('Home page');
+        $I->see('CMS homepage content goes here.');
+    }
+
     /**
      * @param \CliTester $I
      */
diff --git a/src/Test/Unit/Config/Dist/GeneratorTest.php b/src/Test/Unit/Config/Dist/GeneratorTest.php
@@ -82,6 +82,8 @@ protected function setUp(): void
     }
 
     /**
+     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
+     *
      * @throws ConfigurationMismatchException
      */
     public function testGenerate(): void
@@ -100,6 +102,12 @@ public function testGenerate(): void
                 'database' => ['config'],
                 'redis' => ['config'],
             ]);
+        $config->expects($this->exactly(1))
+            ->method('getHost')
+            ->willReturn('magento2.docker');
+        $config->expects($this->exactly(1))
+            ->method('getPort')
+            ->willReturn(80);
         $this->envReaderMock->expects($this->once())
             ->method('read')
             ->willReturn([]);
diff --git a/tests/functional/Codeception/BaseModule.php b/tests/functional/Codeception/BaseModule.php

Original file line number	Diff line number	Diff line change
`@@ -7,15 +7,25 @@`
`7`	`7`
`8`	`8`	`namespace Magento\CloudDocker\Compose;`
`9`	`9`
	`10`	`+use Magento\CloudDocker\Config\Config;`
	`11`	`+use Magento\CloudDocker\Config\Source\SourceInterface;`
	`12`	`+`
`10`	`13`	`/**`
`11`	`14`	`* Creates instance of Manager`
`12`	`15`	`*`
`13`	`16`	`* @see Manager`
`14`	`17`	`*/`
`15`	`18`	`class ManagerFactory`
`16`	`19`	`{`
`17`		`- public function create(): Manager`
	`20`	`+ /**`
	`21`	`+ * Creates instance of Manager`
	`22`	`+ *`
	`23`	`+ * @param Config $config`
	`24`	`+ * @return Manager`
	`25`	`+ * @throws \Magento\CloudDocker\App\ConfigurationMismatchException`
	`26`	`+ */`
	`27`	`+ public function create(Config $config): Manager`
`18`	`28`	`{`
`19`		`- return new Manager();`
	`29`	`+ return new Manager($config);`
`20`	`30`	`}`
`21`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,11 +7,11 @@`
`7`	`7`
`8`	`8`	`namespace Magento\CloudDocker\Compose;`
`9`	`9`
	`10`	`+use Magento\CloudDocker\App\ConfigurationMismatchException;`
`10`	`11`	`use Magento\CloudDocker\Compose\Php\ExtensionResolver;`
`11`	`12`	`use Magento\CloudDocker\Compose\ProductionBuilder\VolumeResolver;`
`12`	`13`	`use Magento\CloudDocker\Config\Config;`
`13`	`14`	`use Magento\CloudDocker\Config\Environment\Converter;`
`14`		`-use Magento\CloudDocker\App\ConfigurationMismatchException;`
`15`	`15`	`use Magento\CloudDocker\Filesystem\FileList;`
`16`	`16`	`use Magento\CloudDocker\Service\ServiceFactory;`
`17`	`17`	`use Magento\CloudDocker\Service\ServiceInterface;`
`@@ -134,7 +134,7 @@ public function __construct(`
`134`	`134`	`*/`
`135`	`135`	`public function build(Config $config): Manager`
`136`	`136`	`{`
`137`		`- $manager = $this->managerFactory->create();`
	`137`	`+ $manager = $this->managerFactory->create($config);`
`138`	`138`
`139`	`139`	`$phpVersion = $config->getServiceVersion(ServiceInterface::SERVICE_PHP);`
`140`	`140`	`$dbVersion = $config->getServiceVersion(ServiceInterface::SERVICE_DB);`
`@@ -292,10 +292,13 @@ public function build(Config $config): Manager`
`292`	`292`	`[`
`293`	`293`	`'volumes' => $volumesRo,`
`294`	`294`	`'environment' => [`
`295`		`- 'VIRTUAL_HOST=magento2.docker',`
	`295`	`+ 'VIRTUAL_HOST=' . $config->getHost(),`
`296`	`296`	`'VIRTUAL_PORT=80',`
`297`	`297`	`'HTTPS_METHOD=noredirect',`
`298`	`298`	`'WITH_XDEBUG=' . (int)$config->hasServiceEnabled(ServiceInterface::SERVICE_FPM_XDEBUG)`
	`299`	`+ ],`
	`300`	`+ 'ports' => [`
	`301`	`+ $config->getPort() . ':80'`
`299`	`302`	`]`
`300`	`303`	`]`
`301`	`304`	`),`
`@@ -312,7 +315,7 @@ public function build(Config $config): Manager`
`312`	`315`	`[`
`313`	`316`	`'networks' => [`
`314`	`317`	`self::NETWORK_MAGENTO => [`
`315`		`- 'aliases' => [Manager::DOMAIN]`
	`318`	`+ 'aliases' => [$config->getHost()]`
`316`	`319`	`]`
`317`	`320`	`]`
`318`	`321`	`]`