mrva/vscode-codeql
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Make mocking helpers independent of vscode

Browse Source
This commit is contained in:
Koen Vlaswinkel
2024-01-16 15:39:10 +01:00
parent 4429385dfd
commit a3ade9984d
3 changed files with 85 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
extensions/ql-vscode/src/view/common/SuggestBox/__tests__/useOpenKey.test.ts
View File

@@ -1,7 +1,7 @@
import type { KeyboardEvent } from "react";
import { renderHook } from "@testing-library/react";
import type { FloatingContext } from "@floating-ui/react";
import { mockedObject } from "../../../../../test/vscode-tests/utils/mocking.helpers";
import { mockedObject } from "../../../../../test/mocked-object";
import { useOpenKey } from "../useOpenKey";
describe("useOpenKey", () => {

80
extensions/ql-vscode/test/mocked-object.ts Normal file
View File

@@ -0,0 +1,80 @@
export type DeepPartial<T> = T extends object
? {
[P in keyof T]?: DeepPartial<T[P]>;
}
: T;
type DynamicProperties<T extends object> = {
[P in keyof T]?: () => T[P];
};
type MockedObjectOptions<T extends object> = {
/**
* Properties for which the given method should be called when accessed.
* The method should return the value to be returned when the property is accessed.
* Methods which are explicitly defined in `methods` will take precedence over
* dynamic properties.
*/
dynamicProperties?: DynamicProperties<T>;
};
export function mockedObject<T extends object>(
props: DeepPartial<T>,
{ dynamicProperties }: MockedObjectOptions<T> = {},
): T {
return new Proxy<T>({} as unknown as T, {
get: (_target, prop) => {
if (prop in props) {
return (props as any)[prop];
}
if (dynamicProperties && prop in dynamicProperties) {
return (dynamicProperties as any)[prop]();
}
// The `then` method is accessed by `Promise.resolve` to check if the object is a thenable.
// We don't want to throw an error when this happens.
if (prop === "then") {
return undefined;
}
// The `asymmetricMatch` is accessed by jest to check if the object is a matcher.
// We don't want to throw an error when this happens.
if (prop === "asymmetricMatch") {
return undefined;
}
// The `Symbol.iterator` is accessed by jest to check if the object is iterable.
// We don't want to throw an error when this happens.
if (prop === Symbol.iterator) {
return undefined;
}
// The `$$typeof` is accessed by jest to check if the object is a React element.
// We don't want to throw an error when this happens.
if (prop === "$$typeof") {
return undefined;
}
// The `nodeType` and `tagName` are accessed by jest to check if the object is a DOM node.
// We don't want to throw an error when this happens.
if (prop === "nodeType" || prop === "tagName") {
return undefined;
}
// The `@@__IMMUTABLE_ITERABLE__@@` and variants are accessed by jest to check if the object is an
// immutable object (from Immutable.js).
// We don't want to throw an error when this happens.
if (prop.toString().startsWith("@@__IMMUTABLE_")) {
return undefined;
}
// The `Symbol.toStringTag` is accessed by jest.
// We don't want to throw an error when this happens.
if (prop === Symbol.toStringTag) {
return "MockedObject";
}
throw new Error(`Method ${String(prop)} not mocked`);
},
});
}

83
extensions/ql-vscode/test/vscode-tests/utils/mocking.helpers.ts
View File

@@ -2,86 +2,11 @@ import type { QuickPickItem, window, Uri } from "vscode";
import type { DatabaseItem } from "../../../src/databases/local-databases";
import type { Octokit } from "@octokit/rest";
export type DeepPartial<T> = T extends object
? {
[P in keyof T]?: DeepPartial<T[P]>;
}
: T;
import type { DeepPartial } from "../../mocked-object";
import { mockedObject } from "../../mocked-object";
type DynamicProperties<T extends object> = {
[P in keyof T]?: () => T[P];
};
type MockedObjectOptions<T extends object> = {
/**
* Properties for which the given method should be called when accessed.
* The method should return the value to be returned when the property is accessed.
* Methods which are explicitly defined in `methods` will take precedence over
* dynamic properties.
*/
dynamicProperties?: DynamicProperties<T>;
};
export function mockedObject<T extends object>(
props: DeepPartial<T>,
{ dynamicProperties }: MockedObjectOptions<T> = {},
): T {
return new Proxy<T>({} as unknown as T, {
get: (_target, prop) => {
if (prop in props) {
return (props as any)[prop];
}
if (dynamicProperties && prop in dynamicProperties) {
return (dynamicProperties as any)[prop]();
}
// The `then` method is accessed by `Promise.resolve` to check if the object is a thenable.
// We don't want to throw an error when this happens.
if (prop === "then") {
return undefined;
}
// The `asymmetricMatch` is accessed by jest to check if the object is a matcher.
// We don't want to throw an error when this happens.
if (prop === "asymmetricMatch") {
return undefined;
}
// The `Symbol.iterator` is accessed by jest to check if the object is iterable.
// We don't want to throw an error when this happens.
if (prop === Symbol.iterator) {
return undefined;
}
// The `$$typeof` is accessed by jest to check if the object is a React element.
// We don't want to throw an error when this happens.
if (prop === "$$typeof") {
return undefined;
}
// The `nodeType` and `tagName` are accessed by jest to check if the object is a DOM node.
// We don't want to throw an error when this happens.
if (prop === "nodeType" || prop === "tagName") {
return undefined;
}
// The `@@__IMMUTABLE_ITERABLE__@@` and variants are accessed by jest to check if the object is an
// immutable object (from Immutable.js).
// We don't want to throw an error when this happens.
if (prop.toString().startsWith("@@__IMMUTABLE_")) {
return undefined;
}
// The `Symbol.toStringTag` is accessed by jest.
// We don't want to throw an error when this happens.
if (prop === Symbol.toStringTag) {
return "MockedObject";
}
throw new Error(`Method ${String(prop)} not mocked`);
},
});
}
export { mockedObject };
export type { DeepPartial };
export function mockedOctokitFunction<
Namespace extends keyof Octokit["rest"],