robojerk/codeql-action

Extract logging statements to separate function

Browse source
This commit is contained in:
Andrew Eisenberg 2022-10-03 08:17:27 -07:00
parent 59fbe34861
commit 5960ce1190
9 changed files with 35 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

7
lib/analyze.js generated
View file

@ -136,12 +136,7 @@ async function runQueries(sarifFolder, memoryFlag, addSnippetsFlag, threadsFlag,
config.paths, config.pathsIgnore, config.languages, logger); config.paths, config.pathsIgnore, config.languages, logger);
} }
const codeql = await (0, codeql_1.getCodeQL)(config.codeQLCmd); const codeql = await (0, codeql_1.getCodeQL)(config.codeQLCmd);
if (await util.useCodeScanningConfigInCli(codeql, featureFlags)) { await util.logCodeScanningConfigInCli(codeql, featureFlags, logger);
logger.info("Code Scanning configuration file being processed in the codeql-action.");
}
else {
logger.info("Code Scanning configuration file being processed in the codeql CLI.");
}
for (const language of config.languages) { for (const language of config.languages) {
const queries = config.queries[language]; const queries = config.queries[language];
const queryFilters = validateQueryFilters(config.originalUserInput["query-filters"]); const queryFilters = validateQueryFilters(config.originalUserInput["query-filters"]);

2
lib/analyze.js.map
View file

File diff suppressed because one or more lines are too long

5
lib/config-utils.js generated
View file

@ -908,14 +908,11 @@ async function initConfig(languagesInput, queriesInput, packsInput, registriesIn
// When using the codescanning config in the CLI, pack downloads // When using the codescanning config in the CLI, pack downloads
// happen in the CLI during the `database init` command, so no need // happen in the CLI during the `database init` command, so no need
// to download them here. // to download them here.
await (0, util_1.logCodeScanningConfigInCli)(codeQL, featureFlags, logger);
if (!(await (0, util_1.useCodeScanningConfigInCli)(codeQL, featureFlags))) { if (!(await (0, util_1.useCodeScanningConfigInCli)(codeQL, featureFlags))) {
logger.info("Code Scanning configuration file being processed in the codeql CLI.");
const registries = parseRegistries(registriesInput); const registries = parseRegistries(registriesInput);
await downloadPacks(codeQL, config.languages, config.packs, registries, apiDetails, config.tempDir, logger); await downloadPacks(codeQL, config.languages, config.packs, registries, apiDetails, config.tempDir, logger);
} }
else {
logger.info("Code Scanning configuration file being processed in the codeql-action.");
}
// Save the config so we can easily access it again in the future // Save the config so we can easily access it again in the future
await saveConfig(config, logger); await saveConfig(config, logger);
return config; return config;

2
lib/config-utils.js.map
View file

File diff suppressed because one or more lines are too long

11
lib/util.js generated
View file

@ -22,7 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod }; return (mod && mod.__esModule) ? mod : { "default": mod };
}; };
Object.defineProperty(exports, "__esModule", { value: true }); Object.defineProperty(exports, "__esModule", { value: true });
exports.withTimeout = exports.tryGetFolderBytes = exports.isGoExtractionReconciliationEnabled = exports.listFolder = exports.doesDirectoryExist = exports.useCodeScanningConfigInCli = exports.isInTestMode = exports.checkActionVersion = exports.getMlPoweredJsQueriesStatus = exports.getMlPoweredJsQueriesPack = exports.ML_POWERED_JS_QUERIES_PACK_NAME = exports.isGoodVersion = exports.delay = exports.bundleDb = exports.codeQlVersionAbove = exports.getCachedCodeQlVersion = exports.cacheCodeQlVersion = exports.isGitHubGhesVersionBelow = exports.isHTTPError = exports.UserError = exports.HTTPError = exports.getRequiredEnvParam = exports.isActions = exports.getMode = exports.enrichEnvironment = exports.initializeEnvironment = exports.EnvVar = exports.Mode = exports.assertNever = exports.getGitHubAuth = exports.apiVersionInRange = exports.DisallowedAPIVersionReason = exports.checkGitHubVersionInRange = exports.getGitHubVersion = exports.GitHubVariant = exports.parseGitHubUrl = exports.getCodeQLDatabasePath = exports.getThreadsFlag = exports.getThreadsFlagValue = exports.getAddSnippetsFlag = exports.getMemoryFlag = exports.getMemoryFlagValue = exports.withTmpDir = exports.getToolNames = exports.getExtraOptionsEnvParam = exports.DID_AUTOBUILD_GO_ENV_VAR_NAME = exports.DEFAULT_DEBUG_DATABASE_NAME = exports.DEFAULT_DEBUG_ARTIFACT_NAME = exports.GITHUB_DOTCOM_URL = void 0; exports.withTimeout = exports.tryGetFolderBytes = exports.isGoExtractionReconciliationEnabled = exports.listFolder = exports.doesDirectoryExist = exports.logCodeScanningConfigInCli = exports.useCodeScanningConfigInCli = exports.isInTestMode = exports.checkActionVersion = exports.getMlPoweredJsQueriesStatus = exports.getMlPoweredJsQueriesPack = exports.ML_POWERED_JS_QUERIES_PACK_NAME = exports.isGoodVersion = exports.delay = exports.bundleDb = exports.codeQlVersionAbove = exports.getCachedCodeQlVersion = exports.cacheCodeQlVersion = exports.isGitHubGhesVersionBelow = exports.isHTTPError = exports.UserError = exports.HTTPError = exports.getRequiredEnvParam = exports.isActions = exports.getMode = exports.enrichEnvironment = exports.initializeEnvironment = exports.EnvVar = exports.Mode = exports.assertNever = exports.getGitHubAuth = exports.apiVersionInRange = exports.DisallowedAPIVersionReason = exports.checkGitHubVersionInRange = exports.getGitHubVersion = exports.GitHubVariant = exports.parseGitHubUrl = exports.getCodeQLDatabasePath = exports.getThreadsFlag = exports.getThreadsFlagValue = exports.getAddSnippetsFlag = exports.getMemoryFlag = exports.getMemoryFlagValue = exports.withTmpDir = exports.getToolNames = exports.getExtraOptionsEnvParam = exports.DID_AUTOBUILD_GO_ENV_VAR_NAME = exports.DEFAULT_DEBUG_DATABASE_NAME = exports.DEFAULT_DEBUG_ARTIFACT_NAME = exports.GITHUB_DOTCOM_URL = void 0;
const fs = __importStar(require("fs")); const fs = __importStar(require("fs"));
const os = __importStar(require("os")); const os = __importStar(require("os"));
const path = __importStar(require("path")); const path = __importStar(require("path"));
@ -679,6 +679,15 @@ async function useCodeScanningConfigInCli(codeql, featureFlags) {
return await codeQlVersionAbove(codeql, codeql_1.CODEQL_VERSION_CONFIG_FILES); return await codeQlVersionAbove(codeql, codeql_1.CODEQL_VERSION_CONFIG_FILES);
} }
exports.useCodeScanningConfigInCli = useCodeScanningConfigInCli; exports.useCodeScanningConfigInCli = useCodeScanningConfigInCli;
async function logCodeScanningConfigInCli(codeql, featureFlags, logger) {
if (await useCodeScanningConfigInCli(codeql, featureFlags)) {
logger.info("Code Scanning configuration file being processed in the codeql CLI.");
}
else {
logger.info("Code Scanning configuration file being processed in the codeql-action.");
}
}
exports.logCodeScanningConfigInCli = logCodeScanningConfigInCli;
/* /*
* Returns whether the path in the argument represents an existing directory. * Returns whether the path in the argument represents an existing directory.
*/ */

2
lib/util.js.map
View file

File diff suppressed because one or more lines are too long

10
src/analyze.ts
View file

@ -240,15 +240,7 @@ export async function runQueries(
const codeql = await getCodeQL(config.codeQLCmd); const codeql = await getCodeQL(config.codeQLCmd);
if (await util.useCodeScanningConfigInCli(codeql, featureFlags)) { await util.logCodeScanningConfigInCli(codeql, featureFlags, logger);
logger.info(
"Code Scanning configuration file being processed in the codeql-action."
);
} else {
logger.info(
"Code Scanning configuration file being processed in the codeql CLI."
);
}
for (const language of config.languages) { for (const language of config.languages) {
const queries = config.queries[language]; const queries = config.queries[language];

10
src/config-utils.ts
View file

@ -24,6 +24,7 @@ import {
codeQlVersionAbove, codeQlVersionAbove,
getMlPoweredJsQueriesPack, getMlPoweredJsQueriesPack,
GitHubVersion, GitHubVersion,
logCodeScanningConfigInCli,
ML_POWERED_JS_QUERIES_PACK_NAME, ML_POWERED_JS_QUERIES_PACK_NAME,
useCodeScanningConfigInCli, useCodeScanningConfigInCli,
} from "./util"; } from "./util";
@ -1704,10 +1705,9 @@ export async function initConfig(
// When using the codescanning config in the CLI, pack downloads // When using the codescanning config in the CLI, pack downloads
// happen in the CLI during the `database init` command, so no need // happen in the CLI during the `database init` command, so no need
// to download them here. // to download them here.
await logCodeScanningConfigInCli(codeQL, featureFlags, logger);
if (!(await useCodeScanningConfigInCli(codeQL, featureFlags))) { if (!(await useCodeScanningConfigInCli(codeQL, featureFlags))) {
logger.info(
"Code Scanning configuration file being processed in the codeql CLI."
);
const registries = parseRegistries(registriesInput); const registries = parseRegistries(registriesInput);
await downloadPacks( await downloadPacks(
codeQL, codeQL,
@ -1718,10 +1718,6 @@ export async function initConfig(
config.tempDir, config.tempDir,
logger logger
); );
} else {
logger.info(
"Code Scanning configuration file being processed in the codeql-action."
);
} }
// Save the config so we can easily access it again in the future // Save the config so we can easily access it again in the future

16
src/util.ts
View file

@ -817,6 +817,22 @@ export async function useCodeScanningConfigInCli(
return await codeQlVersionAbove(codeql, CODEQL_VERSION_CONFIG_FILES); return await codeQlVersionAbove(codeql, CODEQL_VERSION_CONFIG_FILES);
} }
export async function logCodeScanningConfigInCli(
codeql: CodeQL,
featureFlags: FeatureFlags,
logger: Logger
) {
if (await useCodeScanningConfigInCli(codeql, featureFlags)) {
logger.info(
"Code Scanning configuration file being processed in the codeql CLI."
);
} else {
logger.info(
"Code Scanning configuration file being processed in the codeql-action."
);
}
}
/* /*
* Returns whether the path in the argument represents an existing directory. * Returns whether the path in the argument represents an existing directory.
*/ */