This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 832
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update references to
QrCodeEvent, SasEvent and VerificationEvent (
#10991) * Basic test for IncomingSasDialog * Basic test for VerificationPanel * Replace references to IGeneratedSas and ISasEvent * Some secret references to the callbacks types * Update references to `QrCodeEvent`, `SasEvent` and `VerificationEvent`
- Loading branch information
Showing
5 changed files
with
241 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| /* | ||
| Copyright 2023 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 { act, render } from "@testing-library/react"; | ||
| import React from "react"; | ||
| import { Mocked } from "jest-mock"; | ||
| import { VerificationBase } from "matrix-js-sdk/src/crypto/verification/Base"; | ||
| import { | ||
| EmojiMapping, | ||
| ShowSasCallbacks, | ||
| VerifierEvent, | ||
| VerifierEventHandlerMap, | ||
| } from "matrix-js-sdk/src/crypto-api/verification"; | ||
| import { TypedEventEmitter } from "matrix-js-sdk/src/models/typed-event-emitter"; | ||
|
|
||
| import IncomingSasDialog from "../../../../src/components/views/dialogs/IncomingSasDialog"; | ||
| import { stubClient } from "../../../test-utils"; | ||
|
|
||
| describe("IncomingSasDialog", () => { | ||
| beforeEach(() => { | ||
| stubClient(); | ||
| }); | ||
|
|
||
| it("shows a spinner at first", () => { | ||
| const mockVerifier = makeMockVerifier(); | ||
| const { container } = renderComponent(mockVerifier); | ||
| expect(container.getElementsByClassName("mx_Spinner").length).toBeTruthy(); | ||
| }); | ||
|
|
||
| it("should show some emojis once keys are exchanged", () => { | ||
| const mockVerifier = makeMockVerifier(); | ||
| const { container } = renderComponent(mockVerifier); | ||
|
|
||
| // fire the ShowSas event | ||
| const sasEvent = makeMockSasCallbacks(); | ||
| act(() => { | ||
| mockVerifier.emit(VerifierEvent.ShowSas, sasEvent); | ||
| }); | ||
|
|
||
| const emojis = container.getElementsByClassName("mx_VerificationShowSas_emojiSas_block"); | ||
| expect(emojis.length).toEqual(7); | ||
| for (const emoji of emojis) { | ||
| expect(emoji).toHaveTextContent("🦄Unicorn"); | ||
| } | ||
| }); | ||
| }); | ||
|
|
||
| function renderComponent(verifier: VerificationBase, onFinished = () => true) { | ||
| return render(<IncomingSasDialog verifier={verifier} onFinished={onFinished} />); | ||
| } | ||
|
|
||
| function makeMockVerifier(): Mocked<VerificationBase> { | ||
| const verifier = new TypedEventEmitter<VerifierEvent, VerifierEventHandlerMap>(); | ||
| Object.assign(verifier, { | ||
| cancel: jest.fn(), | ||
| }); | ||
| return verifier as unknown as Mocked<VerificationBase>; | ||
| } | ||
|
|
||
| function makeMockSasCallbacks(): ShowSasCallbacks { | ||
| const unicorn: EmojiMapping = ["🦄", "unicorn"]; | ||
| return { | ||
| sas: { | ||
| emoji: new Array<EmojiMapping>(7).fill(unicorn), | ||
| }, | ||
| cancel: jest.fn(), | ||
| confirm: jest.fn(), | ||
| mismatch: jest.fn(), | ||
| }; | ||
| } |
136 changes: 136 additions & 0 deletions
136
test/components/views/right_panel/VerificationPanel-test.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| /* | ||
| Copyright 2023 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 { act, render } from "@testing-library/react"; | ||
| import React from "react"; | ||
| import { | ||
| Phase, | ||
| VerificationRequest, | ||
| VerificationRequestEvent, | ||
| } from "matrix-js-sdk/src/crypto/verification/request/VerificationRequest"; | ||
| import { TypedEventEmitter } from "matrix-js-sdk/src/models/typed-event-emitter"; | ||
| import { User } from "matrix-js-sdk/src/models/user"; | ||
| import { Mocked } from "jest-mock"; | ||
| import { VerificationBase } from "matrix-js-sdk/src/crypto/verification/Base"; | ||
| import { | ||
| EmojiMapping, | ||
| ShowSasCallbacks, | ||
| VerifierEvent, | ||
| VerifierEventHandlerMap, | ||
| } from "matrix-js-sdk/src/crypto-api/verification"; | ||
| import { SAS } from "matrix-js-sdk/src/crypto/verification/SAS"; | ||
| import { IVerificationChannel } from "matrix-js-sdk/src/crypto/verification/request/Channel"; | ||
|
|
||
| import VerificationPanel from "../../../../src/components/views/right_panel/VerificationPanel"; | ||
| import { stubClient } from "../../../test-utils"; | ||
|
|
||
| describe("<VerificationPanel />", () => { | ||
| beforeEach(() => { | ||
| stubClient(); | ||
| }); | ||
|
|
||
| it("should show a 'Verify by emoji' button", () => { | ||
| const container = renderComponent({ | ||
| request: makeMockVerificationRequest(), | ||
| phase: Phase.Ready, | ||
| }); | ||
| container.getByRole("button", { name: "Verify by emoji" }); | ||
| }); | ||
|
|
||
| describe("'Verify by emoji' flow", () => { | ||
| let mockVerifier: Mocked<VerificationBase>; | ||
| let mockRequest: Mocked<VerificationRequest>; | ||
|
|
||
| beforeEach(() => { | ||
| mockVerifier = makeMockVerifier(); | ||
| mockRequest = makeMockVerificationRequest({ | ||
| verifier: mockVerifier, | ||
| chosenMethod: "m.sas.v1", | ||
| }); | ||
| }); | ||
|
|
||
| it("shows a spinner initially", () => { | ||
| const { container } = renderComponent({ | ||
| request: mockRequest, | ||
| phase: Phase.Started, | ||
| }); | ||
| expect(container.getElementsByClassName("mx_Spinner").length).toBeTruthy(); | ||
| }); | ||
|
|
||
| it("should show some emojis once keys are exchanged", () => { | ||
| const { container } = renderComponent({ | ||
| request: mockRequest, | ||
| phase: Phase.Started, | ||
| }); | ||
|
|
||
| // fire the ShowSas event | ||
| const sasEvent = makeMockSasCallbacks(); | ||
| (mockVerifier as unknown as SAS).sasEvent = sasEvent; | ||
| act(() => { | ||
| mockVerifier.emit(VerifierEvent.ShowSas, sasEvent); | ||
| }); | ||
|
|
||
| const emojis = container.getElementsByClassName("mx_VerificationShowSas_emojiSas_block"); | ||
| expect(emojis.length).toEqual(7); | ||
| for (const emoji of emojis) { | ||
| expect(emoji).toHaveTextContent("🦄Unicorn"); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| function renderComponent(props: { request: VerificationRequest; phase: Phase }) { | ||
| const defaultProps = { | ||
| layout: "", | ||
| member: {} as User, | ||
| onClose: () => undefined, | ||
| isRoomEncrypted: false, | ||
| inDialog: false, | ||
| }; | ||
| return render(<VerificationPanel {...defaultProps} {...props} />); | ||
| } | ||
|
|
||
| function makeMockVerificationRequest(props: Partial<VerificationRequest> = {}): Mocked<VerificationRequest> { | ||
| const request = new TypedEventEmitter<VerificationRequestEvent, any>(); | ||
| Object.assign(request, { | ||
| channel: {} as IVerificationChannel, | ||
| cancel: jest.fn(), | ||
| otherPartySupportsMethod: jest.fn().mockReturnValue(true), | ||
| ...props, | ||
| }); | ||
| return request as unknown as Mocked<VerificationRequest>; | ||
| } | ||
|
|
||
| function makeMockVerifier(): Mocked<VerificationBase> { | ||
| const verifier = new TypedEventEmitter<VerifierEvent, VerifierEventHandlerMap>(); | ||
| Object.assign(verifier, { | ||
| cancel: jest.fn(), | ||
| verify: jest.fn(), | ||
| }); | ||
| return verifier as unknown as Mocked<VerificationBase>; | ||
| } | ||
|
|
||
| function makeMockSasCallbacks(): ShowSasCallbacks { | ||
| const unicorn: EmojiMapping = ["🦄", "unicorn"]; | ||
| return { | ||
| sas: { | ||
| emoji: new Array<EmojiMapping>(7).fill(unicorn), | ||
| }, | ||
| cancel: jest.fn(), | ||
| confirm: jest.fn(), | ||
| mismatch: jest.fn(), | ||
| }; | ||
| } |