MCLOUD-6430: Xdebug not working on Magento Cloud Docker 1.1 (#282)

oshmyheliuk · web-flow · commit 00b015a18621 · 2020-09-02T11:51:45.000-05:00
diff --git a/images/php/7.2-fpm/Dockerfile b/images/php/7.2-fpm/Dockerfile
@@ -9,6 +9,7 @@ ENV MAGENTO_RUN_MODE production
 ENV UPLOAD_MAX_FILESIZE 64M
 ENV UPDATE_UID_GID false
 ENV ENABLE_SENDMAIL true
+ENV SET_DOCKER_HOST false
 
 ENV PHP_EXTENSIONS bcmath bz2 calendar exif gd gettext intl mysqli opcache pdo_mysql redis soap sockets sysvmsg sysvsem sysvshm xsl zip pcntl
 
diff --git a/images/php/7.2-fpm/docker-entrypoint.sh b/images/php/7.2-fpm/docker-entrypoint.sh
@@ -58,4 +58,11 @@ fi
 # Configure PHP-FPM
 [ ! -z "${MAGENTO_RUN_MODE}" ] && sed -i "s/!MAGENTO_RUN_MODE!/${MAGENTO_RUN_MODE}/" /usr/local/etc/php-fpm.conf
 
+# Set host.docker.inernal for LINUX os
+if [[ "$SET_DOCKER_HOST" = "true" ]]; then
+  apt update
+  apt install -y iproute2
+  echo -e "`/sbin/ip route|awk '/default/ { print $3 }'`\thost.docker.internal" | sudo tee -a /etc/hosts > /dev/null
+fi
+
 exec "$@"
diff --git a/images/php/7.3-fpm/Dockerfile b/images/php/7.3-fpm/Dockerfile
@@ -9,6 +9,7 @@ ENV MAGENTO_RUN_MODE production
 ENV UPLOAD_MAX_FILESIZE 64M
 ENV UPDATE_UID_GID false
 ENV ENABLE_SENDMAIL true
+ENV SET_DOCKER_HOST false
 
 ENV PHP_EXTENSIONS bcmath bz2 calendar exif gd gettext intl mysqli opcache pdo_mysql redis soap sockets sysvmsg sysvsem sysvshm xsl zip pcntl
 
diff --git a/images/php/7.3-fpm/docker-entrypoint.sh b/images/php/7.3-fpm/docker-entrypoint.sh
@@ -58,4 +58,11 @@ fi
 # Configure PHP-FPM
 [ ! -z "${MAGENTO_RUN_MODE}" ] && sed -i "s/!MAGENTO_RUN_MODE!/${MAGENTO_RUN_MODE}/" /usr/local/etc/php-fpm.conf
 
+# Set host.docker.inernal for LINUX os
+if [[ "$SET_DOCKER_HOST" = "true" ]]; then
+  apt update
+  apt install -y iproute2
+  echo -e "`/sbin/ip route|awk '/default/ { print $3 }'`\thost.docker.internal" | sudo tee -a /etc/hosts > /dev/null
+fi
+
 exec "$@"
diff --git a/images/php/7.4-fpm/Dockerfile b/images/php/7.4-fpm/Dockerfile
@@ -9,6 +9,7 @@ ENV MAGENTO_RUN_MODE production
 ENV UPLOAD_MAX_FILESIZE 64M
 ENV UPDATE_UID_GID false
 ENV ENABLE_SENDMAIL true
+ENV SET_DOCKER_HOST false
 
 ENV PHP_EXTENSIONS bcmath bz2 calendar exif gd gettext intl mysqli opcache pdo_mysql redis soap sockets sysvmsg sysvsem sysvshm xsl zip pcntl
 
diff --git a/images/php/7.4-fpm/docker-entrypoint.sh b/images/php/7.4-fpm/docker-entrypoint.sh
@@ -58,4 +58,11 @@ fi
 # Configure PHP-FPM
 [ ! -z "${MAGENTO_RUN_MODE}" ] && sed -i "s/!MAGENTO_RUN_MODE!/${MAGENTO_RUN_MODE}/" /usr/local/etc/php-fpm.conf
 
+# Set host.docker.inernal for LINUX os
+if [[ "$SET_DOCKER_HOST" = "true" ]]; then
+  apt update
+  apt install -y iproute2
+  echo -e "`/sbin/ip route|awk '/default/ { print $3 }'`\thost.docker.internal" | sudo tee -a /etc/hosts > /dev/null
+fi
+
 exec "$@"
diff --git a/images/php/fpm/Dockerfile b/images/php/fpm/Dockerfile
@@ -9,6 +9,7 @@ ENV MAGENTO_RUN_MODE production
 ENV UPLOAD_MAX_FILESIZE 64M
 ENV UPDATE_UID_GID false
 ENV ENABLE_SENDMAIL true
+ENV SET_DOCKER_HOST false
 
 {%env_php_extensions%}
 
diff --git a/images/php/fpm/docker-entrypoint.sh b/images/php/fpm/docker-entrypoint.sh
@@ -58,4 +58,11 @@ fi
 # Configure PHP-FPM
 [ ! -z "${MAGENTO_RUN_MODE}" ] && sed -i "s/!MAGENTO_RUN_MODE!/${MAGENTO_RUN_MODE}/" /usr/local/etc/php-fpm.conf
 
+# Set host.docker.inernal for LINUX os
+if [[ "$SET_DOCKER_HOST" = "true" ]]; then
+  apt update
+  apt install -y iproute2
+  echo -e "`/sbin/ip route|awk '/default/ { print $3 }'`\thost.docker.internal" | sudo tee -a /etc/hosts > /dev/null
+fi
+
 exec "$@"
diff --git a/src/Command/BuildCompose.php b/src/Command/BuildCompose.php
@@ -171,6 +171,11 @@ protected function configure(): void
                 null,
                 InputOption::VALUE_NONE,
                 'Disable mailhog'
+            )->addOption(
+                Source\CliSource::OPTION_SET_DOCKER_HOST_XDEBUG,
+                null,
+                InputOption::VALUE_NONE,
+                'Sets host.docker.internal for fpm_xdebug container to resolve debug issue for LINUX system'
             );
 
         $this->addOption(
diff --git a/src/Compose/ProductionBuilder.php b/src/Compose/ProductionBuilder.php
@@ -333,14 +333,18 @@ public function build(Config $config): Manager
          * Include Xdebug if --with-xdebug is set
          */
         if ($config->hasServiceEnabled(ServiceInterface::SERVICE_FPM_XDEBUG)) {
+            $envVariables = ['PHP_EXTENSIONS' => implode(' ', array_unique(array_merge($phpExtensions, ['xdebug'])))];
+            if ($config->get(SourceInterface::SYSTEM_SET_DOCKER_HOST)) {
+                $envVariables['SET_DOCKER_HOST'] = true;
+            }
             $manager->addService(
                 self::SERVICE_FPM_XDEBUG,
                 $this->serviceFactory->create(
                     ServiceInterface::SERVICE_FPM_XDEBUG,
                     $phpVersion,
                     [
                         'volumes' => $volumesRo,
-                        'environment' => $this->converter->convert(['PHP_EXTENSIONS' => implode(' ', $phpExtensions)])
+                        'environment' => $this->converter->convert($envVariables)
                     ]
                 ),
                 [self::NETWORK_MAGENTO],
diff --git a/src/Config/Source/CliSource.php b/src/Config/Source/CliSource.php
@@ -45,6 +45,7 @@ class CliSource implements SourceInterface
     public const OPTION_NO_TMP_MOUNTS = 'no-tmp-mounts';
     public const OPTION_SYNC_ENGINE = 'sync-engine';
     public const OPTION_WITH_XDEBUG = 'with-xdebug';
+    public const OPTION_SET_DOCKER_HOST_XDEBUG = 'set-docker-host';
     public const OPTION_WITH_ENTRYPOINT = 'with-entrypoint';
     public const OPTION_WITH_MARIADB_CONF = 'with-mariadb-conf';
 
@@ -220,6 +221,10 @@ public function read(): Repository
             ]);
         }
 
+        if ($this->input->getOption(self::OPTION_SET_DOCKER_HOST_XDEBUG)) {
+            $repository->set(self::SYSTEM_SET_DOCKER_HOST, true);
+        }
+
         if ($envs = $this->input->getOption(self::OPTION_ENV_VARIABLES)) {
             $repository->set(self::VARIABLES, (array)json_decode($envs, true));
         }
diff --git a/src/Config/Source/SourceInterface.php b/src/Config/Source/SourceInterface.php
@@ -142,6 +142,7 @@ interface SourceInterface
     public const SYSTEM_EXPOSE_DB_SALES_PORTS = 'system.expose_db_sales_ports';
     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_DB_INCREMENT_INCREMENT = 'system.db.increment_increment';
     public const SYSTEM_DB_INCREMENT_OFFSET = 'system.db.increment_offset';
diff --git a/src/Service/ServiceFactory.php b/src/Service/ServiceFactory.php
@@ -60,9 +60,6 @@ class ServiceFactory
             'pattern' => '%s:%s-fpm-%s',
             'config' => [
                 'extends' => ServiceInterface::SERVICE_GENERIC,
-                'ports' => [
-                    '9001:9001',
-                ]
             ]
         ],
         ServiceInterface::SERVICE_DB => self::SERVICE_DB_CONFIG,
diff --git a/src/Test/Integration/_files/cloud_base_mftf/docker-compose.exp.yml b/src/Test/Integration/_files/cloud_base_mftf/docker-compose.exp.yml
@@ -152,8 +152,6 @@ services:
     hostname: fpm_xdebug.magento2.docker
     image: 'magento/magento-cloud-docker-php:7.3-fpm-1.1'
     extends: generic
-    ports:
-      - '9001:9001'
     volumes:
       - '.:/app:ro,delegated'
       - './dev:/app/dev:rw,delegated'
@@ -165,7 +163,7 @@ services:
       - 'magento-pub-static:/app/pub/static:rw,delegated'
       - '.docker/mnt:/mnt:rw,delegated'
     environment:
-      - 'PHP_EXTENSIONS=bcmath bz2 calendar exif gd gettext intl mysqli pcntl pdo_mysql soap sockets sysvmsg sysvsem sysvshm opcache zip redis xsl sodium'
+      - 'PHP_EXTENSIONS=bcmath bz2 calendar exif gd gettext intl mysqli pcntl pdo_mysql soap sockets sysvmsg sysvsem sysvshm opcache zip redis xsl sodium xdebug'
     networks:
       magento:
         aliases:
