Merge pull request #425 from aminya/windows-llvm

aminya · web-flow · commit d8571402cbac · 2025-07-03T07:23:39.000-07:00
fix: prefer complete Window LLVM package + add tar tool
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ Setting up a **cross-platform** environment for building and testing C++/C proje
 | cache           | ccache, sccache                                                                                             |
 | documentation   | doxygen, graphviz                                                                                           |
 | coverage        | gcovr, opencppcoverage, kcov                                                                                |
-| other           | python, powershell, sevenzip                                                                                |
+| other           | python, powershell, sevenzip, tar                                                                           |
 
 `setup-cpp` automatically handles the dependencies of the selected tool (e.g., `python` is required for `conan`).
 
diff --git a/action.yml b/action.yml
@@ -166,6 +166,9 @@ inputs:
   git:
     description: "Wether to install git (true/false) or the specific version to install."
     required: false
+  tar:
+    description: "Wether to install tar (true/false) or the specific version to install."
+    required: false
 
 runs:
   using: "node20"
diff --git a/cspell.config.yaml b/cspell.config.yaml
@@ -60,6 +60,7 @@ words:
   - gcovr
   - ghes
   - Graphviz
+  - gtar
   - hadolint
   - iarna
   - inja
diff --git a/dist/legacy/setup-cpp.js b/dist/legacy/setup-cpp.js
diff --git a/dist/legacy/setup-cpp.js.map b/dist/legacy/setup-cpp.js.map
diff --git a/dist/modern/setup-cpp.mjs b/dist/modern/setup-cpp.mjs
diff --git a/dist/modern/setup-cpp.mjs.map b/dist/modern/setup-cpp.mjs.map
diff --git a/src/llvm/llvm_url.ts b/src/llvm/llvm_url.ts
@@ -7,7 +7,13 @@ import { loadAssetList, matchAsset } from "../utils/asset/load-assets.js"
 import { arm64, armv7, powerpc64le, sparc64, sparcv9, x86, x86_64 } from "../utils/env/arch.js"
 import { hasDnf } from "../utils/env/hasDnf.js"
 import { ubuntuVersion } from "../utils/env/ubuntu_version.js"
-import { extractTarByExe, getArchiveType, getExtractFunction } from "../utils/setup/extract.js"
+import {
+  ArchiveType,
+  extract7Zip,
+  extractTarByExe,
+  getArchiveType,
+  getExtractFunction,
+} from "../utils/setup/extract.js"
 import type { PackageInfo } from "../utils/setup/setupBin.js"
 
 const dirname = typeof __dirname === "string" ? __dirname : path.dirname(fileURLToPath(import.meta.url))
@@ -20,16 +26,20 @@ export async function getLLVMPackageInfo(
   const url = await getLLVMAssetURL(platform, arch, version)
   info(`Downloading LLVM from ${url}`)
 
+  const archiveType = getArchiveType(url)
   return {
     url,
     extractedFolderName: "",
     binRelativeDir: "bin",
     binFileName: addExeExt("clang"),
-    extractFunction: platform === "win32"
-      ? getExtractFunction(getArchiveType(url))
-      : (file: string, dest: string) => {
-        return extractTarByExe(file, dest, 1)
-      },
+    extractFunction:
+      (archiveType === ArchiveType.Tar || archiveType === ArchiveType.TarGz || archiveType === ArchiveType.TarXz)
+        ? (file: string, dest: string) => {
+          return process.platform === "win32"
+            ? extract7Zip(file, dest, true)
+            : extractTarByExe(file, dest, 1)
+        }
+        : getExtractFunction(archiveType),
   }
 }
 
@@ -83,8 +93,8 @@ async function getAssetKeywords(platform: string, arch: string) {
 
   switch (platform) {
     case "win32": {
-      // prefer exe over tar.xz for windows
-      optionalKeywords.push(".exe", ".exe")
+      // prefer tar.xz packages of LLVM over exe as they provide a more complete LLVM package
+      optionalKeywords.push(".tar.xz", ".tar.xz")
       const osKeywordsChoice: string[] = []
       if (x86_64.includes(arch)) {
         osKeywordsChoice.push("win64")
diff --git a/src/setup-cpp.ts b/src/setup-cpp.ts
@@ -134,7 +134,7 @@ All the available tools:
       cache: { tools: "--ccache, --sccache" },
       documentation: { tools: "--doxygen, --graphviz" },
       coverage: { tools: "--gcovr, --opencppcoverage, --kcov" },
-      other: { tools: "--python, --powershell, --sevenzip" },
+      other: { tools: "--python, --powershell, --sevenzip, --tar" },
     },
     ["tools"],
   )
diff --git a/src/tar/__tests__/tar.test.ts b/src/tar/__tests__/tar.test.ts
@@ -0,0 +1,12 @@
+import type { InstallationInfo } from "../../utils/setup/setupBin.js"
+import { testBin } from "../../utils/tests/test-helpers.js"
+import { setupTar } from "../tar.js"
+
+jest.setTimeout(300000)
+describe("setup-tar", () => {
+  it("should setup tar", async () => {
+    const installInfo = await setupTar("", "", process.arch)
+
+    await testBin("tar", ["--version"], (installInfo as InstallationInfo | undefined)?.binDir)
+  })
+})
diff --git a/src/tar/tar.ts b/src/tar/tar.ts
@@ -0,0 +1,61 @@
+import { info } from "ci-log"
+import { hasApk, installApkPack } from "setup-alpine"
+import { hasAptGet, installAptPack } from "setup-apt"
+import { installBrewPack } from "setup-brew"
+import which from "which"
+import { hasDnf } from "../utils/env/hasDnf.js"
+import { isArch } from "../utils/env/isArch.js"
+import { setupBin } from "../utils/setup/setupBin.js"
+import { setupDnfPack } from "../utils/setup/setupDnfPack.js"
+import { setupPacmanPack } from "../utils/setup/setupPacmanPack.js"
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export async function setupTar(version: string, setupDir: string, arch: string) {
+  const tar = await which("tar", { nothrow: true })
+  if (tar !== null) {
+    info(`tar already installed at ${tar}`)
+    return
+  }
+
+  switch (process.platform) {
+    case "win32": {
+      // install tar from GnuWin
+      // https://phoenixnap.dl.sourceforge.net/project/gnuwin32/tar/1.13-1/tar-1.13-1-bin.zip?viasf=1
+      return setupBin(
+        "tar",
+        "1.13-1",
+        () => {
+          return {
+            url: "https://phoenixnap.dl.sourceforge.net/project/gnuwin32/tar/1.13-1/tar-1.13-1-bin.zip?viasf=1",
+            extractedFolderName: "",
+            binRelativeDir: "bin",
+            binFileName: "tar.exe",
+          }
+        },
+        setupDir,
+        arch,
+      )
+    }
+    case "darwin": {
+      // installs as gtar
+      return installBrewPack("gnu-tar", version)
+    }
+    case "linux": {
+      if (isArch()) {
+        await setupPacmanPack("gzip")
+        await setupPacmanPack("xz")
+        return setupPacmanPack("tar")
+      } else if (hasDnf()) {
+        return setupDnfPack([{ name: "tar" }, { name: "gzip" }, { name: "xz" }])
+      } else if (hasAptGet()) {
+        return installAptPack([{ name: "tar" }, { name: "gzip" }, { name: "xz-utils" }])
+      } else if (await hasApk()) {
+        return installApkPack([{ name: "tar" }, { name: "gzip" }, { name: "xz" }])
+      }
+      throw new Error("Unsupported linux distribution")
+    }
+    default: {
+      throw new Error("Unsupported platform")
+    }
+  }
+}
diff --git a/src/tool.ts b/src/tool.ts
@@ -29,6 +29,7 @@ import { setupPowershell } from "./powershell/powershell.js"
 import { setupPython } from "./python/python.js"
 import { setupSccache } from "./sccache/sccache.js"
 import { setupSevenZip } from "./sevenzip/sevenzip.js"
+import { setupTar } from "./tar/tar.js"
 import { setupTask } from "./task/task.js"
 import { setupVcpkg } from "./vcpkg/vcpkg.js"
 import { setupVCVarsall } from "./vcvarsall/vcvarsall.js"
@@ -105,6 +106,7 @@ export const setups = {
   sevenzip: setupSevenZip,
   "7zip": setupSevenZip,
   "7z": setupSevenZip,
+  tar: setupTar,
 } as const
 
 export type ToolName = keyof typeof setups
diff --git a/src/utils/setup/extract.ts b/src/utils/setup/extract.ts
@@ -2,16 +2,10 @@ import { basename, dirname, join } from "path"
 import { grantUserWriteAccess } from "admina"
 import { info, warning } from "ci-log"
 import { execa } from "execa"
-import { mkdirp, move } from "fs-extra"
-import { rm } from "fs/promises"
-import { hasApk, installApkPack } from "setup-alpine"
-import { hasAptGet, installAptPack } from "setup-apt"
+import { mkdirp, move, readdir, remove, stat } from "fs-extra"
 import which from "which"
 import { setupSevenZip } from "../../sevenzip/sevenzip.js"
-import { hasDnf } from "../env/hasDnf.js"
-import { isArch } from "../env/isArch.js"
-import { setupDnfPack } from "./setupDnfPack.js"
-import { setupPacmanPack } from "./setupPacmanPack.js"
+import { setupTar } from "../../tar/tar.js"
 export { extractTar, extractXar } from "@actions/tool-cache"
 
 export enum ArchiveType {
@@ -54,9 +48,8 @@ export function getExtractFunction(archiveType: ArchiveType) {
   switch (archiveType) {
     case ArchiveType.Tar:
     case ArchiveType.TarGz:
-      return extractTarByExe
     case ArchiveType.TarXz:
-      return extractTarByExe
+      return process.platform === "win32" ? extract7Zip : extractTarByExe
     case ArchiveType.Zip:
       return extractZip
     default:
@@ -67,23 +60,11 @@ export function getExtractFunction(archiveType: ArchiveType) {
 let sevenZip: string | undefined
 
 /// Extract 7z using 7z
-export async function extract7Zip(file: string, dest: string) {
+export async function extract7Zip(file: string, dest: string, stripComponents: boolean = false) {
   const name = basename(file)
 
   if (/.*\.tar\..+$/.test(name)) {
-    // if the file is tar.*, extract the compression first
-    const tarDir = dirname(file)
-    await run7zip(file, tarDir)
-    // extract the tar
-    const tarName = name.slice(0, -3)
-    const tarFile = join(tarDir, tarName)
-    await run7zip(tarFile, tarDir)
-    await rm(tarFile)
-    // Move the extracted files to the destination
-    const folderName = tarName.slice(0, -4)
-    const folderPath = join(tarDir, folderName)
-    info(`Moving ${folderPath} to ${dest}`)
-    await move(folderPath, dest, { overwrite: true })
+    await extractTarXzBy7zip(file, name, dest, stripComponents)
   } else {
     // extract the 7z file directly
     await run7zip(file, dest)
@@ -92,6 +73,60 @@ export async function extract7Zip(file: string, dest: string) {
   return dest
 }
 
+async function extractTarXzBy7zip(file: string, name: string, dest: string, stripComponents: boolean) {
+  if (!/.*\.tar\..+$/.test(name)) {
+    throw new Error(`Invalid tar file: ${name}`)
+  }
+  // extract the compression first
+  const tarDir = join(dirname(file), "sevenzip-temp")
+  await run7zip(file, tarDir)
+  // extract the tar
+  const tarName = name.slice(0, -3)
+  const tarFile = join(tarDir, tarName)
+  await run7zip(tarFile, tarDir)
+  await remove(tarFile)
+  // move the extracted files to the destination
+  info(`Moving ${tarDir} to ${dest}`)
+  const files = await readdir(tarDir)
+  await Promise.all(
+    files.map(async (file) => {
+      await move(join(tarDir, file), join(dest, file), { overwrite: true })
+    }),
+  )
+  await remove(tarDir)
+
+  if (stripComponents) {
+    await stripPathComponents(dest)
+  }
+}
+
+async function stripPathComponents(dest: string) {
+  info(`Stripping path components from ${dest}`)
+
+  // get all subfolders in the folder
+  const toStrip = await readdir(dest)
+  if (toStrip.length !== 1) {
+    throw new Error(`Expected 1 folder in ${dest}, got ${toStrip.length}`)
+  }
+  const subFolder = toStrip[0]
+  const subFolderPath = join(dest, subFolder)
+  const subFolderStat = await stat(subFolderPath)
+  if (!subFolderStat.isDirectory()) {
+    // if the subfolder is not a directory, do nothing
+    warning(`Expected ${subFolderPath} to be a directory, got ${subFolderStat}.`)
+    return
+  }
+  // for each child of the subfolder, move all files to the destination
+  const subFiles = await readdir(subFolderPath)
+  await Promise.all(
+    subFiles.map((subFile) => {
+      return move(join(subFolderPath, subFile), join(dest, subFile), { overwrite: true })
+    }),
+  )
+  // remove the subfolder
+  await remove(subFolderPath)
+}
+
 async function run7zip(file: string, dest: string) {
   info(`7z: extracting ${file} to ${dest}`)
   await execa(await getSevenZip(), ["x", file, `-o${dest}`, "-y"], { stdio: "inherit" })
@@ -134,7 +169,7 @@ export async function extractZip(file: string, dest: string) {
 }
 
 export async function extractTarByExe(file: string, dest: string, stripComponents: number = 0, flags: string[] = []) {
-  await installTarDependencies(getArchiveType(file))
+  await setupTar("", "", process.arch)
 
   try {
     await mkdirp(dest)
@@ -158,42 +193,3 @@ export async function extractTarByExe(file: string, dest: string, stripComponent
   await grantUserWriteAccess(dest)
   return dest
 }
-
-async function installTarDependencies(archiveType: ArchiveType) {
-  info("Installing tar extraction dependencies")
-
-  switch (archiveType) {
-    case ArchiveType.TarGz: {
-      if (process.platform === "linux") {
-        if (isArch()) {
-          await setupPacmanPack("gzip")
-          await setupPacmanPack("tar")
-        } else if (hasDnf()) {
-          await setupDnfPack([{ name: "gzip" }, { name: "tar" }])
-        } else if (hasAptGet()) {
-          await installAptPack([{ name: "gzip" }, { name: "tar" }])
-        } else if (await hasApk()) {
-          await installApkPack([{ name: "gzip" }, { name: "tar" }])
-        }
-      }
-      break
-    }
-    case ArchiveType.TarXz: {
-      if (process.platform === "linux") {
-        if (isArch()) {
-          await setupPacmanPack("xz")
-          await setupPacmanPack("tar")
-        } else if (hasDnf()) {
-          await setupDnfPack([{ name: "xz" }, { name: "tar" }])
-        } else if (hasAptGet()) {
-          await installAptPack([{ name: "xz-utils" }, { name: "tar" }])
-        } else if (await hasApk()) {
-          await installApkPack([{ name: "xz" }, { name: "tar" }])
-        }
-      }
-      break
-    }
-    default:
-      throw new Error(`Unsupported archive type: ${archiveType} for tar extraction`)
-  }
-}
diff --git a/src/utils/setup/setupBin.ts b/src/utils/setup/setupBin.ts
@@ -138,7 +138,8 @@ async function tryDownload(name: string, version: string, url: string) {
   // try to download the package 4 times with 2 seconds delay
   const downloaded = await retry(
     () => {
-      const downloadedFilePath = join(process.env.RUNNER_TEMP ?? tmpdir(), `${Date.now()}-${basename(url)}`)
+      const prefix = `${Date.now()}-setup-cpp-`
+      const downloadedFilePath = join(process.env.RUNNER_TEMP ?? tmpdir(), `${prefix}${basename(url)}`)
 
       return downloadTool(url, downloadedFilePath)
     },

Original file line number	Diff line number	Diff line change
`@@ -134,7 +134,7 @@ All the available tools:`
`134`	`134`	`cache: { tools: "--ccache, --sccache" },`
`135`	`135`	`documentation: { tools: "--doxygen, --graphviz" },`
`136`	`136`	`coverage: { tools: "--gcovr, --opencppcoverage, --kcov" },`
`137`		`- other: { tools: "--python, --powershell, --sevenzip" },`
	`137`	`+ other: { tools: "--python, --powershell, --sevenzip, --tar" },`
`138`	`138`	`},`
`139`	`139`	`["tools"],`
`140`	`140`	`)`