Create more cypress tests and utilities (#8494)

cypress/support/index.ts

@@ -17,3 +17,4 @@ limitations under the License.
 /// <reference types="cypress" />
 
 import "./synapse";
+import "./login";

cypress/support/login.ts

@@ -0,0 +1,86 @@
+/*
+Copyright 2022 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.
+*/
+
+/// <reference types="cypress" />
+
+import Chainable = Cypress.Chainable;
+import { SynapseInstance } from "../plugins/synapsedocker";
+
+export interface UserCredentials {
+    accessToken: string;
+    userId: string;
+    deviceId: string;
+    password: string;
+    homeServer: string;
+}
+
+declare global {
+    // eslint-disable-next-line @typescript-eslint/no-namespace
+    namespace Cypress {
+        interface Chainable {
+            /**
+             * Generates a test user and instantiates an Element session with that user.
+             * @param synapse the synapse returned by startSynapse
+             * @param displayName the displayName to give the test user
+             */
+            initTestUser(synapse: SynapseInstance, displayName: string): Chainable<UserCredentials>;
+        }
+    }
+}
+
+Cypress.Commands.add("initTestUser", (synapse: SynapseInstance, displayName: string): Chainable<UserCredentials> => {
+    const username = Cypress._.uniqueId("userId_");
+    const password = Cypress._.uniqueId("password_");
+    return cy.registerUser(synapse, username, password, displayName).then(() => {
+        const url = `${synapse.baseUrl}/_matrix/client/r0/login`;
+        return cy.request<{
+            access_token: string;
+            user_id: string;
+            device_id: string;
+            home_server: string;
+        }>({
+            url,
+            method: "POST",
+            body: {
+                "type": "m.login.password",
+                "identifier": {
+                    "type": "m.id.user",
+                    "user": username,
+                },
+                "password": password,
+            },
+        });
+    }).then(response => {
+        return cy.window().then(win => {
+            // Seed the localStorage with the required credentials
+            win.localStorage.setItem("mx_hs_url", synapse.baseUrl);
+            win.localStorage.setItem("mx_user_id", response.body.user_id);
+            win.localStorage.setItem("mx_access_token", response.body.access_token);
+            win.localStorage.setItem("mx_device_id", response.body.device_id);
+            win.localStorage.setItem("mx_is_guest", "false");
+            win.localStorage.setItem("mx_has_pickle_key", "false");
+            win.localStorage.setItem("mx_has_access_token", "true");
+
+            return cy.visit("/").then(() => ({
+                password,
+                accessToken: response.body.access_token,
+                userId: response.body.user_id,
+                deviceId: response.body.device_id,
+                homeServer: response.body.home_server,
+            }));
+        });
+    });
+});

cypress/support/synapse.ts

@@ -16,6 +16,8 @@ limitations under the License.
 
 /// <reference types="cypress" />
 
+import * as crypto from 'crypto';
+
 import Chainable = Cypress.Chainable;
 import AUTWindow = Cypress.AUTWindow;
 import { SynapseInstance } from "../plugins/synapsedocker";
@@ -29,12 +31,27 @@ declare global {
              * @param template path to template within cypress/plugins/synapsedocker/template/ directory.
              */
             startSynapse(template: string): Chainable<SynapseInstance>;
+
             /**
              * Custom command wrapping task:synapseStop whilst preventing uncaught exceptions
              * for if Synapse stopping races with the app's background sync loop.
              * @param synapse the synapse instance returned by startSynapse
              */
             stopSynapse(synapse: SynapseInstance): Chainable<AUTWindow>;
+
+            /**
+             * Register a user on the given Synapse using the shared registration secret.
+             * @param synapse the synapse instance returned by startSynapse
+             * @param username the username of the user to register
+             * @param password the password of the user to register
+             * @param displayName optional display name to set on the newly registered user
+             */
+            registerUser(
+                synapse: SynapseInstance,
+                username: string,
+                password: string,
+                displayName?: string,
+            ): Chainable<Credentials>;
         }
     }
 }
@@ -51,5 +68,54 @@ function stopSynapse(synapse: SynapseInstance): Chainable<AUTWindow> {
     });
 }
 
+interface Credentials {
+    accessToken: string;
+    userId: string;
+    deviceId: string;
+    homeServer: string;
+}
+
+function registerUser(
+    synapse: SynapseInstance,
+    username: string,
+    password: string,
+    displayName?: string,
+): Chainable<Credentials> {
+    const url = `${synapse.baseUrl}/_synapse/admin/v1/register`;
+    return cy.then(() => {
+        // get a nonce
+        return cy.request<{ nonce: string }>({ url });
+    }).then(response => {
+        const { nonce } = response.body;
+        const mac = crypto.createHmac('sha1', synapse.registrationSecret).update(
+            `${nonce}\0${username}\0${password}\0notadmin`,
+        ).digest('hex');
+
+        return cy.request<{
+            access_token: string;
+            user_id: string;
+            home_server: string;
+            device_id: string;
+        }>({
+            url,
+            method: "POST",
+            body: {
+                nonce,
+                username,
+                password,
+                mac,
+                admin: false,
+                displayname: displayName,
+            },
+        });
+    }).then(response => ({
+        homeServer: response.body.home_server,
+        accessToken: response.body.access_token,
+        userId: response.body.user_id,
+        deviceId: response.body.device_id,
+    }));
+}
+
 Cypress.Commands.add("startSynapse", startSynapse);
 Cypress.Commands.add("stopSynapse", stopSynapse);
+Cypress.Commands.add("registerUser", registerUser);