Skip to content

Commit a50b39a

Browse files
mbgmbg
authored
Merge pull request #4235 from github/mbg/deprecate-getRunnerLogger
Remove `getRunnerLogger`
2 parents d04fe60 + 487ba2e commit a50b39a

30 files changed

Lines changed: 329 additions & 251 deletions

‎lib/entry-points.js‎

Lines changed: 16 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/actions-util.test.ts‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ import {
1111
} from "./actions-util";
1212
import { computeAutomationID } from "./api-client";
1313
import { EnvVar } from "./environment";
14-
import { getRunnerLogger } from "./logging";
1514
import { RecordingLogger, setupTests } from "./testing-utils";
1615
import { initializeEnvironment, withTmpDir } from "./util";
1716

@@ -238,7 +237,7 @@ test.serial("fixCodeQualityCategory", (t) => {
238237
GITHUB_EVENT_NAME: "dynamic",
239238
},
240239
() => {
241-
const logger = getRunnerLogger(true);
240+
const logger = new RecordingLogger();
242241

243242
// Categories that should get adjusted.
244243
t.is(fixCodeQualityCategory(logger, "/language:c#"), "/language:csharp");

‎src/analyses.test.ts‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ import {
1515
supportedAnalysisKinds,
1616
} from "./analyses";
1717
import { EnvVar } from "./environment";
18-
import { getRunnerLogger } from "./logging";
1918
import {
2019
createFeatures,
2120
RecordingLogger,
@@ -65,7 +64,7 @@ test.serial(
6564
.withArgs("analysis-kinds")
6665
.returns("code-scanning,code-quality");
6766
const result = await getAnalysisKinds(
68-
getRunnerLogger(true),
67+
new RecordingLogger(),
6968
features,
7069
true,
7170
);
@@ -139,7 +138,7 @@ test.serial(
139138
const optionalInputStub = sinon.stub(actionsUtil, "getOptionalInput");
140139
optionalInputStub.withArgs("quality-queries").returns("code-quality");
141140
const result = await getAnalysisKinds(
142-
getRunnerLogger(true),
141+
new RecordingLogger(),
143142
features,
144143
true,
145144
);
@@ -155,7 +154,7 @@ test.serial(
155154
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
156155
requiredInputStub.withArgs("analysis-kinds").returns("no-such-thing");
157156
await t.throwsAsync(
158-
getAnalysisKinds(getRunnerLogger(true), features, true),
157+
getAnalysisKinds(new RecordingLogger(), features, true),
159158
);
160159
},
161160
);
@@ -181,7 +180,7 @@ for (let i = 0; i < analysisKinds.length; i++) {
181180
.withArgs("analysis-kinds")
182181
.returns([analysisKind, otherAnalysis].join(","));
183182
const result = await getAnalysisKinds(
184-
getRunnerLogger(true),
183+
new RecordingLogger(),
185184
features,
186185
true,
187186
);
@@ -199,7 +198,7 @@ for (let i = 0; i < analysisKinds.length; i++) {
199198
.withArgs("analysis-kinds")
200199
.returns([analysisKind, otherAnalysis].join(","));
201200
await t.throwsAsync(
202-
getAnalysisKinds(getRunnerLogger(true), features, true),
201+
getAnalysisKinds(new RecordingLogger(), features, true),
203202
{
204203
instanceOf: ConfigurationError,
205204
message: `${analysisKind} and ${otherAnalysis} cannot be enabled at the same time`,

‎src/analyze.test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ import { defaultSuites } from "./config/db-config";
1717
import { Feature } from "./feature-flags";
1818
import * as gitUtils from "./git-utils";
1919
import { BuiltInLanguage } from "./languages";
20-
import { getRunnerLogger } from "./logging";
2120
import {
2221
setupTests,
2322
setupActionsVars,
2423
createFeatures,
2524
createTestConfig,
25+
RecordingLogger,
2626
callee,
2727
} from "./testing-utils";
2828
import * as uploadLib from "./upload-lib";
@@ -195,7 +195,7 @@ test.serial("status report fields", async (t) => {
195195
undefined,
196196
codeql,
197197
config,
198-
getRunnerLogger(true),
198+
new RecordingLogger(),
199199
createFeatures([Feature.QaTelemetryEnabled]),
200200
);
201201
t.deepEqual(Object.keys(statusReport).sort(), [

‎src/artifact-scanner.test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ import {
1010
scanArtifactsForTokens,
1111
TokenType,
1212
} from "./artifact-scanner";
13-
import { getRunnerLogger } from "./logging";
1413
import {
1514
checkExpectedLogMessages,
1615
getRecordingLogger,
1716
LoggedMessage,
1817
makeTestToken,
18+
RecordingLogger,
1919
} from "./testing-utils";
2020

2121
test("makeTestToken", (t) => {
@@ -121,7 +121,7 @@ for (const { type, value, checkPattern } of testTokens) {
121121
}
122122

123123
test("scanArtifactsForTokens handles files without tokens", async (t) => {
124-
const logger = getRunnerLogger(true);
124+
const logger = new RecordingLogger();
125125
const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), "scanner-test-"));
126126

127127
try {

‎src/cli/output-cache.test.ts‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,14 @@ import path from "path";
33

44
import test from "ava";
55

6-
import { getRunnerLogger } from "../logging";
7-
import { setupTests } from "../testing-utils";
6+
import { RecordingLogger, setupTests } from "../testing-utils";
87
import * as util from "../util";
98

109
import { getCachedCodeQlVersion } from "./output-cache";
1110

1211
setupTests(test);
1312

14-
const logger = getRunnerLogger(true);
13+
const logger = new RecordingLogger();
1514

1615
test.serial(
1716
"getCachedCodeQlVersion reuses a version persisted by an earlier step",

‎src/codeql.test.ts‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ import type { Config } from "./config-utils";
2222
import * as defaults from "./defaults.json";
2323
import { DocUrl } from "./doc-url";
2424
import { BuiltInLanguage } from "./languages";
25-
import { getRunnerLogger } from "./logging";
2625
import { ToolsSource } from "./setup-codeql";
2726
import {
2827
setupTests,
@@ -34,6 +33,8 @@ import {
3433
makeVersionInfo,
3534
createTestConfig,
3635
makeMacro,
36+
getCodeQLForTesting,
37+
RecordingLogger,
3738
} from "./testing-utils";
3839
import { ToolsDownloadStatusReport } from "./tools-download";
3940
import * as util from "./util";
@@ -102,7 +103,7 @@ async function installIntoToolcache({
102103
undefined, // otherLanguagePacksReason
103104
false, // useOverlayAwareDefaultCliVersion
104105
createFeatures([]),
105-
getRunnerLogger(true),
106+
new RecordingLogger(),
106107
false,
107108
);
108109
}
@@ -140,7 +141,7 @@ function mockApiDetails(apiDetails: Required<GitHubApiDetails>) {
140141
}
141142

142143
async function stubCodeql(): Promise<codeql.CodeQL> {
143-
const codeqlObject = await codeql.getCodeQLForTesting();
144+
const codeqlObject = await getCodeQLForTesting();
144145
sinon.stub(codeqlObject, "getVersion").resolves(makeVersionInfo("2.17.6"));
145146
sinon
146147
.stub(codeqlObject, "isTracedLanguage")
@@ -176,7 +177,7 @@ test.serial(
176177
undefined, // otherLanguagePacksReason
177178
false, // useOverlayAwareDefaultCliVersion
178179
features,
179-
getRunnerLogger(true),
180+
new RecordingLogger(),
180181
false,
181182
);
182183

@@ -212,7 +213,7 @@ test.serial(
212213
undefined, // otherLanguagePacksReason
213214
false, // useOverlayAwareDefaultCliVersion
214215
features,
215-
getRunnerLogger(true),
216+
new RecordingLogger(),
216217
false,
217218
);
218219

@@ -252,7 +253,7 @@ test.serial(
252253
undefined, // otherLanguagePacksReason
253254
false, // useOverlayAwareDefaultCliVersion
254255
features,
255-
getRunnerLogger(true),
256+
new RecordingLogger(),
256257
false,
257258
);
258259
t.assert(toolcache.find("CodeQL", "0.0.0-20200610"));
@@ -362,7 +363,7 @@ for (const {
362363
undefined, // otherLanguagePacksReason
363364
false, // useOverlayAwareDefaultCliVersion
364365
features,
365-
getRunnerLogger(true),
366+
new RecordingLogger(),
366367
false,
367368
);
368369
t.assert(toolcache.find("CodeQL", expectedToolcacheVersion));
@@ -405,7 +406,7 @@ for (const toolcacheVersion of [
405406
undefined, // otherLanguagePacksReason
406407
false, // useOverlayAwareDefaultCliVersion
407408
features,
408-
getRunnerLogger(true),
409+
new RecordingLogger(),
409410
false,
410411
);
411412
t.is(
@@ -450,7 +451,7 @@ test.serial(
450451
undefined, // otherLanguagePacksReason
451452
false, // useOverlayAwareDefaultCliVersion
452453
features,
453-
getRunnerLogger(true),
454+
new RecordingLogger(),
454455
false,
455456
);
456457
t.deepEqual(result.toolsVersion, "0.0.0-20200601");
@@ -497,7 +498,7 @@ test.serial(
497498
undefined, // otherLanguagePacksReason
498499
false, // useOverlayAwareDefaultCliVersion
499500
features,
500-
getRunnerLogger(true),
501+
new RecordingLogger(),
501502
false,
502503
);
503504
t.deepEqual(result.toolsVersion, defaults.cliVersion);
@@ -537,7 +538,7 @@ test.serial(
537538
undefined, // otherLanguagePacksReason
538539
false, // useOverlayAwareDefaultCliVersion
539540
features,
540-
getRunnerLogger(true),
541+
new RecordingLogger(),
541542
false,
542543
);
543544
t.deepEqual(result.toolsVersion, defaults.cliVersion);
@@ -579,7 +580,7 @@ test.serial(
579580
undefined, // otherLanguagePacksReason
580581
false, // useOverlayAwareDefaultCliVersion
581582
features,
582-
getRunnerLogger(true),
583+
new RecordingLogger(),
583584
false,
584585
);
585586

@@ -664,7 +665,7 @@ const injectedConfigMacro = makeMacro({
664665
tempDir,
665666
};
666667
thisStubConfig.computedConfig = generateCodeScanningConfig(
667-
getRunnerLogger(true),
668+
new RecordingLogger(),
668669
thisStubConfig.originalUserInput,
669670
augmentationProperties,
670671
);
@@ -1039,7 +1040,7 @@ test.serial("runTool summarizes autobuilder errors", async (t) => {
10391040
[2019-09-18 12:00:01] [autobuild] A non-error message
10401041
`;
10411042
stubToolRunnerConstructor(1, stderr);
1042-
const codeqlObject = await codeql.getCodeQLForTesting();
1043+
const codeqlObject = await getCodeQLForTesting();
10431044
sinon.stub(codeqlObject, "getVersion").resolves(makeVersionInfo("2.17.6"));
10441045
sinon.stub(codeqlObject, "resolveExtractor").resolves("/path/to/extractor");
10451046
// io throws because of the test CodeQL object.
@@ -1095,7 +1096,7 @@ test.serial("runTool recognizes fatal internal errors", async (t) => {
10951096
com.semmle.util.exception.CatastrophicError: An error occurred while evaluating ControlFlowGraph::ControlFlow::Root.isRootOf/1#dispred#f610e6ed/2@86282cc8
10961097
Severe disk cache trouble (corruption or out of space) at /home/runner/work/_temp/codeql_databases/go/db-go/default/cache/pages/28/33.pack: Failed to write item to disk`;
10971098
stubToolRunnerConstructor(1, stderr);
1098-
const codeqlObject = await codeql.getCodeQLForTesting();
1099+
const codeqlObject = await getCodeQLForTesting();
10991100
sinon.stub(codeqlObject, "getVersion").resolves(makeVersionInfo("2.17.6"));
11001101
sinon.stub(codeqlObject, "resolveExtractor").resolves("/path/to/extractor");
11011102
// io throws because of the test CodeQL object.

‎src/codeql.ts‎

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import {
2626
} from "./feature-flags";
2727
import { isAnalyzingDefaultBranch } from "./git-utils";
2828
import { Language } from "./languages";
29-
import { getRunnerLogger, Logger } from "./logging";
29+
import type { Logger } from "./logging";
3030
import { writeBaseDatabaseOidsFile, writeOverlayChangesFile } from "./overlay";
3131
import { OverlayDatabaseMode } from "./overlay/overlay-database-mode";
3232
import * as setupCodeql from "./setup-codeql";
@@ -486,18 +486,6 @@ export function createStubCodeQL(partialCodeql: Partial<CodeQL>): CodeQL {
486486
};
487487
}
488488

489-
/**
490-
* Get a real, newly created CodeQL instance for testing. The instance refers to
491-
* a non-existent placeholder codeql command, so tests that use this function
492-
* should also stub the toolrunner.ToolRunner constructor.
493-
*/
494-
export async function getCodeQLForTesting(
495-
cmd = "codeql-for-testing",
496-
logger: Logger = getRunnerLogger(true),
497-
): Promise<CodeQL> {
498-
return getCodeQLForCmd(logger, cmd, false);
499-
}
500-
501489
/**
502490
* Return a CodeQL object for CodeQL CLI access.
503491
*
@@ -506,7 +494,7 @@ export async function getCodeQLForTesting(
506494
* version requirement. Must be set to true outside tests.
507495
* @returns A new CodeQL object
508496
*/
509-
async function getCodeQLForCmd(
497+
export async function getCodeQLForCmd(
510498
logger: Logger,
511499
cmd: string,
512500
checkVersion: boolean,

0 commit comments

Comments
 (0)