Skip to content

Commit e26e111

Browse files
committed
Remove calls to fail
Instead of calling `fail` and catching an error, this will use the `rejects.toThrow` assertion to check that a Promise rejects with a specific error.
1 parent 01f6576 commit e26e111

4 files changed

Lines changed: 30 additions & 59 deletions

File tree

extensions/ql-vscode/src/vscode-tests/no-workspace/query-history.test.ts

Lines changed: 17 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ import {
2020
TWO_HOURS_IN_MS,
2121
} from "../../pure/time";
2222
import { tmpDir } from "../../helpers";
23-
import { getErrorMessage } from "../../pure/helpers-pure";
2423
import { HistoryItemLabelProvider } from "../../history-item-label-provider";
2524
import { RemoteQueriesManager } from "../../remote-queries/remote-queries-manager";
2625
import { ResultsView } from "../../interface";
@@ -939,52 +938,38 @@ describe("query-history", () => {
939938
}),
940939
});
941940

942-
try {
943-
await (queryHistoryManager as any).findOtherQueryToCompare(
941+
await expect(
942+
(queryHistoryManager as any).findOtherQueryToCompare(thisQuery, [
944943
thisQuery,
945-
[thisQuery, allHistory[0]],
946-
);
947-
fail("Should have thrown");
948-
} catch (e) {
949-
expect(getErrorMessage(e)).toBe(
950-
"Please select a successful query.",
951-
);
952-
}
944+
allHistory[0],
945+
]),
946+
).rejects.toThrow("Please select a successful query.");
953947
});
954948

955949
it("should throw an error when a databases are not the same", async () => {
956950
queryHistoryManager = await createMockQueryHistory(allHistory);
957951

958-
try {
959-
// localQueryHistory[0] is database a
960-
// localQueryHistory[1] is database b
961-
await (queryHistoryManager as any).findOtherQueryToCompare(
952+
// localQueryHistory[0] is database a
953+
// localQueryHistory[1] is database b
954+
await expect(
955+
(queryHistoryManager as any).findOtherQueryToCompare(
962956
localQueryHistory[0],
963957
[localQueryHistory[0], localQueryHistory[1]],
964-
);
965-
fail("Should have thrown");
966-
} catch (e) {
967-
expect(getErrorMessage(e)).toBe(
968-
"Query databases must be the same.",
969-
);
970-
}
958+
),
959+
).rejects.toThrow("Query databases must be the same.");
971960
});
972961

973962
it("should throw an error when more than 2 queries selected", async () => {
974963
const thisQuery = localQueryHistory[3];
975964
queryHistoryManager = await createMockQueryHistory(allHistory);
976965

977-
try {
978-
await (queryHistoryManager as any).findOtherQueryToCompare(
966+
await expect(
967+
(queryHistoryManager as any).findOtherQueryToCompare(thisQuery, [
979968
thisQuery,
980-
[thisQuery, localQueryHistory[0], localQueryHistory[1]],
981-
);
982-
fail("Should have thrown");
983-
} catch (e) {
984-
expect(getErrorMessage(e)).toBe(
985-
"Please select no more than 2 queries.",
986-
);
987-
}
969+
localQueryHistory[0],
970+
localQueryHistory[1],
971+
]),
972+
).rejects.toThrow("Please select no more than 2 queries.");
988973
});
989974
});
990975

extensions/ql-vscode/src/vscode-tests/no-workspace/remote-queries/gh-api/gh-actions-api-client.test.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import { fail } from "assert";
21
import { Credentials } from "../../../../authentication";
32
import {
43
cancelRemoteQuery,
@@ -124,7 +123,7 @@ describe("gh-actions-api-client real responses", () => {
124123
function skip() {
125124
if (!process.env.VSCODE_CODEQL_GITHUB_TOKEN) {
126125
if (process.env.CI) {
127-
fail(
126+
throw new Error(
128127
"The VSCODE_CODEQL_GITHUB_TOKEN must be set to a valid GITHUB token on CI",
129128
);
130129
} else {

extensions/ql-vscode/src/vscode-tests/no-workspace/remote-queries/remote-query-history.test.ts

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ import { RemoteQueryResult } from "../../../remote-queries/shared/remote-query-r
2020
import { DisposableBucket } from "../../disposable-bucket";
2121
import { testDisposeHandler } from "../../test-dispose-handler";
2222
import { walkDirectory } from "../../../helpers";
23-
import { getErrorMessage } from "../../../pure/helpers-pure";
2423
import { HistoryItemLabelProvider } from "../../../history-item-label-provider";
2524
import { RemoteQueriesManager } from "../../../remote-queries/remote-queries-manager";
2625
import { ResultsView } from "../../../interface";
@@ -394,18 +393,15 @@ describe("Remote queries and query history manager", () => {
394393
const publisher = jest.fn();
395394
const analysisSummaries = [...remoteQueryResult0.analysisSummaries];
396395

397-
try {
398-
await arm.loadAnalysesResults(
396+
await expect(
397+
arm.loadAnalysesResults(
399398
analysisSummaries,
400399
{
401400
isCancellationRequested: true,
402401
} as CancellationToken,
403402
publisher,
404-
);
405-
fail("Should have thrown");
406-
} catch (e) {
407-
expect(getErrorMessage(e)).toContain("cancelled");
408-
}
403+
),
404+
).rejects.toThrow(/cancelled/);
409405

410406
expect(publisher).not.toBeCalled();
411407
});

extensions/ql-vscode/src/vscode-tests/no-workspace/telemetry.test.ts

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ import {
1010
telemetryListener as globalTelemetryListener,
1111
} from "../../telemetry";
1212
import { UserCancellationException } from "../../commandRunner";
13-
import { fail } from "assert";
1413
import { ENABLE_TELEMETRY } from "../../config";
1514
import { createMockExtensionContext } from "./index";
1615

@@ -105,27 +104,19 @@ describe("telemetry reporting", () => {
105104
});
106105

107106
it("should initialize telemetry when global option disabled", async () => {
108-
try {
109-
await enableTelemetry("telemetry", false);
110-
await telemetryListener.initialize();
111-
expect(telemetryListener._reporter).toBeDefined();
107+
await enableTelemetry("telemetry", false);
108+
await telemetryListener.initialize();
109+
expect(telemetryListener._reporter).toBeDefined();
112110

113-
const reporter: any = telemetryListener._reporter;
114-
expect(reporter.userOptIn).toBe(false); // disabled
115-
} catch (e) {
116-
fail(e as Error);
117-
}
111+
const reporter: any = telemetryListener._reporter;
112+
expect(reporter.userOptIn).toBe(false); // disabled
118113
});
119114

120115
it("should not initialize telemetry when extension option disabled", async () => {
121-
try {
122-
await enableTelemetry("codeQL.telemetry", false);
123-
await telemetryListener.initialize();
116+
await enableTelemetry("codeQL.telemetry", false);
117+
await telemetryListener.initialize();
124118

125-
expect(telemetryListener._reporter).toBeUndefined();
126-
} catch (e) {
127-
fail(e as Error);
128-
}
119+
expect(telemetryListener._reporter).toBeUndefined();
129120
});
130121

131122
it("should not initialize telemetry when both options disabled", async () => {

0 commit comments

Comments
 (0)