Fix console container startup issue

src/_base/CHANGELOG.md

@@ -0,0 +1,13 @@
+# CHANGELOG
+
+## 1.5.0 - 20230126
+
+### Added attributes
+
+* `attribute('console.state.steps')` - Steps necessary to test the health of the console container
+* `attribute('console.healthcheck.enabled')` - Defaults to `true` only for local builds
+* `attribute('console.healthcheck.test')` - The command in array format that will run the healthcheck - Defaults to ['CMD', 'app', 'state']
+* `attribute('console.healthcheck.test.start_period')` - Defaults to 5s
+* `attribute('console.healthcheck.test.interval')` - Defaults to 5s
+* `attribute('console.healthcheck.test.timeout')` - Defaults to 3s
+* `attribute('console.healthcheck.test.retries')` - Defaults to 10

src/_base/_twig/docker-compose.yml/service/console.yml.twig

@@ -7,6 +7,14 @@
     build:
       context: ./
       dockerfile: .my127ws/docker/image/console/Dockerfile
+{% if @('console.healthcheck.enabled') %}
+    healthcheck:
+      test: {{ to_nice_yaml( @('console.healthcheck.test'), 2, 8) | raw }}
+      start_period: {{ @('console.healthcheck.start_period') }}
+      interval: {{ @('console.healthcheck.interval') }}
+      timeout: {{ @('console.healthcheck.timeout') }}
+      retries: {{ @('console.healthcheck.retries') }}
+{% endif %}
 {% if @('app.build') == 'dynamic' %}
     entrypoint: [/entrypoint.dynamic.sh]
     command: [sleep, infinity]

src/_base/docker/image/console/root/entrypoint.sh.twig

@@ -36,10 +36,16 @@ run_steps()
     fi
 }
 
+healthcheck_checkpoint()
+{
+  echo 'Entrypoint tasks completed: console has started' > /run/started
+}
+
 bootstrap()
 {
     setup_app_networking
     run_steps
+    healthcheck_checkpoint
 }
 
 bootstrap

src/_base/docker/image/console/root/lib/task/state.sh.twig

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+function test_ok()
+{
+    # run any command required which result can be monitored by Docker's HEALTHCHECK
+    {% for step in @('console.state.steps') -%}
+    {{ step|raw }}
+    {% else -%}
+    :
+    {% endfor %}
+
+}
+
+function task_state()
+{
+  if ! test_ok; then
+    echo "Console is not ready: test steps failed!"
+    return 1
+  fi
+}

src/_base/harness/attributes/common.yml

@@ -297,6 +297,17 @@ attributes.default:
       steps: []
 
   console:
+    state:
+      steps:
+        - if [[ -f /run/started ]]; then cat /run/started; else return 1; fi
+    healthcheck:
+      # we want that enabled only for local builds
+      enabled: false
+      test: ['CMD', 'app', 'state']
+      start_period: 5s
+      interval: 5s
+      timeout: 3s
+      retries: 10
     entrypoint:
       steps: []
 

src/_base/harness/attributes/environment/local.yml

@@ -3,4 +3,7 @@ attributes:
   app:
     build: dynamic
     mode: development
-    version: develop
+    version: develop
+  console:
+    healthcheck:
+      enabled: true

src/_base/harness/config/confd.yml

@@ -12,6 +12,7 @@ confd('harness:/'):
   - { src: docker/image/console/root/lib/task/install.sh }
   - { src: docker/image/console/root/lib/task/migrate.sh }
   - { src: docker/image/console/root/lib/task/rabbitmq/vhosts.sh }
+  - { src: docker/image/console/root/lib/task/state.sh }
   - { src: docker/image/console/root/lib/task/welcome.sh }
   - { src: docker/image/console/root/usr/local/etc/php/php.ini }
   - { src: docker/image/console/root/usr/local/etc/php/conf.d/docker-php-ext-blackfire.ini }

src/_base/harness/scripts/enable.sh.twig

@@ -85,7 +85,8 @@ dynamic_console()
 
     find .my127ws/docker/image/ -type d ! -perm u+rwx,go+rx,o-w -exec chmod u+rwx,go+rx,o-w {} +
 
-    passthru docker-compose up --build -d console
+    # docker-compose will wait for `console` to be in healty status if healthcheck is enabled
+    passthru docker-compose up --build -d console --wait
     passthru docker-compose exec -T -u build console app build
 
     if [ "$USE_MUTAGEN" = yes ]; then

src/akeneo/harness/config/confd.yml

@@ -12,6 +12,7 @@ confd('harness:/'):
   - { src: docker/image/console/root/lib/task/install.sh }
   - { src: docker/image/console/root/lib/task/migrate.sh }
   - { src: docker/image/console/root/lib/task/rabbitmq/vhosts.sh }
+  - { src: docker/image/console/root/lib/task/state.sh }
   - { src: docker/image/console/root/lib/task/welcome.sh }
   - { src: docker/image/console/root/usr/local/etc/php/php.ini }
   - { src: docker/image/console/root/usr/local/etc/php/conf.d/docker-php-ext-blackfire.ini }

src/magento1/harness/config/confd.yml

@@ -12,6 +12,7 @@ confd('harness:/'):
   - { src: docker/image/console/root/lib/task/install.sh }
   - { src: docker/image/console/root/lib/task/migrate.sh }
   - { src: docker/image/console/root/lib/task/rabbitmq/vhosts.sh }
+  - { src: docker/image/console/root/lib/task/state.sh }
   - { src: docker/image/console/root/lib/task/welcome.sh }
   - { src: docker/image/console/root/usr/local/etc/php/php.ini }
   - { src: docker/image/console/root/usr/local/etc/php/conf.d/docker-php-ext-blackfire.ini }

src/magento2/harness/config/confd.yml

@@ -12,6 +12,7 @@ confd('harness:/'):
   - { src: docker/image/console/root/lib/task/install.sh }
   - { src: docker/image/console/root/lib/task/migrate.sh }
   - { src: docker/image/console/root/lib/task/rabbitmq/vhosts.sh }
+  - { src: docker/image/console/root/lib/task/state.sh }
   - { src: docker/image/console/root/lib/task/welcome.sh }
   - { src: docker/image/console/root/usr/local/etc/php/php.ini }
   - { src: docker/image/console/root/usr/local/etc/php/conf.d/docker-php-ext-blackfire.ini }

src/spryker/_twig/docker-compose.yml/service/console.yml.twig

@@ -7,6 +7,14 @@
     build:
       context: ./
       dockerfile: .my127ws/docker/image/console/Dockerfile
+{% if @('console.healthcheck.enabled') %}
+    healthcheck:
+      test: {{ to_nice_yaml( @('console.healthcheck.test'), 2, 8) | raw }}
+      start_period: {{ @('console.healthcheck.start_period') }}
+      interval: {{ @('console.healthcheck.interval') }}
+      timeout: {{ @('console.healthcheck.timeout') }}
+      retries: {{ @('console.healthcheck.retries') }}
+{% endif %}
 {% if @('app.build') == 'dynamic' %}
     image: {{ @('workspace.name') ~ '-console:dev' }}
     entrypoint: [/entrypoint.dynamic.sh]

src/spryker/harness/attributes/environment/local.yml

@@ -5,3 +5,6 @@ attributes:
     build: dynamic
     mode: development
     version: develop
+  console:
+    healthcheck:
+      enabled: true

src/spryker/harness/config/confd.yml

@@ -12,6 +12,7 @@ confd('harness:/'):
   - { src: docker/image/console/root/lib/task/install.sh }
   - { src: docker/image/console/root/lib/task/migrate.sh }
   - { src: docker/image/console/root/lib/task/rabbitmq/vhosts.sh }
+  - { src: docker/image/console/root/lib/task/state.sh }
   - { src: docker/image/console/root/lib/task/welcome.sh }
   - { src: docker/image/console/root/usr/local/etc/php/php.ini }
   - { src: docker/image/console/root/usr/local/etc/php/conf.d/docker-php-ext-blackfire.ini }

src/symfony/harness/config/confd.yml

@@ -12,6 +12,7 @@ confd('harness:/'):
   - { src: docker/image/console/root/lib/task/install.sh }
   - { src: docker/image/console/root/lib/task/migrate.sh }
   - { src: docker/image/console/root/lib/task/rabbitmq/vhosts.sh }
+  - { src: docker/image/console/root/lib/task/state.sh }
   - { src: docker/image/console/root/lib/task/welcome.sh }
   - { src: docker/image/console/root/usr/local/etc/php/php.ini }
   - { src: docker/image/console/root/usr/local/etc/php/conf.d/docker-php-ext-blackfire.ini }

src/wordpress/harness/config/confd.yml

@@ -12,6 +12,7 @@ confd('harness:/'):
   - { src: docker/image/console/root/lib/task/install.sh }
   - { src: docker/image/console/root/lib/task/migrate.sh }
   - { src: docker/image/console/root/lib/task/rabbitmq/vhosts.sh }
+  - { src: docker/image/console/root/lib/task/state.sh }
   - { src: docker/image/console/root/lib/task/welcome.sh }
   - { src: docker/image/console/root/usr/local/etc/php/php.ini }
   - { src: docker/image/console/root/usr/local/etc/php/conf.d/docker-php-ext-blackfire.ini }