mirror of
https://github.com/github/codeql-action
synced 2026-06-10 20:01:39 +03:00
Merge branch 'main' into henrymercer/cleanup-for-mrva
This commit is contained in:
@@ -5,6 +5,8 @@ See the [releases page](https://github.com/github/codeql-action/releases) for th
|
||||
## [UNRELEASED]
|
||||
|
||||
- The `cleanup-level` input to the `analyze` Action is now deprecated. The CodeQL Action has written a limited amount of intermediate results to the database since version 2.2.5, and now automatically manages cleanup. [#2999](https://github.com/github/codeql-action/pull/2999)
|
||||
- The `cleanup-level` input to the `analyze` Action is now deprecated. The CodeQL Action has not written intermediate results to the database since version 2.2.5, so this option now has little to no practical use. [#2998](https://github.com/github/codeql-action/pull/2998)
|
||||
- Update default CodeQL bundle version to 2.22.3. [#3000](https://github.com/github/codeql-action/pull/3000)
|
||||
|
||||
## 3.29.5 - 29 Jul 2025
|
||||
|
||||
|
||||
Generated
+35
@@ -51,6 +51,7 @@ exports.ensureEndsInPeriod = ensureEndsInPeriod;
|
||||
exports.runTool = runTool;
|
||||
exports.getPullRequestBranches = getPullRequestBranches;
|
||||
exports.isAnalyzingPullRequest = isAnalyzingPullRequest;
|
||||
exports.fixCodeQualityCategory = fixCodeQualityCategory;
|
||||
const fs = __importStar(require("fs"));
|
||||
const path = __importStar(require("path"));
|
||||
const core = __importStar(require("@actions/core"));
|
||||
@@ -392,4 +393,38 @@ function getPullRequestBranches() {
|
||||
function isAnalyzingPullRequest() {
|
||||
return getPullRequestBranches() !== undefined;
|
||||
}
|
||||
/**
|
||||
* A workaround for code quality to map category names from old default setup workflows
|
||||
* to ones that the code quality service expects.
|
||||
*/
|
||||
const qualityCategoryMapping = {
|
||||
"c#": "csharp",
|
||||
cpp: "c-cpp",
|
||||
c: "c-cpp",
|
||||
"c++": "c-cpp",
|
||||
java: "java-kotlin",
|
||||
javascript: "javascript-typescript",
|
||||
typescript: "javascript-typescript",
|
||||
kotlin: "java-kotlin",
|
||||
};
|
||||
/** Adjusts the category string for a Code Quality SARIF file if an "old"
|
||||
* category identifier is used by Default Setup.
|
||||
*/
|
||||
function fixCodeQualityCategory(logger, category) {
|
||||
// The `category` should always be set by Default Setup. We perform this check
|
||||
// to avoid potential issues if Code Quality supports Advanced Setup in the future
|
||||
// and before this workaround is removed.
|
||||
if (category !== undefined &&
|
||||
isDefaultSetup() &&
|
||||
category.startsWith("/language:")) {
|
||||
const language = category.substring("/language:".length);
|
||||
const mappedLanguage = qualityCategoryMapping[language];
|
||||
if (mappedLanguage) {
|
||||
const newCategory = `/language:${mappedLanguage}`;
|
||||
logger.info(`Adjusted category for Code Quality from '${category}' to '${newCategory}'.`);
|
||||
return newCategory;
|
||||
}
|
||||
}
|
||||
return category;
|
||||
}
|
||||
//# sourceMappingURL=actions-util.js.map
|
||||
File diff suppressed because one or more lines are too long
Generated
+24
@@ -41,6 +41,7 @@ const ava_1 = __importDefault(require("ava"));
|
||||
const actions_util_1 = require("./actions-util");
|
||||
const api_client_1 = require("./api-client");
|
||||
const environment_1 = require("./environment");
|
||||
const logging_1 = require("./logging");
|
||||
const testing_utils_1 = require("./testing-utils");
|
||||
const util_1 = require("./util");
|
||||
(0, testing_utils_1.setupTests)(ava_1.default);
|
||||
@@ -165,4 +166,27 @@ function withMockedEnv(envVars, testFn) {
|
||||
(0, util_1.initializeEnvironment)("1.2.3");
|
||||
t.deepEqual(process.env[environment_1.EnvVar.VERSION], "1.2.3");
|
||||
});
|
||||
(0, ava_1.default)("fixCodeQualityCategory", (t) => {
|
||||
withMockedEnv({
|
||||
GITHUB_EVENT_NAME: "dynamic",
|
||||
}, () => {
|
||||
const logger = (0, logging_1.getRunnerLogger)(true);
|
||||
// Categories that should get adjusted.
|
||||
t.is((0, actions_util_1.fixCodeQualityCategory)(logger, "/language:c#"), "/language:csharp");
|
||||
t.is((0, actions_util_1.fixCodeQualityCategory)(logger, "/language:cpp"), "/language:c-cpp");
|
||||
t.is((0, actions_util_1.fixCodeQualityCategory)(logger, "/language:c"), "/language:c-cpp");
|
||||
t.is((0, actions_util_1.fixCodeQualityCategory)(logger, "/language:java"), "/language:java-kotlin");
|
||||
t.is((0, actions_util_1.fixCodeQualityCategory)(logger, "/language:javascript"), "/language:javascript-typescript");
|
||||
t.is((0, actions_util_1.fixCodeQualityCategory)(logger, "/language:typescript"), "/language:javascript-typescript");
|
||||
t.is((0, actions_util_1.fixCodeQualityCategory)(logger, "/language:kotlin"), "/language:java-kotlin");
|
||||
// Categories that should not get adjusted.
|
||||
t.is((0, actions_util_1.fixCodeQualityCategory)(logger, "/language:csharp"), "/language:csharp");
|
||||
t.is((0, actions_util_1.fixCodeQualityCategory)(logger, "/language:go"), "/language:go");
|
||||
t.is((0, actions_util_1.fixCodeQualityCategory)(logger, "/language:actions"), "/language:actions");
|
||||
// Other cases.
|
||||
t.is((0, actions_util_1.fixCodeQualityCategory)(logger, undefined), undefined);
|
||||
t.is((0, actions_util_1.fixCodeQualityCategory)(logger, "random string"), "random string");
|
||||
t.is((0, actions_util_1.fixCodeQualityCategory)(logger, "kotlin"), "kotlin");
|
||||
});
|
||||
});
|
||||
//# sourceMappingURL=actions-util.test.js.map
|
||||
File diff suppressed because one or more lines are too long
Generated
+1
-1
@@ -219,7 +219,7 @@ async function run() {
|
||||
uploadResult = await uploadLib.uploadFiles(outputDir, actionsUtil.getRequiredInput("checkout_path"), actionsUtil.getOptionalInput("category"), features, logger, uploadLib.CodeScanningTarget);
|
||||
core.setOutput("sarif-id", uploadResult.sarifID);
|
||||
if (config.augmentationProperties.qualityQueriesInput !== undefined) {
|
||||
const qualityUploadResult = await uploadLib.uploadFiles(outputDir, actionsUtil.getRequiredInput("checkout_path"), actionsUtil.getOptionalInput("category"), features, logger, uploadLib.CodeQualityTarget);
|
||||
const qualityUploadResult = await uploadLib.uploadFiles(outputDir, actionsUtil.getRequiredInput("checkout_path"), actionsUtil.fixCodeQualityCategory(logger, actionsUtil.getOptionalInput("category")), features, logger, uploadLib.CodeQualityTarget);
|
||||
core.setOutput("quality-sarif-id", qualityUploadResult.sarifID);
|
||||
}
|
||||
}
|
||||
|
||||
File diff suppressed because one or more lines are too long
Generated
+9
-6
@@ -465,19 +465,22 @@ async function runQueries(sarifFolder, memoryFlag, addSnippetsFlag, threadsFlag,
|
||||
new Date().getTime() - startTimeRunQueries;
|
||||
logger.startGroup(`Interpreting results for ${language}`);
|
||||
const startTimeInterpretResults = new Date();
|
||||
const analysisSummary = await runInterpretResults(language, undefined, sarifFile, config.debugMode);
|
||||
const analysisSummary = await runInterpretResults(language, undefined, sarifFile, config.debugMode, automationDetailsId);
|
||||
let qualityAnalysisSummary;
|
||||
if (config.augmentationProperties.qualityQueriesInput !== undefined) {
|
||||
logger.info(`Interpreting quality results for ${language}`);
|
||||
const qualityCategory = (0, actions_util_1.fixCodeQualityCategory)(logger, automationDetailsId);
|
||||
const qualitySarifFile = path.join(sarifFolder, `${language}.quality.sarif`);
|
||||
const qualityAnalysisSummary = await runInterpretResults(language, config.augmentationProperties.qualityQueriesInput.map((i) => resolveQuerySuiteAlias(language, i.uses)), qualitySarifFile, config.debugMode);
|
||||
// TODO: move
|
||||
logger.info(qualityAnalysisSummary);
|
||||
qualityAnalysisSummary = await runInterpretResults(language, config.augmentationProperties.qualityQueriesInput.map((i) => resolveQuerySuiteAlias(language, i.uses)), qualitySarifFile, config.debugMode, qualityCategory);
|
||||
}
|
||||
const endTimeInterpretResults = new Date();
|
||||
statusReport[`interpret_results_${language}_duration_ms`] =
|
||||
endTimeInterpretResults.getTime() - startTimeInterpretResults.getTime();
|
||||
logger.endGroup();
|
||||
logger.info(analysisSummary);
|
||||
if (qualityAnalysisSummary) {
|
||||
logger.info(qualityAnalysisSummary);
|
||||
}
|
||||
if (await features.getValue(feature_flags_1.Feature.QaTelemetryEnabled)) {
|
||||
const perQueryAlertCounts = getPerQueryAlertCounts(sarifFile);
|
||||
const perQueryAlertCountEventReport = {
|
||||
@@ -502,9 +505,9 @@ async function runQueries(sarifFolder, memoryFlag, addSnippetsFlag, threadsFlag,
|
||||
}
|
||||
}
|
||||
return statusReport;
|
||||
async function runInterpretResults(language, queries, sarifFile, enableDebugLogging) {
|
||||
async function runInterpretResults(language, queries, sarifFile, enableDebugLogging, category) {
|
||||
const databasePath = util.getCodeQLDatabasePath(config, language);
|
||||
return await codeql.databaseInterpretResults(databasePath, queries, sarifFile, addSnippetsFlag, threadsFlag, enableDebugLogging ? "-vv" : "-v", sarifRunPropertyFlag, automationDetailsId, config, features);
|
||||
return await codeql.databaseInterpretResults(databasePath, queries, sarifFile, addSnippetsFlag, threadsFlag, enableDebugLogging ? "-vv" : "-v", sarifRunPropertyFlag, category, config, features);
|
||||
}
|
||||
/** Get an object with all queries and their counts parsed from a SARIF file path. */
|
||||
function getPerQueryAlertCounts(sarifPath) {
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
Generated
+35
-9
@@ -43,6 +43,7 @@ exports.getConfigFileDirectoryGivenMessage = getConfigFileDirectoryGivenMessage;
|
||||
exports.getNoLanguagesError = getNoLanguagesError;
|
||||
exports.getUnknownLanguagesError = getUnknownLanguagesError;
|
||||
exports.getSupportedLanguageMap = getSupportedLanguageMap;
|
||||
exports.hasActionsWorkflows = hasActionsWorkflows;
|
||||
exports.getRawLanguagesInRepo = getRawLanguagesInRepo;
|
||||
exports.getLanguages = getLanguages;
|
||||
exports.getRawLanguagesNoAutodetect = getRawLanguagesNoAutodetect;
|
||||
@@ -144,17 +145,42 @@ async function getSupportedLanguageMap(codeql) {
|
||||
}
|
||||
return supportedLanguages;
|
||||
}
|
||||
const baseWorkflowsPath = ".github/workflows";
|
||||
/**
|
||||
* Determines if there exists a `.github/workflows` directory with at least
|
||||
* one file in it, which we use as an indicator that there are Actions
|
||||
* workflows in the workspace. This doesn't perfectly detect whether there
|
||||
* are actually workflows, but should be a good approximation.
|
||||
*
|
||||
* Alternatively, we could check specifically for yaml files, or call the
|
||||
* API to check if it knows about workflows.
|
||||
*
|
||||
* @returns True if the non-empty directory exists, false if not.
|
||||
*/
|
||||
function hasActionsWorkflows(sourceRoot) {
|
||||
const workflowsPath = path.resolve(sourceRoot, baseWorkflowsPath);
|
||||
const stats = fs.lstatSync(workflowsPath);
|
||||
return (stats !== undefined &&
|
||||
stats.isDirectory() &&
|
||||
fs.readdirSync(workflowsPath).length > 0);
|
||||
}
|
||||
/**
|
||||
* Gets the set of languages in the current repository.
|
||||
*/
|
||||
async function getRawLanguagesInRepo(repository, logger) {
|
||||
logger.debug(`GitHub repo ${repository.owner} ${repository.repo}`);
|
||||
async function getRawLanguagesInRepo(repository, sourceRoot, logger) {
|
||||
logger.debug(`Automatically detecting languages (${repository.owner}/${repository.repo})`);
|
||||
const response = await api.getApiClient().rest.repos.listLanguages({
|
||||
owner: repository.owner,
|
||||
repo: repository.repo,
|
||||
});
|
||||
logger.debug(`Languages API response: ${JSON.stringify(response)}`);
|
||||
return Object.keys(response.data).map((language) => language.trim().toLowerCase());
|
||||
const result = Object.keys(response.data).map((language) => language.trim().toLowerCase());
|
||||
if (hasActionsWorkflows(sourceRoot)) {
|
||||
logger.debug(`Found a .github/workflows directory`);
|
||||
result.push("actions");
|
||||
}
|
||||
logger.debug(`Raw languages in repository: ${result.join(", ")}`);
|
||||
return result;
|
||||
}
|
||||
/**
|
||||
* Get the languages to analyse.
|
||||
@@ -166,9 +192,9 @@ async function getRawLanguagesInRepo(repository, logger) {
|
||||
* If no languages could be detected from either the workflow or the repository
|
||||
* then throw an error.
|
||||
*/
|
||||
async function getLanguages(codeql, languagesInput, repository, logger) {
|
||||
async function getLanguages(codeql, languagesInput, repository, sourceRoot, logger) {
|
||||
// Obtain languages without filtering them.
|
||||
const { rawLanguages, autodetected } = await getRawLanguages(languagesInput, repository, logger);
|
||||
const { rawLanguages, autodetected } = await getRawLanguages(languagesInput, repository, sourceRoot, logger);
|
||||
const languageMap = await getSupportedLanguageMap(codeql);
|
||||
const languagesSet = new Set();
|
||||
const unknownLanguages = [];
|
||||
@@ -215,7 +241,7 @@ function getRawLanguagesNoAutodetect(languagesInput) {
|
||||
* @returns A tuple containing a list of languages in this repository that might be
|
||||
* analyzable and whether or not this list was determined automatically.
|
||||
*/
|
||||
async function getRawLanguages(languagesInput, repository, logger) {
|
||||
async function getRawLanguages(languagesInput, repository, sourceRoot, logger) {
|
||||
// If the user has specified languages, use those.
|
||||
const languagesFromInput = getRawLanguagesNoAutodetect(languagesInput);
|
||||
if (languagesFromInput.length > 0) {
|
||||
@@ -223,15 +249,15 @@ async function getRawLanguages(languagesInput, repository, logger) {
|
||||
}
|
||||
// Otherwise, autodetect languages in the repository.
|
||||
return {
|
||||
rawLanguages: await getRawLanguagesInRepo(repository, logger),
|
||||
rawLanguages: await getRawLanguagesInRepo(repository, sourceRoot, logger),
|
||||
autodetected: true,
|
||||
};
|
||||
}
|
||||
/**
|
||||
* Get the default config, populated without user configuration file.
|
||||
*/
|
||||
async function getDefaultConfig({ languagesInput, queriesInput, qualityQueriesInput, packsInput, buildModeInput, dbLocation, trapCachingEnabled, dependencyCachingEnabled, debugMode, debugArtifactName, debugDatabaseName, repository, tempDir, codeql, githubVersion, features, logger, }) {
|
||||
const languages = await getLanguages(codeql, languagesInput, repository, logger);
|
||||
async function getDefaultConfig({ languagesInput, queriesInput, qualityQueriesInput, packsInput, buildModeInput, dbLocation, trapCachingEnabled, dependencyCachingEnabled, debugMode, debugArtifactName, debugDatabaseName, repository, tempDir, codeql, sourceRoot, githubVersion, features, logger, }) {
|
||||
const languages = await getLanguages(codeql, languagesInput, repository, sourceRoot, logger);
|
||||
const buildMode = await parseBuildModeInput(buildModeInput, languages, features, logger);
|
||||
const augmentationProperties = await calculateAugmentation(packsInput, queriesInput, qualityQueriesInput, languages);
|
||||
const { trapCaches, trapCacheDownloadTime } = await downloadCacheWithTime(trapCachingEnabled, codeql, languages, logger);
|
||||
|
||||
File diff suppressed because one or more lines are too long
Generated
+2
-2
@@ -826,12 +826,12 @@ const mockRepositoryNwo = (0, repository_1.parseRepositoryNwo)("owner/repo");
|
||||
});
|
||||
if (args.expectedLanguages) {
|
||||
// happy path
|
||||
const actualLanguages = await configUtils.getLanguages(codeQL, args.languagesInput, mockRepositoryNwo, mockLogger);
|
||||
const actualLanguages = await configUtils.getLanguages(codeQL, args.languagesInput, mockRepositoryNwo, ".", mockLogger);
|
||||
t.deepEqual(actualLanguages.sort(), args.expectedLanguages.sort());
|
||||
}
|
||||
else {
|
||||
// there is an error
|
||||
await t.throwsAsync(async () => await configUtils.getLanguages(codeQL, args.languagesInput, mockRepositoryNwo, mockLogger), { message: args.expectedError });
|
||||
await t.throwsAsync(async () => await configUtils.getLanguages(codeQL, args.languagesInput, mockRepositoryNwo, ".", mockLogger), { message: args.expectedError });
|
||||
}
|
||||
t.deepEqual(mockRequest.called, args.expectedApiCall);
|
||||
});
|
||||
|
||||
File diff suppressed because one or more lines are too long
+4
-4
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"bundleVersion": "codeql-bundle-v2.22.2",
|
||||
"cliVersion": "2.22.2",
|
||||
"priorBundleVersion": "codeql-bundle-v2.22.1",
|
||||
"priorCliVersion": "2.22.1"
|
||||
"bundleVersion": "codeql-bundle-v2.22.3",
|
||||
"cliVersion": "2.22.3",
|
||||
"priorBundleVersion": "codeql-bundle-v2.22.2",
|
||||
"priorCliVersion": "2.22.2"
|
||||
}
|
||||
|
||||
Generated
+1
-1
@@ -80,7 +80,7 @@ async function run() {
|
||||
if (fs.lstatSync(sarifPath).isDirectory()) {
|
||||
const qualitySarifFiles = upload_lib.findSarifFilesInDir(sarifPath, upload_lib.CodeQualityTarget.sarifPredicate);
|
||||
if (qualitySarifFiles.length !== 0) {
|
||||
await upload_lib.uploadSpecifiedFiles(qualitySarifFiles, checkoutPath, category, features, logger, upload_lib.CodeQualityTarget);
|
||||
await upload_lib.uploadSpecifiedFiles(qualitySarifFiles, checkoutPath, actionsUtil.fixCodeQualityCategory(logger, category), features, logger, upload_lib.CodeQualityTarget);
|
||||
}
|
||||
}
|
||||
// We don't upload results in test mode, so don't wait for processing
|
||||
|
||||
@@ -1 +1 @@
|
||||
{"version":3,"file":"upload-sarif-action.js","sourceRoot":"","sources":["../src/upload-sarif-action.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAyB;AAEzB,oDAAsC;AAEtC,4DAA8C;AAC9C,iDAAyE;AACzE,6CAAgD;AAChD,mDAA2C;AAC3C,uCAAqD;AACrD,6CAAgD;AAChD,mDAOyB;AACzB,yDAA2C;AAC3C,iCAQgB;AAMhB,KAAK,UAAU,uBAAuB,CACpC,SAAe,EACf,WAA0C,EAC1C,MAAc;IAEd,MAAM,gBAAgB,GAAG,MAAM,IAAA,sCAAsB,EACnD,0BAAU,CAAC,WAAW,EACtB,SAAS,EACT,SAAS,EACT,SAAS,EACT,MAAM,IAAA,qBAAc,EAAC,MAAM,CAAC,EAC5B,MAAM,CACP,CAAC;IACF,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACnC,MAAM,YAAY,GAA4B;YAC5C,GAAG,gBAAgB;YACnB,GAAG,WAAW;SACf,CAAC;QACF,MAAM,IAAA,gCAAgB,EAAC,YAAY,CAAC,CAAC;IACvC,CAAC;AACH,CAAC;AAED,KAAK,UAAU,GAAG;IAChB,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC7B,MAAM,MAAM,GAAG,IAAA,0BAAgB,GAAE,CAAC;IAClC,IAAA,4BAAqB,EAAC,IAAA,+BAAgB,GAAE,CAAC,CAAC;IAE1C,MAAM,aAAa,GAAG,MAAM,IAAA,6BAAgB,GAAE,CAAC;IAC/C,IAAA,yBAAkB,EAAC,IAAA,+BAAgB,GAAE,EAAE,aAAa,CAAC,CAAC;IAEtD,6CAA6C;IAC7C,WAAW,CAAC,aAAa,EAAE,CAAC;IAE5B,MAAM,aAAa,GAAG,IAAA,6BAAgB,GAAE,CAAC;IACzC,MAAM,QAAQ,GAAG,IAAI,wBAAQ,CAC3B,aAAa,EACb,aAAa,EACb,IAAA,oCAAqB,GAAE,EACvB,MAAM,CACP,CAAC;IAEF,MAAM,wBAAwB,GAAG,MAAM,IAAA,sCAAsB,EAC3D,0BAAU,CAAC,WAAW,EACtB,UAAU,EACV,SAAS,EACT,SAAS,EACT,MAAM,IAAA,qBAAc,EAAC,MAAM,CAAC,EAC5B,MAAM,CACP,CAAC;IACF,IAAI,wBAAwB,KAAK,SAAS,EAAE,CAAC;QAC3C,MAAM,IAAA,gCAAgB,EAAC,wBAAwB,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,WAAW,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QAC7D,MAAM,YAAY,GAAG,WAAW,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;QACnE,MAAM,QAAQ,GAAG,WAAW,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAE1D,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,WAAW,CAC/C,SAAS,EACT,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,UAAU,CAAC,kBAAkB,CAC9B,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;QAEjD,qGAAqG;QACrG,oGAAoG;QACpG,yCAAyC;QACzC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;YAC1C,MAAM,iBAAiB,GAAG,UAAU,CAAC,mBAAmB,CACtD,SAAS,EACT,UAAU,CAAC,iBAAiB,CAAC,cAAc,CAC5C,CAAC;YAEF,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACnC,MAAM,UAAU,CAAC,oBAAoB,CACnC,iBAAiB,EACjB,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,UAAU,CAAC,iBAAiB,CAC7B,CAAC;YACJ,CAAC;QACH,CAAC;QAED,qEAAqE;QACrE,IAAI,IAAA,mBAAY,GAAE,EAAE,CAAC;YACnB,IAAI,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;QAClE,CAAC;aAAM,IAAI,WAAW,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,KAAK,MAAM,EAAE,CAAC;YAC1E,MAAM,UAAU,CAAC,iBAAiB,CAChC,IAAA,6BAAgB,GAAE,EAClB,YAAY,CAAC,OAAO,EACpB,MAAM,CACP,CAAC;YACF,6FAA6F;YAC7F,kCAAkC;QACpC,CAAC;QACD,MAAM,uBAAuB,CAAC,SAAS,EAAE,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAC9E,CAAC;IAAC,OAAO,cAAc,EAAE,CAAC;QACxB,MAAM,KAAK,GACT,IAAA,oCAAoB,EAAC,0BAAU,CAAC,WAAW,CAAC;YAC5C,cAAc,YAAY,UAAU,CAAC,uBAAuB;YAC1D,CAAC,CAAC,IAAI,yBAAkB,CAAC,cAAc,CAAC,OAAO,CAAC;YAChD,CAAC,CAAC,IAAA,gBAAS,EAAC,cAAc,CAAC,CAAC;QAChC,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAExB,MAAM,qBAAqB,GAAG,MAAM,IAAA,sCAAsB,EACxD,0BAAU,CAAC,WAAW,EACtB,IAAA,gCAAgB,EAAC,KAAK,CAAC,EACvB,SAAS,EACT,SAAS,EACT,MAAM,IAAA,qBAAc,EAAC,MAAM,CAAC,EAC5B,MAAM,EACN,OAAO,EACP,KAAK,CAAC,KAAK,CACZ,CAAC;QACF,IAAI,qBAAqB,KAAK,SAAS,EAAE,CAAC;YACxC,MAAM,IAAA,gCAAgB,EAAC,qBAAqB,CAAC,CAAC;QAChD,CAAC;QACD,OAAO;IACT,CAAC;AACH,CAAC;AAED,KAAK,UAAU,UAAU;IACvB,IAAI,CAAC;QACH,MAAM,GAAG,EAAE,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,SAAS,CACZ,sCAAsC,IAAA,sBAAe,EAAC,KAAK,CAAC,EAAE,CAC/D,CAAC;IACJ,CAAC;AACH,CAAC;AAED,KAAK,UAAU,EAAE,CAAC"}
|
||||
{"version":3,"file":"upload-sarif-action.js","sourceRoot":"","sources":["../src/upload-sarif-action.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAyB;AAEzB,oDAAsC;AAEtC,4DAA8C;AAC9C,iDAAyE;AACzE,6CAAgD;AAChD,mDAA2C;AAC3C,uCAAqD;AACrD,6CAAgD;AAChD,mDAOyB;AACzB,yDAA2C;AAC3C,iCAQgB;AAMhB,KAAK,UAAU,uBAAuB,CACpC,SAAe,EACf,WAA0C,EAC1C,MAAc;IAEd,MAAM,gBAAgB,GAAG,MAAM,IAAA,sCAAsB,EACnD,0BAAU,CAAC,WAAW,EACtB,SAAS,EACT,SAAS,EACT,SAAS,EACT,MAAM,IAAA,qBAAc,EAAC,MAAM,CAAC,EAC5B,MAAM,CACP,CAAC;IACF,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACnC,MAAM,YAAY,GAA4B;YAC5C,GAAG,gBAAgB;YACnB,GAAG,WAAW;SACf,CAAC;QACF,MAAM,IAAA,gCAAgB,EAAC,YAAY,CAAC,CAAC;IACvC,CAAC;AACH,CAAC;AAED,KAAK,UAAU,GAAG;IAChB,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC7B,MAAM,MAAM,GAAG,IAAA,0BAAgB,GAAE,CAAC;IAClC,IAAA,4BAAqB,EAAC,IAAA,+BAAgB,GAAE,CAAC,CAAC;IAE1C,MAAM,aAAa,GAAG,MAAM,IAAA,6BAAgB,GAAE,CAAC;IAC/C,IAAA,yBAAkB,EAAC,IAAA,+BAAgB,GAAE,EAAE,aAAa,CAAC,CAAC;IAEtD,6CAA6C;IAC7C,WAAW,CAAC,aAAa,EAAE,CAAC;IAE5B,MAAM,aAAa,GAAG,IAAA,6BAAgB,GAAE,CAAC;IACzC,MAAM,QAAQ,GAAG,IAAI,wBAAQ,CAC3B,aAAa,EACb,aAAa,EACb,IAAA,oCAAqB,GAAE,EACvB,MAAM,CACP,CAAC;IAEF,MAAM,wBAAwB,GAAG,MAAM,IAAA,sCAAsB,EAC3D,0BAAU,CAAC,WAAW,EACtB,UAAU,EACV,SAAS,EACT,SAAS,EACT,MAAM,IAAA,qBAAc,EAAC,MAAM,CAAC,EAC5B,MAAM,CACP,CAAC;IACF,IAAI,wBAAwB,KAAK,SAAS,EAAE,CAAC;QAC3C,MAAM,IAAA,gCAAgB,EAAC,wBAAwB,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,WAAW,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QAC7D,MAAM,YAAY,GAAG,WAAW,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;QACnE,MAAM,QAAQ,GAAG,WAAW,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAE1D,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,WAAW,CAC/C,SAAS,EACT,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,UAAU,CAAC,kBAAkB,CAC9B,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;QAEjD,qGAAqG;QACrG,oGAAoG;QACpG,yCAAyC;QACzC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;YAC1C,MAAM,iBAAiB,GAAG,UAAU,CAAC,mBAAmB,CACtD,SAAS,EACT,UAAU,CAAC,iBAAiB,CAAC,cAAc,CAC5C,CAAC;YAEF,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACnC,MAAM,UAAU,CAAC,oBAAoB,CACnC,iBAAiB,EACjB,YAAY,EACZ,WAAW,CAAC,sBAAsB,CAAC,MAAM,EAAE,QAAQ,CAAC,EACpD,QAAQ,EACR,MAAM,EACN,UAAU,CAAC,iBAAiB,CAC7B,CAAC;YACJ,CAAC;QACH,CAAC;QAED,qEAAqE;QACrE,IAAI,IAAA,mBAAY,GAAE,EAAE,CAAC;YACnB,IAAI,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;QAClE,CAAC;aAAM,IAAI,WAAW,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,KAAK,MAAM,EAAE,CAAC;YAC1E,MAAM,UAAU,CAAC,iBAAiB,CAChC,IAAA,6BAAgB,GAAE,EAClB,YAAY,CAAC,OAAO,EACpB,MAAM,CACP,CAAC;YACF,6FAA6F;YAC7F,kCAAkC;QACpC,CAAC;QACD,MAAM,uBAAuB,CAAC,SAAS,EAAE,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAC9E,CAAC;IAAC,OAAO,cAAc,EAAE,CAAC;QACxB,MAAM,KAAK,GACT,IAAA,oCAAoB,EAAC,0BAAU,CAAC,WAAW,CAAC;YAC5C,cAAc,YAAY,UAAU,CAAC,uBAAuB;YAC1D,CAAC,CAAC,IAAI,yBAAkB,CAAC,cAAc,CAAC,OAAO,CAAC;YAChD,CAAC,CAAC,IAAA,gBAAS,EAAC,cAAc,CAAC,CAAC;QAChC,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAExB,MAAM,qBAAqB,GAAG,MAAM,IAAA,sCAAsB,EACxD,0BAAU,CAAC,WAAW,EACtB,IAAA,gCAAgB,EAAC,KAAK,CAAC,EACvB,SAAS,EACT,SAAS,EACT,MAAM,IAAA,qBAAc,EAAC,MAAM,CAAC,EAC5B,MAAM,EACN,OAAO,EACP,KAAK,CAAC,KAAK,CACZ,CAAC;QACF,IAAI,qBAAqB,KAAK,SAAS,EAAE,CAAC;YACxC,MAAM,IAAA,gCAAgB,EAAC,qBAAqB,CAAC,CAAC;QAChD,CAAC;QACD,OAAO;IACT,CAAC;AACH,CAAC;AAED,KAAK,UAAU,UAAU;IACvB,IAAI,CAAC;QACH,MAAM,GAAG,EAAE,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,SAAS,CACZ,sCAAsC,IAAA,sBAAe,EAAC,KAAK,CAAC,EAAE,CAC/D,CAAC;IACJ,CAAC;AACH,CAAC;AAED,KAAK,UAAU,EAAE,CAAC"}
|
||||
+4
-3
@@ -8027,9 +8027,10 @@
|
||||
}
|
||||
},
|
||||
"node_modules/tmp": {
|
||||
"version": "0.2.3",
|
||||
"resolved": "https://registry.npmjs.org/tmp/-/tmp-0.2.3.tgz",
|
||||
"integrity": "sha512-nZD7m9iCPC5g0pYmcaxogYKggSfLsdxl8of3Q/oIbqCqLLIO9IAF0GWjX1z9NZRHPiXv8Wex4yDCaZsgEw0Y8w==",
|
||||
"version": "0.2.4",
|
||||
"resolved": "https://registry.npmjs.org/tmp/-/tmp-0.2.4.tgz",
|
||||
"integrity": "sha512-UdiSoX6ypifLmrfQ/XfiawN6hkjSBpCjhKxxZcWlUUmoXLaCKQU0bx4HF/tdDK2uzRuchf1txGvrWBzYREssoQ==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">=14.14"
|
||||
}
|
||||
|
||||
-304
@@ -1,304 +0,0 @@
|
||||
|
||||
|
||||
## v0.2.2 (2024-02-28)
|
||||
|
||||
#### :bug: Bug Fix
|
||||
* [#278](https://github.com/raszi/node-tmp/pull/278) Closes [#268](https://github.com/raszi/node-tmp/issues/268): Revert "fix #246: remove any double quotes or single quotes… ([@mbargiel](https://github.com/mbargiel))
|
||||
|
||||
#### :memo: Documentation
|
||||
* [#279](https://github.com/raszi/node-tmp/pull/279) Closes [#266](https://github.com/raszi/node-tmp/issues/266): move paragraph on graceful cleanup to the head of the documentation ([@silkentrance](https://github.com/silkentrance))
|
||||
|
||||
#### Committers: 5
|
||||
- Carsten Klein ([@silkentrance](https://github.com/silkentrance))
|
||||
- Dave Nicolson ([@dnicolson](https://github.com/dnicolson))
|
||||
- KARASZI István ([@raszi](https://github.com/raszi))
|
||||
- Maxime Bargiel ([@mbargiel](https://github.com/mbargiel))
|
||||
- [@robertoaceves](https://github.com/robertoaceves)
|
||||
|
||||
|
||||
## v0.2.1 (2020-04-28)
|
||||
|
||||
#### :rocket: Enhancement
|
||||
* [#252](https://github.com/raszi/node-tmp/pull/252) Closes [#250](https://github.com/raszi/node-tmp/issues/250): introduce tmpdir option for overriding the system tmp dir ([@silkentrance](https://github.com/silkentrance))
|
||||
|
||||
#### :house: Internal
|
||||
* [#253](https://github.com/raszi/node-tmp/pull/253) Closes [#191](https://github.com/raszi/node-tmp/issues/191): generate changelog from pull requests using lerna-changelog ([@silkentrance](https://github.com/silkentrance))
|
||||
|
||||
#### Committers: 1
|
||||
- Carsten Klein ([@silkentrance](https://github.com/silkentrance))
|
||||
|
||||
|
||||
## v0.2.0 (2020-04-25)
|
||||
|
||||
#### :rocket: Enhancement
|
||||
* [#234](https://github.com/raszi/node-tmp/pull/234) feat: stabilize tmp for v0.2.0 release ([@silkentrance](https://github.com/silkentrance))
|
||||
|
||||
#### :bug: Bug Fix
|
||||
* [#231](https://github.com/raszi/node-tmp/pull/231) Closes [#230](https://github.com/raszi/node-tmp/issues/230): regression after fix for #197 ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#220](https://github.com/raszi/node-tmp/pull/220) Closes [#197](https://github.com/raszi/node-tmp/issues/197): return sync callback when using the sync interface, otherwise return the async callback ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#193](https://github.com/raszi/node-tmp/pull/193) Closes [#192](https://github.com/raszi/node-tmp/issues/192): tmp must not exit the process on its own ([@silkentrance](https://github.com/silkentrance))
|
||||
|
||||
#### :memo: Documentation
|
||||
* [#221](https://github.com/raszi/node-tmp/pull/221) Gh 206 document name option ([@silkentrance](https://github.com/silkentrance))
|
||||
|
||||
#### :house: Internal
|
||||
* [#226](https://github.com/raszi/node-tmp/pull/226) Closes [#212](https://github.com/raszi/node-tmp/issues/212): enable direct name option test ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#225](https://github.com/raszi/node-tmp/pull/225) Closes [#211](https://github.com/raszi/node-tmp/issues/211): existing tests must clean up after themselves ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#224](https://github.com/raszi/node-tmp/pull/224) Closes [#217](https://github.com/raszi/node-tmp/issues/217): name tests must use tmpName ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#223](https://github.com/raszi/node-tmp/pull/223) Closes [#214](https://github.com/raszi/node-tmp/issues/214): refactor tests and lib ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#198](https://github.com/raszi/node-tmp/pull/198) Update dependencies to latest versions ([@matsev](https://github.com/matsev))
|
||||
|
||||
#### Committers: 2
|
||||
- Carsten Klein ([@silkentrance](https://github.com/silkentrance))
|
||||
- Mattias Severson ([@matsev](https://github.com/matsev))
|
||||
|
||||
|
||||
## v0.1.0 (2019-03-20)
|
||||
|
||||
#### :rocket: Enhancement
|
||||
* [#177](https://github.com/raszi/node-tmp/pull/177) fix: fail early if there is no tmp dir specified ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#159](https://github.com/raszi/node-tmp/pull/159) Closes [#121](https://github.com/raszi/node-tmp/issues/121) ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#161](https://github.com/raszi/node-tmp/pull/161) Closes [#155](https://github.com/raszi/node-tmp/issues/155) ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#166](https://github.com/raszi/node-tmp/pull/166) fix: avoid relying on Node’s internals ([@addaleax](https://github.com/addaleax))
|
||||
* [#144](https://github.com/raszi/node-tmp/pull/144) prepend opts.dir || tmpDir to template if no path is given ([@silkentrance](https://github.com/silkentrance))
|
||||
|
||||
#### :bug: Bug Fix
|
||||
* [#183](https://github.com/raszi/node-tmp/pull/183) Closes [#182](https://github.com/raszi/node-tmp/issues/182) fileSync takes empty string postfix option ([@gutte](https://github.com/gutte))
|
||||
* [#130](https://github.com/raszi/node-tmp/pull/130) Closes [#129](https://github.com/raszi/node-tmp/issues/129) install process listeners safely ([@silkentrance](https://github.com/silkentrance))
|
||||
|
||||
#### :memo: Documentation
|
||||
* [#188](https://github.com/raszi/node-tmp/pull/188) HOTCloses [#187](https://github.com/raszi/node-tmp/issues/187): restore behaviour for #182 ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#180](https://github.com/raszi/node-tmp/pull/180) fix gh-179: template no longer accepts arbitrary paths ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#175](https://github.com/raszi/node-tmp/pull/175) docs: add `unsafeCleanup` option to jsdoc ([@kerimdzhanov](https://github.com/kerimdzhanov))
|
||||
* [#151](https://github.com/raszi/node-tmp/pull/151) docs: fix link to tmp-promise ([@silkentrance](https://github.com/silkentrance))
|
||||
|
||||
#### :house: Internal
|
||||
* [#184](https://github.com/raszi/node-tmp/pull/184) test: add missing tests for #182 ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#171](https://github.com/raszi/node-tmp/pull/171) chore: drop old NodeJS support ([@poppinlp](https://github.com/poppinlp))
|
||||
* [#170](https://github.com/raszi/node-tmp/pull/170) chore: update dependencies ([@raszi](https://github.com/raszi))
|
||||
* [#165](https://github.com/raszi/node-tmp/pull/165) test: add missing tests ([@raszi](https://github.com/raszi))
|
||||
* [#163](https://github.com/raszi/node-tmp/pull/163) chore: add lint npm task ([@raszi](https://github.com/raszi))
|
||||
* [#107](https://github.com/raszi/node-tmp/pull/107) chore: add coverage report ([@raszi](https://github.com/raszi))
|
||||
* [#141](https://github.com/raszi/node-tmp/pull/141) test: refactor tests for mocha ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#154](https://github.com/raszi/node-tmp/pull/154) chore: change Travis configuration ([@raszi](https://github.com/raszi))
|
||||
* [#152](https://github.com/raszi/node-tmp/pull/152) fix: drop Node v0.6.0 ([@raszi](https://github.com/raszi))
|
||||
|
||||
#### Committers: 6
|
||||
- Anna Henningsen ([@addaleax](https://github.com/addaleax))
|
||||
- Carsten Klein ([@silkentrance](https://github.com/silkentrance))
|
||||
- Dan Kerimdzhanov ([@kerimdzhanov](https://github.com/kerimdzhanov))
|
||||
- Gustav Klingstedt ([@gutte](https://github.com/gutte))
|
||||
- KARASZI István ([@raszi](https://github.com/raszi))
|
||||
- PoppinL ([@poppinlp](https://github.com/poppinlp))
|
||||
|
||||
|
||||
## v0.0.33 (2017-08-12)
|
||||
|
||||
#### :rocket: Enhancement
|
||||
* [#147](https://github.com/raszi/node-tmp/pull/147) fix: with name option try at most once to get a unique tmp name ([@silkentrance](https://github.com/silkentrance))
|
||||
|
||||
#### :bug: Bug Fix
|
||||
* [#149](https://github.com/raszi/node-tmp/pull/149) fix(fileSync): must honor detachDescriptor and discardDescriptor options ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#119](https://github.com/raszi/node-tmp/pull/119) Closes [#115](https://github.com/raszi/node-tmp/issues/115) ([@silkentrance](https://github.com/silkentrance))
|
||||
|
||||
#### :memo: Documentation
|
||||
* [#128](https://github.com/raszi/node-tmp/pull/128) Closes [#127](https://github.com/raszi/node-tmp/issues/127) add reference to tmp-promise ([@silkentrance](https://github.com/silkentrance))
|
||||
|
||||
#### :house: Internal
|
||||
* [#135](https://github.com/raszi/node-tmp/pull/135) Closes [#133](https://github.com/raszi/node-tmp/issues/133), #134 ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#123](https://github.com/raszi/node-tmp/pull/123) docs: update tmp.js MIT license header to 2017 ([@madnight](https://github.com/madnight))
|
||||
* [#122](https://github.com/raszi/node-tmp/pull/122) chore: add issue template ([@silkentrance](https://github.com/silkentrance))
|
||||
|
||||
#### Committers: 2
|
||||
- Carsten Klein ([@silkentrance](https://github.com/silkentrance))
|
||||
- Fabian Beuke ([@madnight](https://github.com/madnight))
|
||||
|
||||
|
||||
## v0.0.32 (2017-03-24)
|
||||
|
||||
#### :memo: Documentation
|
||||
* [#106](https://github.com/raszi/node-tmp/pull/106) doc: add proper JSDoc documentation ([@raszi](https://github.com/raszi))
|
||||
|
||||
#### :house: Internal
|
||||
* [#111](https://github.com/raszi/node-tmp/pull/111) test: add Windows tests ([@binki](https://github.com/binki))
|
||||
* [#110](https://github.com/raszi/node-tmp/pull/110) chore: add AppVeyor ([@binki](https://github.com/binki))
|
||||
* [#105](https://github.com/raszi/node-tmp/pull/105) chore: use const where possible ([@raszi](https://github.com/raszi))
|
||||
* [#104](https://github.com/raszi/node-tmp/pull/104) style: fix various style issues ([@raszi](https://github.com/raszi))
|
||||
|
||||
#### Committers: 2
|
||||
- KARASZI István ([@raszi](https://github.com/raszi))
|
||||
- Nathan Phillip Brink ([@binki](https://github.com/binki))
|
||||
|
||||
|
||||
## v0.0.31 (2016-11-21)
|
||||
|
||||
#### :rocket: Enhancement
|
||||
* [#99](https://github.com/raszi/node-tmp/pull/99) feat: add next callback functionality ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#94](https://github.com/raszi/node-tmp/pull/94) feat: add options to control descriptor management ([@pabigot](https://github.com/pabigot))
|
||||
|
||||
#### :house: Internal
|
||||
* [#101](https://github.com/raszi/node-tmp/pull/101) fix: Include files in the package.json ([@raszi](https://github.com/raszi))
|
||||
|
||||
#### Committers: 3
|
||||
- Carsten Klein ([@silkentrance](https://github.com/silkentrance))
|
||||
- KARASZI István ([@raszi](https://github.com/raszi))
|
||||
- Peter A. Bigot ([@pabigot](https://github.com/pabigot))
|
||||
|
||||
|
||||
## v0.0.30 (2016-11-01)
|
||||
|
||||
#### :bug: Bug Fix
|
||||
* [#96](https://github.com/raszi/node-tmp/pull/96) fix: constants for Node 6 ([@jnj16180340](https://github.com/jnj16180340))
|
||||
* [#98](https://github.com/raszi/node-tmp/pull/98) fix: garbage collector ([@Ari-H](https://github.com/Ari-H))
|
||||
|
||||
#### Committers: 2
|
||||
- Nate Johnson ([@jnj16180340](https://github.com/jnj16180340))
|
||||
- [@Ari-H](https://github.com/Ari-H)
|
||||
|
||||
|
||||
## v0.0.29 (2016-09-18)
|
||||
|
||||
#### :rocket: Enhancement
|
||||
* [#87](https://github.com/raszi/node-tmp/pull/87) fix: replace calls to deprecated fs API functions ([@OlliV](https://github.com/OlliV))
|
||||
|
||||
#### :bug: Bug Fix
|
||||
* [#70](https://github.com/raszi/node-tmp/pull/70) fix: prune `_removeObjects` correctly ([@joliss](https://github.com/joliss))
|
||||
* [#71](https://github.com/raszi/node-tmp/pull/71) Fix typo ([@gcampax](https://github.com/gcampax))
|
||||
|
||||
#### :memo: Documentation
|
||||
* [#77](https://github.com/raszi/node-tmp/pull/77) docs: change mkstemps to mkstemp ([@thefourtheye](https://github.com/thefourtheye))
|
||||
|
||||
#### :house: Internal
|
||||
* [#92](https://github.com/raszi/node-tmp/pull/92) chore: add Travis CI support for Node 6 ([@amilajack](https://github.com/amilajack))
|
||||
* [#79](https://github.com/raszi/node-tmp/pull/79) fix: remove unneeded require statement ([@whmountains](https://github.com/whmountains))
|
||||
|
||||
#### Committers: 6
|
||||
- Amila Welihinda ([@amilajack](https://github.com/amilajack))
|
||||
- Caleb Whiting ([@whmountains](https://github.com/whmountains))
|
||||
- Giovanni Campagna ([@gcampax](https://github.com/gcampax))
|
||||
- Jo Liss ([@joliss](https://github.com/joliss))
|
||||
- Olli Vanhoja ([@OlliV](https://github.com/OlliV))
|
||||
- Sakthipriyan Vairamani ([@thefourtheye](https://github.com/thefourtheye))
|
||||
|
||||
|
||||
## v0.0.28 (2015-09-27)
|
||||
|
||||
#### :bug: Bug Fix
|
||||
* [#63](https://github.com/raszi/node-tmp/pull/63) fix: delete for _rmdirRecursiveSync ([@voltrevo](https://github.com/voltrevo))
|
||||
|
||||
#### :memo: Documentation
|
||||
* [#64](https://github.com/raszi/node-tmp/pull/64) docs: fix typo in the README ([@JTKnox91](https://github.com/JTKnox91))
|
||||
|
||||
#### :house: Internal
|
||||
* [#67](https://github.com/raszi/node-tmp/pull/67) test: add node v4.0 v4.1 to travis config ([@raszi](https://github.com/raszi))
|
||||
* [#66](https://github.com/raszi/node-tmp/pull/66) chore(deps): update deps ([@raszi](https://github.com/raszi))
|
||||
|
||||
#### Committers: 3
|
||||
- Andrew Morris ([@voltrevo](https://github.com/voltrevo))
|
||||
- John T. Knox ([@JTKnox91](https://github.com/JTKnox91))
|
||||
- KARASZI István ([@raszi](https://github.com/raszi))
|
||||
|
||||
|
||||
## v0.0.27 (2015-08-15)
|
||||
|
||||
#### :bug: Bug Fix
|
||||
* [#60](https://github.com/raszi/node-tmp/pull/60) fix: unlinking when the file has been already removed ([@silkentrance](https://github.com/silkentrance))
|
||||
|
||||
#### :memo: Documentation
|
||||
* [#55](https://github.com/raszi/node-tmp/pull/55) docs(README): update README ([@raszi](https://github.com/raszi))
|
||||
|
||||
#### :house: Internal
|
||||
* [#56](https://github.com/raszi/node-tmp/pull/56) style(jshint): fix JSHint error ([@raszi](https://github.com/raszi))
|
||||
* [#53](https://github.com/raszi/node-tmp/pull/53) chore: update license attribute ([@pdehaan](https://github.com/pdehaan))
|
||||
|
||||
#### Committers: 3
|
||||
- Carsten Klein ([@silkentrance](https://github.com/silkentrance))
|
||||
- KARASZI István ([@raszi](https://github.com/raszi))
|
||||
- Peter deHaan ([@pdehaan](https://github.com/pdehaan))
|
||||
|
||||
|
||||
## v0.0.26 (2015-05-12)
|
||||
|
||||
#### :rocket: Enhancement
|
||||
* [#40](https://github.com/raszi/node-tmp/pull/40) Fix for #39 ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#42](https://github.com/raszi/node-tmp/pull/42) Fix for #17 ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#41](https://github.com/raszi/node-tmp/pull/41) Fix for #37 ([@silkentrance](https://github.com/silkentrance))
|
||||
* [#32](https://github.com/raszi/node-tmp/pull/32) add ability to customize file/dir names ([@shime](https://github.com/shime))
|
||||
* [#29](https://github.com/raszi/node-tmp/pull/29) tmp.file have responsibility to close file, not only unlink file ([@vhain](https://github.com/vhain))
|
||||
|
||||
#### :bug: Bug Fix
|
||||
* [#51](https://github.com/raszi/node-tmp/pull/51) fix(windows): fix tempDir on windows ([@raszi](https://github.com/raszi))
|
||||
* [#49](https://github.com/raszi/node-tmp/pull/49) remove object from _removeObjects if cleanup fn is called Closes [#48](https://github.com/raszi/node-tmp/issues/48) ([@bmeck](https://github.com/bmeck))
|
||||
|
||||
#### :memo: Documentation
|
||||
* [#45](https://github.com/raszi/node-tmp/pull/45) Fix for #44 ([@silkentrance](https://github.com/silkentrance))
|
||||
|
||||
#### :house: Internal
|
||||
* [#34](https://github.com/raszi/node-tmp/pull/34) Create LICENSE ([@ScottWeinstein](https://github.com/ScottWeinstein))
|
||||
|
||||
#### Committers: 6
|
||||
- Bradley Farias ([@bmeck](https://github.com/bmeck))
|
||||
- Carsten Klein ([@silkentrance](https://github.com/silkentrance))
|
||||
- Hrvoje Šimić ([@shime](https://github.com/shime))
|
||||
- Juwan Yoo ([@vhain](https://github.com/vhain))
|
||||
- KARASZI István ([@raszi](https://github.com/raszi))
|
||||
- Scott Weinstein ([@ScottWeinstein](https://github.com/ScottWeinstein))
|
||||
|
||||
|
||||
## v0.0.24 (2014-07-11)
|
||||
|
||||
#### :rocket: Enhancement
|
||||
* [#25](https://github.com/raszi/node-tmp/pull/25) Added removeCallback passing ([@foxel](https://github.com/foxel))
|
||||
|
||||
#### Committers: 1
|
||||
- Andrey Kupreychik ([@foxel](https://github.com/foxel))
|
||||
|
||||
|
||||
## v0.0.23 (2013-12-03)
|
||||
|
||||
#### :rocket: Enhancement
|
||||
* [#21](https://github.com/raszi/node-tmp/pull/21) If we are not on node 0.8, don't register an uncaughtException handler ([@wibblymat](https://github.com/wibblymat))
|
||||
|
||||
#### Committers: 1
|
||||
- Mat Scales ([@wibblymat](https://github.com/wibblymat))
|
||||
|
||||
|
||||
## v0.0.22 (2013-11-29)
|
||||
|
||||
#### :rocket: Enhancement
|
||||
* [#19](https://github.com/raszi/node-tmp/pull/19) Rethrow only on node v0.8. ([@mcollina](https://github.com/mcollina))
|
||||
|
||||
#### Committers: 1
|
||||
- Matteo Collina ([@mcollina](https://github.com/mcollina))
|
||||
|
||||
|
||||
## v0.0.21 (2013-08-07)
|
||||
|
||||
#### :bug: Bug Fix
|
||||
* [#16](https://github.com/raszi/node-tmp/pull/16) Fix bug where we delete contents of symlinks ([@lightsofapollo](https://github.com/lightsofapollo))
|
||||
|
||||
#### Committers: 1
|
||||
- James Lal ([@lightsofapollo](https://github.com/lightsofapollo))
|
||||
|
||||
|
||||
## v0.0.17 (2013-04-09)
|
||||
|
||||
#### :rocket: Enhancement
|
||||
* [#9](https://github.com/raszi/node-tmp/pull/9) add recursive remove option ([@oscar-broman](https://github.com/oscar-broman))
|
||||
|
||||
#### Committers: 1
|
||||
- [@oscar-broman](https://github.com/oscar-broman)
|
||||
|
||||
|
||||
## v0.0.14 (2012-08-26)
|
||||
|
||||
#### :rocket: Enhancement
|
||||
* [#5](https://github.com/raszi/node-tmp/pull/5) Export _getTmpName for temporary file name creation ([@joscha](https://github.com/joscha))
|
||||
|
||||
#### Committers: 1
|
||||
- Joscha Feth ([@joscha](https://github.com/joscha))
|
||||
|
||||
|
||||
## Previous Releases < v0.0.14
|
||||
|
||||
- no information available
|
||||
+195
-137
@@ -18,34 +18,24 @@ const _c = { fs: fs.constants, os: os.constants };
|
||||
/*
|
||||
* The working inner variables.
|
||||
*/
|
||||
const
|
||||
// the random characters to choose from
|
||||
const // the random characters to choose from
|
||||
RANDOM_CHARS = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz',
|
||||
|
||||
TEMPLATE_PATTERN = /XXXXXX/,
|
||||
|
||||
DEFAULT_TRIES = 3,
|
||||
|
||||
CREATE_FLAGS = (_c.O_CREAT || _c.fs.O_CREAT) | (_c.O_EXCL || _c.fs.O_EXCL) | (_c.O_RDWR || _c.fs.O_RDWR),
|
||||
|
||||
// constants are off on the windows platform and will not match the actual errno codes
|
||||
IS_WIN32 = os.platform() === 'win32',
|
||||
EBADF = _c.EBADF || _c.os.errno.EBADF,
|
||||
ENOENT = _c.ENOENT || _c.os.errno.ENOENT,
|
||||
|
||||
DIR_MODE = 0o700 /* 448 */,
|
||||
FILE_MODE = 0o600 /* 384 */,
|
||||
|
||||
EXIT = 'exit',
|
||||
|
||||
// this will hold the objects need to be removed on exit
|
||||
_removeObjects = [],
|
||||
|
||||
// API change in fs.rmdirSync leads to error when passing in a second parameter, e.g. the callback
|
||||
FN_RMDIR_SYNC = fs.rmdirSync.bind(fs);
|
||||
|
||||
let
|
||||
_gracefulCleanup = false;
|
||||
let _gracefulCleanup = false;
|
||||
|
||||
/**
|
||||
* Recursively remove a directory and its contents.
|
||||
@@ -75,38 +65,35 @@ function FN_RIMRAF_SYNC(dirPath) {
|
||||
* @param {?tmpNameCallback} callback the callback function
|
||||
*/
|
||||
function tmpName(options, callback) {
|
||||
const
|
||||
args = _parseArguments(options, callback),
|
||||
const args = _parseArguments(options, callback),
|
||||
opts = args[0],
|
||||
cb = args[1];
|
||||
|
||||
try {
|
||||
_assertAndSanitizeOptions(opts);
|
||||
} catch (err) {
|
||||
return cb(err);
|
||||
}
|
||||
_assertAndSanitizeOptions(opts, function (err, sanitizedOptions) {
|
||||
if (err) return cb(err);
|
||||
|
||||
let tries = opts.tries;
|
||||
(function _getUniqueName() {
|
||||
try {
|
||||
const name = _generateTmpName(opts);
|
||||
let tries = sanitizedOptions.tries;
|
||||
(function _getUniqueName() {
|
||||
try {
|
||||
const name = _generateTmpName(sanitizedOptions);
|
||||
|
||||
// check whether the path exists then retry if needed
|
||||
fs.stat(name, function (err) {
|
||||
/* istanbul ignore else */
|
||||
if (!err) {
|
||||
// check whether the path exists then retry if needed
|
||||
fs.stat(name, function (err) {
|
||||
/* istanbul ignore else */
|
||||
if (tries-- > 0) return _getUniqueName();
|
||||
if (!err) {
|
||||
/* istanbul ignore else */
|
||||
if (tries-- > 0) return _getUniqueName();
|
||||
|
||||
return cb(new Error('Could not get a unique tmp filename, max tries reached ' + name));
|
||||
}
|
||||
return cb(new Error('Could not get a unique tmp filename, max tries reached ' + name));
|
||||
}
|
||||
|
||||
cb(null, name);
|
||||
});
|
||||
} catch (err) {
|
||||
cb(err);
|
||||
}
|
||||
}());
|
||||
cb(null, name);
|
||||
});
|
||||
} catch (err) {
|
||||
cb(err);
|
||||
}
|
||||
})();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -117,15 +104,14 @@ function tmpName(options, callback) {
|
||||
* @throws {Error} if the options are invalid or could not generate a filename
|
||||
*/
|
||||
function tmpNameSync(options) {
|
||||
const
|
||||
args = _parseArguments(options),
|
||||
const args = _parseArguments(options),
|
||||
opts = args[0];
|
||||
|
||||
_assertAndSanitizeOptions(opts);
|
||||
const sanitizedOptions = _assertAndSanitizeOptionsSync(opts);
|
||||
|
||||
let tries = opts.tries;
|
||||
let tries = sanitizedOptions.tries;
|
||||
do {
|
||||
const name = _generateTmpName(opts);
|
||||
const name = _generateTmpName(sanitizedOptions);
|
||||
try {
|
||||
fs.statSync(name);
|
||||
} catch (e) {
|
||||
@@ -143,8 +129,7 @@ function tmpNameSync(options) {
|
||||
* @param {?fileCallback} callback
|
||||
*/
|
||||
function file(options, callback) {
|
||||
const
|
||||
args = _parseArguments(options, callback),
|
||||
const args = _parseArguments(options, callback),
|
||||
opts = args[0],
|
||||
cb = args[1];
|
||||
|
||||
@@ -181,13 +166,12 @@ function file(options, callback) {
|
||||
* @throws {Error} if cannot create a file
|
||||
*/
|
||||
function fileSync(options) {
|
||||
const
|
||||
args = _parseArguments(options),
|
||||
const args = _parseArguments(options),
|
||||
opts = args[0];
|
||||
|
||||
const discardOrDetachDescriptor = opts.discardDescriptor || opts.detachDescriptor;
|
||||
const name = tmpNameSync(opts);
|
||||
var fd = fs.openSync(name, CREATE_FLAGS, opts.mode || FILE_MODE);
|
||||
let fd = fs.openSync(name, CREATE_FLAGS, opts.mode || FILE_MODE);
|
||||
/* istanbul ignore else */
|
||||
if (opts.discardDescriptor) {
|
||||
fs.closeSync(fd);
|
||||
@@ -208,8 +192,7 @@ function fileSync(options) {
|
||||
* @param {?dirCallback} callback
|
||||
*/
|
||||
function dir(options, callback) {
|
||||
const
|
||||
args = _parseArguments(options, callback),
|
||||
const args = _parseArguments(options, callback),
|
||||
opts = args[0],
|
||||
cb = args[1];
|
||||
|
||||
@@ -236,8 +219,7 @@ function dir(options, callback) {
|
||||
* @throws {Error} if it cannot create a directory
|
||||
*/
|
||||
function dirSync(options) {
|
||||
const
|
||||
args = _parseArguments(options),
|
||||
const args = _parseArguments(options),
|
||||
opts = args[0];
|
||||
|
||||
const name = tmpNameSync(opts);
|
||||
@@ -288,8 +270,7 @@ function _removeFileSync(fdPath) {
|
||||
} finally {
|
||||
try {
|
||||
fs.unlinkSync(fdPath[1]);
|
||||
}
|
||||
catch (e) {
|
||||
} catch (e) {
|
||||
// reraise any unanticipated error
|
||||
if (!_isENOENT(e)) rethrownException = e;
|
||||
}
|
||||
@@ -361,7 +342,6 @@ function _prepareRemoveCallback(removeFunction, fileOrDirName, sync, cleanupCall
|
||||
|
||||
// if sync is true, the next parameter will be ignored
|
||||
return function _cleanupCallback(next) {
|
||||
|
||||
/* istanbul ignore else */
|
||||
if (!called) {
|
||||
// remove cleanupCallback from cache
|
||||
@@ -374,7 +354,7 @@ function _prepareRemoveCallback(removeFunction, fileOrDirName, sync, cleanupCall
|
||||
if (sync || removeFunction === FN_RMDIR_SYNC || removeFunction === FN_RIMRAF_SYNC) {
|
||||
return removeFunction(fileOrDirName);
|
||||
} else {
|
||||
return removeFunction(fileOrDirName, next || function() {});
|
||||
return removeFunction(fileOrDirName, next || function () {});
|
||||
}
|
||||
}
|
||||
};
|
||||
@@ -409,8 +389,7 @@ function _garbageCollector() {
|
||||
* @private
|
||||
*/
|
||||
function _randomChars(howMany) {
|
||||
let
|
||||
value = [],
|
||||
let value = [],
|
||||
rnd = null;
|
||||
|
||||
// make sure that we do not fail because we ran out of entropy
|
||||
@@ -420,24 +399,13 @@ function _randomChars(howMany) {
|
||||
rnd = crypto.pseudoRandomBytes(howMany);
|
||||
}
|
||||
|
||||
for (var i = 0; i < howMany; i++) {
|
||||
for (let i = 0; i < howMany; i++) {
|
||||
value.push(RANDOM_CHARS[rnd[i] % RANDOM_CHARS.length]);
|
||||
}
|
||||
|
||||
return value.join('');
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper which determines whether a string s is blank, that is undefined, or empty or null.
|
||||
*
|
||||
* @private
|
||||
* @param {string} s
|
||||
* @returns {Boolean} true whether the string s is blank, false otherwise
|
||||
*/
|
||||
function _isBlank(s) {
|
||||
return s === null || _isUndefined(s) || !s.trim();
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether the `obj` parameter is defined or not.
|
||||
*
|
||||
@@ -479,6 +447,51 @@ function _parseArguments(options, callback) {
|
||||
return [actualOptions, callback];
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve the specified path name in respect to tmpDir.
|
||||
*
|
||||
* The specified name might include relative path components, e.g. ../
|
||||
* so we need to resolve in order to be sure that is is located inside tmpDir
|
||||
*
|
||||
* @private
|
||||
*/
|
||||
function _resolvePath(name, tmpDir, cb) {
|
||||
const pathToResolve = path.isAbsolute(name) ? name : path.join(tmpDir, name);
|
||||
|
||||
fs.stat(pathToResolve, function (err) {
|
||||
if (err) {
|
||||
fs.realpath(path.dirname(pathToResolve), function (err, parentDir) {
|
||||
if (err) return cb(err);
|
||||
|
||||
cb(null, path.join(parentDir, path.basename(pathToResolve)));
|
||||
});
|
||||
} else {
|
||||
fs.realpath(path, cb);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve the specified path name in respect to tmpDir.
|
||||
*
|
||||
* The specified name might include relative path components, e.g. ../
|
||||
* so we need to resolve in order to be sure that is is located inside tmpDir
|
||||
*
|
||||
* @private
|
||||
*/
|
||||
function _resolvePathSync(name, tmpDir) {
|
||||
const pathToResolve = path.isAbsolute(name) ? name : path.join(tmpDir, name);
|
||||
|
||||
try {
|
||||
fs.statSync(pathToResolve);
|
||||
return fs.realpathSync(pathToResolve);
|
||||
} catch (_err) {
|
||||
const parentDir = fs.realpathSync(path.dirname(pathToResolve));
|
||||
|
||||
return path.join(parentDir, path.basename(pathToResolve));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates a new temporary name.
|
||||
*
|
||||
@@ -487,16 +500,17 @@ function _parseArguments(options, callback) {
|
||||
* @private
|
||||
*/
|
||||
function _generateTmpName(opts) {
|
||||
|
||||
const tmpDir = opts.tmpdir;
|
||||
|
||||
/* istanbul ignore else */
|
||||
if (!_isUndefined(opts.name))
|
||||
if (!_isUndefined(opts.name)) {
|
||||
return path.join(tmpDir, opts.dir, opts.name);
|
||||
}
|
||||
|
||||
/* istanbul ignore else */
|
||||
if (!_isUndefined(opts.template))
|
||||
if (!_isUndefined(opts.template)) {
|
||||
return path.join(tmpDir, opts.dir, opts.template).replace(TEMPLATE_PATTERN, _randomChars(6));
|
||||
}
|
||||
|
||||
// prefix and postfix
|
||||
const name = [
|
||||
@@ -512,33 +526,32 @@ function _generateTmpName(opts) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts whether the specified options are valid, also sanitizes options and provides sane defaults for missing
|
||||
* options.
|
||||
* Asserts and sanitizes the basic options.
|
||||
*
|
||||
* @param {Options} options
|
||||
* @private
|
||||
*/
|
||||
function _assertAndSanitizeOptions(options) {
|
||||
function _assertOptionsBase(options) {
|
||||
if (!_isUndefined(options.name)) {
|
||||
const name = options.name;
|
||||
|
||||
options.tmpdir = _getTmpDir(options);
|
||||
// assert that name is not absolute and does not contain a path
|
||||
if (path.isAbsolute(name)) throw new Error(`name option must not contain an absolute path, found "${name}".`);
|
||||
|
||||
const tmpDir = options.tmpdir;
|
||||
|
||||
/* istanbul ignore else */
|
||||
if (!_isUndefined(options.name))
|
||||
_assertIsRelative(options.name, 'name', tmpDir);
|
||||
/* istanbul ignore else */
|
||||
if (!_isUndefined(options.dir))
|
||||
_assertIsRelative(options.dir, 'dir', tmpDir);
|
||||
/* istanbul ignore else */
|
||||
if (!_isUndefined(options.template)) {
|
||||
_assertIsRelative(options.template, 'template', tmpDir);
|
||||
if (!options.template.match(TEMPLATE_PATTERN))
|
||||
throw new Error(`Invalid template, found "${options.template}".`);
|
||||
// must not fail on valid .<name> or ..<name> or similar such constructs
|
||||
const basename = path.basename(name);
|
||||
if (basename === '..' || basename === '.' || basename !== name)
|
||||
throw new Error(`name option must not contain a path, found "${name}".`);
|
||||
}
|
||||
|
||||
/* istanbul ignore else */
|
||||
if (!_isUndefined(options.tries) && isNaN(options.tries) || options.tries < 0)
|
||||
if (!_isUndefined(options.template) && !options.template.match(TEMPLATE_PATTERN)) {
|
||||
throw new Error(`Invalid template, found "${options.template}".`);
|
||||
}
|
||||
|
||||
/* istanbul ignore else */
|
||||
if ((!_isUndefined(options.tries) && isNaN(options.tries)) || options.tries < 0) {
|
||||
throw new Error(`Invalid tries, found "${options.tries}".`);
|
||||
}
|
||||
|
||||
// if a name was specified we will try once
|
||||
options.tries = _isUndefined(options.name) ? options.tries || DEFAULT_TRIES : 1;
|
||||
@@ -547,65 +560,103 @@ function _assertAndSanitizeOptions(options) {
|
||||
options.discardDescriptor = !!options.discardDescriptor;
|
||||
options.unsafeCleanup = !!options.unsafeCleanup;
|
||||
|
||||
// sanitize dir, also keep (multiple) blanks if the user, purportedly sane, requests us to
|
||||
options.dir = _isUndefined(options.dir) ? '' : path.relative(tmpDir, _resolvePath(options.dir, tmpDir));
|
||||
options.template = _isUndefined(options.template) ? undefined : path.relative(tmpDir, _resolvePath(options.template, tmpDir));
|
||||
// sanitize further if template is relative to options.dir
|
||||
options.template = _isBlank(options.template) ? undefined : path.relative(options.dir, options.template);
|
||||
|
||||
// for completeness' sake only, also keep (multiple) blanks if the user, purportedly sane, requests us to
|
||||
options.name = _isUndefined(options.name) ? undefined : options.name;
|
||||
options.prefix = _isUndefined(options.prefix) ? '' : options.prefix;
|
||||
options.postfix = _isUndefined(options.postfix) ? '' : options.postfix;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve the specified path name in respect to tmpDir.
|
||||
* Gets the relative directory to tmpDir.
|
||||
*
|
||||
* The specified name might include relative path components, e.g. ../
|
||||
* so we need to resolve in order to be sure that is is located inside tmpDir
|
||||
*
|
||||
* @param name
|
||||
* @param tmpDir
|
||||
* @returns {string}
|
||||
* @private
|
||||
*/
|
||||
function _resolvePath(name, tmpDir) {
|
||||
if (name.startsWith(tmpDir)) {
|
||||
return path.resolve(name);
|
||||
} else {
|
||||
return path.resolve(path.join(tmpDir, name));
|
||||
}
|
||||
function _getRelativePath(option, name, tmpDir, cb) {
|
||||
if (_isUndefined(name)) return cb(null);
|
||||
|
||||
_resolvePath(name, tmpDir, function (err, resolvedPath) {
|
||||
if (err) return cb(err);
|
||||
|
||||
const relativePath = path.relative(tmpDir, resolvedPath);
|
||||
|
||||
if (!resolvedPath.startsWith(tmpDir)) {
|
||||
return cb(new Error(`${option} option must be relative to "${tmpDir}", found "${relativePath}".`));
|
||||
}
|
||||
|
||||
cb(null, relativePath);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts whether specified name is relative to the specified tmpDir.
|
||||
* Gets the relative path to tmpDir.
|
||||
*
|
||||
* @param {string} name
|
||||
* @param {string} option
|
||||
* @param {string} tmpDir
|
||||
* @throws {Error}
|
||||
* @private
|
||||
*/
|
||||
function _assertIsRelative(name, option, tmpDir) {
|
||||
if (option === 'name') {
|
||||
// assert that name is not absolute and does not contain a path
|
||||
if (path.isAbsolute(name))
|
||||
throw new Error(`${option} option must not contain an absolute path, found "${name}".`);
|
||||
// must not fail on valid .<name> or ..<name> or similar such constructs
|
||||
let basename = path.basename(name);
|
||||
if (basename === '..' || basename === '.' || basename !== name)
|
||||
throw new Error(`${option} option must not contain a path, found "${name}".`);
|
||||
function _getRelativePathSync(option, name, tmpDir) {
|
||||
if (_isUndefined(name)) return;
|
||||
|
||||
const resolvedPath = _resolvePathSync(name, tmpDir);
|
||||
const relativePath = path.relative(tmpDir, resolvedPath);
|
||||
|
||||
if (!resolvedPath.startsWith(tmpDir)) {
|
||||
throw new Error(`${option} option must be relative to "${tmpDir}", found "${relativePath}".`);
|
||||
}
|
||||
else { // if (option === 'dir' || option === 'template') {
|
||||
// assert that dir or template are relative to tmpDir
|
||||
if (path.isAbsolute(name) && !name.startsWith(tmpDir)) {
|
||||
throw new Error(`${option} option must be relative to "${tmpDir}", found "${name}".`);
|
||||
|
||||
return relativePath;
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts whether the specified options are valid, also sanitizes options and provides sane defaults for missing
|
||||
* options.
|
||||
*
|
||||
* @private
|
||||
*/
|
||||
function _assertAndSanitizeOptions(options, cb) {
|
||||
_getTmpDir(options, function (err, tmpDir) {
|
||||
if (err) return cb(err);
|
||||
|
||||
options.tmpdir = tmpDir;
|
||||
|
||||
try {
|
||||
_assertOptionsBase(options, tmpDir);
|
||||
} catch (err) {
|
||||
return cb(err);
|
||||
}
|
||||
let resolvedPath = _resolvePath(name, tmpDir);
|
||||
if (!resolvedPath.startsWith(tmpDir))
|
||||
throw new Error(`${option} option must be relative to "${tmpDir}", found "${resolvedPath}".`);
|
||||
}
|
||||
|
||||
// sanitize dir, also keep (multiple) blanks if the user, purportedly sane, requests us to
|
||||
_getRelativePath('dir', options.dir, tmpDir, function (err, dir) {
|
||||
if (err) return cb(err);
|
||||
|
||||
options.dir = _isUndefined(dir) ? '' : dir;
|
||||
|
||||
// sanitize further if template is relative to options.dir
|
||||
_getRelativePath('template', options.template, tmpDir, function (err, template) {
|
||||
if (err) return cb(err);
|
||||
|
||||
options.template = template;
|
||||
|
||||
cb(null, options);
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts whether the specified options are valid, also sanitizes options and provides sane defaults for missing
|
||||
* options.
|
||||
*
|
||||
* @private
|
||||
*/
|
||||
function _assertAndSanitizeOptionsSync(options) {
|
||||
const tmpDir = (options.tmpdir = _getTmpDirSync(options));
|
||||
|
||||
_assertOptionsBase(options, tmpDir);
|
||||
|
||||
const dir = _getRelativePathSync('dir', options.dir, tmpDir);
|
||||
options.dir = _isUndefined(dir) ? '' : dir;
|
||||
|
||||
options.template = _getRelativePathSync('template', options.template, tmpDir);
|
||||
|
||||
return options;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -663,11 +714,18 @@ function setGracefulCleanup() {
|
||||
* Returns the currently configured tmp dir from os.tmpdir().
|
||||
*
|
||||
* @private
|
||||
* @param {?Options} options
|
||||
* @returns {string} the currently configured tmp dir
|
||||
*/
|
||||
function _getTmpDir(options) {
|
||||
return path.resolve(options && options.tmpdir || os.tmpdir());
|
||||
function _getTmpDir(options, cb) {
|
||||
return fs.realpath((options && options.tmpdir) || os.tmpdir(), cb);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the currently configured tmp dir from os.tmpdir().
|
||||
*
|
||||
* @private
|
||||
*/
|
||||
function _getTmpDirSync(options) {
|
||||
return fs.realpathSync((options && options.tmpdir) || os.tmpdir());
|
||||
}
|
||||
|
||||
// Install process exit listener
|
||||
@@ -768,7 +826,7 @@ Object.defineProperty(module.exports, 'tmpdir', {
|
||||
enumerable: true,
|
||||
configurable: false,
|
||||
get: function () {
|
||||
return _getTmpDir();
|
||||
return _getTmpDirSync();
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
+2
-2
@@ -1,8 +1,8 @@
|
||||
{
|
||||
"name": "tmp",
|
||||
"version": "0.2.3",
|
||||
"version": "0.2.4",
|
||||
"description": "Temporary file and directory creator",
|
||||
"author": "KARASZI István <github@spam.raszi.hu> (http://raszi.hu/)",
|
||||
"author": "KARASZI István <github@spam.raszi.hu>",
|
||||
"contributors": [
|
||||
"Carsten Klein <trancesilken@gmail.com> (https://github.com/silkentrance)"
|
||||
],
|
||||
|
||||
Generated
+4
-3
@@ -8095,9 +8095,10 @@
|
||||
}
|
||||
},
|
||||
"node_modules/tmp": {
|
||||
"version": "0.2.3",
|
||||
"resolved": "https://registry.npmjs.org/tmp/-/tmp-0.2.3.tgz",
|
||||
"integrity": "sha512-nZD7m9iCPC5g0pYmcaxogYKggSfLsdxl8of3Q/oIbqCqLLIO9IAF0GWjX1z9NZRHPiXv8Wex4yDCaZsgEw0Y8w==",
|
||||
"version": "0.2.4",
|
||||
"resolved": "https://registry.npmjs.org/tmp/-/tmp-0.2.4.tgz",
|
||||
"integrity": "sha512-UdiSoX6ypifLmrfQ/XfiawN6hkjSBpCjhKxxZcWlUUmoXLaCKQU0bx4HF/tdDK2uzRuchf1txGvrWBzYREssoQ==",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">=14.14"
|
||||
}
|
||||
|
||||
@@ -1,9 +1,14 @@
|
||||
import * as github from "@actions/github";
|
||||
import test from "ava";
|
||||
|
||||
import { getPullRequestBranches, isAnalyzingPullRequest } from "./actions-util";
|
||||
import {
|
||||
fixCodeQualityCategory,
|
||||
getPullRequestBranches,
|
||||
isAnalyzingPullRequest,
|
||||
} from "./actions-util";
|
||||
import { computeAutomationID } from "./api-client";
|
||||
import { EnvVar } from "./environment";
|
||||
import { getRunnerLogger } from "./logging";
|
||||
import { setupTests } from "./testing-utils";
|
||||
import { initializeEnvironment } from "./util";
|
||||
|
||||
@@ -193,3 +198,51 @@ test("initializeEnvironment", (t) => {
|
||||
initializeEnvironment("1.2.3");
|
||||
t.deepEqual(process.env[EnvVar.VERSION], "1.2.3");
|
||||
});
|
||||
|
||||
test("fixCodeQualityCategory", (t) => {
|
||||
withMockedEnv(
|
||||
{
|
||||
GITHUB_EVENT_NAME: "dynamic",
|
||||
},
|
||||
() => {
|
||||
const logger = getRunnerLogger(true);
|
||||
|
||||
// Categories that should get adjusted.
|
||||
t.is(fixCodeQualityCategory(logger, "/language:c#"), "/language:csharp");
|
||||
t.is(fixCodeQualityCategory(logger, "/language:cpp"), "/language:c-cpp");
|
||||
t.is(fixCodeQualityCategory(logger, "/language:c"), "/language:c-cpp");
|
||||
t.is(
|
||||
fixCodeQualityCategory(logger, "/language:java"),
|
||||
"/language:java-kotlin",
|
||||
);
|
||||
t.is(
|
||||
fixCodeQualityCategory(logger, "/language:javascript"),
|
||||
"/language:javascript-typescript",
|
||||
);
|
||||
t.is(
|
||||
fixCodeQualityCategory(logger, "/language:typescript"),
|
||||
"/language:javascript-typescript",
|
||||
);
|
||||
t.is(
|
||||
fixCodeQualityCategory(logger, "/language:kotlin"),
|
||||
"/language:java-kotlin",
|
||||
);
|
||||
|
||||
// Categories that should not get adjusted.
|
||||
t.is(
|
||||
fixCodeQualityCategory(logger, "/language:csharp"),
|
||||
"/language:csharp",
|
||||
);
|
||||
t.is(fixCodeQualityCategory(logger, "/language:go"), "/language:go");
|
||||
t.is(
|
||||
fixCodeQualityCategory(logger, "/language:actions"),
|
||||
"/language:actions",
|
||||
);
|
||||
|
||||
// Other cases.
|
||||
t.is(fixCodeQualityCategory(logger, undefined), undefined);
|
||||
t.is(fixCodeQualityCategory(logger, "random string"), "random string");
|
||||
t.is(fixCodeQualityCategory(logger, "kotlin"), "kotlin");
|
||||
},
|
||||
);
|
||||
});
|
||||
|
||||
@@ -8,6 +8,7 @@ import * as io from "@actions/io";
|
||||
import { JSONSchemaForNPMPackageJsonFiles } from "@schemastore/package";
|
||||
|
||||
import type { Config } from "./config-utils";
|
||||
import { Logger } from "./logging";
|
||||
import {
|
||||
doesDirectoryExist,
|
||||
getCodeQLDatabasePath,
|
||||
@@ -409,3 +410,47 @@ export function getPullRequestBranches(): PullRequestBranches | undefined {
|
||||
export function isAnalyzingPullRequest(): boolean {
|
||||
return getPullRequestBranches() !== undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* A workaround for code quality to map category names from old default setup workflows
|
||||
* to ones that the code quality service expects.
|
||||
*/
|
||||
const qualityCategoryMapping: Record<string, string> = {
|
||||
"c#": "csharp",
|
||||
cpp: "c-cpp",
|
||||
c: "c-cpp",
|
||||
"c++": "c-cpp",
|
||||
java: "java-kotlin",
|
||||
javascript: "javascript-typescript",
|
||||
typescript: "javascript-typescript",
|
||||
kotlin: "java-kotlin",
|
||||
};
|
||||
|
||||
/** Adjusts the category string for a Code Quality SARIF file if an "old"
|
||||
* category identifier is used by Default Setup.
|
||||
*/
|
||||
export function fixCodeQualityCategory(
|
||||
logger: Logger,
|
||||
category?: string,
|
||||
): string | undefined {
|
||||
// The `category` should always be set by Default Setup. We perform this check
|
||||
// to avoid potential issues if Code Quality supports Advanced Setup in the future
|
||||
// and before this workaround is removed.
|
||||
if (
|
||||
category !== undefined &&
|
||||
isDefaultSetup() &&
|
||||
category.startsWith("/language:")
|
||||
) {
|
||||
const language = category.substring("/language:".length);
|
||||
const mappedLanguage = qualityCategoryMapping[language];
|
||||
if (mappedLanguage) {
|
||||
const newCategory = `/language:${mappedLanguage}`;
|
||||
logger.info(
|
||||
`Adjusted category for Code Quality from '${category}' to '${newCategory}'.`,
|
||||
);
|
||||
return newCategory;
|
||||
}
|
||||
}
|
||||
|
||||
return category;
|
||||
}
|
||||
|
||||
@@ -336,7 +336,10 @@ async function run() {
|
||||
const qualityUploadResult = await uploadLib.uploadFiles(
|
||||
outputDir,
|
||||
actionsUtil.getRequiredInput("checkout_path"),
|
||||
actionsUtil.getOptionalInput("category"),
|
||||
actionsUtil.fixCodeQualityCategory(
|
||||
logger,
|
||||
actionsUtil.getOptionalInput("category"),
|
||||
),
|
||||
features,
|
||||
logger,
|
||||
uploadLib.CodeQualityTarget,
|
||||
|
||||
+16
-5
@@ -7,6 +7,7 @@ import del from "del";
|
||||
import * as yaml from "js-yaml";
|
||||
|
||||
import {
|
||||
fixCodeQualityCategory,
|
||||
getRequiredInput,
|
||||
getTemporaryDirectory,
|
||||
PullRequestBranches,
|
||||
@@ -698,24 +699,29 @@ export async function runQueries(
|
||||
undefined,
|
||||
sarifFile,
|
||||
config.debugMode,
|
||||
automationDetailsId,
|
||||
);
|
||||
|
||||
let qualityAnalysisSummary: string | undefined;
|
||||
if (config.augmentationProperties.qualityQueriesInput !== undefined) {
|
||||
logger.info(`Interpreting quality results for ${language}`);
|
||||
const qualityCategory = fixCodeQualityCategory(
|
||||
logger,
|
||||
automationDetailsId,
|
||||
);
|
||||
const qualitySarifFile = path.join(
|
||||
sarifFolder,
|
||||
`${language}.quality.sarif`,
|
||||
);
|
||||
const qualityAnalysisSummary = await runInterpretResults(
|
||||
qualityAnalysisSummary = await runInterpretResults(
|
||||
language,
|
||||
config.augmentationProperties.qualityQueriesInput.map((i) =>
|
||||
resolveQuerySuiteAlias(language, i.uses),
|
||||
),
|
||||
qualitySarifFile,
|
||||
config.debugMode,
|
||||
qualityCategory,
|
||||
);
|
||||
|
||||
// TODO: move
|
||||
logger.info(qualityAnalysisSummary);
|
||||
}
|
||||
const endTimeInterpretResults = new Date();
|
||||
statusReport[`interpret_results_${language}_duration_ms`] =
|
||||
@@ -723,6 +729,10 @@ export async function runQueries(
|
||||
logger.endGroup();
|
||||
logger.info(analysisSummary);
|
||||
|
||||
if (qualityAnalysisSummary) {
|
||||
logger.info(qualityAnalysisSummary);
|
||||
}
|
||||
|
||||
if (await features.getValue(Feature.QaTelemetryEnabled)) {
|
||||
const perQueryAlertCounts = getPerQueryAlertCounts(sarifFile);
|
||||
|
||||
@@ -759,6 +769,7 @@ export async function runQueries(
|
||||
queries: string[] | undefined,
|
||||
sarifFile: string,
|
||||
enableDebugLogging: boolean,
|
||||
category: string | undefined,
|
||||
): Promise<string> {
|
||||
const databasePath = util.getCodeQLDatabasePath(config, language);
|
||||
return await codeql.databaseInterpretResults(
|
||||
@@ -769,7 +780,7 @@ export async function runQueries(
|
||||
threadsFlag,
|
||||
enableDebugLogging ? "-vv" : "-v",
|
||||
sarifRunPropertyFlag,
|
||||
automationDetailsId,
|
||||
category,
|
||||
config,
|
||||
features,
|
||||
);
|
||||
|
||||
@@ -1159,6 +1159,7 @@ const mockRepositoryNwo = parseRepositoryNwo("owner/repo");
|
||||
codeQL,
|
||||
args.languagesInput,
|
||||
mockRepositoryNwo,
|
||||
".",
|
||||
mockLogger,
|
||||
);
|
||||
|
||||
@@ -1171,6 +1172,7 @@ const mockRepositoryNwo = parseRepositoryNwo("owner/repo");
|
||||
codeQL,
|
||||
args.languagesInput,
|
||||
mockRepositoryNwo,
|
||||
".",
|
||||
mockLogger,
|
||||
),
|
||||
{ message: args.expectedError },
|
||||
|
||||
+44
-4
@@ -321,23 +321,58 @@ export async function getSupportedLanguageMap(
|
||||
return supportedLanguages;
|
||||
}
|
||||
|
||||
const baseWorkflowsPath = ".github/workflows";
|
||||
|
||||
/**
|
||||
* Determines if there exists a `.github/workflows` directory with at least
|
||||
* one file in it, which we use as an indicator that there are Actions
|
||||
* workflows in the workspace. This doesn't perfectly detect whether there
|
||||
* are actually workflows, but should be a good approximation.
|
||||
*
|
||||
* Alternatively, we could check specifically for yaml files, or call the
|
||||
* API to check if it knows about workflows.
|
||||
*
|
||||
* @returns True if the non-empty directory exists, false if not.
|
||||
*/
|
||||
export function hasActionsWorkflows(sourceRoot: string): boolean {
|
||||
const workflowsPath = path.resolve(sourceRoot, baseWorkflowsPath);
|
||||
const stats = fs.lstatSync(workflowsPath);
|
||||
return (
|
||||
stats !== undefined &&
|
||||
stats.isDirectory() &&
|
||||
fs.readdirSync(workflowsPath).length > 0
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the set of languages in the current repository.
|
||||
*/
|
||||
export async function getRawLanguagesInRepo(
|
||||
repository: RepositoryNwo,
|
||||
sourceRoot: string,
|
||||
logger: Logger,
|
||||
): Promise<string[]> {
|
||||
logger.debug(`GitHub repo ${repository.owner} ${repository.repo}`);
|
||||
logger.debug(
|
||||
`Automatically detecting languages (${repository.owner}/${repository.repo})`,
|
||||
);
|
||||
const response = await api.getApiClient().rest.repos.listLanguages({
|
||||
owner: repository.owner,
|
||||
repo: repository.repo,
|
||||
});
|
||||
|
||||
logger.debug(`Languages API response: ${JSON.stringify(response)}`);
|
||||
return Object.keys(response.data as Record<string, number>).map((language) =>
|
||||
language.trim().toLowerCase(),
|
||||
const result = Object.keys(response.data as Record<string, number>).map(
|
||||
(language) => language.trim().toLowerCase(),
|
||||
);
|
||||
|
||||
if (hasActionsWorkflows(sourceRoot)) {
|
||||
logger.debug(`Found a .github/workflows directory`);
|
||||
result.push("actions");
|
||||
}
|
||||
|
||||
logger.debug(`Raw languages in repository: ${result.join(", ")}`);
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -354,12 +389,14 @@ export async function getLanguages(
|
||||
codeql: CodeQL,
|
||||
languagesInput: string | undefined,
|
||||
repository: RepositoryNwo,
|
||||
sourceRoot: string,
|
||||
logger: Logger,
|
||||
): Promise<Language[]> {
|
||||
// Obtain languages without filtering them.
|
||||
const { rawLanguages, autodetected } = await getRawLanguages(
|
||||
languagesInput,
|
||||
repository,
|
||||
sourceRoot,
|
||||
logger,
|
||||
);
|
||||
|
||||
@@ -420,6 +457,7 @@ export function getRawLanguagesNoAutodetect(
|
||||
export async function getRawLanguages(
|
||||
languagesInput: string | undefined,
|
||||
repository: RepositoryNwo,
|
||||
sourceRoot: string,
|
||||
logger: Logger,
|
||||
): Promise<{
|
||||
rawLanguages: string[];
|
||||
@@ -432,7 +470,7 @@ export async function getRawLanguages(
|
||||
}
|
||||
// Otherwise, autodetect languages in the repository.
|
||||
return {
|
||||
rawLanguages: await getRawLanguagesInRepo(repository, logger),
|
||||
rawLanguages: await getRawLanguagesInRepo(repository, sourceRoot, logger),
|
||||
autodetected: true,
|
||||
};
|
||||
}
|
||||
@@ -481,6 +519,7 @@ export async function getDefaultConfig({
|
||||
repository,
|
||||
tempDir,
|
||||
codeql,
|
||||
sourceRoot,
|
||||
githubVersion,
|
||||
features,
|
||||
logger,
|
||||
@@ -489,6 +528,7 @@ export async function getDefaultConfig({
|
||||
codeql,
|
||||
languagesInput,
|
||||
repository,
|
||||
sourceRoot,
|
||||
logger,
|
||||
);
|
||||
|
||||
|
||||
+4
-4
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"bundleVersion": "codeql-bundle-v2.22.2",
|
||||
"cliVersion": "2.22.2",
|
||||
"priorBundleVersion": "codeql-bundle-v2.22.1",
|
||||
"priorCliVersion": "2.22.1"
|
||||
"bundleVersion": "codeql-bundle-v2.22.3",
|
||||
"cliVersion": "2.22.3",
|
||||
"priorBundleVersion": "codeql-bundle-v2.22.2",
|
||||
"priorCliVersion": "2.22.2"
|
||||
}
|
||||
|
||||
@@ -112,7 +112,7 @@ async function run() {
|
||||
await upload_lib.uploadSpecifiedFiles(
|
||||
qualitySarifFiles,
|
||||
checkoutPath,
|
||||
category,
|
||||
actionsUtil.fixCodeQualityCategory(logger, category),
|
||||
features,
|
||||
logger,
|
||||
upload_lib.CodeQualityTarget,
|
||||
|
||||
Reference in New Issue
Block a user