56 lines
1.7 KiB
TypeScript
56 lines
1.7 KiB
TypeScript
|
/*
|
||
|
|
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 EventEmitter from "events";
|
||
|
|
import { MethodKeysOf, mocked, MockedObject } from "jest-mock";
|
||
|
|
import { MatrixClient } from "matrix-js-sdk/src/matrix";
|
||
|
|
|
||
|
|
import { MatrixClientPeg } from "../../src/MatrixClientPeg";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Mock client with real event emitter
|
||
|
|
* useful for testing code that listens
|
||
|
|
* to MatrixClient events
|
||
|
|
*/
|
||
|
|
export class MockClientWithEventEmitter extends EventEmitter {
|
||
|
|
constructor(mockProperties: Partial<Record<MethodKeysOf<MatrixClient>, unknown>> = {}) {
|
||
|
|
super();
|
||
|
|
|
||
|
|
Object.assign(this, mockProperties);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* - make a mock client
|
||
|
|
* - cast the type to mocked(MatrixClient)
|
||
|
|
* - spy on MatrixClientPeg.get to return the mock
|
||
|
|
* eg
|
||
|
|
* ```
|
||
|
|
* const mockClient = getMockClientWithEventEmitter({
|
||
|
|
getUserId: jest.fn().mockReturnValue(aliceId),
|
||
|
|
});
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
export const getMockClientWithEventEmitter = (
|
||
|
|
mockProperties: Partial<Record<MethodKeysOf<MatrixClient>, unknown>>,
|
||
|
|
): MockedObject<MatrixClient> => {
|
||
|
|
const mock = mocked(new MockClientWithEventEmitter(mockProperties) as unknown as MatrixClient);
|
||
|
|
|
||
|
|
jest.spyOn(MatrixClientPeg, 'get').mockReturnValue(mock);
|
||
|
|
return mock;
|
||
|
|
};
|
||
|
|
|