feat: change the installation directory to ~/tool

aminya · aminya · commit c6eb5ca89b5a · 2021-11-21T12:53:27.000-06:00
BREAKING CHANGE
diff --git a/dist/setup_cpp.js b/dist/setup_cpp.js
diff --git a/dist/setup_cpp.js.map b/dist/setup_cpp.js.map
diff --git a/src/brew/brew.ts b/src/brew/brew.ts
@@ -5,7 +5,7 @@ import which from "which"
 let binDir: string | undefined
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-export function setupBrew(_version: string, _setupCppDir: string, _arch: string) {
+export function setupBrew(_version: string, _setupDir: string, _arch: string) {
   if (!["darwin", "linux"].includes(process.platform)) {
     return undefined
   }
diff --git a/src/ccache/ccache.ts b/src/ccache/ccache.ts
@@ -3,7 +3,7 @@ import { setupBrewPack } from "../utils/setup/setupBrewPack"
 import { setupChocoPack } from "../utils/setup/setupChocoPack"
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-export function setupCcache(version: string, _setupCppDir: string, _arch: string) {
+export function setupCcache(version: string, _setupDir: string, _arch: string) {
   switch (process.platform) {
     case "win32": {
       return setupChocoPack("ccache", version)
diff --git a/src/chocolatey/chocolatey.ts b/src/chocolatey/chocolatey.ts
@@ -11,7 +11,7 @@ export function setupChocolatey(
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   _version: string,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  _setupCppDir: string,
+  _setupDir: string,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   _arch: string
 ): InstallationInfo | undefined {
diff --git a/src/cmake/cmake.ts b/src/cmake/cmake.ts
@@ -60,6 +60,6 @@ function getCmakePackageInfo(version: string, platform?: NodeJS.Platform): Packa
 
 /** Setup cmake */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-export function setupCmake(version: string, setupCppDir: string, _arch: string): Promise<InstallationInfo> {
-  return setupBin("cmake", version, getCmakePackageInfo, setupCppDir)
+export function setupCmake(version: string, setupDir: string, _arch: string): Promise<InstallationInfo> {
+  return setupBin("cmake", version, getCmakePackageInfo, setupDir)
 }
diff --git a/src/conan/conan.ts b/src/conan/conan.ts
@@ -1,6 +1,6 @@
 import { setupPipPack } from "../utils/setup/setupPipPack"
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-export function setupConan(version: string | undefined, _setupCppDir: string, _arch: string) {
+export function setupConan(version: string | undefined, _setupDir: string, _arch: string) {
   return setupPipPack("conan", version)
 }
diff --git a/src/cppcheck/cppcheck.ts b/src/cppcheck/cppcheck.ts
@@ -4,7 +4,7 @@ import { setupBrewPack } from "../utils/setup/setupBrewPack"
 import { setupChocoPack } from "../utils/setup/setupChocoPack"
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-export async function setupCppcheck(version: string | undefined, _setupCppDir: string, _arch: string) {
+export async function setupCppcheck(version: string | undefined, _setupDir: string, _arch: string) {
   switch (process.platform) {
     case "win32": {
       await setupChocoPack("cppcheck", version)
diff --git a/src/doxygen/doxygen.ts b/src/doxygen/doxygen.ts
@@ -4,7 +4,7 @@ import { setupBrewPack } from "../utils/setup/setupBrewPack"
 import { setupChocoPack } from "../utils/setup/setupChocoPack"
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-export async function setupDoxygen(version: string | undefined, _setupCppDir: string, _arch: string) {
+export async function setupDoxygen(version: string | undefined, _setupDir: string, _arch: string) {
   switch (process.platform) {
     case "win32": {
       await setupChocoPack("doxygen.install", version)
diff --git a/src/gcc/gcc.ts b/src/gcc/gcc.ts
@@ -9,7 +9,7 @@ import semverCoerce from "semver/functions/coerce"
 import { setupMacOSSDK } from "../macos-sdk/macos-sdk"
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-export async function setupGcc(version: string, _setupCppDir: string, arch: string) {
+export async function setupGcc(version: string, _setupDir: string, arch: string) {
   let binDir: string | undefined
   switch (process.platform) {
     case "win32": {
diff --git a/src/gcovr/gcovr.ts b/src/gcovr/gcovr.ts
@@ -1,6 +1,6 @@
 import { setupPipPack } from "../utils/setup/setupPipPack"
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-export function setupGcovr(version: string | undefined, _setupCppDir: string, _arch: string) {
+export function setupGcovr(version: string | undefined, _setupDir: string, _arch: string) {
   return setupPipPack("gcovr", version)
 }
diff --git a/src/llvm/llvm.ts b/src/llvm/llvm.ts
@@ -231,17 +231,14 @@ async function getLLVMPackageInfo(version: string, platform: NodeJS.Platform): P
   }
 }
 
-// const DEFAULT_UNIX_DIRECTORY = "./llvm"
-// const DEFAULT_WIN32_DIRECTORY = "C:/Program Files/LLVM"
-
 export async function setupLLVM(
   version: string,
-  setupCppDir: string,
+  setupDir: string,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   _arch: string
 ): Promise<InstallationInfo> {
-  const installationInfo = await setupBin("llvm", version, getLLVMPackageInfo, setupCppDir)
-  await activateLLVM(setupCppDir, version)
+  const installationInfo = await setupBin("llvm", version, getLLVMPackageInfo, setupDir)
+  await activateLLVM(setupDir, version)
   return installationInfo
 }
 
diff --git a/src/main.ts b/src/main.ts
@@ -23,6 +23,7 @@ import { setupGcc } from "./gcc/gcc"
 import { InstallationInfo } from "./utils/setup/setupBin"
 import { error, success } from "./utils/io/io"
 import { setupVcpkg } from "./vcpkg/vcpkg"
+import { join } from "path"
 
 /** The setup functions */
 const setups = {
@@ -93,7 +94,7 @@ export async function main(args: string[]): Promise<number> {
   const arch = opts.architecture ?? process.arch
 
   // the installation dir for the tools that are downloaded directly
-  const setupCppDir = process.env.SETUP_CPP_DIR ?? untildify("~/setup_cpp")
+  const setupCppDir = process.env.SETUP_CPP_DIR ?? untildify("~/")
 
   // report messages
   const successMessages: string[] = []
@@ -114,7 +115,7 @@ export async function main(args: string[]): Promise<number> {
       // runnig the setup function for this tool
       try {
         // eslint-disable-next-line no-await-in-loop
-        const installationInfo = await setupFunction(getVersion(tool, value), setupCppDir, arch)
+        const installationInfo = await setupFunction(getVersion(tool, value), join(setupCppDir, tool), arch)
 
         // preparing a report string
         if (installationInfo !== undefined) {
@@ -152,14 +153,14 @@ export async function main(args: string[]): Promise<number> {
         case "llvm":
         case "clang":
         case "clang++": {
-          await setupLLVM(getVersion("llvm", version) as string, setupCppDir, arch)
+          await setupLLVM(getVersion("llvm", version) as string, join(setupCppDir, "llvm"), arch)
           break
         }
         case "gcc":
         case "mingw":
         case "cygwin":
         case "msys": {
-          await setupGcc(getVersion("gcc", version) as string, setupCppDir, arch)
+          await setupGcc(getVersion("gcc", version) as string, join(setupCppDir, "gcc"), arch)
           break
         }
         case "cl":
@@ -169,7 +170,7 @@ export async function main(args: string[]): Promise<number> {
         case "visualstudio":
         case "visualcpp":
         case "visualc++": {
-          await setupMSVC(getVersion("msvc", version) as string, setupCppDir, arch)
+          await setupMSVC(getVersion("msvc", version) as string, join(setupCppDir, "msvc"), arch)
           break
         }
         default: {
@@ -221,15 +222,15 @@ main(process.argv)
 function printHelp() {
   core.info(`
 setup_cpp [options]
-setup_cpp --compiler llvm --cmake true --ninja true --ccache true --conan "1.40.1"
+setup_cpp --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
 
 Install all the tools required for building and testing C++/C projects.
 
 --architecture\t the cpu architecture to install the tools for. By default it uses the current CPU architecture.
 --compiler\t the <compiler> to install.
           \t You can specify the version instead of specifying just the name e.g: --compiler 'llvm-11'
 
---tool_name\t pass "true" or pass the <version> you would like to install for this tool.
+--tool_name\t pass "true" or pass the <version> you would like to install for this tool. e.g. --conan true or --conan "1.42.1"
 
 All the available tools:
 --llvm
diff --git a/src/meson/meson.ts b/src/meson/meson.ts
@@ -1,6 +1,6 @@
 import { setupPipPack } from "../utils/setup/setupPipPack"
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-export function setupMeson(version: string | undefined, _setupCppDir: string, _arch: string) {
+export function setupMeson(version: string | undefined, _setupDir: string, _arch: string) {
   return setupPipPack("meson", version)
 }
diff --git a/src/msvc/msvc.ts b/src/msvc/msvc.ts
@@ -22,7 +22,7 @@ function getArch(arch: string): string {
 
 export async function setupMSVC(
   version: MSVCVersion,
-  _setupCppDir: string,
+  _setupDir: string,
   arch: string,
   sdk?: string,
   uwp?: boolean,
diff --git a/src/ninja/ninja.ts b/src/ninja/ninja.ts
@@ -27,6 +27,6 @@ function getNinjaPackageInfo(version: string, platform: NodeJS.Platform): Packag
 }
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-export function setupNinja(version: string, setupCppDir: string, _arch: string): Promise<InstallationInfo> {
-  return setupBin("ninja", version, getNinjaPackageInfo, setupCppDir)
+export function setupNinja(version: string, setupDir: string, _arch: string): Promise<InstallationInfo> {
+  return setupBin("ninja", version, getNinjaPackageInfo, setupDir)
 }
diff --git a/src/opencppcoverage/opencppcoverage.ts b/src/opencppcoverage/opencppcoverage.ts
@@ -2,7 +2,7 @@ import { addPath } from "../utils/path/addPath"
 import { setupChocoPack } from "../utils/setup/setupChocoPack"
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-export async function setupOpencppcoverage(version: string | undefined, _setupCppDir: string, _arch: string) {
+export async function setupOpencppcoverage(version: string | undefined, _setupDir: string, _arch: string) {
   if (process.platform !== "win32") {
     return
   }
diff --git a/src/python/actions_python.ts b/src/python/actions_python.ts
@@ -7,7 +7,7 @@ function isPyPyVersion(versionSpec: string) {
   return versionSpec.startsWith("pypy-")
 }
 
-export async function setupActionsPython(version: string, _setupCppDir: string, arch: string) {
+export async function setupActionsPython(version: string, _setupDir: string, arch: string) {
   if (isPyPyVersion(version)) {
     const installed = await finderPyPy.findPyPyVersion(version, arch)
     core.info(
diff --git a/src/python/python.ts b/src/python/python.ts
@@ -8,24 +8,24 @@ import { join } from "path"
 import { isCI } from "../utils/env/isci"
 import { setupActionsPython } from "./actions_python"
 
-export function setupPython(version: string, setupCppDir: string, arch: string) {
+export function setupPython(version: string, setupDir: string, arch: string) {
   if (!isCI()) {
     // TODO parse versoin
-    return setupPythonViaSystem("", setupCppDir, arch)
+    return setupPythonViaSystem("", setupDir, arch)
   }
   try {
-    return setupActionsPython(version, setupCppDir, arch)
+    return setupActionsPython(version, setupDir, arch)
   } catch (err) {
-    return setupPythonViaSystem(version, setupCppDir, arch)
+    return setupPythonViaSystem(version, setupDir, arch)
   }
 }
 
-export async function setupPythonViaSystem(version: string, setupCppDir: string, arch: string) {
+export async function setupPythonViaSystem(version: string, setupDir: string, arch: string) {
   switch (process.platform) {
     case "win32": {
       // Get an unique output directory name from the URL.
       const key: string = await hasha.async(version + arch, { algorithm: "md5" })
-      const installDir = join(setupCppDir, key, "python")
+      const installDir = join(setupDir, key, "python")
       const binDir = installDir
       await setupChocoPack("python3", version, [`/InstallDir:${installDir}`])
 
diff --git a/src/utils/setup/setupBin.ts b/src/utils/setup/setupBin.ts
@@ -3,7 +3,6 @@ import { info } from "@actions/core"
 import { addPath } from "../path/addPath"
 import { join } from "path"
 import { existsSync } from "fs"
-import * as hasha from "hasha"
 import { tmpdir } from "os"
 import { isCI } from "../env/isci"
 
@@ -40,7 +39,7 @@ export async function setupBin(
   name: string,
   version: string,
   getPackageInfo: (version: string, platform: NodeJS.Platform) => PackageInfo | Promise<PackageInfo>,
-  setupCppDir: string
+  setupDir: string
 ): Promise<InstallationInfo> {
   process.env.RUNNER_TEMP = process.env.RUNNER_TEMP ?? tmpdir()
   process.env.RUNNER_TOOL_CACHE = process.env.RUNNER_TOOL_CACH ?? join(tmpdir(), "setup_cpp", "ToolCache")
@@ -63,18 +62,14 @@ export async function setupBin(
     }
   }
 
-  // Get an unique output directory name from the URL.
-  const key: string = await hasha.async(url, { algorithm: "md5" })
-  const rootDir = join(setupCppDir, key)
-
   // download ane extract the package into the installation directory.
-  if (!existsSync(rootDir)) {
+  if (!existsSync(setupDir)) {
     info(`Download and extract ${name} ${version}`)
     const downloaded = await downloadTool(url)
-    await extractFunction?.(downloaded, rootDir)
+    await extractFunction?.(downloaded, setupDir)
   }
 
-  const installDir = join(rootDir, extractedFolderName)
+  const installDir = join(setupDir, extractedFolderName)
   const binDir = join(installDir, binRelativeDir)
 
   // Adding the bin dir to the path
@@ -84,7 +79,7 @@ export async function setupBin(
 
   // check if inside Github Actions. If so, cache the installation
   if (isCI() && typeof process.env.RUNNER_TOOL_CACHE === "string") {
-    await cacheDir(rootDir, name, version)
+    await cacheDir(setupDir, name, version)
   }
 
   return { installDir, binDir }
diff --git a/src/vcpkg/vcpkg.ts b/src/vcpkg/vcpkg.ts
@@ -1,22 +1,20 @@
 import { addPath } from "@actions/core"
 import execa from "execa"
-import path from "path"
-import untildify from "untildify"
+import path, { dirname } from "path"
 import which from "which"
 import { addShellExtension, addShellHere } from "../utils/extension/extension"
 import { InstallationInfo } from "../utils/setup/setupBin"
 
 let hasVCPKG = false
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-export function setupVcpkg(_version: string, _setupCppDir: string, _arch: string): InstallationInfo {
+export function setupVcpkg(_version: string, setupDir: string, _arch: string): InstallationInfo {
   if (!hasVCPKG || which.sync("vcpkg", { nothrow: true }) === null) {
-    execa.sync("git", ["clone", "https://github.com/microsoft/vcpkg"], { cwd: untildify("~/") })
-    const vcpkgDir = untildify("~/vcpkg")
-    execa.sync(addShellExtension(addShellHere("bootstrap-vcpkg")), { cwd: vcpkgDir, shell: true })
-    addPath(vcpkgDir)
+    execa.sync("git", ["clone", "https://github.com/microsoft/vcpkg"], { cwd: dirname(setupDir) })
+    execa.sync(addShellExtension(addShellHere("bootstrap-vcpkg")), { cwd: setupDir, shell: true })
+    addPath(setupDir)
     hasVCPKG = true
-    return { binDir: vcpkgDir }
+    return { binDir: setupDir }
   }
 
   return { binDir: path.dirname(which.sync("vcpkg")) }

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import which from "which"`
`5`	`5`	`let binDir: string \| undefined`
`6`	`6`
`7`	`7`	`// eslint-disable-next-line @typescript-eslint/no-unused-vars`
`8`		`-export function setupBrew(_version: string, _setupCppDir: string, _arch: string) {`
	`8`	`+export function setupBrew(_version: string, _setupDir: string, _arch: string) {`
`9`	`9`	`if (!["darwin", "linux"].includes(process.platform)) {`
`10`	`10`	`return undefined`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,6 @@ function getCmakePackageInfo(version: string, platform?: NodeJS.Platform): Packa`
`60`	`60`
`61`	`61`	`/** Setup cmake */`
`62`	`62`	`// eslint-disable-next-line @typescript-eslint/no-unused-vars`
`63`		`-export function setupCmake(version: string, setupCppDir: string, _arch: string): Promise<InstallationInfo> {`
`64`		`- return setupBin("cmake", version, getCmakePackageInfo, setupCppDir)`
	`63`	`+export function setupCmake(version: string, setupDir: string, _arch: string): Promise<InstallationInfo> {`
	`64`	`+ return setupBin("cmake", version, getCmakePackageInfo, setupDir)`
`65`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`import { setupPipPack } from "../utils/setup/setupPipPack"`
`2`	`2`
`3`	`3`	`// eslint-disable-next-line @typescript-eslint/no-unused-vars`
`4`		`-export function setupConan(version: string \| undefined, _setupCppDir: string, _arch: string) {`
	`4`	`+export function setupConan(version: string \| undefined, _setupDir: string, _arch: string) {`
`5`	`5`	`return setupPipPack("conan", version)`
`6`	`6`	`}`