Add dendrite support to cypress tests (#9884)

* Minimum hacks required to run cypress tests with dendrite

* Remove wget hack since dendrite containers now have curl

* Add basic dendritedocker plugin & hack into login spec for testing

* Add generic HomeserverInstance interface

* Add env var to configure which homeserver to use

* Remove synapse specific homeserver support api

* Update the rest of the tests to use HomeserverInstance

* Update cypress docs to reference new homeserver abstraction

* Fix formatting issues

* Change dendrite to use main branch container

Author: devonh

.gitignore

@@ -24,6 +24,7 @@ package-lock.json
 /cypress/downloads
 /cypress/screenshots
 /cypress/synapselogs
+/cypress/dendritelogs
 # These could have files in them but don't currently
 # Cypress will still auto-create them though...
 /cypress/performance

cypress.config.ts

@@ -33,6 +33,7 @@ export default defineConfig({
     env: {
         // Docker tag to use for `ghcr.io/matrix-org/sliding-sync-proxy` image.
         SLIDING_SYNC_PROXY_TAG: "v0.6.0",
+        HOMESERVER: "synapse",
     },
     retries: {
         runMode: 4,

cypress/e2e/composer/composer.spec.ts

@@ -16,25 +16,25 @@ limitations under the License.
 
 /// <reference types="cypress" />
 
-import { SynapseInstance } from "../../plugins/synapsedocker";
+import { HomeserverInstance } from "../../plugins/utils/homeserver";
 import { SettingLevel } from "../../../src/settings/SettingLevel";
 
 describe("Composer", () => {
-    let synapse: SynapseInstance;
+    let homeserver: HomeserverInstance;
 
     beforeEach(() => {
-        cy.startSynapse("default").then((data) => {
-            synapse = data;
+        cy.startHomeserver("default").then((data) => {
+            homeserver = data;
         });
     });
 
     afterEach(() => {
-        cy.stopSynapse(synapse);
+        cy.stopHomeserver(homeserver);
     });
 
     describe("CIDER", () => {
         beforeEach(() => {
-            cy.initTestUser(synapse, "Janet").then(() => {
+            cy.initTestUser(homeserver, "Janet").then(() => {
                 cy.createRoom({ name: "Composing Room" });
             });
             cy.viewRoomByName("Composing Room");
@@ -101,7 +101,7 @@ describe("Composer", () => {
     describe("WYSIWYG", () => {
         beforeEach(() => {
             cy.enableLabsFeature("feature_wysiwyg_composer");
-            cy.initTestUser(synapse, "Janet").then(() => {
+            cy.initTestUser(homeserver, "Janet").then(() => {
                 cy.createRoom({ name: "Composing Room" });
             });
             cy.viewRoomByName("Composing Room");

cypress/e2e/create-room/create-room.spec.ts

@@ -16,7 +16,7 @@ limitations under the License.
 
 /// <reference types="cypress" />
 
-import { SynapseInstance } from "../../plugins/synapsedocker";
+import { HomeserverInstance } from "../../plugins/utils/homeserver";
 import Chainable = Cypress.Chainable;
 
 function openCreateRoomDialog(): Chainable<JQuery<HTMLElement>> {
@@ -26,18 +26,18 @@ function openCreateRoomDialog(): Chainable<JQuery<HTMLElement>> {
 }
 
 describe("Create Room", () => {
-    let synapse: SynapseInstance;
+    let homeserver: HomeserverInstance;
 
     beforeEach(() => {
-        cy.startSynapse("default").then((data) => {
-            synapse = data;
+        cy.startHomeserver("default").then((data) => {
+            homeserver = data;
 
-            cy.initTestUser(synapse, "Jim");
+            cy.initTestUser(homeserver, "Jim");
         });
     });
 
     afterEach(() => {
-        cy.stopSynapse(synapse);
+        cy.stopHomeserver(homeserver);
     });
 
     it("should allow us to create a public room with name, topic & address set", () => {

cypress/e2e/crypto/crypto.spec.ts

@@ -18,12 +18,12 @@ import type { ISendEventResponse, MatrixClient, Room } from "matrix-js-sdk/src/m
 import type { VerificationRequest } from "matrix-js-sdk/src/crypto/verification/request/VerificationRequest";
 import type { ISasEvent } from "matrix-js-sdk/src/crypto/verification/SAS";
 import type { CypressBot } from "../../support/bot";
-import { SynapseInstance } from "../../plugins/synapsedocker";
+import { HomeserverInstance } from "../../plugins/utils/homeserver";
 import Chainable = Cypress.Chainable;
 
 type EmojiMapping = [emoji: string, name: string];
 interface CryptoTestContext extends Mocha.Context {
-    synapse: SynapseInstance;
+    homeserver: HomeserverInstance;
     bob: CypressBot;
 }
 
@@ -155,16 +155,16 @@ const verify = function (this: CryptoTestContext) {
 
 describe("Cryptography", function () {
     beforeEach(function () {
-        cy.startSynapse("default")
-            .as("synapse")
-            .then((synapse: SynapseInstance) => {
-                cy.initTestUser(synapse, "Alice", undefined, "alice_");
-                cy.getBot(synapse, { displayName: "Bob", autoAcceptInvites: false, userIdPrefix: "bob_" }).as("bob");
+        cy.startHomeserver("default")
+            .as("homeserver")
+            .then((homeserver: HomeserverInstance) => {
+                cy.initTestUser(homeserver, "Alice", undefined, "alice_");
+                cy.getBot(homeserver, { displayName: "Bob", autoAcceptInvites: false, userIdPrefix: "bob_" }).as("bob");
             });
     });
 
     afterEach(function (this: CryptoTestContext) {
-        cy.stopSynapse(this.synapse);
+        cy.stopHomeserver(this.homeserver);
     });
 
     it("setting up secure key backup should work", () => {
@@ -215,7 +215,7 @@ describe("Cryptography", function () {
         cy.bootstrapCrossSigning();
 
         // bob has a second, not cross-signed, device
-        cy.loginBot(this.synapse, this.bob.getUserId(), this.bob.__cypress_password, {}).as("bobSecondDevice");
+        cy.loginBot(this.homeserver, this.bob.getUserId(), this.bob.__cypress_password, {}).as("bobSecondDevice");
 
         autoJoin(this.bob);
 

cypress/e2e/crypto/decryption-failure.spec.ts

@@ -17,7 +17,7 @@ limitations under the License.
 import type { VerificationRequest } from "matrix-js-sdk/src/crypto/verification/request/VerificationRequest";
 import type { ISasEvent } from "matrix-js-sdk/src/crypto/verification/SAS";
 import type { MatrixClient } from "matrix-js-sdk/src/matrix";
-import { SynapseInstance } from "../../plugins/synapsedocker";
+import { HomeserverInstance } from "../../plugins/utils/homeserver";
 import { UserCredentials } from "../../support/login";
 import Chainable = Cypress.Chainable;
 
@@ -56,20 +56,20 @@ const handleVerificationRequest = (request: VerificationRequest): Chainable<Emoj
 };
 
 describe("Decryption Failure Bar", () => {
-    let synapse: SynapseInstance | undefined;
+    let homeserver: HomeserverInstance | undefined;
     let testUser: UserCredentials | undefined;
     let bot: MatrixClient | undefined;
     let roomId: string;
 
     beforeEach(function () {
-        cy.startSynapse("default").then((syn: SynapseInstance) => {
-            synapse = syn;
-            cy.initTestUser(synapse, TEST_USER)
+        cy.startHomeserver("default").then((hs: HomeserverInstance) => {
+            homeserver = hs;
+            cy.initTestUser(homeserver, TEST_USER)
                 .then((creds: UserCredentials) => {
                     testUser = creds;
                 })
                 .then(() => {
-                    cy.getBot(synapse, { displayName: BOT_USER }).then((cli) => {
+                    cy.getBot(homeserver, { displayName: BOT_USER }).then((cli) => {
                         bot = cli;
                     });
                 })
@@ -97,15 +97,15 @@ describe("Decryption Failure Bar", () => {
     });
 
     afterEach(() => {
-        cy.stopSynapse(synapse);
+        cy.stopHomeserver(homeserver);
     });
 
     it(
         "should prompt the user to verify, if this device isn't verified " +
             "and there are other verified devices or backups",
         () => {
             let otherDevice: MatrixClient | undefined;
-            cy.loginBot(synapse, testUser.username, testUser.password, {})
+            cy.loginBot(homeserver, testUser.username, testUser.password, {})
                 .then(async (cli) => {
                     otherDevice = cli;
                     await otherDevice.bootstrapCrossSigning({
@@ -169,7 +169,7 @@ describe("Decryption Failure Bar", () => {
         "should prompt the user to reset keys, if this device isn't verified " +
             "and there are no other verified devices or backups",
         () => {
-            cy.loginBot(synapse, testUser.username, testUser.password, {}).then(async (cli) => {
+            cy.loginBot(homeserver, testUser.username, testUser.password, {}).then(async (cli) => {
                 await cli.bootstrapCrossSigning({
                     authUploadDeviceSigningKeys: async (makeRequest) => {
                         await makeRequest({});

cypress/e2e/editing/editing.spec.ts

@@ -19,7 +19,7 @@ limitations under the License.
 import type { MsgType } from "matrix-js-sdk/src/@types/event";
 import type { ISendEventResponse } from "matrix-js-sdk/src/@types/requests";
 import type { EventType } from "matrix-js-sdk/src/@types/event";
-import { SynapseInstance } from "../../plugins/synapsedocker";
+import { HomeserverInstance } from "../../plugins/utils/homeserver";
 import Chainable = Cypress.Chainable;
 
 const sendEvent = (roomId: string): Chainable<ISendEventResponse> => {
@@ -30,20 +30,20 @@ const sendEvent = (roomId: string): Chainable<ISendEventResponse> => {
 };
 
 describe("Editing", () => {
-    let synapse: SynapseInstance;
+    let homeserver: HomeserverInstance;
 
     beforeEach(() => {
-        cy.startSynapse("default").then((data) => {
-            synapse = data;
-            cy.initTestUser(synapse, "Edith").then(() => {
+        cy.startHomeserver("default").then((data) => {
+            homeserver = data;
+            cy.initTestUser(homeserver, "Edith").then(() => {
                 cy.injectAxe();
                 return cy.createRoom({ name: "Test room" }).as("roomId");
             });
         });
     });
 
     afterEach(() => {
-        cy.stopSynapse(synapse);
+        cy.stopHomeserver(homeserver);
     });
 
     it("should close the composer when clicking save after making a change and undoing it", () => {

cypress/e2e/integration-manager/get-openid-token.spec.ts

@@ -16,7 +16,7 @@ limitations under the License.
 
 /// <reference types="cypress" />
 
-import { SynapseInstance } from "../../plugins/synapsedocker";
+import { HomeserverInstance } from "../../plugins/utils/homeserver";
 import { UserCredentials } from "../../support/login";
 
 const ROOM_NAME = "Integration Manager Test";
@@ -73,17 +73,17 @@ function sendActionFromIntegrationManager(integrationManagerUrl: string) {
 
 describe("Integration Manager: Get OpenID Token", () => {
     let testUser: UserCredentials;
-    let synapse: SynapseInstance;
+    let homeserver: HomeserverInstance;
     let integrationManagerUrl: string;
 
     beforeEach(() => {
         cy.serveHtmlFile(INTEGRATION_MANAGER_HTML).then((url) => {
             integrationManagerUrl = url;
         });
-        cy.startSynapse("default").then((data) => {
-            synapse = data;
+        cy.startHomeserver("default").then((data) => {
+            homeserver = data;
 
-            cy.initTestUser(synapse, USER_DISPLAY_NAME, () => {
+            cy.initTestUser(homeserver, USER_DISPLAY_NAME, () => {
                 cy.window().then((win) => {
                     win.localStorage.setItem("mx_scalar_token", INTEGRATION_MANAGER_TOKEN);
                     win.localStorage.setItem(`mx_scalar_token_at_${integrationManagerUrl}`, INTEGRATION_MANAGER_TOKEN);
@@ -122,7 +122,7 @@ describe("Integration Manager: Get OpenID Token", () => {
     });
 
     afterEach(() => {
-        cy.stopSynapse(synapse);
+        cy.stopHomeserver(homeserver);
         cy.stopWebServers();
     });
 

cypress/e2e/integration-manager/kick.spec.ts

@@ -16,7 +16,7 @@ limitations under the License.
 
 /// <reference types="cypress" />
 
-import { SynapseInstance } from "../../plugins/synapsedocker";
+import { HomeserverInstance } from "../../plugins/utils/homeserver";
 import { MatrixClient } from "../../global";
 import { UserCredentials } from "../../support/login";
 
@@ -94,17 +94,17 @@ function expectKickedMessage(shouldExist: boolean) {
 
 describe("Integration Manager: Kick", () => {
     let testUser: UserCredentials;
-    let synapse: SynapseInstance;
+    let homeserver: HomeserverInstance;
     let integrationManagerUrl: string;
 
     beforeEach(() => {
         cy.serveHtmlFile(INTEGRATION_MANAGER_HTML).then((url) => {
             integrationManagerUrl = url;
         });
-        cy.startSynapse("default").then((data) => {
-            synapse = data;
+        cy.startHomeserver("default").then((data) => {
+            homeserver = data;
 
-            cy.initTestUser(synapse, USER_DISPLAY_NAME, () => {
+            cy.initTestUser(homeserver, USER_DISPLAY_NAME, () => {
                 cy.window().then((win) => {
                     win.localStorage.setItem("mx_scalar_token", INTEGRATION_MANAGER_TOKEN);
                     win.localStorage.setItem(`mx_scalar_token_at_${integrationManagerUrl}`, INTEGRATION_MANAGER_TOKEN);
@@ -140,12 +140,12 @@ describe("Integration Manager: Kick", () => {
                 name: ROOM_NAME,
             }).as("roomId");
 
-            cy.getBot(synapse, { displayName: BOT_DISPLAY_NAME, autoAcceptInvites: true }).as("bob");
+            cy.getBot(homeserver, { displayName: BOT_DISPLAY_NAME, autoAcceptInvites: true }).as("bob");
         });
     });
 
     afterEach(() => {
-        cy.stopSynapse(synapse);
+        cy.stopHomeserver(homeserver);
         cy.stopWebServers();
     });
 

cypress/e2e/integration-manager/read_events.spec.ts

@@ -16,7 +16,7 @@ limitations under the License.
 
 /// <reference types="cypress" />
 
-import { SynapseInstance } from "../../plugins/synapsedocker";
+import { HomeserverInstance } from "../../plugins/utils/homeserver";
 import { UserCredentials } from "../../support/login";
 
 const ROOM_NAME = "Integration Manager Test";
@@ -87,17 +87,17 @@ function sendActionFromIntegrationManager(
 
 describe("Integration Manager: Read Events", () => {
     let testUser: UserCredentials;
-    let synapse: SynapseInstance;
+    let homeserver: HomeserverInstance;
     let integrationManagerUrl: string;
 
     beforeEach(() => {
         cy.serveHtmlFile(INTEGRATION_MANAGER_HTML).then((url) => {
             integrationManagerUrl = url;
         });
-        cy.startSynapse("default").then((data) => {
-            synapse = data;
+        cy.startHomeserver("default").then((data) => {
+            homeserver = data;
 
-            cy.initTestUser(synapse, USER_DISPLAY_NAME, () => {
+            cy.initTestUser(homeserver, USER_DISPLAY_NAME, () => {
                 cy.window().then((win) => {
                     win.localStorage.setItem("mx_scalar_token", INTEGRATION_MANAGER_TOKEN);
                     win.localStorage.setItem(`mx_scalar_token_at_${integrationManagerUrl}`, INTEGRATION_MANAGER_TOKEN);
@@ -136,7 +136,7 @@ describe("Integration Manager: Read Events", () => {
     });
 
     afterEach(() => {
-        cy.stopSynapse(synapse);
+        cy.stopHomeserver(homeserver);
         cy.stopWebServers();
     });