MAGECLOUD-5185: Platform-agnostic Docker builder #102 (#149)

Author: shiftedreality

.travis.yml

@@ -16,3 +16,4 @@ script:
   - ./vendor/bin/phpcs ./src --standard=./tests/static/phpcs-ruleset.xml -p -n
   - ./vendor/bin/phpmd ./src xml ./tests/static/phpmd-ruleset.xml
   - ./vendor/bin/phpunit --configuration ./tests/unit
+  - ./vendor/bin/phpunit --configuration ./tests/integration

bin/ece-docker

@@ -6,13 +6,5 @@
  */
 $container = require __DIR__ . '/../bootstrap.php';
 
-use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
-use Symfony\Component\Config\FileLocator;
-
-$loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../config'));
-$loader->load('services.xml');
-
-$container->compile();
-
 $application = new Magento\CloudDocker\Application($container);
 $application->run();

bootstrap.php

@@ -3,16 +3,8 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-use Magento\CloudDocker\Filesystem\DirectoryList;
-use Symfony\Component\DependencyInjection\ContainerBuilder;
-
 require __DIR__ . '/autoload.php';
 
-$container = new ContainerBuilder();
-$container->set(DirectoryList::class, new DirectoryList(
-    __DIR__,
-    BP,
-    ECE_BP
-));
+use Magento\CloudDocker\App\Container;
 
-return $container;
+return new Container(__DIR__, BP, ECE_BP);

composer.json

@@ -29,20 +29,23 @@
     ],
     "autoload": {
         "psr-4": {
-            "Magento\\CloudDocker\\": "src/"
+            "Magento\\CloudDocker\\": "src/",
+            "Magento\\CloudDocker\\Test\\Integration\\": "tests/integration"
         }
     },
     "scripts": {
-        "test": [
-            "@phpstan",
-            "@phpcs",
-            "@phpmd",
-            "@phpunit"
+        "test:all": [
+            "@test:phpstan",
+            "@test:phpcs",
+            "@test:phpmd",
+            "@test:unit",
+            "@test:integration"
         ],
-        "phpstan": "phpstan analyse -c tests/static/phpstan.neon",
-        "phpcs": "phpcs src --standard=tests/static/phpcs-ruleset.xml -p -n",
-        "phpmd": "phpmd src xml tests/static/phpmd-ruleset.xml",
-        "phpunit": "phpunit --configuration tests/unit"
+        "test:phpstan": "phpstan analyse -c tests/static/phpstan.neon",
+        "test:phpcs": "phpcs src --standard=tests/static/phpcs-ruleset.xml -p -n",
+        "test:phpmd": "phpmd src xml tests/static/phpmd-ruleset.xml",
+        "test:unit": "phpunit --configuration tests/unit",
+        "test:integration": "phpunit --configuration tests/integration"
     },
     "config": {
         "sort-packages": true

config/services.xml

@@ -6,7 +6,10 @@
         <!-- Default configuration for services in *this* file -->
         <defaults autowire="true" autoconfigure="true" public="true"/>
 
-        <prototype namespace="Magento\CloudDocker\" resource="../src/*" exclude="../src/{App,Test}"/>
+        <prototype namespace="Magento\CloudDocker\" resource="../src/*" exclude="../src/{Test}"/>
+        <service id="Magento\CloudDocker\App\Container" autowire="false"/>
+        <service id="Magento\CloudDocker\App\ContainerInterface" alias="container"/>
+        <service id="Magento\CloudDocker\App\ContainerException" autowire="false"/>
         <service id="Magento\CloudDocker\Compose\BuilderFactory">
             <argument key="$strategies" type="collection">
                 <argument key="developer">Magento\CloudDocker\Compose\DeveloperBuilder</argument>
@@ -16,10 +19,15 @@
         </service>
         <service id="Magento\CloudDocker\Filesystem\DirectoryList" autowire="false"/>
         <service id="Magento\CloudDocker\Filesystem\FilesystemException" autowire="false"/>
+        <service id="Magento\CloudDocker\Config\Source\SourceException" autowire="false"/>
         <service id="Magento\CloudDocker\Filesystem\FileNotFoundException" autowire="false"/>
+        <service id="Magento\CloudDocker\App\ConfigurationMismatchException" autowire="false"/>
+        <service id="Magento\CloudDocker\App\GenericException" autowire="false"/>
         <service id="Magento\CloudDocker\Compose\DeveloperBuilder" shared="false"/>
         <service id="Magento\CloudDocker\Compose\ProductionBuilder" shared="false"/>
         <service id="Magento\CloudDocker\Compose\FunctionalBuilder" shared="false"/>
+        <service id="Magento\CloudDocker\Config\Config" autowire="false"/>
+        <service id="Magento\CloudDocker\Config\Source\CliSource" autowire="false"/>
         <service id="Composer\Semver\VersionParser"/>
         <service id="Composer\Semver\Semver"/>
     </services>

src/App/Container.php

@@ -0,0 +1,85 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CloudDocker\App;
+
+use Magento\CloudDocker\Filesystem\DirectoryList;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
+use Symfony\Component\Config\FileLocator;
+use Exception;
+
+/**
+ * Application container
+ */
+class Container implements ContainerInterface
+{
+    /**
+     * @var \Symfony\Component\DependencyInjection\Container
+     */
+    private $container;
+
+    /**
+     * @param string $root
+     * @param string $magentoRoot
+     * @param string|null $eceToolsRoot
+     * @throws ContainerException
+     */
+    public function __construct(string $root, string $magentoRoot, string $eceToolsRoot = null)
+    {
+        $containerBuilder = new ContainerBuilder();
+        $containerBuilder->set('container', $this);
+        $containerBuilder->setDefinition('container', new Definition(__CLASS__))
+            ->setArguments([$root, $magentoRoot, $eceToolsRoot]);
+
+        $containerBuilder->set(DirectoryList::class, new DirectoryList(
+            $root,
+            $magentoRoot,
+            $eceToolsRoot
+        ));
+
+        try {
+            $loader = new XmlFileLoader($containerBuilder, new FileLocator([__DIR__ . '/../../config']));
+            $loader->load('services.xml');
+        } catch (Exception $exception) {
+            throw new ContainerException($exception->getMessage(), $exception->getCode(), $exception);
+        }
+
+        $containerBuilder->compile();
+
+        $this->container = $containerBuilder;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function get($id)
+    {
+        return $this->container->get($id);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function has($id): bool
+    {
+        return $this->container->has($id);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function create(string $abstract, array $params = [])
+    {
+        if (empty($params) && $this->has($abstract)) {
+            return $this->get($abstract);
+        }
+
+        return new $abstract(...array_values($params));
+    }
+}

src/App/ContainerException.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CloudDocker\App;
+
+/**
+ * Container generic exception
+ */
+class ContainerException extends GenericException
+{
+}

src/App/ContainerInterface.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CloudDocker\App;
+
+/**
+ * Interface for DI container
+ */
+interface ContainerInterface extends \Psr\Container\ContainerInterface
+{
+    /**
+     * Create an object
+     *
+     * @param string $abstract
+     * @param array $params
+     * @return mixed
+     */
+    public function create(string $abstract, array $params = []);
+}

src/App/GenericException.php

@@ -7,6 +7,8 @@
 
 namespace Magento\CloudDocker\App;
 
+use Throwable;
+
 /**
  * Base exception
  */
@@ -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);
     }