chore(docker): improve image adding DB_CREATE and DB_UPGRADE options (refs #52)

Author: mborne

.docker/Dockerfile

@@ -1,67 +1,56 @@
-FROM php:8.1-apache
+#----------------------------------------------------------------------
+# Download vendor from composer.json in dedicated layer
+#----------------------------------------------------------------------
+FROM composer:2.3 as vendor
 
-#ENV COMPOSER_ALLOW_SUPERUSER=1
-RUN rm /etc/apt/preferences.d/no-debian-php
+RUN mkdir -p /opt/validator-api
+WORKDIR /opt/validator-api
+COPY composer.json .
+RUN composer install --no-scripts --prefer-dist
 
 #----------------------------------------------------------------------
-# Env vars for validator-api
+# Create base layer for dev and production
 #----------------------------------------------------------------------
-ENV APP_ENV=prod
-ENV VALIDATOR_PATH=/opt/ign-validator/validator-cli.jar
-
-ENV POSTGRES_USER=validator
-ENV POSTGRES_PASSWORD=validator
+FROM php:8.2-apache as base
 
-RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y locales
+ENV DEBIAN_FRONTEND=noninteractive
+ENV LANG fr_FR.UTF-8
+ENV VALIDATOR_PATH=/opt/ign-validator/validator-cli.jar
 
 #----------------------------------------------------------------------
 # Configure locale to fr_FR.UTF-8
 # see also https://stackoverflow.com/a/41797247
 #----------------------------------------------------------------------
-RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y locales \
+RUN apt-get update && apt-get install -y locales \
  && sed -i -e 's/# en_US.UTF-8 UTF-8/fr_FR.UTF-8 UTF-8/' /etc/locale.gen \
- && dpkg-reconfigure --frontend=noninteractive locales \
+ && dpkg-reconfigure locales \
  && update-locale LANG=fr_FR.UTF-8 \
- && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
-
-ENV LANG fr_FR.UTF-8
+ && rm -rf /var/lib/apt/lists/*
 
 #----------------------------------------------------------------------
 # Install common tools
 #----------------------------------------------------------------------
-RUN apt-get update -qq \
-  && apt-get install -y lsb-release gnupg2 wget curl vim git \
-  && echo "deb https://packages.sury.org/php/ $(lsb_release -cs) main" > /etc/apt/sources.list.d/php.list \
-  && curl -sS https://packages.sury.org/php/apt.gpg | apt-key add - \
-  && apt-get update -qq \
-  && apt-get install -qy \
+RUN apt-get update \
+  && apt-get install -y \
     unzip \
     make \
-    php-dev \
+    curl wget \
     zip \
- && curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer \
- && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+ && rm -rf /var/lib/apt/lists/*
 
 #----------------------------------------------------------------------
-# Configure PHP and pecl
+# Configure PHP
 #----------------------------------------------------------------------
 COPY .docker/php.ini /usr/local/etc/php/conf.d/app.ini
-RUN pear config-set php_ini /usr/local/etc/php/conf.d/app.ini
-RUN if [ "${http_proxy}" != "" ]; then \
-    pear config-set http_proxy ${http_proxy} \
-    ;fi
 
 #----------------------------------------------------------------------
 # Install PHP extensions
 #----------------------------------------------------------------------
 RUN apt-get update -qq \
  && apt-get install -y postgresql-client libpq-dev libzip-dev \
  && docker-php-ext-configure pgsql -with-pgsql=/usr/local/pgsql \
- && docker-php-ext-install pdo pdo_pgsql pgsql zip \
- && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
-
-RUN pecl install xdebug \
-    && docker-php-ext-enable xdebug
+ && docker-php-ext-install opcache pdo pdo_pgsql pgsql zip \
+ && rm -rf /var/lib/apt/lists/*
 
 #----------------------------------------------------------------------
 # Configure apache
@@ -78,40 +67,61 @@ RUN a2enmod rewrite remoteip
 RUN apt-get update -qq \
  # see https://github.com/debuerreotype/docker-debian-artifacts/issues/24
  && mkdir -p /usr/share/man/man1 \
- && apt-get install -y openjdk-11-jdk-headless gdal-bin \
+ && apt-get install -y openjdk-17-jdk-headless gdal-bin \
  && java -version \
  && ogrinfo --version \
- && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+ && rm -rf /var/lib/apt/lists/*
 
 #----------------------------------------------------------------------
 # Setup /opt/ign-validator/validator-cli.jar
 #----------------------------------------------------------------------
 ARG validator_version=4.4.0
-RUN apt-get update -qq \
- && wget --quiet -O /tmp/validator-cli.deb https://github.com/IGNF/validator/releases/download/v${validator_version}/ign-validator_${validator_version}_all.deb \
- && dpkg -i /tmp/validator-cli.deb \
- && rm -f /tmp/validator-cli.deb \
- && echo "validator-cli.jar version : $(java -jar /opt/ign-validator/validator-cli.jar version)" \
- && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+RUN mkdir -p /opt/ign-validator \
+ && wget --quiet -O ${VALIDATOR_PATH} https://github.com/IGNF/validator/releases/download/v${validator_version}/validator-cli.jar \
+ && echo "validator-cli.jar version : $(java -jar /opt/ign-validator/validator-cli.jar version)"
 
 #----------------------------------------------------------------------
 # Install validator-api
 #----------------------------------------------------------------------
-COPY --chown=www-data:www-data . /opt/validator-api
+COPY . /opt/validator-api
 WORKDIR /opt/validator-api
-USER www-data
-RUN composer install
+COPY --from=vendor /opt/validator-api/vendor vendor
 
 #----------------------------------------------------------------------
 # Prepare data storage
 # (Note that /opt/validator-api/var/data is shared between containers)
 #----------------------------------------------------------------------
-RUN mkdir -p /opt/validator-api/var/data/validations
+RUN mkdir -p /opt/validator-api/var/data/validations \
+ && chown -R www-data:www-data /opt/validator-api/var
+
+# ensure ogr2ogr can write in $HOME/.gdal ...
+ENV HOME=/opt/validator-api/var
+
 VOLUME /opt/validator-api/var/data
 
+USER www-data
 
-#----------------------------------------------------------------------
-# Replace default command
-#----------------------------------------------------------------------
 EXPOSE 8000
 CMD ["/opt/validator-api/.docker/application.sh"]
+
+#----------------------------------------------------------------------
+# DEV image with xdebug
+#----------------------------------------------------------------------
+FROM base as dev
+
+ENV APP_ENV=dev
+
+USER root
+# install xdebug extension for php
+RUN pear config-set http_proxy ${http_proxy} \
+ && pear config-set php_ini $PHP_INI_DIR/php.ini \
+ && pecl install xdebug \
+ && docker-php-ext-enable xdebug
+USER www-data
+
+#----------------------------------------------------------------------
+# Production image without xdebug
+#----------------------------------------------------------------------
+FROM base as prod
+
+ENV APP_ENV=prod

.docker/application.sh

@@ -1,14 +1,30 @@
 #!/bin/bash
 set -e
 
+#---------------------------------------------------------------------------
+# env vars specific to .docker/application.sh
+#---------------------------------------------------------------------------
+
+# allows to enable / disable automatic database creation (doctrine:database:create)
+DB_CREATE=${DB_CREATE:-0}
+# allows to enable / disable automatic schema upgrade (doctrine:schema:update)
+DB_UPGRADE=${DB_UPGRADE:-1}
+
+# run (apache2) / backend / test 
 ACTION=${1:-run}
 
 run(){
     #---------------------------------------------------------------------------
     # Ensure that database is created and schema is up to date.
     #---------------------------------------------------------------------------
-    bin/console doctrine:database:create --if-not-exists
-    bin/console doctrine:schema:update --force
+    if [ "$DB_CREATE" = "1" ];
+    then
+        bin/console doctrine:database:create --if-not-exists
+    fi
+    if [ "$DB_UPGRADE" = "1" ];
+    then
+        bin/console doctrine:schema:update --force --complete
+    fi
 
     #---------------------------------------------------------------------------
     # start apache as www-data
@@ -24,7 +40,7 @@ test(){
     export APP_ENV=test
     export DATABASE_URL="postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@database:5432/validator_api_test?serverVersion=13&charset=utf8"
     bin/console --env=test doctrine:database:create --if-not-exists
-    bin/console --env=test doctrine:schema:update --force
+    bin/console --env=test doctrine:schema:update --complete --force
     XDEBUG_MODE=coverage vendor/bin/phpunit
 }
 

docker-compose.yml

@@ -4,18 +4,24 @@ services:
 
   # validator-api service
   api:
-    image: ignf/validator-api:latest
+    image: ignf/validator-api:master-dev
     build:
       context: .
       dockerfile: .docker/Dockerfile
+      target: dev
       args:
         - http_proxy
         - https_proxy
     environment:
       - HTTP_PROXY=${HTTP_PROXY}
       - HTTPS_PROXY=${HTTPS_PROXY}
+      # important for ogr2ogr...
+      - http_proxy=${HTTP_PROXY}
+      - https_proxy=${HTTPS_PROXY}
       - APP_ENV=${APP_ENV}
-      - POSTGRES_USER=${POSTGRES_USER}
+      - DB_CREATE=1
+      - DB_UPGRADE=1
+      - POSTGRES_USER=validator
       - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
       - DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@database:5432/validator_api?serverVersion=13&charset=utf8
     networks:
@@ -52,12 +58,15 @@ services:
   #-----------------------------------------------------------------------
   # Process validations
   #-----------------------------------------------------------------------
-  orchestrator:
-    image: ignf/validator-api:latest
+  backend:
+    image: ignf/validator-api:master-dev
     command: .docker/application.sh backend
     environment:
       - HTTP_PROXY=${HTTP_PROXY}
       - HTTPS_PROXY=${HTTPS_PROXY}
+      # important for ogr2ogr...
+      - http_proxy=${HTTP_PROXY}
+      - https_proxy=${HTTPS_PROXY}
       - APP_ENV=${APP_ENV}
       - POSTGRES_USER=${POSTGRES_USER}
       - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}