Merge branch 'main' into shay/no_redact

Author: H-Shay

.github/CODEOWNERS

@@ -1,2 +1,8 @@
 # Automatically request reviews from the synapse-core and dendrite-core teams when a pull request comes in.
-* @matrix-org/synapse-core @matrix-org/dendrite-core
+* @matrix-org/synapse-core @matrix-org/dendrite-core
+
+# For modifications to complement internals, also directly request review from Kegan.
+/build/ @matrix-org/synapse-core @matrix-org/dendrite-core @kegsay
+/cmd/ @matrix-org/synapse-core @matrix-org/dendrite-core @kegsay
+/internal/ @matrix-org/synapse-core @matrix-org/dendrite-core @kegsay
+/runtime/ @matrix-org/synapse-core @matrix-org/dendrite-core @kegsay

.github/workflows/ci.yaml

@@ -40,7 +40,7 @@ jobs:
           - homeserver: Synapse
             tags: synapse_blacklist msc3083 msc3787 faster_joins
             env: "COMPLEMENT_SHARE_ENV_PREFIX=PASS_ PASS_SYNAPSE_COMPLEMENT_DATABASE=sqlite"
-            timeout: 12m
+            timeout: 20m
 
           - homeserver: Dendrite
             tags: msc2836 dendrite_blacklist
@@ -66,7 +66,7 @@ jobs:
         # See https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu2004-Readme.md specifically GOROOT_1_17_X64
         run: |
           sudo apt-get update && sudo apt-get install -y libolm3 libolm-dev
-          go get -v github.com/haveyoudebuggedit/gotestfmt/v2/cmd/gotestfmt@latest
+          go get -v github.com/gotesttools/gotestfmt/v2/cmd/gotestfmt@latest
 
       - name: "Checkout corresponding ${{ matrix.homeserver }} branch"
         shell: bash

ENVIRONMENT.md

@@ -0,0 +1,44 @@
+*This file is automatically generated via ./cmd/gendoc*
+
+## Complement Configuration
+Complement is configured exclusively through the use of environment variables. These variables are described below.
+
+#### `COMPLEMENT_ALWAYS_PRINT_SERVER_LOGS`
+If 1, always prints the Homeserver container logs even on success.  
+- Type: `bool`
+- Default: 0
+
+#### `COMPLEMENT_BASE_IMAGE`
+**Required.** The name of the Docker image to use as a base homeserver when generating blueprints. This image must conform to Complement's rules on containers, such as listening on the correct ports.  
+- Type: `string`
+
+#### `COMPLEMENT_BASE_IMAGE_*`
+This allows you to override the base image used for a particular named homeserver. For example, `COMPLEMENT_BASE_IMAGE_HS1=complement-dendrite:latest` would use `complement-dendrite:latest` for the `hs1` homeserver in blueprints, but not any other homeserver (e.g `hs2`). This matching is case-insensitive. This allows Complement to test how different homeserver implementations work with each other.  
+- Type: `map[string]string`
+
+#### `COMPLEMENT_DEBUG`
+If 1, prints out more verbose logging such as HTTP request/response bodies.  
+- Type: `bool`
+- Default: 0
+
+#### `COMPLEMENT_HOSTNAME_RUNNING_COMPLEMENT`
+The hostname of Complement from the perspective of a Homeserver running inside a container. This can be useful for container runtimes using another hostname to access the host from a container, like Podman that uses `host.containers.internal` instead.  
+- Type: `string`
+- Default: host.docker.internal
+
+#### `COMPLEMENT_HOST_MOUNTS`
+A list of semicolon separated host mounts to mount on every container. The structure of the mount is `host-path:container-path:[ro]` for example `/path/on/host:/path/on/container` - you can optionally specify `:ro` to mount the path as readonly. A complete example with multiple mounts would look like `/host/a:/container/a:ro;/host/b:/container/b;/host/c:/container/c`  
+- Type: `[]HostMount`
+
+#### `COMPLEMENT_KEEP_BLUEPRINTS`
+A list of space separated blueprint names to not clean up after running. For example, `one_to_one_room alice` would not delete the homeserver images for the blueprints `alice` and `one_to_one_room`. This can speed up homeserver runs if you frequently run the same base image over and over again. If the base image changes, this should not be set as it means an older version of the base image will be used for the named blueprints.  
+- Type: `[]string`
+
+#### `COMPLEMENT_SHARE_ENV_PREFIX`
+If set, all environment variables on the host with this prefix will be shared with every homeserver, with the prefix removed. For example, if the prefix was `FOO_` then setting `FOO_BAR=baz` on the host would translate to `BAR=baz` on the container. Useful for passing through extra Homeserver configuration options without sharing all host environment variables.  
+- Type: `string`
+
+#### `COMPLEMENT_SPAWN_HS_TIMEOUT_SECS`
+The number of seconds to wait for a Homeserver container to be responsive after starting the container. Responsiveness is detected by `HEALTHCHECK` being healthy *and* the `/versions` endpoint returning 200 OK.  
+- Type: `Duration`
+- Default: 30