Share the common configurations among different modules

This change is used to generalize a template docker-compose file for all
modules. Ideally, the leaf module only need to keep a docker compose
file for all platforms (docker-compose.yml).

NOTE:
The version of docker-compose file downgrades from 3.4 to 2.1 because
the 'extends' keyword is not supported in Compose version 3.x.

Change-Id: I2e36fd9236eda86cb5fcf940d787ccefe9200696
Reviewed-by: Maurice Kalinowski <maurice.kalinowski@qt.io>
 
 
 
 
 
 

3 files changed, 53 insertions, 3 deletions

diff --git a/mkspecs/features/data/testserver/Dockerfile b/mkspecs/features/data/testserver/Dockerfile
index 8fb664a1d2..a20d289d3f 100644
--- a/mkspecs/features/data/testserver/Dockerfile
+++ b/mkspecs/features/data/testserver/Dockerfile
@@ -21,7 +21,9 @@ RUN echo "#!/usr/bin/env bash\n" \
 RUN chmod +x startup.sh
 
 # rewrite the default configurations of avahi-daemon
+# Disable IPv6 of avahi-daemon to resolve the unstable connections on Windows
 ARG test_domain
 RUN sed -i -e "s,#domain-name=local,domain-name=${test_domain:-test-net.qt.local}," \
         -e "s,#publish-aaaa-on-ipv4=yes,publish-aaaa-on-ipv4=no," \
+        -e "s,use-ipv6=yes,use-ipv6=no," \
         /etc/avahi/avahi-daemon.conf
diff --git a/mkspecs/features/data/testserver/docker-compose-common.yml b/mkspecs/features/data/testserver/docker-compose-common.yml
new file mode 100644
index 0000000000..58282c1273
--- /dev/null
+++ b/mkspecs/features/data/testserver/docker-compose-common.yml
@@ -0,0 +1,38 @@
+version: '2.1'
+
+# This is a template docker-compose file shared with all modules. It is based
+# on 'extending services' feature of compose file version 2.1.
+# See https://docs.docker.com/compose/extends/#extending-services for details.
+#
+# Example: testserver/docker-compose.yml
+# services:
+#     foo:
+#         extends:
+#             file: ${SHARED_DATA}/docker-compose-common.yml
+#             service: ${SHARED_SERVICE}
+#         container_name: qt-test-server-foo
+#         hostname: ${HOST_NAME:-foo}
+#         build:
+#             context: .
+#             args:
+#                 provisioningImage: qt-test-server-foo:537fe302f61851d1663...
+#                 serviceDir: ./foo
+#         command: service/foo.sh
+
+x-services:
+    &default-service
+    domainname: ${TEST_DOMAIN}
+    build:
+        context: .
+        dockerfile: ${SHARED_DATA}/Dockerfile
+        args:
+            test_domain: ${TEST_DOMAIN}
+    entrypoint: ./startup.sh
+
+services:
+    bridge-network: *default-service
+    host-network:
+        << : *default-service
+        network_mode: "host"
+        extra_hosts:
+            - "qt-test-server.${TEST_DOMAIN}:${MACHINE_IP}"
diff --git a/mkspecs/features/unsupported/testserver.prf b/mkspecs/features/unsupported/testserver.prf
index 6507a360c5..32bd4df30c 100644
--- a/mkspecs/features/unsupported/testserver.prf
+++ b/mkspecs/features/unsupported/testserver.prf
@@ -94,29 +94,33 @@ isEmpty(TESTSERVER_VERSION) {
         # binds the same port on the host. An alternative solution is to deploy
         # the docker environment into VirtualBox using docker-machine.
         isEmpty(TESTSERVER_COMPOSE_FILE): TESTSERVER_COMPOSE_FILE = \
-            $$dirname(_QMAKE_CONF_)/tests/testserver/docker-compose-for-macOS.yml
+            $$dirname(_QMAKE_CONF_)/tests/testserver/docker-compose-host-network.yml
 
         # The connection configuration for the target machine
         MACHINE_CONFIG = $(shell docker-machine config qt-test-server)
 
         # The environment variables passed to the docker-compose file
         TEST_ENV = 'MACHINE_IP=$(shell docker-machine ip qt-test-server)'
+        TEST_ENV += 'HOST_NAME=qt-test-server'
         TEST_ENV += 'TEST_DOMAIN=$$DNSDOMAIN'
         TEST_ENV += 'SHARED_DATA=$$PWD/../data/testserver'
+        TEST_ENV += 'SHARED_SERVICE=host-network'
         TEST_CMD = env
     } else:equals(QMAKE_HOST.os, Windows) {
         # There is no docker bridge on Windows. It is impossible to ping a container.
         # Use docker-machine to deploy the docker environment into VirtualBox.
         isEmpty(TESTSERVER_COMPOSE_FILE): TESTSERVER_COMPOSE_FILE = \
-            $$dirname(_QMAKE_CONF_)/tests/testserver/docker-compose-for-windows.yml
+            $$dirname(_QMAKE_CONF_)/tests/testserver/docker-compose-host-network.yml
 
         # The connection configuration for the target machine
         MACHINE_CONFIG = (docker-machine config qt-test-server)
 
         # The environment variables passed to the docker-compose file
         TEST_ENV = '\$\$env:MACHINE_IP = docker-machine ip qt-test-server;'
+        TEST_ENV += '\$\$env:HOST_NAME = $$shell_quote(\"qt-test-server\");'
         TEST_ENV += '\$\$env:TEST_DOMAIN = $$shell_quote(\"$$DNSDOMAIN\");'
         TEST_ENV += '\$\$env:SHARED_DATA = $$shell_quote(\"$$PWD/../data/testserver\");'
+        TEST_ENV += '\$\$env:SHARED_SERVICE = $$shell_quote(\"host-network\");'
 
         # Docker-compose CLI environment variables:
         # Enable path conversion from Windows-style to Unix-style in volume definitions.
@@ -126,12 +130,18 @@ isEmpty(TESTSERVER_VERSION) {
         CONFIG += PowerShell
     } else {
         isEmpty(TESTSERVER_COMPOSE_FILE): TESTSERVER_COMPOSE_FILE = \
-            $$dirname(_QMAKE_CONF_)/tests/testserver/docker-compose.yml
+            $$dirname(_QMAKE_CONF_)/tests/testserver/docker-compose-bridge-network.yml
         # The environment variables passed to the docker-compose file
         TEST_ENV = 'TEST_DOMAIN=$$DNSDOMAIN'
         TEST_ENV += 'SHARED_DATA=$$PWD/../data/testserver'
+        TEST_ENV += 'SHARED_SERVICE=bridge-network'
         TEST_CMD = env
     }
+
+    # If $$TESTSERVER_COMPOSE_FILE defined by platform doesn't exist, the default
+    # docker-compose.yml is used as a fallback.
+    !exists($$TESTSERVER_COMPOSE_FILE): TESTSERVER_COMPOSE_FILE = \
+        $$dirname(_QMAKE_CONF_)/tests/testserver/docker-compose.yml
     !exists($$TESTSERVER_COMPOSE_FILE): error("Invalid TESTSERVER_COMPOSE_FILE specified")