From 736cbc06da28e448fa351b71cf23fe32edd55c41 Mon Sep 17 00:00:00 2001 From: Mikunj Date: Mon, 1 Jun 2020 15:04:09 +1000 Subject: [PATCH] Add tests --- js/modules/data.js | 76 ++++++++++--------- js/modules/signal.js | 2 + .../session/crypto/MessageEncrypter_test.ts | 47 ++++++++++++ .../utils/stubs/SignalAddressProtocolStub.ts | 27 +++++++ ts/test/utils/stubs/index.ts | 1 + ts/window.ts | 7 ++ 6 files changed, 123 insertions(+), 37 deletions(-) create mode 100644 ts/test/session/crypto/MessageEncrypter_test.ts create mode 100644 ts/test/utils/stubs/SignalAddressProtocolStub.ts create mode 100644 ts/test/utils/stubs/index.ts diff --git a/js/modules/data.js b/js/modules/data.js index 39819d5e4..cfbc3d006 100644 --- a/js/modules/data.js +++ b/js/modules/data.js @@ -1,7 +1,8 @@ /* global window, setTimeout, clearTimeout, IDBKeyRange, dcodeIO */ - const electron = require('electron'); +const { ipcRenderer } = electron; + // TODO: this results in poor readability, would be // much better to explicitly call with `_`. const { @@ -21,12 +22,6 @@ const _ = require('lodash'); const { base64ToArrayBuffer, arrayBufferToBase64 } = require('./crypto'); const MessageType = require('./types/message'); -const { ipcRenderer } = electron; - -// We listen to a lot of events on ipcRenderer, often on the same channel. This prevents -// any warnings that might be sent to the console in that case. -ipcRenderer.setMaxListeners(0); - const DATABASE_UPDATE_TIMEOUT = 2 * 60 * 1000; // two minutes const SQL_CHANNEL_KEY = 'sql-channel'; @@ -44,6 +39,7 @@ let _shutdownPromise = null; const channels = {}; module.exports = { + init, _jobs, _cleanData, @@ -212,6 +208,42 @@ module.exports = { createOrUpdateSenderKeys, }; +function init() { + // We listen to a lot of events on ipcRenderer, often on the same channel. This prevents + // any warnings that might be sent to the console in that case. + ipcRenderer.setMaxListeners(0); + + forEach(module.exports, fn => { + if (isFunction(fn) && fn.name !== 'init') { + makeChannel(fn.name); + } + }); + + ipcRenderer.on( + `${SQL_CHANNEL_KEY}-done`, + (event, jobId, errorForDisplay, result) => { + const job = _getJob(jobId); + if (!job) { + throw new Error( + `Received SQL channel reply to job ${jobId}, but did not have it in our registry!` + ); + } + + const { resolve, reject, fnName } = job; + + if (errorForDisplay) { + return reject( + new Error( + `Error received from SQL channel job ${jobId} (${fnName}): ${errorForDisplay}` + ) + ); + } + + return resolve(result); + } + ); +} + // When IPC arguments are prepared for the cross-process send, they are JSON.stringified. // We can't send ArrayBuffers or BigNumbers (what we get from proto library for dates). function _cleanData(data) { @@ -352,30 +384,6 @@ function _getJob(id) { return _jobs[id]; } -ipcRenderer.on( - `${SQL_CHANNEL_KEY}-done`, - (event, jobId, errorForDisplay, result) => { - const job = _getJob(jobId); - if (!job) { - throw new Error( - `Received SQL channel reply to job ${jobId}, but did not have it in our registry!` - ); - } - - const { resolve, reject, fnName } = job; - - if (errorForDisplay) { - return reject( - new Error( - `Error received from SQL channel job ${jobId} (${fnName}): ${errorForDisplay}` - ) - ); - } - - return resolve(result); - } -); - function makeChannel(fnName) { channels[fnName] = (...args) => { const jobId = _makeJob(fnName); @@ -398,12 +406,6 @@ function makeChannel(fnName) { }; } -forEach(module.exports, fn => { - if (isFunction(fn)) { - makeChannel(fn.name); - } -}); - function keysToArrayBuffer(keys, data) { const updated = cloneDeep(data); for (let i = 0, max = keys.length; i < max; i += 1) { diff --git a/js/modules/signal.js b/js/modules/signal.js index c676c5845..b4dad50a8 100644 --- a/js/modules/signal.js +++ b/js/modules/signal.js @@ -263,6 +263,8 @@ function initializeMigrations({ exports.setup = (options = {}) => { const { Attachments, userDataPath, getRegionCode, logger } = options; + Data.init(); + const Migrations = initializeMigrations({ userDataPath, getRegionCode, diff --git a/ts/test/session/crypto/MessageEncrypter_test.ts b/ts/test/session/crypto/MessageEncrypter_test.ts new file mode 100644 index 000000000..7a8ce125b --- /dev/null +++ b/ts/test/session/crypto/MessageEncrypter_test.ts @@ -0,0 +1,47 @@ +import { expect } from 'chai'; +import * as crypto from 'crypto'; +import * as sinon from 'sinon'; +import * as window from '../../../window'; +import { MessageEncrypter } from '../../../session/crypto'; +import { EncryptionType } from '../../../session/types/EncryptionType'; + +describe('MessageEncrypter', () => { + const sandbox = sinon.sandbox.create(); + + beforeEach(() => { + sandbox.stub(window); + }); + + afterEach(() => { + sandbox.restore(); + }); + + describe('EncryptionType', () => { + describe('MediumGroup', () => { + it('should throw an error', async () => { + const data = crypto.randomBytes(10); + const promise = MessageEncrypter.encrypt('1', data, EncryptionType.MediumGroup); + await expect(promise).to.be.rejectedWith('Encryption is not yet supported'); + }); + }); + + /* + describe('SessionReset', () => { + it('should call FallbackSessionCipher', async () => { + }); + + it('should pass the padded message body to encrypt', async () => { + }); + }); + + describe('Signal', () => { + it('should call SessionCipher', async () => { + + }); + + it('should pass the padded message body to encrypt', async () => { + }); + }); + */ + }); +}); diff --git a/ts/test/utils/stubs/SignalAddressProtocolStub.ts b/ts/test/utils/stubs/SignalAddressProtocolStub.ts new file mode 100644 index 000000000..28f7697a4 --- /dev/null +++ b/ts/test/utils/stubs/SignalAddressProtocolStub.ts @@ -0,0 +1,27 @@ +import { SignalProtocolAddress } from "../../../../libtextsecure/libsignal-protocol"; + +export class SignalProtocolAddressStub extends SignalProtocolAddress { + private readonly hexEncodedPublicKey: string; + private readonly deviceId: number; + constructor(hexEncodedPublicKey: string, deviceId: number) { + super(hexEncodedPublicKey, deviceId); + this.hexEncodedPublicKey = hexEncodedPublicKey; + this.deviceId = deviceId; + } + + // tslint:disable-next-line: function-name + public static fromString(encodedAddress: string): SignalProtocolAddressStub { + const values = encodedAddress.split('.'); + + return new SignalProtocolAddressStub(values[0], Number(values[1])); + } + + public getName(): string { return this.hexEncodedPublicKey; } + public getDeviceId(): number { return this.deviceId; } + + public equals(other: SignalProtocolAddress): boolean { + return other.getName() === this.hexEncodedPublicKey; + } + + public toString(): string { return this.hexEncodedPublicKey; } +} diff --git a/ts/test/utils/stubs/index.ts b/ts/test/utils/stubs/index.ts new file mode 100644 index 000000000..8459903f1 --- /dev/null +++ b/ts/test/utils/stubs/index.ts @@ -0,0 +1 @@ +export * from './SignalAddressProtocolStub'; diff --git a/ts/window.ts b/ts/window.ts index 1cfa81639..51376df70 100644 --- a/ts/window.ts +++ b/ts/window.ts @@ -74,6 +74,13 @@ interface WindowInterface extends Window { resetDatabase: any; } +// In the case for tests +// tslint:disable-next-line: no-typeof-undefined +if (typeof(window) === 'undefined') { + const globalAny: any = global; + globalAny.window = {}; +} + declare const window: WindowInterface; // TODO: Is there an easier way to dynamically export these?