MCLOUD-7089: Support alternative docker image locations with ece-docker (#8)

oshmyheliuk · web-flow · commit 656fb1ca95f3 · 2020-11-02T08:56:04.000-06:00
diff --git a/src/Compose/ProductionBuilder/Service/Blackfire.php b/src/Compose/ProductionBuilder/Service/Blackfire.php
@@ -63,7 +63,8 @@ public function getConfig(Config $config): array
                     'BLACKFIRE_CLIENT_TOKEN' => $config->getBlackfireConfig()['client_token']
                 ],
                 'ports' => ["8707"]
-            ]
+            ],
+            $config->getServiceImage($this->getServiceName())
         );
     }
 
diff --git a/src/Compose/ProductionBuilder/Service/Build.php b/src/Compose/ProductionBuilder/Service/Build.php
@@ -71,7 +71,9 @@ public function getConfig(Config $config): array
         return $this->serviceFactory->create(
             $this->getServiceName(),
             $config->getServiceVersion(ServiceInterface::SERVICE_PHP),
-            ['volumes' => $this->volume->getBuild($config)]
+            ['volumes' => $this->volume->getBuild($config)],
+            $config->getServiceImage(ServiceInterface::SERVICE_PHP),
+            $config->getServiceImagePattern(ServiceInterface::SERVICE_PHP_CLI)
         );
     }
 
diff --git a/src/Compose/ProductionBuilder/Service/Cron.php b/src/Compose/ProductionBuilder/Service/Cron.php
@@ -71,7 +71,9 @@ public function getConfig(Config $config): array
         $cron = $this->serviceFactory->create(
             ServiceInterface::SERVICE_PHP_CLI,
             $config->getServiceVersion(ServiceInterface::SERVICE_PHP),
-            ['command' => 'run-cron']
+            ['command' => 'run-cron'],
+            $config->getServiceImage(ServiceInterface::SERVICE_PHP),
+            $config->getServiceImagePattern(ServiceInterface::SERVICE_PHP_CLI)
         );
         $preparedCronConfig = [];
 
diff --git a/src/Compose/ProductionBuilder/Service/Deploy.php b/src/Compose/ProductionBuilder/Service/Deploy.php
@@ -71,7 +71,9 @@ public function getConfig(Config $config): array
         return $this->serviceFactory->create(
             $this->getServiceName(),
             $config->getServiceVersion(ServiceInterface::SERVICE_PHP),
-            ['volumes' => $this->volume->getRo($config)]
+            ['volumes' => $this->volume->getRo($config)],
+            $config->getServiceImage(ServiceInterface::SERVICE_PHP),
+            $config->getServiceImagePattern(ServiceInterface::SERVICE_PHP_CLI)
         );
     }
 
diff --git a/src/Compose/ProductionBuilder/Service/ElasticSearch.php b/src/Compose/ProductionBuilder/Service/ElasticSearch.php
@@ -70,7 +70,9 @@ public function getConfig(Config $config): array
         return $this->serviceFactory->create(
             $this->getServiceName(),
             $config->getServiceVersion($this->getServiceName()),
-            !empty($esEnvVars) ? ['environment' => $esEnvVars] : []
+            !empty($esEnvVars) ? ['environment' => $esEnvVars] : [],
+            $config->getServiceImage($this->getServiceName()),
+            $config->getServiceImagePattern($this->getServiceName())
         );
     }
 
diff --git a/src/Compose/ProductionBuilder/Service/Fpm.php b/src/Compose/ProductionBuilder/Service/Fpm.php
@@ -63,7 +63,9 @@ public function getConfig(Config $config): array
         return $this->serviceFactory->create(
             $this->getServiceName(),
             $config->getServiceVersion(ServiceInterface::SERVICE_PHP),
-            ['volumes' => $this->volume->getRo($config)]
+            ['volumes' => $this->volume->getRo($config)],
+            $config->getServiceImage(ServiceInterface::SERVICE_PHP),
+            $config->getServiceImagePattern($this->getServiceName())
         );
     }
 
diff --git a/src/Compose/ProductionBuilder/Service/FpmXdebug.php b/src/Compose/ProductionBuilder/Service/FpmXdebug.php
@@ -94,7 +94,9 @@ public function getConfig(Config $config): array
             [
                 'volumes' => $this->volume->getRo($config),
                 'environment' => $this->converter->convert($envVariables)
-            ]
+            ],
+            $config->getServiceImage(ServiceInterface::SERVICE_PHP),
+            $config->getServiceImagePattern($this->getServiceName())
         );
     }
 
diff --git a/src/Compose/ProductionBuilder/Service/Generic.php b/src/Compose/ProductionBuilder/Service/Generic.php
@@ -81,7 +81,9 @@ public function getConfig(Config $config): array
                         'PHP_EXTENSIONS' => implode(' ', $this->phpExtension->get($config)),
                     ]
                 )
-            ]
+            ],
+            $config->getServiceImage(ServiceInterface::SERVICE_PHP),
+            $config->getServiceImagePattern(ServiceInterface::SERVICE_PHP_CLI)
         );
     }
 
diff --git a/src/Compose/ProductionBuilder/Service/Mailhog.php b/src/Compose/ProductionBuilder/Service/Mailhog.php
@@ -59,7 +59,9 @@ public function getConfig(Config $config): array
                     $config->getMailHogSmtpPort() . ':1025',
                     $config->getMailHogHttpPort() . ':8025',
                 ]
-            ]
+            ],
+            $config->getServiceImage($this->getServiceName()),
+            $config->getServiceImagePattern($this->getServiceName())
         );
     }
 
diff --git a/src/Compose/ProductionBuilder/Service/Node.php b/src/Compose/ProductionBuilder/Service/Node.php
@@ -61,7 +61,9 @@ public function getConfig(Config $config): array
         return $this->serviceFactory->create(
             $this->getServiceName(),
             $config->getServiceVersion($this->getServiceName()),
-            ['volumes' => $this->volume->getRo($config)]
+            ['volumes' => $this->volume->getRo($config)],
+            $config->getServiceImage($this->getServiceName()),
+            $config->getServiceImagePattern($this->getServiceName())
         );
     }
 
diff --git a/src/Compose/ProductionBuilder/Service/RabbitMq.php b/src/Compose/ProductionBuilder/Service/RabbitMq.php
@@ -53,7 +53,9 @@ public function getConfig(Config $config): array
     {
         return $this->serviceFactory->create(
             $this->getServiceName(),
-            $config->getServiceVersion($this->getServiceName())
+            $config->getServiceVersion($this->getServiceName()),
+            [],
+            $config->getServiceImage($this->getServiceName())
         );
     }
 
diff --git a/src/Compose/ProductionBuilder/Service/Redis.php b/src/Compose/ProductionBuilder/Service/Redis.php
@@ -61,7 +61,8 @@ public function getConfig(Config $config): array
                     'timeout' => '30s',
                     'retries' => 3
                 ]
-            ]
+            ],
+            $config->getServiceImage($this->getServiceName())
         );
     }
 
diff --git a/src/Compose/ProductionBuilder/Service/Test.php b/src/Compose/ProductionBuilder/Service/Test.php
@@ -71,7 +71,9 @@ public function getConfig(Config $config): array
         return $this->serviceFactory->create(
             ServiceInterface::SERVICE_PHP_CLI,
             $config->getServiceVersion(ServiceInterface::SERVICE_PHP),
-            ['volumes' => $this->volume->getRw($config)]
+            ['volumes' => $this->volume->getRw($config)],
+            $config->getServiceImage(ServiceInterface::SERVICE_PHP),
+            $config->getServiceImagePattern(ServiceInterface::SERVICE_PHP_CLI)
         );
     }
 
diff --git a/src/Compose/ProductionBuilder/Service/Tls.php b/src/Compose/ProductionBuilder/Service/Tls.php
@@ -37,15 +37,15 @@ public function __construct(ServiceFactory $serviceFactory)
      */
     public function getName(): string
     {
-        return ServiceInterface::SERVICE_TLS;
+        return BuilderInterface::SERVICE_TLS;
     }
 
     /**
      * @inheritDoc
      */
     public function getServiceName(): string
     {
-        return $this->getName();
+        return ServiceInterface::SERVICE_NGINX;
     }
 
     /**
@@ -67,7 +67,9 @@ public function getConfig(Config $config): array
                     $config->getPort() . ':80',
                     $config->getTlsPort() . ':443'
                 ]
-            ]
+            ],
+            $config->getServiceImage($this->getServiceName()),
+            $config->getServiceImagePattern($this->getServiceName())
         );
     }
 
diff --git a/src/Compose/ProductionBuilder/Service/Varnish.php b/src/Compose/ProductionBuilder/Service/Varnish.php
@@ -53,7 +53,10 @@ public function getConfig(Config $config): array
     {
         return $this->serviceFactory->create(
             $this->getServiceName(),
-            $config->getServiceVersion($this->getServiceName())
+            $config->getServiceVersion($this->getServiceName()),
+            [],
+            $config->getServiceImage($this->getServiceName()),
+            $config->getServiceImagePattern($this->getServiceName())
         );
     }
 
diff --git a/src/Compose/ProductionBuilder/Service/Web.php b/src/Compose/ProductionBuilder/Service/Web.php
@@ -68,7 +68,9 @@ public function getConfig(Config $config): array
                 'environment' => [
                     'WITH_XDEBUG=' . (int)$config->hasServiceEnabled(ServiceInterface::SERVICE_FPM_XDEBUG)
                 ]
-            ]
+            ],
+            $config->getServiceImage(ServiceInterface::SERVICE_NGINX),
+            $config->getServiceImagePattern(ServiceInterface::SERVICE_NGINX)
         );
     }
 
diff --git a/src/Config/Config.php b/src/Config/Config.php
@@ -207,18 +207,22 @@ public function getServiceVersion(string $name): string
 
     /**
      * @param string $name
-     * @return string
+     * @return string|null
      * @throws ConfigurationMismatchException
      */
-    public function getServiceImage(string $name): string
+    public function getServiceImage(string $name): ?string
     {
-        $key = $this->getKey($name, 'image');
-
-        if (!$this->all()->has($key)) {
-            throw new ConfigurationMismatchException('Service image is not defined');
-        }
+        return $this->all()->get($this->getKey($name, 'image'));
+    }
 
-        return $this->all()->get($key);
+    /**
+     * @param string $name
+     * @return string|null
+     * @throws ConfigurationMismatchException
+     */
+    public function getServiceImagePattern(string $name): ?string
+    {
+        return $this->all()->get($this->getKey($name, 'image-pattern'));
     }
 
     /**
diff --git a/src/Service/ServiceFactory.php b/src/Service/ServiceFactory.php
@@ -36,6 +36,18 @@ class ServiceFactory
         ]
     ];
 
+    /**
+     * Default nginx configuration for nginx and tls services
+     */
+    private const SERVICE_NGINX_CONFIG = [
+        'image' => 'magento/magento-cloud-docker-nginx',
+        'version' => '1.19',
+        'pattern' => self::PATTERN_VERSIONED,
+        'config' => [
+            'extends' => ServiceInterface::SERVICE_GENERIC,
+        ]
+    ];
+
     /**
      * @var array
      */
@@ -65,27 +77,13 @@ class ServiceFactory
         ServiceInterface::SERVICE_DB => self::SERVICE_DB_CONFIG,
         ServiceInterface::SERVICE_DB_QUOTE => self::SERVICE_DB_CONFIG,
         ServiceInterface::SERVICE_DB_SALES => self::SERVICE_DB_CONFIG,
-        ServiceInterface::SERVICE_NGINX => [
-            'image' => 'magento/magento-cloud-docker-nginx',
-            'version' => '1.19',
-            'pattern' => self::PATTERN_VERSIONED,
-            'config' => [
-                'extends' => ServiceInterface::SERVICE_GENERIC,
-            ]
-        ],
+        ServiceInterface::SERVICE_NGINX => self::SERVICE_NGINX_CONFIG,
         ServiceInterface::SERVICE_VARNISH => [
             'image' => 'magento/magento-cloud-docker-varnish',
             'version' => '6.2',
             'pattern' => self::PATTERN_VERSIONED,
         ],
-        ServiceInterface::SERVICE_TLS => [
-            'image' => 'magento/magento-cloud-docker-nginx',
-            'version' => '1.19',
-            'pattern' => self::PATTERN_VERSIONED,
-            'config' => [
-                'extends' => ServiceInterface::SERVICE_GENERIC,
-            ]
-        ],
+        ServiceInterface::SERVICE_TLS => self::SERVICE_NGINX_CONFIG,
         ServiceInterface::SERVICE_REDIS => [
             'image' => 'redis',
             'pattern' => self::PATTERN_STD,
@@ -163,11 +161,17 @@ public function __construct(FileList $fileList)
      * @param string $version
      * @param array $config
      * @param string $image
+     * @param string|null $imagePattern
      * @return array
      * @throws ConfigurationMismatchException
      */
-    public function create(string $name, string $version, array $config = [], string $image = null): array
-    {
+    public function create(
+        string $name,
+        string $version,
+        array $config = [],
+        string $image = null,
+        string $imagePattern = null
+    ): array {
         if (!array_key_exists($name, self::$config)) {
             throw new ConfigurationMismatchException(sprintf(
                 'Service "%s" is not supported',
@@ -179,7 +183,7 @@ public function create(string $name, string $version, array $config = [], string
         $defaultConfig = $metaConfig['config'] ?? [];
 
         $image = $image ?: $metaConfig['image'];
-        $pattern = $metaConfig['pattern'];
+        $pattern = $imagePattern ?: $metaConfig['pattern'];
 
         return array_replace(
             ['image' => sprintf($pattern, $image, $version, $this->getMcdVersion())],
diff --git a/src/Test/Integration/BuildCustomComposeTest.php b/src/Test/Integration/BuildCustomComposeTest.php
diff --git a/src/Test/Integration/_files/custom_cloud_custom_images/.docker/.gitignore b/src/Test/Integration/_files/custom_cloud_custom_images/.docker/.gitignore
diff --git a/src/Test/Integration/_files/custom_cloud_custom_images/.docker/config.php.dist b/src/Test/Integration/_files/custom_cloud_custom_images/.docker/config.php.dist
diff --git a/src/Test/Integration/_files/custom_cloud_custom_images/composer.json b/src/Test/Integration/_files/custom_cloud_custom_images/composer.json
diff --git a/src/Test/Integration/_files/custom_cloud_custom_images/docker-compose.exp.yml b/src/Test/Integration/_files/custom_cloud_custom_images/docker-compose.exp.yml

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,8 @@ public function getConfig(Config $config): array`
`63`	`63`	`'BLACKFIRE_CLIENT_TOKEN' => $config->getBlackfireConfig()['client_token']`
`64`	`64`	`],`
`65`	`65`	`'ports' => ["8707"]`
`66`		`- ]`
	`66`	`+ ],`
	`67`	`+ $config->getServiceImage($this->getServiceName())`
`67`	`68`	`);`
`68`	`69`	`}`
`69`	`70`
Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,9 @@ public function getConfig(Config $config): array`
`94`	`94`	`[`
`95`	`95`	`'volumes' => $this->volume->getRo($config),`
`96`	`96`	`'environment' => $this->converter->convert($envVariables)`
`97`		`- ]`
	`97`	`+ ],`
	`98`	`+ $config->getServiceImage(ServiceInterface::SERVICE_PHP),`
	`99`	`+ $config->getServiceImagePattern($this->getServiceName())`
`98`	`100`	`);`
`99`	`101`	`}`
`100`	`102`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,9 @@ public function getConfig(Config $config): array`
`81`	`81`	`'PHP_EXTENSIONS' => implode(' ', $this->phpExtension->get($config)),`
`82`	`82`	`]`
`83`	`83`	`)`
`84`		`- ]`
	`84`	`+ ],`
	`85`	`+ $config->getServiceImage(ServiceInterface::SERVICE_PHP),`
	`86`	`+ $config->getServiceImagePattern(ServiceInterface::SERVICE_PHP_CLI)`
`85`	`87`	`);`
`86`	`88`	`}`
`87`	`89`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,9 @@ public function getConfig(Config $config): array`
`59`	`59`	`$config->getMailHogSmtpPort() . ':1025',`
`60`	`60`	`$config->getMailHogHttpPort() . ':8025',`
`61`	`61`	`]`
`62`		`- ]`
	`62`	`+ ],`
	`63`	`+ $config->getServiceImage($this->getServiceName()),`
	`64`	`+ $config->getServiceImagePattern($this->getServiceName())`
`63`	`65`	`);`
`64`	`66`	`}`
`65`	`67`