matrix-client-crypto-spec: reorder

Separate the helper functions from the tests, and order them by functionality rather than by test order. I've been struggling to find the tests among the helpers, and struggling to find the helpers among the other helpers. Hopefully this will help.
2025-12-04 05:02:41 +03:00 · 2016-06-21 10:11:02 +01:00
parent 573a9140d3
commit cb6566a198
1 changed files with 238 additions and 239 deletions
--- a/spec/integ/matrix-client-crypto.spec.js
+++ b/spec/integ/matrix-client-crypto.spec.js
@@ -18,12 +18,6 @@ MockStorageApi.prototype = {
    }
 };

-describe("MatrixClient crypto", function() {
-    if (!sdk.CRYPTO_ENABLED) {
-        return;
-    }
-
-    var baseUrl = "http://localhost.or.something";
 var aliHttpBackend;
 var bobHttpBackend;
 var aliClient;
@@ -46,49 +40,21 @@ describe("MatrixClient crypto", function() {
 var aliMessages;
 var bobMessages;

-    beforeEach(function() {
-        aliLocalStore = new MockStorageApi();
-        aliStorage = new sdk.WebStorageSessionStore(aliLocalStore);
-        bobStorage = new sdk.WebStorageSessionStore(new MockStorageApi());
-        utils.beforeEach(this);

-        aliHttpBackend = new HttpBackend();
-        aliClient = sdk.createClient({
-            baseUrl: baseUrl,
-            userId: aliUserId,
-            accessToken: aliAccessToken,
-            deviceId: aliDeviceId,
-            sessionStore: aliStorage,
-            request: aliHttpBackend.requestFn,
-        });
-
-        bobHttpBackend = new HttpBackend();
-        bobClient = sdk.createClient({
-            baseUrl: baseUrl,
-            userId: bobUserId,
-            accessToken: bobAccessToken,
-            deviceId: bobDeviceId,
-            sessionStore: bobStorage,
-            request: bobHttpBackend.requestFn,
-        });
-
-        aliMessages = [];
-        bobMessages = [];
-    });
-
-    afterEach(function() {
-        aliClient.stopClient();
-        bobClient.stopClient();
-    });
-
-    describe("Ali account setup", function() {
-        it("should have device keys", function(done) {
-            expect(aliClient.deviceKeys).toBeDefined();
-            expect(aliClient.deviceKeys.user_id).toEqual(aliUserId);
-            expect(aliClient.deviceKeys.device_id).toEqual(aliDeviceId);
-            done();
+function aliUploadsKeys() {
+    var uploadPath = "/keys/upload/" + aliDeviceId;
+    aliHttpBackend.when("POST", uploadPath).respond(200, function(path, content) {
+        expect(content.one_time_keys).toEqual({});
+        aliDeviceKeys = content.device_keys;
+        return {one_time_key_counts: {curve25519: 0}};
    });
+    return q.all([
+        aliClient.uploadKeys(0),
+        aliHttpBackend.flush(uploadPath, 1),
+    ]).then(function() {
+        console.log("ali uploaded keys");
    });
+}

 function bobUploadsKeys() {
    var uploadPath = "/keys/upload/bvcxz";
@@ -118,12 +84,6 @@ describe("MatrixClient crypto", function() {
    });
 }

-    it("Bob uploads without one-time keys and with one-time keys", function(done) {
-        q()
-            .then(bobUploadsKeys)
-            .catch(utils.failTest).done(done);
-    });
-
 function aliDownloadsKeys() {
    var bobKeys = {};
    bobKeys[bobDeviceId] = bobDeviceKeys;
@@ -149,12 +109,20 @@ describe("MatrixClient crypto", function() {
    });
 }

-    it("Ali downloads Bobs keys", function(done) {
-        q()
-            .then(bobUploadsKeys)
-            .then(aliDownloadsKeys)
-            .catch(utils.failTest).done(done);
+function bobDownloadsKeys() {
+    var aliKeys = {};
+    aliKeys[aliDeviceId] = aliDeviceKeys;
+    bobHttpBackend.when("POST", "/keys/query").respond(200, function(path, content) {
+        expect(content.device_keys[aliUserId]).toEqual({});
+        var result = {};
+        result[aliUserId] = aliKeys;
+        return {device_keys: result};
    });
+    return q.all([
+        bobClient.downloadKeys([aliUserId]),
+        bobHttpBackend.flush(),
+    ]);
+}

 function aliEnablesEncryption() {
    aliHttpBackend.when("POST", "/keys/claim").respond(200, function(path, content) {
@@ -184,13 +152,36 @@ describe("MatrixClient crypto", function() {
    return p;
 }

-    it("Ali enables encryption", function(done) {
-        q()
-            .then(bobUploadsKeys)
-            .then(aliDownloadsKeys)
-            .then(aliEnablesEncryption)
-            .catch(utils.failTest).done(done);
+function bobEnablesEncryption() {
+    return bobClient.setRoomEncryption(roomId, {
+        algorithm: "m.olm.v1.curve25519-aes-sha2",
+        members: [aliUserId, bobUserId]
+    }).then(function(res) {
+        console.log("bob enabled encryption");
+        expect(res.missingUsers).toEqual([]);
+        expect(res.missingDevices).toEqual({});
+        expect(bobClient.isRoomEncrypted(roomId)).toBeTruthy();
    });
+}
+
+function aliSendsMessage() {
+    return sendMessage(aliHttpBackend, aliClient).then(function(content) {
+        aliMessages.push(content);
+        var ciphertext = content.ciphertext[bobDeviceCurve25519Key];
+        expect(ciphertext).toBeDefined();
+    });
+}
+
+function bobSendsMessage() {
+    return sendMessage(bobHttpBackend, bobClient).then(function(content) {
+        bobMessages.push(content);
+        var aliKeyId = "curve25519:" + aliDeviceId;
+        var aliDeviceCurve25519Key = aliDeviceKeys.keys[aliKeyId];
+        var ciphertext = content.ciphertext[aliDeviceCurve25519Key];
+        expect(ciphertext).toBeDefined();
+        return ciphertext;
+    });
+}

 function sendMessage(httpBackend, client) {
    var path = "/send/m.room.encrypted/";
@@ -210,27 +201,14 @@ describe("MatrixClient crypto", function() {
    });
 }

-    function aliSendsMessage() {
-        return sendMessage(aliHttpBackend, aliClient).then(function(content) {
-            aliMessages.push(content);
-            var ciphertext = content.ciphertext[bobDeviceCurve25519Key];
-            expect(ciphertext).toBeDefined();
-        });
+function aliRecvMessage() {
+    var message = bobMessages.shift();
+    return recvMessage(aliHttpBackend, aliClient, message);
 }

-    it("Ali sends a message", function(done) {
-        q()
-            .then(bobUploadsKeys)
-            .then(aliDownloadsKeys)
-            .then(aliEnablesEncryption)
-            .then(aliSendsMessage)
-            .catch(utils.failTest).done(done);
-    });
-
-    function startClient(httpBackend, client) {
-        client.startClient();
-        httpBackend.when("GET", "/pushrules").respond(200, {});
-        httpBackend.when("POST", "/filter").respond(200, { filter_id: "fid" });
+function bobRecvMessage() {
+    var message = aliMessages.shift();
+    return recvMessage(bobHttpBackend, bobClient, message);
 }

 function recvMessage(httpBackend, client, message) {
@@ -269,11 +247,92 @@ describe("MatrixClient crypto", function() {
    return deferred.promise;
 }

-    function bobRecvMessage() {
-        var message = aliMessages.shift();
-        return recvMessage(bobHttpBackend, bobClient, message);
+function startClient(httpBackend, client) {
+    client.startClient();
+    httpBackend.when("GET", "/pushrules").respond(200, {});
+    httpBackend.when("POST", "/filter").respond(200, { filter_id: "fid" });
 }

+
+describe("MatrixClient crypto", function() {
+    if (!sdk.CRYPTO_ENABLED) {
+        return;
+    }
+
+    beforeEach(function() {
+        aliLocalStore = new MockStorageApi();
+        aliStorage = new sdk.WebStorageSessionStore(aliLocalStore);
+        bobStorage = new sdk.WebStorageSessionStore(new MockStorageApi());
+        utils.beforeEach(this);
+
+        aliHttpBackend = new HttpBackend();
+        aliClient = sdk.createClient({
+            baseUrl: "http://alis.server",
+            userId: aliUserId,
+            accessToken: aliAccessToken,
+            deviceId: aliDeviceId,
+            sessionStore: aliStorage,
+            request: aliHttpBackend.requestFn,
+        });
+
+        bobHttpBackend = new HttpBackend();
+        bobClient = sdk.createClient({
+            baseUrl: "http://bobs.server",
+            userId: bobUserId,
+            accessToken: bobAccessToken,
+            deviceId: bobDeviceId,
+            sessionStore: bobStorage,
+            request: bobHttpBackend.requestFn,
+        });
+
+        aliMessages = [];
+        bobMessages = [];
+    });
+
+    afterEach(function() {
+        aliClient.stopClient();
+        bobClient.stopClient();
+    });
+
+    describe("Ali account setup", function() {
+        it("should have device keys", function(done) {
+            expect(aliClient.deviceKeys).toBeDefined();
+            expect(aliClient.deviceKeys.user_id).toEqual(aliUserId);
+            expect(aliClient.deviceKeys.device_id).toEqual(aliDeviceId);
+            done();
+        });
+    });
+
+    it("Bob uploads without one-time keys and with one-time keys", function(done) {
+        q()
+            .then(bobUploadsKeys)
+            .catch(utils.failTest).done(done);
+    });
+
+    it("Ali downloads Bobs keys", function(done) {
+        q()
+            .then(bobUploadsKeys)
+            .then(aliDownloadsKeys)
+            .catch(utils.failTest).done(done);
+    });
+
+    it("Ali enables encryption", function(done) {
+        q()
+            .then(bobUploadsKeys)
+            .then(aliDownloadsKeys)
+            .then(aliEnablesEncryption)
+            .catch(utils.failTest).done(done);
+    });
+
+    it("Ali sends a message", function(done) {
+        q()
+            .then(bobUploadsKeys)
+            .then(aliDownloadsKeys)
+            .then(aliEnablesEncryption)
+            .then(aliSendsMessage)
+            .catch(utils.failTest).done(done);
+    });
+
    it("Bob receives a message", function(done) {
        q()
            .then(bobUploadsKeys)
@@ -296,66 +355,6 @@ describe("MatrixClient crypto", function() {
            .catch(utils.failTest).done(done);
    });

-
-    function aliUploadsKeys() {
-        var uploadPath = "/keys/upload/" + aliDeviceId;
-        aliHttpBackend.when("POST", uploadPath).respond(200, function(path, content) {
-            expect(content.one_time_keys).toEqual({});
-            aliDeviceKeys = content.device_keys;
-            return {one_time_key_counts: {curve25519: 0}};
-        });
-        return q.all([
-            aliClient.uploadKeys(0),
-            aliHttpBackend.flush(uploadPath, 1),
-        ]).then(function() {
-            console.log("ali uploaded keys");
-        });
-    }
-
-    function bobDownloadsKeys() {
-        var aliKeys = {};
-        aliKeys[aliDeviceId] = aliDeviceKeys;
-        bobHttpBackend.when("POST", "/keys/query").respond(200, function(path, content) {
-            expect(content.device_keys[aliUserId]).toEqual({});
-            var result = {};
-            result[aliUserId] = aliKeys;
-            return {device_keys: result};
-        });
-        return q.all([
-            bobClient.downloadKeys([aliUserId]),
-            bobHttpBackend.flush(),
-        ]);
-    }
-
-    function bobEnablesEncryption() {
-        return bobClient.setRoomEncryption(roomId, {
-            algorithm: "m.olm.v1.curve25519-aes-sha2",
-            members: [aliUserId, bobUserId]
-        }).then(function(res) {
-            console.log("bob enabled encryption");
-            expect(res.missingUsers).toEqual([]);
-            expect(res.missingDevices).toEqual({});
-            expect(bobClient.isRoomEncrypted(roomId)).toBeTruthy();
-        });
-    }
-
-    function bobSendsMessage() {
-        return sendMessage(bobHttpBackend, bobClient).then(function(content) {
-            bobMessages.push(content);
-            var aliKeyId = "curve25519:" + aliDeviceId;
-            var aliDeviceCurve25519Key = aliDeviceKeys.keys[aliKeyId];
-            var ciphertext = content.ciphertext[aliDeviceCurve25519Key];
-            expect(ciphertext).toBeDefined();
-            return ciphertext;
-        });
-    }
-
-    function aliRecvMessage() {
-        var message = bobMessages.shift();
-        return recvMessage(aliHttpBackend, aliClient, message);
-    }
-
-
    it("Bob replies to the message", function(done) {
        q()
            .then(bobUploadsKeys)