chore(docker): add xdebug support

.gitignore

@@ -9,6 +9,7 @@
 sonar-project.properties
 
 PrestaShop/
+prestashop/
 vendor/
 .prestashop-tags
 .prestashop-minor-tags

README.md

@@ -39,6 +39,7 @@ PrestaShop Flashlight can be used as a **development environment**, a **CI/CD as
 - [Custom post-scripts](./examples/with-post-scripts/)
 - [Ngrok tunneling](./examples/ngrok-tunnel)
 - [Auto installation of modules](./examples/auto-install-modules/)
+- [XDEBUG PrestaShop](./examples/xdebug-prestashop/)
 - Develop a PrestaShop Theme (coming soon)
 - Use in GitHub Action (coming soon)
 

docker/alpine.Dockerfile

@@ -20,8 +20,8 @@ ENV COMPOSER_HOME=/var/composer
 ENV PHP_ENV=development
 COPY ./assets/php-configuration.sh /tmp/
 RUN apk --no-cache add -U \
-  bash less vim geoip git tzdata zip curl jq make \
-  nginx nginx-mod-http-headers-more nginx-mod-http-geoip \
+  bash less vim geoip git tzdata zip curl jq make autoconf g++ \
+  linux-headers nginx nginx-mod-http-headers-more nginx-mod-http-geoip\
   nginx-mod-stream nginx-mod-stream-geoip ca-certificates \
   gnu-libiconv php-common mariadb-client sudo freetype-dev \
   zlib-dev libjpeg-turbo-dev libpng-dev oniguruma-dev \
@@ -56,6 +56,11 @@ RUN PHP_CS_FIXER=$(jq -r '."'"${PHP_VERSION}"'".php_cs_fixer' < /tmp/php-flavour
   && wget -q -O /usr/bin/php-cs-fixer "https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/releases/download/${PHP_CS_FIXER}/php-cs-fixer.phar" \
   && chmod a+x /usr/bin/php-cs-fixer
 
+# Install xdebug
+RUN PHP_XDEBUG=$(jq -r '."'"${PHP_VERSION}"'".xdebug' < /tmp/php-flavours.json) \
+  && pecl install xdebug-${PHP_XDEBUG} \
+  && docker-php-ext-enable xdebug
+
 # Install Node.js and pnpm (yarn and npm are included)
 RUN if [ "0.0.0" = "$NODE_VERSION" ]; then exit 0; fi \
   && apk --no-cache add -U python3 nodejs npm yarn \

docker/debian.Dockerfile

@@ -22,8 +22,8 @@ RUN export DEBIAN_FRONTEND=noninteractive \
   && apt-get update \
   && apt-get install --no-install-recommends -qqy ca-certificates \
   && apt-get install --no-install-recommends -qqy bash less vim git \
-  tzdata zip unzip curl wget make jq netcat-traditional \
-  lsb-release libgnutls30 gnupg libiconv-hook1 libonig-dev \
+  tzdata zip unzip curl wget make jq netcat-traditional build-essential \
+  lsb-release libgnutls30 gnupg libiconv-hook1 libonig-dev autoconf \
   nginx libnginx-mod-http-headers-more-filter libnginx-mod-http-geoip \
   libnginx-mod-http-geoip libnginx-mod-stream mariadb-client sudo \
   && apt-get clean \
@@ -82,6 +82,11 @@ RUN PHP_CS_FIXER=$(jq -r '."'"${PHP_VERSION}"'".php_cs_fixer' < /tmp/php-flavour
   && wget -q -O /usr/bin/php-cs-fixer "https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/releases/download/${PHP_CS_FIXER}/php-cs-fixer.phar" \
   && chmod a+x /usr/bin/php-cs-fixer
 
+# Install xdebug
+RUN PHP_XDEBUG=$(jq -r '."'"${PHP_VERSION}"'".xdebug' < /tmp/php-flavours.json) \
+  && pecl install xdebug-${PHP_XDEBUG} \
+  && docker-php-ext-enable xdebug
+
 # Install Node.js and pnpm (yarn and npm are included)
 RUN if [ "0.0.0" = "$NODE_VERSION" ]; then exit 0; fi \
   && export DEBIAN_FRONTEND=noninteractive \

examples/xdebug-prestashop/README.md

@@ -0,0 +1,31 @@
+# XDEBUG PrestaShop
+
+You found a bug in PrestaShop? Want to track down a weird behavior? XDEBUG can help you, even within a docker environment. Here is an example to showcase the integration of this tool with PrestaShop Flashlight.
+
+# Requirements
+
+To enable XDEBUG capabilities within your favorite IDE, you have to mount the PrestaShop sources from your local host to the target PrestaShop Flashlight docker container.
+
+```sh
+CONTAINER_NAME=flashlight-nightly
+PS_FLASHLIGHT_TAG=nightly
+docker create --name "$CONTAINER_NAME" "prestashop/prestashop-flashlight:$PS_FLASHLIGHT_TAG"
+docker cp "$CONTAINER_NAME:/var/www/html" ./PrestaShop
+docker rm "$CONTAINER_NAME"
+```
+
+Now you will have the exact copy of the `PS_FLASHLIGHT_TAG` prestashop source code copied locally.
+You are now all set to start PrestaShop Flashlight with your local source binding:
+
+```
+docker compose up prestashop
+```
+
+# Usage
+
+@TODO: describe here some IDE configurations
+
+# External ressources
+
+- xdebug with VSCode: https://marketplace.visualstudio.com/items?itemName=xdebug.php-debug
+- xdebug with PHPStorm: https://www.jetbrains.com/help/phpstorm/configuring-xdebug.html

examples/xdebug-prestashop/docker-compose.yml

@@ -0,0 +1,38 @@
+name: flashlight-develop-prestashop
+services:
+  prestashop:
+    image: prestashop/prestashop-flashlight:latest
+    depends_on:
+      mysql:
+        condition: service_healthy
+    environment:
+      - PS_DOMAIN=localhost:8000
+      - INIT_SCRIPTS_DIR=/tmp/init-scripts
+      - INIT_SCRIPTS_USER=root
+    volumes:
+      - ./PrestaShop:/var/www/html:rw
+    ports:
+      - 8000:80
+
+  mysql:
+    image: mariadb:lts
+    healthcheck:
+      test:
+        [
+          "CMD",
+          "mysqladmin",
+          "ping",
+          "--host=localhost",
+          "--user=root",
+          "--password=prestashop",
+        ]
+      interval: 10s
+      timeout: 10s
+      retries: 5
+    environment:
+      - MYSQL_HOST=mysql
+      - MYSQL_USER=prestashop
+      - MYSQL_PASSWORD=prestashop
+      - MYSQL_ROOT_PASSWORD=prestashop
+      - MYSQL_PORT=3306
+      - MYSQL_DATABASE=prestashop

php-flavours.json

@@ -4,55 +4,63 @@
     "debian": "7.1-fpm-buster",
     "php_cs_fixer": "v3.3.0",
     "phpstan": "1.4.10",
-    "phpunit": "7.5.20"
+    "phpunit": "7.5.20",
+    "xdebug": "2.9.8"
   },
   "7.2": {
     "alpine": "7.2-fpm-alpine",
     "debian": "7.2-fpm-buster",
     "php_cs_fixer": "v3.4.0",
     "phpstan": "HEAD",
-    "phpunit": "8.5.34"
+    "phpunit": "8.5.34",
+    "xdebug": "3.1.6"
   },
   "7.3": {
     "alpine": "7.3-fpm-alpine",
     "debian": "7.3-fpm-buster",
     "php_cs_fixer": "v3.4.0",
     "phpstan": "HEAD",
-    "phpunit": "9.6.13"
+    "phpunit": "9.6.13",
+    "xdebug": "3.1.6"
   },
   "7.4": {
     "alpine": "7.4-fpm-alpine",
     "debian": "7.4-fpm-buster",
     "php_cs_fixer": "v3.40.0",
     "phpstan": "HEAD",
-    "phpunit": "9.6.13"
+    "phpunit": "9.6.13",
+    "xdebug": "3.1.6"
   },
   "8.0": {
     "alpine": "8.0-fpm-alpine",
     "debian": "8.0-fpm-bullseye",
     "php_cs_fixer": "v3.40.0",
     "phpstan": "HEAD",
-    "phpunit": "9.6.13"
+    "phpunit": "9.6.13",
+    "xdebug": "3.3.1"
   },
   "8.1": {
     "alpine": "8.1-fpm-alpine",
     "debian": "8.1-fpm-bookworm",
     "php_cs_fixer": "v3.40.0",
     "phpstan": "HEAD",
-    "phpunit": "10.4.2"
+    "phpunit": "10.4.2",
+    "xdebug": "3.3.1"
   },
   "8.2": {
     "alpine": "8.2-fpm-alpine",
     "debian": "8.2-fpm-bookworm",
     "php_cs_fixer": "v3.40.0",
     "phpstan": "HEAD",
-    "phpunit": "10.4.2"
+    "phpunit": "10.4.2",
+    "xdebug": "3.3.1"
   },
   "8.3": {
     "alpine": "8.3-fpm-alpine",
     "debian": "8.3-fpm-bookworm",
     "php_cs_fixer": "v3.40.0",
     "phpstan": "HEAD",
-    "phpunit": "10.4.2"
+    "phpunit": "10.4.2",
+    "xdebug": "3.3.1"
   }
 }