robojerk/codeql-action

Merge pull request #2767 from github/cklin/prefer-gtar

Browse source 
Prefer gtar if available
This commit is contained in:
Ian Lynagh 2025-02-17 12:31:54 +00:00 • committed by GitHub
commit 8c1551cdd4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 55 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -4,7 +4,7 @@ See the [releases page](https://github.com/github/codeql-action/releases) for th
## [UNRELEASED]
No user facing changes.
- Update the action to prefer `gtar` over `tar` to make zstd archive extraction more robust. [2767](https://github.com/github/codeql-action/pull/2767)
## 3.28.9 - 07 Feb 2025

37
lib/tar.js generated
View file

@ -48,8 +48,8 @@ const actions_util_1 = require("./actions-util");
const util_1 = require("./util");
const MIN_REQUIRED_BSD_TAR_VERSION = "3.4.3";
const MIN_REQUIRED_GNU_TAR_VERSION = "1.31";
async function getTarVersion() {
const tar = await io.which("tar", true);
async function getTarVersion(programName) {
const tar = await io.which(programName, true);
let stdout = "";
const exitCode = await new toolrunner_1.ToolRunner(tar, ["--version"], {
listeners: {
@ -59,31 +59,46 @@ async function getTarVersion() {
},
}).exec();
if (exitCode !== 0) {
throw new Error("Failed to call tar --version");
throw new Error(`Failed to call ${programName} --version`);
}
// Return whether this is GNU tar or BSD tar, and the version number
if (stdout.includes("GNU tar")) {
const match = stdout.match(/tar \(GNU tar\) ([0-9.]+)/);
if (!match || !match[1]) {
throw new Error("Failed to parse output of tar --version.");
throw new Error(`Failed to parse output of ${programName} --version.`);
}
return { type: "gnu", version: match[1] };
return { name: programName, type: "gnu", version: match[1] };
}
else if (stdout.includes("bsdtar")) {
const match = stdout.match(/bsdtar ([0-9.]+)/);
if (!match || !match[1]) {
throw new Error("Failed to parse output of tar --version.");
throw new Error(`Failed to parse output of ${programName} --version.`);
}
return { type: "bsd", version: match[1] };
return { name: programName, type: "bsd", version: match[1] };
}
else {
throw new Error("Unknown tar version");
}
}
async function pickTarCommand() {
// bsdtar 3.5.3 on the macos-14 (arm) action runner image is prone to crash with the following
// error messages when extracting zstd archives:
//
// tar: Child process exited with status 1
// tar: Error exit delayed from previous errors.
//
// To avoid this problem, prefer GNU tar under the name "gtar" if it is available.
try {
return await getTarVersion("gtar");
}
catch {
return await getTarVersion("tar");
}
}
async function isZstdAvailable(logger) {
const foundZstdBinary = await (0, util_1.isBinaryAccessible)("zstd", logger);
try {
const tarVersion = await getTarVersion();
const tarVersion = await pickTarCommand();
const { type, version } = tarVersion;
logger.info(`Found ${type} tar version ${version}.`);
switch (type) {
@ -150,9 +165,9 @@ async function extractTarZst(tar, dest, tarVersion, logger) {
args.push("--overwrite");
}
args.push("-f", tar instanceof stream.Readable ? "-" : tar, "-C", dest);
process.stdout.write(`[command]tar ${args.join(" ")}\n`);
process.stdout.write(`[command]${tarVersion.name} ${args.join(" ")}\n`);
await new Promise((resolve, reject) => {
const tarProcess = (0, child_process_1.spawn)("tar", args, { stdio: "pipe" });
const tarProcess = (0, child_process_1.spawn)(tarVersion.name, args, { stdio: "pipe" });
let stdout = "";
tarProcess.stdout?.on("data", (data) => {
stdout += data.toString();
@ -174,7 +189,7 @@ async function extractTarZst(tar, dest, tarVersion, logger) {
}
tarProcess.on("exit", (code) => {
if (code !== 0) {
reject(new actions_util_1.CommandInvocationError("tar", args, code ?? undefined, stdout, stderr));
reject(new actions_util_1.CommandInvocationError(tarVersion.name, args, code ?? undefined, stdout, stderr));
}
resolve();
});

2
lib/tar.js.map
View file

File diff suppressed because one or more lines are too long

38
src/tar.ts
View file

@ -15,12 +15,13 @@ const MIN_REQUIRED_BSD_TAR_VERSION = "3.4.3";
const MIN_REQUIRED_GNU_TAR_VERSION = "1.31";
export type TarVersion = {
name: string;
type: "gnu" | "bsd";
version: string;
};
async function getTarVersion(): Promise<TarVersion> {
const tar = await io.which("tar", true);
async function getTarVersion(programName: string): Promise<TarVersion> {
const tar = await io.which(programName, true);
let stdout = "";
const exitCode = await new ToolRunner(tar, ["--version"], {
listeners: {
@ -30,28 +31,43 @@ async function getTarVersion(): Promise<TarVersion> {
},
}).exec();
if (exitCode !== 0) {
throw new Error("Failed to call tar --version");
throw new Error(`Failed to call ${programName} --version`);
}
// Return whether this is GNU tar or BSD tar, and the version number
if (stdout.includes("GNU tar")) {
const match = stdout.match(/tar \(GNU tar\) ([0-9.]+)/);
if (!match || !match[1]) {
throw new Error("Failed to parse output of tar --version.");
throw new Error(`Failed to parse output of ${programName} --version.`);
}
return { type: "gnu", version: match[1] };
return { name: programName, type: "gnu", version: match[1] };
} else if (stdout.includes("bsdtar")) {
const match = stdout.match(/bsdtar ([0-9.]+)/);
if (!match || !match[1]) {
throw new Error("Failed to parse output of tar --version.");
throw new Error(`Failed to parse output of ${programName} --version.`);
}
return { type: "bsd", version: match[1] };
return { name: programName, type: "bsd", version: match[1] };
} else {
throw new Error("Unknown tar version");
}
}
async function pickTarCommand(): Promise<TarVersion> {
// bsdtar 3.5.3 on the macos-14 (arm) action runner image is prone to crash with the following
// error messages when extracting zstd archives:
//
// tar: Child process exited with status 1
// tar: Error exit delayed from previous errors.
//
// To avoid this problem, prefer GNU tar under the name "gtar" if it is available.
try {
return await getTarVersion("gtar");
} catch {
return await getTarVersion("tar");
}
}
export interface ZstdAvailability {
available: boolean;
foundZstdBinary: boolean;
@ -63,7 +79,7 @@ export async function isZstdAvailable(
): Promise<ZstdAvailability> {
const foundZstdBinary = await isBinaryAccessible("zstd", logger);
try {
const tarVersion = await getTarVersion();
const tarVersion = await pickTarCommand();
const { type, version } = tarVersion;
logger.info(`Found ${type} tar version ${version}.`);
switch (type) {
@ -162,10 +178,10 @@ export async function extractTarZst(
args.push("-f", tar instanceof stream.Readable ? "-" : tar, "-C", dest);
process.stdout.write(`[command]tar ${args.join(" ")}\n`);
process.stdout.write(`[command]${tarVersion.name} ${args.join(" ")}\n`);
await new Promise<void>((resolve, reject) => {
const tarProcess = spawn("tar", args, { stdio: "pipe" });
const tarProcess = spawn(tarVersion.name, args, { stdio: "pipe" });
let stdout = "";
tarProcess.stdout?.on("data", (data: Buffer) => {
@ -196,7 +212,7 @@ export async function extractTarZst(
if (code !== 0) {
reject(
new CommandInvocationError(
"tar",
tarVersion.name,
args,
code ?? undefined,
stdout,