Merge the Complement testing Docker images into a single, multi-purpose image.

changelog.d/12881.misc

@@ -0,0 +1 @@
+Merge the Complement testing Docker images into a single, multi-purpose image.

docker/Dockerfile-workers

@@ -26,6 +26,11 @@ COPY ./docker/prefix-log /usr/local/bin/
 # Expose nginx listener port
 EXPOSE 8080/tcp
 
+# Default to starting Redis.
+# (This environment variable is only used in the Complement image to disable
+# Redis when workers aren't being used)
+ENV START_REDIS=true
+
 # A script to read environment variables and create the necessary
 # files to run the desired worker configuration. Will start supervisord.
 COPY ./docker/configure_workers_and_start.py /configure_workers_and_start.py

docker/complement/Dockerfile

@@ -1,22 +1,48 @@
-# A dockerfile which builds an image suitable for testing Synapse under
-# complement.
+# This dockerfile builds on top of 'docker/Dockerfile-worker' in matrix-org/synapse
+# by including a built-in postgres instance, as well as setting up the homeserver so
+# that it is ready for testing via Complement.
+#
+# Instructions for building this image from those it depends on is detailed in this guide:
+# https://github.com/matrix-org/synapse/blob/develop/docker/README-testing.md#testing-with-postgresql-and-single-or-multi-process-synapse
+FROM matrixdotorg/synapse-workers
+
+# Install postgresql
+RUN apt-get update && \
+  DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends -y postgresql-13
+
+# Configure a user and create a database for Synapse
+RUN pg_ctlcluster 13 main start &&  su postgres -c "echo \
+ \"ALTER USER postgres PASSWORD 'somesecret'; \
+ CREATE DATABASE synapse \
+  ENCODING 'UTF8' \
+  LC_COLLATE='C' \
+  LC_CTYPE='C' \
+  template=template0;\" | psql" && pg_ctlcluster 13 main stop
+
+# Modify the shared homeserver config with postgres support, certificate setup
+# and the disabling of rate-limiting
+COPY conf/workers-shared.yaml /conf/workers/shared.yaml
 
-ARG SYNAPSE_VERSION=latest
-
-FROM matrixdotorg/synapse:${SYNAPSE_VERSION}
-
-ENV SERVER_NAME=localhost
-
-COPY conf/* /conf/
+WORKDIR /data
 
-# generate a signing key
-RUN generate_signing_key -o /conf/server.signing.key
+COPY conf/postgres.supervisord.conf /etc/supervisor/conf.d/postgres.conf
 
-WORKDIR /data
+# Copy the entrypoint
+COPY conf/start-complement-synapse-workers.sh /
 
+# Expose nginx's listener ports
 EXPOSE 8008 8448
 
-ENTRYPOINT ["/conf/start.sh"]
+ENTRYPOINT ["/start-complement-synapse-workers.sh"]
 
+# Update the healthcheck to have a shorter check interval
 HEALTHCHECK --start-period=5s --interval=1s --timeout=1s \
-    CMD curl -fSs http://localhost:8008/health || exit 1
+    CMD /bin/sh /healthcheck.sh
+
+# TODO Ideally we should be able to pass env vars straight in via Complement
+# but for now we burn them in to the image.
+# See https://github.com/matrix-org/complement/issues/6.
+ARG use_workers=true
+ENV SYNAPSE_COMPLEMENT_USE_WORKERS $use_workers
+ARG database=postgres
+ENV SYNAPSE_COMPLEMENT_DATABASE $database

docker/complement/conf-workers/postgres.supervisord.conf → docker/complement/conf/postgres.supervisord.conf

@@ -1,6 +1,9 @@
 [program:postgres]
 command=/usr/local/bin/prefix-log /usr/bin/pg_ctlcluster 13 main start --foreground
 
+# Only start if START_POSTGRES=1
+autostart=%(ENV_START_POSTGRES)s
+
 # Lower priority number = starts first
 priority=1