Merge pull request #15 from matrix-org/michaelk/return_data_from_cypress

Return information from a get_timeline method.

Author: michaelkaye

README.md

@@ -4,3 +4,4 @@ Trafficlight adapter for element-web
 This code provides a cypress-based adapter for running trafficlight clients against element web.
 
 See matrix-org/trafficlight for more information on how to run using this.
+

cypress/e2e/trafficlight/actions/timeline.ts

@@ -46,3 +46,18 @@ export function verifyLastMessageIsTrusted(): string {
         .find(".mx_EventTile_e2eIcon").should("not.exist");
     return "verified";
 }
+
+export function getTimeline(): JSONValue {
+    const rsp = [];
+    Cypress.$('.mx_EventTile').each(
+        function(index, obj) {
+            tile = {};
+            tile['user'] = Cypress.$(obj).find('.mx_BaseAvatar_image').attr('title');
+            const e2eicon = Cypress.$(obj).find('.mx_EventTile_e2eIcon').attr('class');
+            tile['e2e_issues'] = e2eicon;
+            tile['message'] = Cypress.$(obj).find('.mx_EventTile_content').text();
+            rsp.push(tile);
+        },
+    );
+    return { "response": "got_timeline", "timeline": rsp };
+}

cypress/e2e/trafficlight/trafficlight.spec.ts

@@ -39,6 +39,7 @@ import {
     openRoom,
 } from "./actions/room";
 import {
+    getTimeline,
     sendMessage,
     verifyLastMessageIsTrusted,
     verifyLastMessageIsUTD,
@@ -104,7 +105,13 @@ function recurse() {
     const respondUrl = `${Cypress.env('TRAFFICLIGHT_URL') }/client/${ Cypress.env('TRAFFICLIGHT_UUID') }/respond`;
 
     function sendResponse(responseStatus) {
-        cy.request('POST', respondUrl, { response: responseStatus }).then((response) => {
+        let data;
+        if (typeof responseStatus == "string") {
+            data = { response: responseStatus };
+        } else {
+            data = responseStatus;
+        }
+        cy.request('POST', respondUrl, data).then((response) => {
             expect(response.status).to.eq(200);
         });
     }
@@ -130,7 +137,7 @@ function recurse() {
     });
 }
 
-function runAction(action: string, data: JSONValue): string | undefined {
+function runAction(action: string, data: JSONValue): string | JSONValue | undefined {
     switch (action) {
         // Auth
         case 'register':
@@ -246,6 +253,9 @@ function runAction(action: string, data: JSONValue): string | undefined {
             }
             return advanceClock(milliseconds);
         }
+        case "get_timeline": {
+            return getTimeline();
+        }
         case "clear_idb_storage":
             return clearIDBStorage();
         case "reload":

src/trafficlight.ts

@@ -86,7 +86,7 @@ async function uploadFile(trafficlightUrl: string, uuid: string, filename: strin
     return promise;
 }
 
-async function runCypress(trafficlightUrl: string, uuid: string): Promise<boolean> {
+async function runCypress(trafficlightUrl: string, uuid: string, openMode: boolean): Promise<boolean> {
     const cypressOptions = {
         headed: true,
         // @ts-ignore-next-line
@@ -101,7 +101,7 @@ async function runCypress(trafficlightUrl: string, uuid: string): Promise<boolea
         },
         config: {
             retries: { // Override cypress.json - we want to run exactly once.
-                'openMode': 0,
+                'openMode': openMode ? 1 : 0,
                 'runMode': 0,
             },
             e2e: {
@@ -132,17 +132,25 @@ async function runCypress(trafficlightUrl: string, uuid: string): Promise<boolea
     }
 }
 
-async function runRepeatedly(trafficlightUrl: string) {
+async function runRepeatedly(trafficlightUrl: string, openMode: boolean) {
     // need to find an exit condition here
     let shouldContinue = true;
     while (shouldContinue) {
         const uuid = crypto.randomUUID();
         await registerClient(trafficlightUrl, uuid);
-        shouldContinue = await runCypress(trafficlightUrl, uuid);
+        shouldContinue = await runCypress(trafficlightUrl, uuid, openMode);
     }
 }
 
 const trafficlightUrl = process.env.TRAFFICLIGHT_URL || 'http://127.0.0.1:5000';
-runRepeatedly(trafficlightUrl).then((result) => {
+
+let openMode = false;
+for (let i = 0; i < process.argv.length; i++) {
+    if (process.argv[i] == "open") {
+        openMode = true;
+    }
+}
+
+runRepeatedly(trafficlightUrl, openMode).then((result) => {
     console.log(`Finished looping forever(?), got ${result}`);
 });