From 78e2c787e08b7fef7d50cf02cf9aceb907d8670a Mon Sep 17 00:00:00 2001
From: lukebarnard <luke.barnard99@gmail.com>
Date: Wed, 18 Jan 2017 11:53:17 +0100
Subject: [PATCH] Refactor and document test helpers.

---
 .../elements/MemberEventListSummary-test.js   | 64 ++++++++++---------
 test/test-utils.js                            | 12 +++-
 2 files changed, 45 insertions(+), 31 deletions(-)

diff --git a/test/components/views/elements/MemberEventListSummary-test.js b/test/components/views/elements/MemberEventListSummary-test.js
index 39a79eaf6c..93c085f88c 100644
--- a/test/components/views/elements/MemberEventListSummary-test.js
+++ b/test/components/views/elements/MemberEventListSummary-test.js
@@ -4,12 +4,15 @@ const ReactDOM = require("react-dom");
 const ReactTestUtils = require('react-addons-test-utils');
 const sdk = require('matrix-react-sdk');
 const MemberEventListSummary = sdk.getComponent('views.elements.MemberEventListSummary');
+var jssdk = require('matrix-js-sdk');
+var MatrixEvent = jssdk.MatrixEvent;
 
 const testUtils = require('../../../test-utils');
 describe.only('MemberEventListSummary', function() {
     let sandbox;
     let parentDiv;
 
+    // Generate dummy event tiles for use in simulating an expanded MELS
     const generateTiles = (events) => {
         return events.map((e) => {
             return (
@@ -20,42 +23,41 @@ describe.only('MemberEventListSummary', function() {
         });
     };
 
+    /**
+     * Generates a membership event with the target of the event set as a mocked RoomMember based
+     * on `parameters.userId`.
+     * @param {string} eventId the ID of the event.
+     * @param {object} parameters the parameters to use to create the event.
+     * @param {string} parameters.membership the membership to assign to `content.membership`
+     * @param {string} parameters.userId the state key and target userId of the event. If
+     * `parameters.senderId` is not specified, this is also used as the event sender.
+     * @param {string} parameters.prevMembership the membership to assign to
+     * `prev_content.membership`.
+     * @param {string} parameters.senderId the user ID of the sender of the event. Optional.
+     * Defaults to `parameters.userId`.
+     * @returns {MatrixEvent} the event created.
+     */
     const generateMembershipEvent = (eventId, parameters) => {
-        let membership = parameters.membership;
-        let userId = parameters.userId;
-        let prevMembership = parameters.prevMembership;
-        let senderId = parameters.senderId;
-        return {
-            content: {
-                membership: membership,
-            },
-            target: {
-                name: userId.match(/@([^:]*):/)[1],
+        let e = testUtils.mkMembership({
+            event: true,
+            user: parameters.senderId || parameters.userId,
+            skey: parameters.userId,
+            mship: parameters.membership,
+            prevMship: parameters.prevMembership,
+            target : {
+                name: parameters.userId.match(/@([^:]*):/)[1], // Use localpart as display name
+                userId: parameters.userId,
                 getAvatarUrl: () => {
                     return "avatar.jpeg";
                 },
-                userId: userId,
             },
-            getId: () => {
-                return eventId;
-            },
-            getContent: function() {
-                return this.content;
-            },
-            getPrevContent: function() {
-                return {
-                    membership: prevMembership ? prevMembership : this.content,
-                };
-            },
-            getSender: () => {
-                return senderId || userId;
-            },
-            getStateKey: () => {
-                return userId;
-            },
-        };
+        });
+        // Override random event ID
+        e.event.event_id = eventId;
+        return e;
     };
 
+    // Generate mock MatrixEvents from the array of parameters
     const generateEvents = (parameters) => {
         const res = [];
         for (let i = 0; i < parameters.length; i++) {
@@ -64,6 +66,9 @@ describe.only('MemberEventListSummary', function() {
         return res;
     };
 
+    // Generate the same sequence of `events` for `n` users, where each user ID
+    // is created by replacing the first "$" in userIdTemplate with `i` for
+    // `i = 0 .. n`.
     const generateEventsForUsers = (userIdTemplate, n, events) => {
         let eventsForUsers = [];
         let userId = "";
@@ -71,7 +76,6 @@ describe.only('MemberEventListSummary', function() {
             userId = userIdTemplate.replace('$', i);
             events.forEach((e) => {
                 e.userId = userId;
-                return e;
             });
             eventsForUsers = eventsForUsers.concat(generateEvents(events));
         }
diff --git a/test/test-utils.js b/test/test-utils.js
index db405c2e1a..cdfae4421c 100644
--- a/test/test-utils.js
+++ b/test/test-utils.js
@@ -108,6 +108,7 @@ export function mkEvent(opts) {
         room_id: opts.room,
         sender: opts.user,
         content: opts.content,
+        prev_content: opts.prev_content,
         event_id: "$" + Math.random() + "-" + Math.random(),
         origin_server_ts: opts.ts,
     };
@@ -150,7 +151,9 @@ export function mkPresence(opts) {
  * @param {Object} opts Values for the membership.
  * @param {string} opts.room The room ID for the event.
  * @param {string} opts.mship The content.membership for the event.
+ * @param {string} opts.prevMship The prev_content.membership for the event.
  * @param {string} opts.user The user ID for the event.
+ * @param {RoomMember} opts.target The target of the event.
  * @param {string} opts.skey The other user ID for the event if applicable
  * e.g. for invites/bans.
  * @param {string} opts.name The content.displayname for the event.
@@ -169,9 +172,16 @@ export function mkMembership(opts) {
     opts.content = {
         membership: opts.mship
     };
+    if (opts.prevMship) {
+        opts.prev_content = { membership: opts.prevMship };
+    }
     if (opts.name) { opts.content.displayname = opts.name; }
     if (opts.url) { opts.content.avatar_url = opts.url; }
-    return mkEvent(opts);
+    let e = mkEvent(opts);
+    if (opts.target) {
+        e.target = opts.target;
+    }
+    return e;
 };
 
 /**