Merge pull request #1710 from matthiasn/test/toxiproxy_docker

test: use toxiproxy and dendrite cli in docker

Author: matthiasn

.gitignore

@@ -79,5 +79,5 @@ whisper.cpp/whisper.cpp-*/
 # FVM Version Cache
 .fvm/
 
-integration_test/dendrite/config/jetstream/
-integration_test/dendrite/config/logs/
+integration_test/docker/config/jetstream/
+integration_test/docker/config/logs/

integration_test/README.md

@@ -1,19 +1,23 @@
 # Integration test for Matrix sync
 
-Clone [dendrite](https://github.com/matrix-org/dendrite) into a sibling directory,
-e.g. `~/github/dendrite`. Build it, we need the executable in order to create users for the test.
+For the Matrix integration tests, there's a [Docker Compose](https://docs.docker.com/compose/) setup
+that starts the following services:
 
-Run dendrite in a separate shell:
+- [dendrite](https://github.com/matrix-org/dendrite): the Matrix homeserver we use in the test
+- [postgres](https://hub.docker.com/_/postgres/): a PostgreSQL server used by dendrite
+- [toxiproxy](https://github.com/Shopify/toxiproxy): a TCP proxy for simulating bad networks
+
+Run the docker containers in a separate shell:
 
 ```shell
-    $ cd integration_test/dendrite/
+    $ cd docker
     $ docker-compose up
 ```
 
 Run the test script:
 
 ````shell
-    $ ./integration_test/run_matrix_tests.sh
+    $ ./run_matrix_tests.sh
 ````
 
 The test script will create two users and then run a Flutter integration test that instantiates two
@@ -23,22 +27,19 @@ successfully. Also see [PR #1695](https://github.com/matthiasn/lotti/pull/1695)
 
 ## Testing with simulated bad network
 
-Install [toxiproxy](https://github.com/Shopify/toxiproxy) and run server:
-
-````shell
-    $ toxiproxy-server
-````
-
-In separate shell:
+Set up the toxiproxy server running in the docker compose environment:
 
 ````shell
-    $ toxiproxy-cli create -l localhost:18008 -u localhost:8008 dendrite-proxy
-    $ toxiproxy-cli toxic add -t latency -a latency=1000 dendrite-proxy
-    $ toxiproxy-cli toxic add -t bandwidth -a rate=100 dendrite-proxy
+    $ ./setup_toxiproxy_docker.sh
 ````
 
 Run the test script against `toxiproxy`;
 
 ````shell
-    $ SLOW_NETWORK=true ./integration_test/run_matrix_tests.sh
+    $ SLOW_NETWORK=true ./run_matrix_tests.sh
 ````
+
+With the simulated bad network (with added 1000 ms latency and throttled to 100 KB/s), the tests 
+should still complete successfully, it'll just take a bit longer. For example on an M1 Max, it
+typically takes around 1m 25s with the bad network simulation, and around 50s with non-degraded
+network.

integration_test/dendrite/config/dendrite.yaml integration_test/docker/config/dendrite.yaml

@@ -1,5 +1,3 @@
-version: "3.4"
-
 services:
   postgres:
     hostname: postgres
@@ -21,8 +19,8 @@ services:
     networks:
       - internal
 
-  monolith:
-    hostname: monolith
+  dendrite:
+    hostname: dendrite
     image: matrixdotorg/dendrite-monolith:latest
     command: -really-enable-open-registration
     ports:
@@ -42,6 +40,17 @@ services:
       - internal
     restart: unless-stopped
 
+  toxiproxy:
+    hostname: toxiproxy
+    image: ghcr.io/shopify/toxiproxy:2.9.0
+    depends_on:
+      - dendrite
+    ports:
+      - 18008:18008
+      - 8474:8474
+    networks:
+      - internal
+
 networks:
   internal:
     attachable: true

integration_test/dendrite/config/matrix_key.pem integration_test/docker/config/matrix_key.pem

@@ -49,7 +49,7 @@ void main() {
             : 'http://localhost:8008';
     const testPassword = bool.hasEnvironment(testPasswordEnv)
         ? String.fromEnvironment(testPasswordEnv)
-        : '?Secret123@!';
+        : '?Secret123@';
 
     const config1 = MatrixConfig(
       homeServer: testHomeServer,

integration_test/dendrite/config/server.crt integration_test/docker/config/server.crt

@@ -1,21 +1,22 @@
 #!/bin/bash
+# Go to directory of script
+cd "$(dirname "$0")" || exit
 
 # Create user name
 uuid1=$(uuidgen)
 uuid2=$(uuidgen)
 TEST_USER1="$(tr '[:upper:]' '[:lower:]' <<< "$uuid1")"
 TEST_USER2="$(tr '[:upper:]' '[:lower:]' <<< "$uuid2")"
 
-# Go to dendrite docker directory that contains config and keys
-cd ../dendrite/build/docker/config || exit
-
-# Create user using the create-account binary in dendrite build
-../../../bin/create-account -config dendrite.yaml -username "$TEST_USER1" -admin -password "?Secret123@!"
-../../../bin/create-account -config dendrite.yaml -username "$TEST_USER2" -admin -password "?Secret123@!"
+cd docker || exit
+docker compose exec dendrite create-account -config dendrite.yaml -username "$TEST_USER1" -admin -password "?Secret123@"
+docker compose exec dendrite create-account -config dendrite.yaml -username "$TEST_USER2" -admin -password "?Secret123@"
 cd - > /dev/null || exit
+cd ..
 
 fvm flutter test integration_test/matrix_service_test.dart \
 --dart-define=TEST_USER1="@$TEST_USER1:localhost" \
 --dart-define=TEST_USER2="@$TEST_USER2:localhost" \
 --dart-define=SLOW_NETWORK="$SLOW_NETWORK"
 
+cd - || exit

integration_test/dendrite/config/server.key integration_test/docker/config/server.key

@@ -0,0 +1,9 @@
+#!/bin/bash
+# Go to directory of script
+cd "$(dirname "$0")" || exit
+
+cd docker || exit
+docker compose exec toxiproxy /toxiproxy-cli create -l toxiproxy:18008 -u dendrite:8008 dendrite-proxy
+docker compose exec toxiproxy /toxiproxy-cli toxic add -t latency -a latency=1000 dendrite-proxy
+docker compose exec toxiproxy /toxiproxy-cli toxic add -t bandwidth -a rate=100 dendrite-proxy
+cd ..

integration_test/dendrite/docker-compose.yml integration_test/docker/docker-compose.yml

@@ -1088,10 +1088,10 @@ packages:
     dependency: "direct dev"
     description:
       name: freezed
-      sha256: "57247f692f35f068cae297549a46a9a097100685c6780fe67177503eea5ed4e5"
+      sha256: "24f77b50776d4285cc4b3a1665bb79852714c09b878363efbe64788c179c4284"
       url: "https://pub.dev"
     source: hosted
-    version: "2.4.7"
+    version: "2.5.0"
   freezed_annotation:
     dependency: "direct main"
     description:
@@ -1149,10 +1149,10 @@ packages:
     dependency: "direct main"
     description:
       name: google_fonts
-      sha256: b1ac0fe2832c9cc95e5e88b57d627c5e68c223b9657f4b96e1487aa9098c7b82
+      sha256: "5b1726fee554d1cc9db1baef8061b126567ff0a1140a03ed7de936e62f2ab98b"
       url: "https://pub.dev"
     source: hosted
-    version: "6.2.1"
+    version: "6.2.0"
   graphs:
     dependency: transitive
     description:
@@ -1651,10 +1651,10 @@ packages:
     dependency: "direct main"
     description:
       name: meta
-      sha256: "7687075e408b093f36e6bbf6c91878cc0d4cd10f409506f7bc996f68220b9136"
+      sha256: "25dfcaf170a0190f47ca6355bdd4552cb8924b430512ff0cafb8db9bd41fe33b"
       url: "https://pub.dev"
     source: hosted
-    version: "1.12.0"
+    version: "1.14.0"
   mgrs_dart:
     dependency: transitive
     description:
@@ -1955,10 +1955,10 @@ packages:
     dependency: transitive
     description:
       name: pointycastle
-      sha256: "43ac87de6e10afabc85c445745a7b799e04de84cebaa4fd7bf55a5e1e9604d29"
+      sha256: "70fe966348fe08c34bf929582f1d8247d9d9408130723206472b4687227e4333"
       url: "https://pub.dev"
     source: hosted
-    version: "3.7.4"
+    version: "3.8.0"
   polylabel:
     dependency: transitive
     description:
@@ -2728,10 +2728,10 @@ packages:
     dependency: transitive
     description:
       name: video_player
-      sha256: "822e68b62403bebea846b012988ee1e77262e7b786345594a444c59338096ddf"
+      sha256: efa2e24042166906ddf836dd131258d0371d0009cdf0476f6a83fd992a17f5d0
       url: "https://pub.dev"
     source: hosted
-    version: "2.8.4"
+    version: "2.8.5"
   video_player_android:
     dependency: transitive
     description:
@@ -2918,4 +2918,4 @@ packages:
     version: "3.1.2"
 sdks:
   dart: ">=3.3.0 <4.0.0"
-  flutter: ">=3.19.2"
+  flutter: ">=3.19.0"

integration_test/matrix_service_test.dart

@@ -1,7 +1,7 @@
 name: lotti
 description: Achieve your goals and keep your data private with Lotti.
 publish_to: 'none'
-version: 0.9.445+2432
+version: 0.9.445+2433
 
 msix_config:
   display_name: LottiApp