mirror of https://github.com/actions/cache.git
Use BSD tar on windows (#126)
* Use BSD tar on windows * Linting * Fallback to which tar if no system tar * Fix formatting * Bump prettier and typescriptpull/136/head
Josh Gross
5 years ago
committed by
GitHub
parent
4809f4ada4
commit
3854a40aee
@ -0,0 +1,58 @@
|
|||||||
|
import * as exec from "@actions/exec";
|
||||||
|
import * as io from "@actions/io";
|
||||||
|
import * as tar from "../src/tar";
|
||||||
|
|
||||||
|
jest.mock("@actions/exec");
|
||||||
|
jest.mock("@actions/io");
|
||||||
|
|
||||||
|
beforeAll(() => {
|
||||||
|
jest.spyOn(io, "which").mockImplementation(tool => {
|
||||||
|
return Promise.resolve(tool);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("extract tar", async () => {
|
||||||
|
const mkdirMock = jest.spyOn(io, "mkdirP");
|
||||||
|
const execMock = jest.spyOn(exec, "exec");
|
||||||
|
|
||||||
|
const archivePath = "cache.tar";
|
||||||
|
const targetDirectory = "~/.npm/cache";
|
||||||
|
await tar.extractTar(archivePath, targetDirectory);
|
||||||
|
|
||||||
|
expect(mkdirMock).toHaveBeenCalledWith(targetDirectory);
|
||||||
|
|
||||||
|
const IS_WINDOWS = process.platform === "win32";
|
||||||
|
const tarPath = IS_WINDOWS
|
||||||
|
? `${process.env["windir"]}\\System32\\tar.exe`
|
||||||
|
: "tar";
|
||||||
|
expect(execMock).toHaveBeenCalledTimes(1);
|
||||||
|
expect(execMock).toHaveBeenCalledWith(`"${tarPath}"`, [
|
||||||
|
"-xz",
|
||||||
|
"-f",
|
||||||
|
archivePath,
|
||||||
|
"-C",
|
||||||
|
targetDirectory
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("create tar", async () => {
|
||||||
|
const execMock = jest.spyOn(exec, "exec");
|
||||||
|
|
||||||
|
const archivePath = "cache.tar";
|
||||||
|
const sourceDirectory = "~/.npm/cache";
|
||||||
|
await tar.createTar(archivePath, sourceDirectory);
|
||||||
|
|
||||||
|
const IS_WINDOWS = process.platform === "win32";
|
||||||
|
const tarPath = IS_WINDOWS
|
||||||
|
? `${process.env["windir"]}\\System32\\tar.exe`
|
||||||
|
: "tar";
|
||||||
|
expect(execMock).toHaveBeenCalledTimes(1);
|
||||||
|
expect(execMock).toHaveBeenCalledWith(`"${tarPath}"`, [
|
||||||
|
"-cz",
|
||||||
|
"-f",
|
||||||
|
archivePath,
|
||||||
|
"-C",
|
||||||
|
sourceDirectory,
|
||||||
|
"."
|
||||||
|
]);
|
||||||
|
});
|
||||||
@ -0,0 +1,47 @@
|
|||||||
|
import { exec } from "@actions/exec";
|
||||||
|
import * as io from "@actions/io";
|
||||||
|
import { existsSync } from "fs";
|
||||||
|
|
||||||
|
async function getTarPath(): Promise<string> {
|
||||||
|
// Explicitly use BSD Tar on Windows
|
||||||
|
const IS_WINDOWS = process.platform === "win32";
|
||||||
|
if (IS_WINDOWS) {
|
||||||
|
const systemTar = `${process.env["windir"]}\\System32\\tar.exe`;
|
||||||
|
if (existsSync(systemTar)) {
|
||||||
|
return systemTar;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return await io.which("tar", true);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function execTar(args: string[]): Promise<void> {
|
||||||
|
try {
|
||||||
|
await exec(`"${await getTarPath()}"`, args);
|
||||||
|
} catch (error) {
|
||||||
|
const IS_WINDOWS = process.platform === "win32";
|
||||||
|
if (IS_WINDOWS) {
|
||||||
|
throw new Error(
|
||||||
|
`Tar failed with error: ${error?.message}. Ensure BSD tar is installed and on the PATH.`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
throw new Error(`Tar failed with error: ${error?.message}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function extractTar(
|
||||||
|
archivePath: string,
|
||||||
|
targetDirectory: string
|
||||||
|
): Promise<void> {
|
||||||
|
// Create directory to extract tar into
|
||||||
|
await io.mkdirP(targetDirectory);
|
||||||
|
const args = ["-xz", "-f", archivePath, "-C", targetDirectory];
|
||||||
|
await execTar(args);
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function createTar(
|
||||||
|
archivePath: string,
|
||||||
|
sourceDirectory: string
|
||||||
|
): Promise<void> {
|
||||||
|
const args = ["-cz", "-f", archivePath, "-C", sourceDirectory, "."];
|
||||||
|
await execTar(args);
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue