Skip to content

Commit 23d418c

Browse files
committed
Remove getRunnerLogger
1 parent 924990a commit 23d418c

26 files changed

Lines changed: 195 additions & 220 deletions

‎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
@@ -15,12 +15,12 @@ import { createStubCodeQL } from "./codeql";
1515
import { defaultSuites } from "./config/db-config";
1616
import { Feature } from "./feature-flags";
1717
import { BuiltInLanguage } from "./languages";
18-
import { getRunnerLogger } from "./logging";
1918
import {
2019
setupTests,
2120
setupActionsVars,
2221
createFeatures,
2322
createTestConfig,
23+
RecordingLogger,
2424
} from "./testing-utils";
2525
import * as uploadLib from "./upload-lib";
2626
import * as util from "./util";
@@ -107,7 +107,7 @@ test.serial("status report fields", async (t) => {
107107
undefined,
108108
codeql,
109109
config,
110-
getRunnerLogger(true),
110+
new RecordingLogger(),
111111
createFeatures([Feature.QaTelemetryEnabled]),
112112
);
113113
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: 12 additions & 12 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,
@@ -35,6 +34,7 @@ import {
3534
createTestConfig,
3635
makeMacro,
3736
getCodeQLForTesting,
37+
RecordingLogger,
3838
} from "./testing-utils";
3939
import { ToolsDownloadStatusReport } from "./tools-download";
4040
import * as util from "./util";
@@ -103,7 +103,7 @@ async function installIntoToolcache({
103103
undefined, // otherLanguagePacksReason
104104
false, // useOverlayAwareDefaultCliVersion
105105
createFeatures([]),
106-
getRunnerLogger(true),
106+
new RecordingLogger(),
107107
false,
108108
);
109109
}
@@ -177,7 +177,7 @@ test.serial(
177177
undefined, // otherLanguagePacksReason
178178
false, // useOverlayAwareDefaultCliVersion
179179
features,
180-
getRunnerLogger(true),
180+
new RecordingLogger(),
181181
false,
182182
);
183183

@@ -213,7 +213,7 @@ test.serial(
213213
undefined, // otherLanguagePacksReason
214214
false, // useOverlayAwareDefaultCliVersion
215215
features,
216-
getRunnerLogger(true),
216+
new RecordingLogger(),
217217
false,
218218
);
219219

@@ -253,7 +253,7 @@ test.serial(
253253
undefined, // otherLanguagePacksReason
254254
false, // useOverlayAwareDefaultCliVersion
255255
features,
256-
getRunnerLogger(true),
256+
new RecordingLogger(),
257257
false,
258258
);
259259
t.assert(toolcache.find("CodeQL", "0.0.0-20200610"));
@@ -363,7 +363,7 @@ for (const {
363363
undefined, // otherLanguagePacksReason
364364
false, // useOverlayAwareDefaultCliVersion
365365
features,
366-
getRunnerLogger(true),
366+
new RecordingLogger(),
367367
false,
368368
);
369369
t.assert(toolcache.find("CodeQL", expectedToolcacheVersion));
@@ -406,7 +406,7 @@ for (const toolcacheVersion of [
406406
undefined, // otherLanguagePacksReason
407407
false, // useOverlayAwareDefaultCliVersion
408408
features,
409-
getRunnerLogger(true),
409+
new RecordingLogger(),
410410
false,
411411
);
412412
t.is(
@@ -451,7 +451,7 @@ test.serial(
451451
undefined, // otherLanguagePacksReason
452452
false, // useOverlayAwareDefaultCliVersion
453453
features,
454-
getRunnerLogger(true),
454+
new RecordingLogger(),
455455
false,
456456
);
457457
t.deepEqual(result.toolsVersion, "0.0.0-20200601");
@@ -498,7 +498,7 @@ test.serial(
498498
undefined, // otherLanguagePacksReason
499499
false, // useOverlayAwareDefaultCliVersion
500500
features,
501-
getRunnerLogger(true),
501+
new RecordingLogger(),
502502
false,
503503
);
504504
t.deepEqual(result.toolsVersion, defaults.cliVersion);
@@ -538,7 +538,7 @@ test.serial(
538538
undefined, // otherLanguagePacksReason
539539
false, // useOverlayAwareDefaultCliVersion
540540
features,
541-
getRunnerLogger(true),
541+
new RecordingLogger(),
542542
false,
543543
);
544544
t.deepEqual(result.toolsVersion, defaults.cliVersion);
@@ -580,7 +580,7 @@ test.serial(
580580
undefined, // otherLanguagePacksReason
581581
false, // useOverlayAwareDefaultCliVersion
582582
features,
583-
getRunnerLogger(true),
583+
new RecordingLogger(),
584584
false,
585585
);
586586

@@ -665,7 +665,7 @@ const injectedConfigMacro = makeMacro({
665665
tempDir,
666666
};
667667
thisStubConfig.computedConfig = generateCodeScanningConfig(
668-
getRunnerLogger(true),
668+
new RecordingLogger(),
669669
thisStubConfig.originalUserInput,
670670
augmentationProperties,
671671
);

‎src/config-utils.test.ts‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ import { RepositoryProperties } from "./feature-flags/properties";
2121
import * as gitUtils from "./git-utils";
2222
import { GitVersionInfo } from "./git-utils";
2323
import { BuiltInLanguage, Language } from "./languages";
24-
import { getRunnerLogger } from "./logging";
2524
import { CODEQL_OVERLAY_MINIMUM_VERSION } from "./overlay";
2625
import * as overlayDiagnostics from "./overlay/diagnostics";
2726
import { OverlayDisabledReason } from "./overlay/diagnostics";
@@ -42,6 +41,7 @@ import {
4241
callee,
4342
SAMPLE_DOTCOM_API_DETAILS,
4443
AssertableTarget,
44+
RecordingLogger,
4545
} from "./testing-utils";
4646
import {
4747
GitHubVariant,
@@ -102,7 +102,7 @@ function createTestInitConfigInputs(
102102
features: createFeatures([]),
103103
repositoryProperties: {},
104104
enableFileCoverageInformation: true,
105-
logger: getRunnerLogger(true),
105+
logger: new RecordingLogger(),
106106
} satisfies configUtils.InitConfigInputs,
107107
overrides,
108108
);
@@ -150,7 +150,7 @@ function mockListLanguages(languages: string[]) {
150150

151151
test.serial("load empty config", async (t) => {
152152
return await withTmpDir(async (tempDir) => {
153-
const logger = getRunnerLogger(true);
153+
const logger = new RecordingLogger();
154154
const languages = "javascript,python";
155155

156156
setupActionsVars(tempDir, tempDir);
@@ -194,7 +194,7 @@ test.serial("load empty config", async (t) => {
194194

195195
test.serial("load code quality config", async (t) => {
196196
return await withTmpDir(async (tempDir) => {
197-
const logger = getRunnerLogger(true);
197+
const logger = new RecordingLogger();
198198
const languages = "actions";
199199

200200
setupActionsVars(tempDir, tempDir);
@@ -249,7 +249,7 @@ test.serial(
249249
"initActionState doesn't throw if there are queries configured in the repository properties",
250250
async (t) => {
251251
return await withTmpDir(async (tempDir) => {
252-
const logger = getRunnerLogger(true);
252+
const logger = new RecordingLogger();
253253
const languages = "javascript";
254254

255255
setupActionsVars(tempDir, tempDir);
@@ -311,7 +311,7 @@ test.serial(
311311

312312
test.serial("loading a saved config produces the same config", async (t) => {
313313
return await withTmpDir(async (tempDir) => {
314-
const logger = getRunnerLogger(true);
314+
const logger = new RecordingLogger();
315315

316316
const codeql = createStubCodeQL({
317317
async resolveLanguages() {
@@ -359,7 +359,7 @@ test.serial("loading a saved config produces the same config", async (t) => {
359359

360360
test.serial("loading config with version mismatch throws", async (t) => {
361361
return await withTmpDir(async (tempDir) => {
362-
const logger = getRunnerLogger(true);
362+
const logger = new RecordingLogger();
363363

364364
const codeql = createStubCodeQL({
365365
async resolveLanguages() {
@@ -782,12 +782,12 @@ test.serial("Unknown languages", async (t) => {
782782
});
783783
});
784784

785-
const mockLogger = getRunnerLogger(true);
785+
const mockLogger = new RecordingLogger();
786786

787787
test.serial("no generateRegistries when registries is undefined", async (t) => {
788788
return await withTmpDir(async (tmpDir) => {
789789
const registriesInput = undefined;
790-
const logger = getRunnerLogger(true);
790+
const logger = new RecordingLogger();
791791
const { registriesAuthTokens, qlconfigFile } =
792792
await configUtils.generateRegistries(registriesInput, tmpDir, logger);
793793

@@ -808,7 +808,7 @@ test.serial(
808808
token: "not-a-token",
809809
},
810810
]);
811-
const logger = getRunnerLogger(true);
811+
const logger = new RecordingLogger();
812812
const { registriesAuthTokens, qlconfigFile } =
813813
await configUtils.generateRegistries(registriesInput, tmpDir, logger);
814814

@@ -2245,7 +2245,7 @@ test("applyIncrementalAnalysisSettings: no-op when mode is not Overlay and diff
22452245
const config = createTestConfig({});
22462246
config.overlayDatabaseMode = OverlayDatabaseMode.None;
22472247
const codeql = createStubCodeQL({});
2248-
const logger = getRunnerLogger(true);
2248+
const logger = new RecordingLogger();
22492249

22502250
await configUtils.applyIncrementalAnalysisSettings(
22512251
config,
@@ -2263,7 +2263,7 @@ test("applyIncrementalAnalysisSettings: keeps overlay mode and adds exclusions w
22632263
overlayDatabaseMode: OverlayDatabaseMode.Overlay,
22642264
});
22652265
const codeql = createStubCodeQL({});
2266-
const logger = getRunnerLogger(true);
2266+
const logger = new RecordingLogger();
22672267

22682268
await configUtils.applyIncrementalAnalysisSettings(
22692269
config,
@@ -2286,7 +2286,7 @@ test.serial(
22862286
});
22872287
config.useOverlayDatabaseCaching = true;
22882288
const codeql = createStubCodeQL({});
2289-
const logger = getRunnerLogger(true);
2289+
const logger = new RecordingLogger();
22902290
const addDiagnosticsStub = sinon
22912291
.stub(overlayDiagnostics, "addOverlayDisablementDiagnostics")
22922292
.resolves();
@@ -2318,7 +2318,7 @@ test.serial(
23182318
config.useOverlayDatabaseCaching = false;
23192319
config.overlayModeSetExplicitly = true;
23202320
const codeql = createStubCodeQL({});
2321-
const logger = getRunnerLogger(true);
2321+
const logger = new RecordingLogger();
23222322
const addDiagnosticsStub = sinon
23232323
.stub(overlayDiagnostics, "addOverlayDisablementDiagnostics")
23242324
.resolves();
@@ -2341,7 +2341,7 @@ test("applyIncrementalAnalysisSettings: adds exclusions for diff-informed-only r
23412341
const config = createTestConfig({});
23422342
config.overlayDatabaseMode = OverlayDatabaseMode.None;
23432343
const codeql = createStubCodeQL({});
2344-
const logger = getRunnerLogger(true);
2344+
const logger = new RecordingLogger();
23452345

23462346
await configUtils.applyIncrementalAnalysisSettings(
23472347
config,
@@ -2555,7 +2555,7 @@ test("determineUserConfig - merges configs if FF is enabled in Default Setup", a
25552555
// also check whether loading the configuration from disk that was written
25562556
// by `determineUserConfig` matches our expectations.
25572557
const loadedFromDisk = configUtils.getLocalConfig(
2558-
getRunnerLogger(true),
2558+
new RecordingLogger(),
25592559
expectedConfigPath,
25602560
false,
25612561
);

0 commit comments

Comments
 (0)