feat: add apt-fast as an installable tool

Author: aminya

README.md

@@ -31,7 +31,7 @@ Setting up a **cross-platform** environment for building and testing C++/C proje
 | --------------- | ----------------------------------------------------------------------------------------------------------- |
 | compiler        | llvm, gcc, msvc, apple-clang, vcvarsall                                                                     |
 | build system    | cmake, ninja, meson, make, task, bazel                                                                      |
-| package manager | vcpkg, conan, choco, brew, nala, git, setup-cpp                                                             |
+| package manager | vcpkg, conan, choco, brew, apt-fast, nala, git, setup-cpp                                                   |
 | analyzer/linter | clang-tidy, clang-format, cppcheck, cpplint, flawfinder, lizard, infer, cmakelang, cmake-format, cmake-lint |
 | cache           | ccache, sccache                                                                                             |
 | documentation   | doxygen, graphviz                                                                                           |

dev/docker/ci/ubuntu.dockerfile

@@ -23,6 +23,7 @@ COPY "./dist/modern" "/usr/lib/setup-cpp/"
 
 # install the cpp tools
 RUN node --enable-source-maps /usr/lib/setup-cpp/setup-cpp.mjs \
+        --apt-fast true \
         --cmake true \
         --ninja true \
         --task true \

dist/legacy/setup-cpp.js

@@ -0,0 +1,21 @@
+import { execRootSync } from "admina"
+import { hasAptGet } from "../../utils/env/hasAptGet.js"
+import { testBin } from "../../utils/tests/test-helpers.js"
+import { setupAptFast } from "../apt-fast.js"
+
+jest.setTimeout(300000)
+describe("setup-apt-fast", () => {
+  if (!hasAptGet()) {
+    test.skip("should setup apt-fast", () => {})
+    return
+  }
+  it("should setup apt-fast", async () => {
+    const installInfo = await setupAptFast("", "", process.arch)
+    await testBin("apt-fast", ["--version"], installInfo?.binDir)
+  })
+
+  afterAll(() => {
+    // remove apt-fast to run the rest of the tests with apt-get
+    execRootSync("apt-get", ["remove", "-y", "apt-fast"])
+  })
+})

dist/legacy/setup-cpp.js.map

@@ -0,0 +1,58 @@
+import { tmpdir } from "os"
+import { dirname, join } from "path"
+import { execRootSync } from "admina"
+import { error } from "ci-log"
+import { readFile, writeFile } from "fs/promises"
+import { DownloaderHelper } from "node-downloader-helper"
+import which from "which"
+import { hasAptGet } from "../utils/env/hasAptGet.js"
+
+let binDir: string | undefined
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export async function setupAptFast(_version: string, _setupDir: string, _arch: string) {
+  if (!hasAptGet()) {
+    return undefined
+  }
+  if (typeof binDir === "string") {
+    return { binDir }
+  }
+
+  const maybeBinDir = which.sync("apt-fast", { nothrow: true })
+  if (maybeBinDir !== null) {
+    binDir = dirname(maybeBinDir)
+    return { binDir }
+  }
+
+  binDir = "/usr/bin" // eslint-disable-line require-atomic-updates
+
+  // Install via the installer script
+  await setupAptFastViaInstaller()
+
+  return { binDir }
+}
+
+async function setupAptFastViaInstaller() {
+  const installer = new DownloaderHelper(
+    "https://git.io/vokNn",
+    tmpdir(),
+    { fileName: "install-apt-fast.sh" },
+  )
+  installer.on("error", (err) => {
+    throw new Error(`Failed to download install-apt-fast.sh: ${err}`)
+  })
+  await installer.start()
+
+  const installerPath = join(tmpdir(), "install-apt-fast.sh")
+
+  // Patch the installer script to not use sudo explicitly
+  const script = await readFile(installerPath, "utf8")
+  await writeFile(installerPath, script.replace(/sudo/g, ""))
+
+  try {
+    execRootSync("bash", [installerPath])
+  } catch (err) {
+    error(`Failed to install apt-fast via installer: ${err}`)
+    execRootSync("apt", ["install", "-y", "-t", "apt-fast", "apt-fast"])
+  }
+}

dist/modern/setup-cpp.mjs

@@ -126,7 +126,7 @@ All the available tools:
       "build system": {
         tools: "--cmake, --ninja, --meson, --make, --task, --bazel",
       },
-      "package manager": { tools: "--vcpkg, --conan, --choco, --brew, --nala, --git, --setup-cpp" },
+      "package manager": { tools: "--vcpkg, --conan, --choco, --brew, --apt-fast, --nala, --git, --setup-cpp" },
       "analyzer/linter": {
         tools:
           "--clang-tidy, --clang-format, --cppcheck, --cpplint, --flawfinder, --lizard, --infer, , --cmakelang, --cmake-lint, --cmake-format",

dist/modern/setup-cpp.mjs.map

@@ -1,4 +1,5 @@
 import { setupBrew } from "setup-brew"
+import { setupAptFast } from "./apt-fast/apt-fast.js"
 import { setupBazel } from "./bazel/bazel.js"
 import { setupCcache } from "./ccache/ccache.js"
 import { setupChocolatey } from "./chocolatey/chocolatey.js"
@@ -61,8 +62,10 @@ export const llvmTools = ["llvm", "clang", "clang++", "clang-tidy", "clang-forma
 
 /** The setup functions */
 export const setups = {
-  git: setupGit,
+  "apt-fast": setupAptFast,
+  aptfast: setupAptFast,
   nala: setupNala,
+  git: setupGit,
   brew: setupBrew,
   choco: setupChocolatey,
   python: setupPython,