PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Unit test typescriptification - MKeyVerificationConclusion (#8435)

Browse source 
* test/components/views/messages/MKeyVerificationConclusion-test.js -> tsx

Signed-off-by: Kerry Archibald <kerrya@element.io>

* ts fixes

Signed-off-by: Kerry Archibald <kerrya@element.io>

* add missing copyright

Signed-off-by: Kerry Archibald <kerrya@element.io>
This commit is contained in:
Kerry 2022-04-28 13:44:04 +02:00 committed by GitHub
parent 699a9aeaaf
commit ecd7d8b5e8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 132 additions and 99 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

99
test/components/views/messages/MKeyVerificationConclusion-test.js
View file

@ -1,99 +0,0 @@
import React from 'react';
import TestRenderer from 'react-test-renderer';
import { EventEmitter } from 'events';
import { MatrixEvent } from 'matrix-js-sdk/src/matrix';
import * as TestUtils from '../../../test-utils';
import { MatrixClientPeg } from '../../../../src/MatrixClientPeg';
import MKeyVerificationConclusion from '../../../../src/components/views/messages/MKeyVerificationConclusion';
const trustworthy = () => ({ isCrossSigningVerified: () => true });
const untrustworthy = () => ({ isCrossSigningVerified: () => false });
describe("MKeyVerificationConclusion", () => {
beforeEach(() => {
TestUtils.stubClient();
const client = MatrixClientPeg.get();
client.checkUserTrust = trustworthy;
const emitter = new EventEmitter();
client.on = emitter.on.bind(emitter);
client.removeListener = emitter.removeListener.bind(emitter);
client.emit = emitter.emit.bind(emitter);
});
it("shouldn't render if there's no verificationRequest", () => {
const event = new MatrixEvent({});
const renderer = TestRenderer.create(
<MKeyVerificationConclusion mxEvent={event} />,
);
expect(renderer.toJSON()).toBeNull();
});
it("shouldn't render if the verificationRequest is pending", () => {
const event = new MatrixEvent({});
event.verificationRequest = new EventEmitter();
event.verificationRequest.pending = true;
const renderer = TestRenderer.create(
<MKeyVerificationConclusion mxEvent={event} />,
);
expect(renderer.toJSON()).toBeNull();
});
it("shouldn't render if the event type is cancel but the request type isn't", () => {
const event = new MatrixEvent({ type: "m.key.verification.cancel" });
event.verificationRequest = new EventEmitter();
event.verificationRequest.cancelled = false;
const renderer = TestRenderer.create(
<MKeyVerificationConclusion mxEvent={event} />,
);
expect(renderer.toJSON()).toBeNull();
});
it("shouldn't render if the event type is done but the request type isn't", () => {
const event = new MatrixEvent({ type: "m.key.verification.done" });
event.verificationRequest = new EventEmitter();
event.verificationRequest.done = false;
const renderer = TestRenderer.create(
<MKeyVerificationConclusion mxEvent={event} />,
);
expect(renderer.toJSON()).toBeNull();
});
it("shouldn't render if the user isn't actually trusted", () => {
const client = MatrixClientPeg.get();
client.checkUserTrust = untrustworthy;
const event = new MatrixEvent({ type: "m.key.verification.done" });
event.verificationRequest = new EventEmitter();
event.verificationRequest.done = true;
const renderer = TestRenderer.create(
<MKeyVerificationConclusion mxEvent={event} />,
);
expect(renderer.toJSON()).toBeNull();
});
it("should rerender appropriately if user trust status changes", () => {
const client = MatrixClientPeg.get();
client.checkUserTrust = untrustworthy;
const event = new MatrixEvent({ type: "m.key.verification.done" });
event.verificationRequest = new EventEmitter();
event.verificationRequest.done = true;
event.verificationRequest.otherUserId = "@someuser:domain";
const renderer = TestRenderer.create(
<MKeyVerificationConclusion mxEvent={event} />,
);
expect(renderer.toJSON()).toBeNull();
client.checkUserTrust = trustworthy;
/* Ensure we don't rerender for every trust status change of any user */
client.emit("userTrustStatusChanged", "@anotheruser:domain");
expect(renderer.toJSON()).toBeNull();
/* But when our user changes, we do rerender */
client.emit("userTrustStatusChanged", event.verificationRequest.otherUserId);
expect(renderer.toJSON()).not.toBeNull();
});
});

132
test/components/views/messages/MKeyVerificationConclusion-test.tsx Normal file
View file

@ -0,0 +1,132 @@
/*
Copyright 2022 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 React from 'react';
import TestRenderer from 'react-test-renderer';
import { EventEmitter } from 'events';
import { MatrixEvent, EventType } from 'matrix-js-sdk/src/matrix';
import { CryptoEvent } from 'matrix-js-sdk/src/crypto';
import { UserTrustLevel } from 'matrix-js-sdk/src/crypto/CrossSigning';
import { VerificationRequest } from 'matrix-js-sdk/src/crypto/verification/request/VerificationRequest';
import { MatrixClientPeg } from '../../../../src/MatrixClientPeg';
import MKeyVerificationConclusion from '../../../../src/components/views/messages/MKeyVerificationConclusion';
import { getMockClientWithEventEmitter } from '../../../test-utils';
const trustworthy = ({ isCrossSigningVerified: () => true }) as unknown as UserTrustLevel;
const untrustworthy = ({ isCrossSigningVerified: () => false }) as unknown as UserTrustLevel;
describe("MKeyVerificationConclusion", () => {
const userId = '@user:server';
const mockClient = getMockClientWithEventEmitter({
getRoom: jest.fn(),
getUserId: jest.fn().mockReturnValue(userId),
checkUserTrust: jest.fn(),
});
const getMockVerificationRequest = (
{ pending, cancelled, done, otherUserId }:
{ pending?: boolean, cancelled?: boolean, done?: boolean, otherUserId?: string },
) => {
class MockVerificationRequest extends EventEmitter {
constructor(
public readonly pending: boolean,
public readonly cancelled: boolean,
public readonly done: boolean,
public readonly otherUserId: string,
) {
super();
}
}
return new MockVerificationRequest(pending, cancelled, done, otherUserId) as unknown as VerificationRequest;
};
beforeEach(() => {
jest.clearAllMocks();
mockClient.checkUserTrust.mockReturnValue(trustworthy);
});
afterAll(() => {
jest.spyOn(MatrixClientPeg, 'get').mockRestore();
});
it("shouldn't render if there's no verificationRequest", () => {
const event = new MatrixEvent({});
const renderer = TestRenderer.create(
<MKeyVerificationConclusion mxEvent={event} />,
);
expect(renderer.toJSON()).toBeNull();
});
it("shouldn't render if the verificationRequest is pending", () => {
const event = new MatrixEvent({});
event.verificationRequest = getMockVerificationRequest({ pending: true });
const renderer = TestRenderer.create(
<MKeyVerificationConclusion mxEvent={event} />,
);
expect(renderer.toJSON()).toBeNull();
});
it("shouldn't render if the event type is cancel but the request type isn't", () => {
const event = new MatrixEvent({ type: EventType.KeyVerificationCancel });
event.verificationRequest = getMockVerificationRequest({ cancelled: false });
const renderer = TestRenderer.create(
<MKeyVerificationConclusion mxEvent={event} />,
);
expect(renderer.toJSON()).toBeNull();
});
it("shouldn't render if the event type is done but the request type isn't", () => {
const event = new MatrixEvent({ type: "m.key.verification.done" });
event.verificationRequest = getMockVerificationRequest({ done: false });
const renderer = TestRenderer.create(
<MKeyVerificationConclusion mxEvent={event} />,
);
expect(renderer.toJSON()).toBeNull();
});
it("shouldn't render if the user isn't actually trusted", () => {
mockClient.checkUserTrust.mockReturnValue(untrustworthy);
const event = new MatrixEvent({ type: "m.key.verification.done" });
event.verificationRequest = getMockVerificationRequest({ done: true });
const renderer = TestRenderer.create(
<MKeyVerificationConclusion mxEvent={event} />,
);
expect(renderer.toJSON()).toBeNull();
});
it("should rerender appropriately if user trust status changes", () => {
mockClient.checkUserTrust.mockReturnValue(untrustworthy);
const event = new MatrixEvent({ type: "m.key.verification.done" });
event.verificationRequest = getMockVerificationRequest({ done: true, otherUserId: "@someuser:domain" });
const renderer = TestRenderer.create(
<MKeyVerificationConclusion mxEvent={event} />,
);
expect(renderer.toJSON()).toBeNull();
mockClient.checkUserTrust.mockReturnValue(trustworthy);
/* Ensure we don't rerender for every trust status change of any user */
mockClient.emit(CryptoEvent.UserTrustStatusChanged, "@anotheruser:domain");
expect(renderer.toJSON()).toBeNull();
/* But when our user changes, we do rerender */
mockClient.emit(CryptoEvent.UserTrustStatusChanged, event.verificationRequest.otherUserId);
expect(renderer.toJSON()).not.toBeNull();
});
});