Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support xz #108

Merged
merged 1 commit into from
Nov 25, 2024
Merged

feat: support xz #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,3 +234,21 @@ jobs:
repo: magnusopera/terrabuild
prerelease: true
- run: terrabuild version

weval: # Example of a project w/ .tar.xz artifact and extracted wrapping folder
strategy:
matrix:
version: [ "v0.3.2" ]
runs-on: [ "ubuntu-latest" ]
runs-on: ${{ matrix.runs-on }}
steps:
- uses: actions/checkout@v1
- run: npm ci
- run: npm run build
- uses: ./
with:
repo: bytecodealliance/weval
tag: ${{ matrix.version }}
extension: "\\.xz"
- run:
weval --version
72 changes: 51 additions & 21 deletions lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ const tc = __importStar(require("@actions/tool-cache"));
const utils_1 = require("@actions/github/lib/utils");
const plugin_throttling_1 = require("@octokit/plugin-throttling");
const ThrottlingOctokit = utils_1.GitHub.plugin(plugin_throttling_1.throttling);
const SUPPORTED_TAR_EXTENSIONS = [
'.tar.gz',
'.tar.xz',
'.tar.bz2',
'.tgz',
];
function run() {
return __awaiter(this, void 0, void 0, function* () {
try {
Expand Down Expand Up @@ -69,8 +75,8 @@ function run() {
&& tag !== "latest"
&& tag !== "";
const [owner, repoName] = repo.split("/");
// If a project name was manually configured, use it
const assetName = core.getInput("asset-name");
// Use configured project name if present
let assetName = core.getInput("asset-name");
let osMatch = [];
// Determine Platform
let osPlatform = core.getInput("platform");
Expand Down Expand Up @@ -121,7 +127,7 @@ function run() {
let extMatchRegexForm = "";
if (extMatching) {
if (extension === "") {
extMatchRegexForm = "\.(tar.gz|zip|tgz)";
extMatchRegexForm = "\.(tar.gz|tar.xz|zip|tgz)";
core.info(`==> Using default file extension matching: ${extMatchRegexForm}`);
}
else {
Expand Down Expand Up @@ -250,16 +256,20 @@ function run() {
}
const extensionMatches = extensionRegex.test(normalized);
if (!extensionMatches) {
core.debug("extenison didn't match");
core.debug("extension didn't match");
}
return nameIncluded && osArchMatches && osMatches && vendorMatches && libcMatches && extensionMatches;
const matches = nameIncluded && osArchMatches && osMatches && vendorMatches && libcMatches && extensionMatches;
if (matches) {
core.info(`artifact matched: ${normalized}`);
}
return matches;
});
if (!asset) {
const found = release.assets.map(f => f.name);
throw new Error(`Could not find asset for ${tag}. Found: ${found}`);
}
const url = asset.url;
core.info(`Downloading ${assetName} from ${url}`);
core.info(`Downloading ${asset.name} from ${url}`);
const binPath = yield tc.downloadTool(url, undefined, `token ${token}`, {
accept: 'application/octet-stream'
});
Expand All @@ -275,26 +285,41 @@ function run() {
yield extractFn(binPath, dest);
}
core.info(`Automatically extracted release asset ${asset.name} to ${dest}`);
const bins = fs.readdirSync(finalBinLocation, { withFileTypes: true })
.filter(item => item.isFile())
.map(bin => bin.name);
if (bins.length === 0)
// Attempt to find an extracted file that might be a binary matching the project
const binFiles = fs.readdirSync(finalBinLocation, { recursive: true, withFileTypes: true })
.filter(item => item.name.includes(assetName) && item.isFile());
if (binFiles.length === 0)
throw new Error(`No files found in ${finalBinLocation}`);
else if (bins.length > 1 && renameTo !== "") {
else if (binFiles.length > 1 && renameTo !== "") {
core.warning("rename-to parameter ignored when installing \
a release from an archive that contains multiple files.");
}
if (chmodTo !== "") {
bins.forEach(bin => {
const binPath = path.join(finalBinLocation, bin);
// Ensure binaries that were found are in the dir that will be added to PATH
for (const { parentPath, name } of binFiles) {
const currentBinPath = path.resolve(path.join(parentPath, name));
const finalBinPath = path.resolve(path.join(finalBinLocation, name));
// If the binary is in a path *other* than the one that will be added to PATH
// copy it over
if (currentBinPath != finalBinPath) {
try {
core.debug(`detected binary not in folder on PATH, copying binary from [${currentBinPath}] to [${finalBinPath}]`);
fs.copyFileSync(currentBinPath, finalBinPath);
}
catch (copyErr) {
core.setFailed(`Failed to copy binary to folder in PATH: ${copyErr}`);
}
}
// Apply chmod if configured
if (chmodTo !== "") {
try {
fs.chmodSync(binPath, chmodTo);
core.info(`chmod'd ${binPath} to ${chmodTo}`);
fs.chmodSync(finalBinPath, chmodTo);
core.info(`chmod'd ${finalBinPath} to ${chmodTo}`);
}
catch (chmodErr) {
core.setFailed(`Failed to chmod ${binPath} to ${chmodTo}: ${chmodErr}`);
core.setFailed(`Failed to chmod ${finalBinPath} to ${chmodTo}: ${chmodErr}`);
}
});
}
core.info(`installed binary [${finalBinPath}] (present in PATH)`);
}
}
else {
Expand Down Expand Up @@ -387,7 +412,9 @@ function cachePrimaryKey(info) {
`${info.owner}/${info.assetName}/${info.tag}/${info.osPlatform}-${info.osArch}`;
}
function toolPath(info) {
return path.join(getCacheDirectory(), info.owner, info.assetName, info.tag, `${info.osPlatform}-${info.osArch}`);
var _a;
let subDir = (_a = info.assetName) !== null && _a !== void 0 ? _a : info.repoName;
return path.join(getCacheDirectory(), info.owner, subDir, info.tag, `${info.osPlatform}-${info.osArch}`);
}
function getCacheDirectory() {
const cacheDirectory = process.env['RUNNER_TOOL_CACHE'] || '';
Expand All @@ -397,7 +424,7 @@ function getCacheDirectory() {
return cacheDirectory;
}
function getExtractFn(assetName) {
if (assetName.endsWith('.tar.gz') || assetName.endsWith('.tar.bz2') || assetName.endsWith('.tgz')) {
if (SUPPORTED_TAR_EXTENSIONS.some(ext => assetName.endsWith(ext))) {
return tc.extractTar;
}
else if (assetName.endsWith('.zip')) {
Expand All @@ -408,7 +435,10 @@ function getExtractFn(assetName) {
}
}
function getExtractFlags(assetName) {
if (assetName.endsWith('tar.bz2')) {
if (assetName.endsWith('tar.xz')) {
return "xJ";
}
else if (assetName.endsWith('tar.bz2')) {
return "xj";
}
else {
Expand Down
79 changes: 55 additions & 24 deletions src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ import { throttling } from "@octokit/plugin-throttling";

const ThrottlingOctokit = GitHub.plugin(throttling);

const SUPPORTED_TAR_EXTENSIONS = [
'.tar.gz',
'.tar.xz',
'.tar.bz2',
'.tgz',
];

interface ToolInfo {
owner: string;
assetName: string;
Expand Down Expand Up @@ -62,8 +69,8 @@ async function run() {

const [owner, repoName] = repo.split("/")

// If a project name was manually configured, use it
const assetName = core.getInput("asset-name");
// Use configured project name if present
let assetName = core.getInput("asset-name");

let osMatch: string[] = []

Expand Down Expand Up @@ -118,7 +125,7 @@ async function run() {
let extMatchRegexForm = "";
if (extMatching) {
if (extension === "") {
extMatchRegexForm = "\.(tar.gz|zip|tgz)";
extMatchRegexForm = "\.(tar.gz|tar.xz|zip|tgz)";
core.info(`==> Using default file extension matching: ${extMatchRegexForm}`);
} else {
extMatchRegexForm = extension;
Expand Down Expand Up @@ -248,9 +255,12 @@ async function run() {
const libcMatches = libcRegex.test(normalized);
if (!libcMatches) { core.debug("libc calling didn't match"); }
const extensionMatches = extensionRegex.test(normalized);
if (!extensionMatches) { core.debug("extenison didn't match"); }
if (!extensionMatches) { core.debug("extension didn't match"); }

const matches = nameIncluded && osArchMatches && osMatches && vendorMatches && libcMatches && extensionMatches;
if (matches) { core.info(`artifact matched: ${normalized}`); }

return nameIncluded && osArchMatches && osMatches && vendorMatches && libcMatches && extensionMatches
return matches;
})

if (!asset) {
Expand All @@ -262,7 +272,7 @@ async function run() {

const url = asset.url

core.info(`Downloading ${assetName} from ${url}`)
core.info(`Downloading ${asset.name} from ${url}`)
const binPath = await tc.downloadTool(url,
undefined,
`token ${token}`,
Expand All @@ -275,6 +285,7 @@ async function run() {
if (extractFn !== undefined) {
// Release is an archive file so extract it to the destination
const extractFlags = getExtractFlags(asset.name)

if (extractFlags !== undefined) {
core.info(`Attempting to extract archive with custom flags ${extractFlags}`)
await extractFn(binPath, dest, extractFlags);
Expand All @@ -283,26 +294,43 @@ async function run() {
}
core.info(`Automatically extracted release asset ${asset.name} to ${dest}`);

const bins = fs.readdirSync(finalBinLocation, { withFileTypes: true })
.filter(item => item.isFile())
.map(bin => bin.name);
if (bins.length === 0)
// Attempt to find an extracted file that might be a binary matching the project
const binFiles = fs.readdirSync(finalBinLocation, { recursive: true, withFileTypes: true })
.filter(item => item.name.includes(assetName) && item.isFile());
if (binFiles.length === 0)
throw new Error(`No files found in ${finalBinLocation}`);
else if (bins.length > 1 && renameTo !== "") {
else if (binFiles.length > 1 && renameTo !== "") {
core.warning("rename-to parameter ignored when installing \
a release from an archive that contains multiple files.");
}

if (chmodTo !== "") {
bins.forEach(bin => {
const binPath = path.join(finalBinLocation, bin);
try {
fs.chmodSync(binPath, chmodTo);
core.info(`chmod'd ${binPath} to ${chmodTo}`)
} catch (chmodErr) {
core.setFailed(`Failed to chmod ${binPath} to ${chmodTo}: ${chmodErr}`);
}
});
// Ensure binaries that were found are in the dir that will be added to PATH
for (const { parentPath, name } of binFiles) {
const currentBinPath = path.resolve(path.join(parentPath, name));
const finalBinPath = path.resolve(path.join(finalBinLocation, name));

// If the binary is in a path *other* than the one that will be added to PATH
// copy it over
if (currentBinPath != finalBinPath) {
try {
core.debug(`detected binary not in folder on PATH, copying binary from [${currentBinPath}] to [${finalBinPath}]`);
fs.copyFileSync(currentBinPath, finalBinPath);
} catch (copyErr) {
core.setFailed(`Failed to copy binary to folder in PATH: ${copyErr}`);
}
}

// Apply chmod if configured
if (chmodTo !== "") {
try {
fs.chmodSync(finalBinPath, chmodTo);
core.info(`chmod'd ${finalBinPath} to ${chmodTo}`)
} catch (chmodErr) {
core.setFailed(`Failed to chmod ${finalBinPath} to ${chmodTo}: ${chmodErr}`);
}
}

core.info(`installed binary [${finalBinPath}] (present in PATH)`);
}
} else {
// As it wasn't an archive we've just downloaded it as a blob, this uses an auto-assigned name which will
Expand Down Expand Up @@ -393,8 +421,9 @@ function cachePrimaryKey(info: ToolInfo): string | undefined {
}

function toolPath(info: ToolInfo): string {
let subDir = info.assetName ? info.assetName : info.repoName;
return path.join(getCacheDirectory(),
info.owner, info.assetName, info.tag,
info.owner, subDir, info.tag,
`${info.osPlatform}-${info.osArch}`);
}

Expand All @@ -407,7 +436,7 @@ function getCacheDirectory() {
}

function getExtractFn(assetName: any) {
if (assetName.endsWith('.tar.gz') || assetName.endsWith('.tar.bz2') || assetName.endsWith('.tgz')) {
if (SUPPORTED_TAR_EXTENSIONS.some(ext => assetName.endsWith(ext))) {
return tc.extractTar;
} else if (assetName.endsWith('.zip')) {
return tc.extractZip;
Expand All @@ -417,7 +446,9 @@ function getExtractFn(assetName: any) {
}

function getExtractFlags(assetName: any) {
if (assetName.endsWith('tar.bz2')) {
if (assetName.endsWith('tar.xz')) {
return "xJ";
} else if (assetName.endsWith('tar.bz2')) {
return "xj";
} else {
return undefined;
Expand Down
Loading