Add a login test against Synapse to Playwright (#11913)

* Install playwright Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Add foundations for writing tests under Playwright Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * .gitignore juggling Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Add tsconfig and fix eslint rules Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Add docker & synapse plugins Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Add login.spec.ts Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Wire up fixture which sets up ElementAppPage & bakes config.json Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Remove launch test, it has served its purpose Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Remove test which has been ported to Playwright Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Fix test not cleaning up after itself Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Move registerUser to the Homeserver interface Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Remove unused fixture param Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Remove redundant launch test Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Add newline --------- Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> Co-authored-by: R Midhun Suresh <hi@midhun.dev>
2023-11-22 11:49:51 +00:00
parent ecc46aeb8c
commit 52e3e0de1f
26 changed files with 1138 additions and 89 deletions
@@ -0,0 +1,64 @@
+/*
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { test as base } from "@playwright/test";
+
+import { HomeserverInstance, StartHomeserverOpts } from "./plugins/utils/homeserver";
+import { Synapse } from "./plugins/synapse";
+
+const CONFIG_JSON = {
+    // This is deliberately quite a minimal config.json, so that we can test that the default settings
+    // actually work.
+    //
+    // The only thing that we really *need* (otherwise Element refuses to load) is a default homeserver.
+    // We point that to a guaranteed-invalid domain.
+    default_server_config: {
+        "m.homeserver": {
+            base_url: "https://server.invalid",
+        },
+    },
+
+    // the location tests want a map style url.
+    map_style_url: "https://api.maptiler.com/maps/streets/style.json?key=fU3vlMsMn4Jb6dnEIFsx",
+};
+
+export const test = base.extend<{
+    startHomeserverOpts: StartHomeserverOpts | string;
+    homeserver: HomeserverInstance;
+}>({
+    page: async ({ context, page }, use) => {
+        await context.route(`http://localhost:8080/config.json*`, async (route) => {
+            await route.fulfill({ json: CONFIG_JSON });
+        });
+
+        await use(page);
+    },
+
+    startHomeserverOpts: "default",
+    homeserver: async ({ request, startHomeserverOpts: opts }, use) => {
+        if (typeof opts === "string") {
+            opts = { template: opts };
+        }
+
+        const server = new Synapse(request);
+        await use(await server.start(opts));
+        await server.stop();
+    },
+});
+
+test.use({});
+
+export { expect } from "@playwright/test";