Add some test utils in a new entrypoint (#4127)
* Clean up README a little This just removes some of the most egregious lies and outdated stuff. There's a *lot* more that can be done here. * Add some test utils in a new entrypoint * Fix comment * Update src/testing.tswatcha-develop
Richard van der Hoff
2 years ago
committed by
GitHub
parent
4ba1341f8f
commit
dce8acbf17
@ -0,0 +1,88 @@ |
||||
/* |
||||
Copyright 2024 The Matrix.org Foundation C.I.C. |
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License"); |
||||
you may not use this file except in compliance with the License. |
||||
You may obtain a copy of the License at |
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software |
||||
distributed under the License is distributed on an "AS IS" BASIS, |
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
See the License for the specific language governing permissions and |
||||
limitations under the License. |
||||
*/ |
||||
|
||||
import { mkDecryptionFailureMatrixEvent, mkEncryptedMatrixEvent, mkMatrixEvent } from "../../src/testing"; |
||||
import { EventType } from "../../src"; |
||||
|
||||
describe("testing", () => { |
||||
describe("mkMatrixEvent", () => { |
||||
it("makes an event", () => { |
||||
const event = mkMatrixEvent({ |
||||
content: { body: "blah" }, |
||||
sender: "@alice:test", |
||||
type: EventType.RoomMessage, |
||||
roomId: "!test:room", |
||||
}); |
||||
|
||||
expect(event.getContent()).toEqual({ body: "blah" }); |
||||
expect(event.sender?.userId).toEqual("@alice:test"); |
||||
expect(event.isState()).toBe(false); |
||||
}); |
||||
|
||||
it("makes a state event", () => { |
||||
const event = mkMatrixEvent({ |
||||
content: { body: "blah" }, |
||||
sender: "@alice:test", |
||||
type: EventType.RoomTopic, |
||||
roomId: "!test:room", |
||||
stateKey: "", |
||||
}); |
||||
|
||||
expect(event.getContent()).toEqual({ body: "blah" }); |
||||
expect(event.sender?.userId).toEqual("@alice:test"); |
||||
expect(event.isState()).toBe(true); |
||||
expect(event.getStateKey()).toEqual(""); |
||||
}); |
||||
}); |
||||
|
||||
describe("mkEncryptedMatrixEvent", () => { |
||||
it("makes an event", async () => { |
||||
const event = await mkEncryptedMatrixEvent({ |
||||
plainContent: { body: "blah" }, |
||||
sender: "@alice:test", |
||||
plainType: EventType.RoomMessage, |
||||
roomId: "!test:room", |
||||
}); |
||||
|
||||
expect(event.sender?.userId).toEqual("@alice:test"); |
||||
expect(event.isEncrypted()).toBe(true); |
||||
expect(event.isDecryptionFailure()).toBe(false); |
||||
expect(event.getContent()).toEqual({ body: "blah" }); |
||||
expect(event.getType()).toEqual("m.room.message"); |
||||
}); |
||||
}); |
||||
|
||||
describe("mkDecryptionFailureMatrixEvent", () => { |
||||
it("makes an event", async () => { |
||||
const event = await mkDecryptionFailureMatrixEvent({ |
||||
sender: "@alice:test", |
||||
roomId: "!test:room", |
||||
code: "UNKNOWN", |
||||
msg: "blah", |
||||
}); |
||||
|
||||
expect(event.sender?.userId).toEqual("@alice:test"); |
||||
expect(event.isEncrypted()).toBe(true); |
||||
expect(event.isDecryptionFailure()).toBe(true); |
||||
expect(event.getContent()).toEqual({ |
||||
body: "** Unable to decrypt: DecryptionError: blah **", |
||||
msgtype: "m.bad.encrypted", |
||||
}); |
||||
expect(event.getType()).toEqual("m.room.message"); |
||||
expect(event.isState()).toBe(false); |
||||
}); |
||||
}); |
||||
}); |
||||
@ -0,0 +1,165 @@ |
||||
/* |
||||
Copyright 2024 The Matrix.org Foundation C.I.C. |
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License"); |
||||
you may not use this file except in compliance with the License. |
||||
You may obtain a copy of the License at |
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software |
||||
distributed under the License is distributed on an "AS IS" BASIS, |
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
See the License for the specific language governing permissions and |
||||
limitations under the License. |
||||
*/ |
||||
|
||||
/** |
||||
* This file is a secondary entrypoint for the js-sdk library, exposing utilities which might be useful for writing tests. |
||||
* |
||||
* In general it should not be included in runtime applications. |
||||
* |
||||
* @packageDocumentation |
||||
*/ |
||||
|
||||
import { IContent, IEvent, IUnsigned, MatrixEvent } from "./models/event"; |
||||
import { RoomMember } from "./models/room-member"; |
||||
import { EventType } from "./@types/event"; |
||||
import { IEventDecryptionResult } from "./@types/crypto"; |
||||
import { DecryptionError } from "./crypto/algorithms"; |
||||
|
||||
/** |
||||
* Create a {@link MatrixEvent}. |
||||
* |
||||
* @param opts - Values for the event. |
||||
*/ |
||||
export function mkMatrixEvent(opts: { |
||||
/** Room ID of the event. */ |
||||
roomId: string; |
||||
|
||||
/** The sender of the event. */ |
||||
sender: string; |
||||
|
||||
/** The type of the event. */ |
||||
type: EventType | string; |
||||
|
||||
/** Optional `state_key` for the event. If unspecified, a non-state event is created. */ |
||||
stateKey?: string; |
||||
|
||||
/** Optional `origin_server_ts` for the event. If unspecified, the timestamp will be set to 0. */ |
||||
ts?: number; |
||||
|
||||
/** Optional `event_id` for the event. If provided will be used as event ID; else an ID is generated. */ |
||||
eventId?: string; |
||||
|
||||
/** Content of the event. */ |
||||
content: IContent; |
||||
|
||||
/** Optional `unsigned` data for the event. */ |
||||
unsigned?: IUnsigned; |
||||
}): MatrixEvent { |
||||
const event: Partial<IEvent> = { |
||||
type: opts.type, |
||||
room_id: opts.roomId, |
||||
sender: opts.sender, |
||||
content: opts.content, |
||||
event_id: opts.eventId ?? "$" + Math.random() + "-" + Math.random(), |
||||
origin_server_ts: opts.ts ?? 0, |
||||
unsigned: opts.unsigned, |
||||
}; |
||||
if (opts.stateKey !== undefined) { |
||||
event.state_key = opts.stateKey; |
||||
} |
||||
|
||||
const mxEvent = new MatrixEvent(event); |
||||
mxEvent.sender = { |
||||
userId: opts.sender, |
||||
membership: "join", |
||||
name: opts.sender, |
||||
rawDisplayName: opts.sender, |
||||
roomId: opts.sender, |
||||
getAvatarUrl: () => {}, |
||||
getMxcAvatarUrl: () => {}, |
||||
} as unknown as RoomMember; |
||||
return mxEvent; |
||||
} |
||||
|
||||
/** |
||||
* Create a `MatrixEvent` representing a successfully-decrypted `m.room.encrypted` event. |
||||
* |
||||
* @param opts - Values for the event. |
||||
*/ |
||||
export async function mkEncryptedMatrixEvent(opts: { |
||||
/** Room ID of the event. */ |
||||
roomId: string; |
||||
|
||||
/** The sender of the event. */ |
||||
sender: string; |
||||
|
||||
/** The type the event will have, once it has been decrypted. */ |
||||
plainType: EventType | string; |
||||
|
||||
/** The content the event will have, once it has been decrypted. */ |
||||
plainContent: IContent; |
||||
}): Promise<MatrixEvent> { |
||||
// we construct an event which has been decrypted by stubbing out CryptoBackend.decryptEvent and then
|
||||
// calling MatrixEvent.attemptDecryption.
|
||||
|
||||
const mxEvent = mkMatrixEvent({ |
||||
type: EventType.RoomMessageEncrypted, |
||||
roomId: opts.roomId, |
||||
sender: opts.sender, |
||||
content: { algorithm: "m.megolm.v1.aes-sha2" }, |
||||
}); |
||||
|
||||
const decryptionResult: IEventDecryptionResult = { |
||||
claimedEd25519Key: "", |
||||
clearEvent: { |
||||
type: opts.plainType, |
||||
content: opts.plainContent, |
||||
}, |
||||
forwardingCurve25519KeyChain: [], |
||||
senderCurve25519Key: "", |
||||
untrusted: false, |
||||
}; |
||||
|
||||
const mockCrypto = { |
||||
decryptEvent: async (_ev): Promise<IEventDecryptionResult> => decryptionResult, |
||||
} as Parameters<MatrixEvent["attemptDecryption"]>[0]; |
||||
await mxEvent.attemptDecryption(mockCrypto); |
||||
return mxEvent; |
||||
} |
||||
|
||||
/** |
||||
* Create a `MatrixEvent` representing a `m.room.encrypted` event which could not be decrypted. |
||||
* |
||||
* @param opts - Values for the event. |
||||
*/ |
||||
export async function mkDecryptionFailureMatrixEvent(opts: { |
||||
/** Room ID of the event. */ |
||||
roomId: string; |
||||
|
||||
/** The sender of the event. */ |
||||
sender: string; |
||||
|
||||
/** The reason code for the failure */ |
||||
code: string; |
||||
|
||||
/** A textual reason for the failure */ |
||||
msg: string; |
||||
}): Promise<MatrixEvent> { |
||||
const mxEvent = mkMatrixEvent({ |
||||
type: EventType.RoomMessageEncrypted, |
||||
roomId: opts.roomId, |
||||
sender: opts.sender, |
||||
content: { algorithm: "m.megolm.v1.aes-sha2" }, |
||||
}); |
||||
|
||||
const mockCrypto = { |
||||
decryptEvent: async (_ev): Promise<IEventDecryptionResult> => { |
||||
throw new DecryptionError(opts.code, opts.msg); |
||||
}, |
||||
} as Parameters<MatrixEvent["attemptDecryption"]>[0]; |
||||
await mxEvent.attemptDecryption(mockCrypto); |
||||
return mxEvent; |
||||
} |
||||
Loading…
Reference in new issue