Merge pull request #137 from aminya/refactor-version [skip ci]

aminya · web-flow · commit 73a098f0c640 · 2022-11-02T20:44:00.000-07:00
diff --git a/dist/node12/setup_cpp.js b/dist/node12/setup_cpp.js
diff --git a/dist/node12/setup_cpp.js.map b/dist/node12/setup_cpp.js.map
diff --git a/dist/node16/setup_cpp.js b/dist/node16/setup_cpp.js
diff --git a/dist/node16/setup_cpp.js.map b/dist/node16/setup_cpp.js.map
diff --git a/src/__tests__/main.test.ts b/src/__tests__/main.test.ts
@@ -1,4 +1,4 @@
-import { syncVersions, getVersion } from "../default_versions"
+import { syncVersions, getVersion } from "../versions/versions"
 import { getCompilerInfo, Inputs, parseArgs } from "../main"
 
 jest.setTimeout(300000)
diff --git a/src/cmake/__tests__/cmake.test.ts b/src/cmake/__tests__/cmake.test.ts
@@ -1,7 +1,7 @@
 import { setupCmake } from "../cmake"
 import { setupTmpDir, cleanupTmpDir, testBin } from "../../utils/tests/test-helpers"
 import ciDetect from "@npmcli/ci-detect"
-import { getVersion } from "../../default_versions"
+import { getVersion } from "../../versions/versions"
 
 jest.setTimeout(300000)
 
diff --git a/src/conan/__tests__/conan.test.ts b/src/conan/__tests__/conan.test.ts
@@ -1,6 +1,6 @@
 import { setupConan } from "../conan"
 import { testBin } from "../../utils/tests/test-helpers"
-import { getVersion } from "../../default_versions"
+import { getVersion } from "../../versions/versions"
 
 jest.setTimeout(300000)
 describe("setup-conan", () => {
diff --git a/src/cppcheck/__tests__/cppcheck.test.ts b/src/cppcheck/__tests__/cppcheck.test.ts
@@ -1,6 +1,6 @@
 import { setupCppcheck } from "../cppcheck"
 import { testBin } from "../../utils/tests/test-helpers"
-import { getVersion } from "../../default_versions"
+import { getVersion } from "../../versions/versions"
 
 jest.setTimeout(300000)
 describe("setup-cppcheck", () => {
diff --git a/src/doxygen/__tests__/doxygen.test.ts b/src/doxygen/__tests__/doxygen.test.ts
@@ -1,7 +1,7 @@
 import { setupDoxygen } from "../doxygen"
 import { cleanupTmpDir, setupTmpDir, testBin } from "../../utils/tests/test-helpers"
 import { InstallationInfo } from "../../utils/setup/setupBin"
-import { getVersion } from "../../default_versions"
+import { getVersion } from "../../versions/versions"
 import which from "which"
 import { ubuntuVersion } from "../../utils/env/ubuntu_version"
 
diff --git a/src/doxygen/doxygen.ts b/src/doxygen/doxygen.ts
@@ -8,7 +8,7 @@ import { addExeExt, join } from "patha"
 import { extractTar, extractZip } from "../utils/setup/extract"
 import { notice } from "ci-log"
 import { setupGraphviz } from "../graphviz/graphviz"
-import { getVersion } from "../default_versions"
+import { getVersion } from "../versions/versions"
 import { existsSync } from "fs"
 import { isArch } from "../utils/env/isArch"
 import { hasDnf } from "../utils/env/hasDnf"
diff --git a/src/gcc/__tests__/gcc.test.ts b/src/gcc/__tests__/gcc.test.ts
@@ -1,6 +1,6 @@
 import { cleanupTmpDir, setupTmpDir, testBin } from "../../utils/tests/test-helpers"
 import { setupGcc } from "../gcc"
-import { getVersion } from "../../default_versions"
+import { getVersion } from "../../versions/versions"
 import { join, addExeExt } from "patha"
 import execa from "execa"
 import { chmodSync } from "fs"
diff --git a/src/gcovr/__tests__/gcovr.test.ts b/src/gcovr/__tests__/gcovr.test.ts
@@ -1,6 +1,6 @@
 import { setupGcovr } from "../gcovr"
 import { testBin } from "../../utils/tests/test-helpers"
-import { getVersion } from "../../default_versions"
+import { getVersion } from "../../versions/versions"
 import { ubuntuVersion } from "../../utils/env/ubuntu_version"
 
 jest.setTimeout(300000)
diff --git a/src/graphviz/__tests__/graphviz.test.ts b/src/graphviz/__tests__/graphviz.test.ts
@@ -1,7 +1,7 @@
 import { setupGraphviz } from "../graphviz"
 import { cleanupTmpDir, setupTmpDir, testBin } from "../../utils/tests/test-helpers"
 import { InstallationInfo } from "../../utils/setup/setupBin"
-import { getVersion } from "../../default_versions"
+import { getVersion } from "../../versions/versions"
 
 jest.setTimeout(300000)
 describe("setup-graphviz", () => {
diff --git a/src/kcov/kcov.ts b/src/kcov/kcov.ts
@@ -2,7 +2,7 @@ import execa from "execa"
 import { join, addExeExt } from "patha"
 import which from "which"
 import { setupCmake } from "../cmake/cmake"
-import { getVersion } from "../default_versions"
+import { getVersion } from "../versions/versions"
 import { extractTarByExe } from "../utils/setup/extract"
 import { setupAptPack } from "../utils/setup/setupAptPack"
 import { setupPacmanPack } from "../utils/setup/setupPacmanPack"
diff --git a/src/llvm/__tests__/llvm.test.ts b/src/llvm/__tests__/llvm.test.ts
@@ -6,7 +6,7 @@ import ciDetect from "@npmcli/ci-detect"
 import execa from "execa"
 import path, { addExeExt } from "patha"
 import { chmodSync } from "fs"
-import { getVersion } from "../../default_versions"
+import { getVersion } from "../../versions/versions"
 import { ubuntuVersion } from "../../utils/env/ubuntu_version"
 import * as io from "@actions/io"
 
diff --git a/src/llvm/llvm.ts b/src/llvm/llvm.ts
@@ -19,7 +19,7 @@ import { info, warning } from "ci-log"
 import { existsSync } from "fs"
 import ciDetect from "@npmcli/ci-detect"
 import { setupGcc } from "../gcc/gcc"
-import { getVersion } from "../default_versions"
+import { getVersion } from "../versions/versions"
 import { isArch } from "../utils/env/isArch"
 import { isUbuntu } from "../utils/env/isUbuntu"
 
diff --git a/src/main.ts b/src/main.ts
@@ -31,7 +31,7 @@ import numerousLocale from "numerous/locales/en.js"
 import { ubuntuVersion } from "./utils/env/ubuntu_version"
 
 import semverValid from "semver/functions/valid"
-import { getVersion, syncVersions } from "./default_versions"
+import { getVersion, syncVersions } from "./versions/versions"
 import { setupGcc } from "./gcc/gcc"
 import { InstallationInfo } from "./utils/setup/setupBin"
 import { error, info, success, warning } from "ci-log"
@@ -148,13 +148,7 @@ export async function main(args: string[]): Promise<number> {
 
   // installing the specified tools
 
-  let osVersion: number[] | null = null
-  try {
-    // get the version if not already done
-    osVersion = await ubuntuVersion()
-  } catch (err) {
-    warning((err as Error).toString())
-  }
+  const osVersion = await ubuntuVersion()
 
   // sync the version for the llvm tools
   if (!syncVersions(opts, ["llvm", "clangtidy", "clangformat"])) {
diff --git a/src/meson/__tests__/meson.test.ts b/src/meson/__tests__/meson.test.ts
@@ -1,6 +1,6 @@
 import { setupMeson } from "../meson"
 import { testBin } from "../../utils/tests/test-helpers"
-import { getVersion } from "../../default_versions"
+import { getVersion } from "../../versions/versions"
 import { ubuntuVersion } from "../../utils/env/ubuntu_version"
 
 jest.setTimeout(300000)
diff --git a/src/ninja/__tests__/ninja.test.ts b/src/ninja/__tests__/ninja.test.ts
@@ -1,7 +1,7 @@
 import { setupNinja } from "../ninja"
 import { setupTmpDir, cleanupTmpDir, testBin } from "../../utils/tests/test-helpers"
 import ciDetect from "@npmcli/ci-detect"
-import { getVersion } from "../../default_versions"
+import { getVersion } from "../../versions/versions"
 
 jest.setTimeout(300000)
 async function testNinja(directory: string) {
diff --git a/src/powershell/__tests__/powershell.test.ts b/src/powershell/__tests__/powershell.test.ts
@@ -1,6 +1,6 @@
 import { setupPowershell } from "../powershell"
 import { testBin } from "../../utils/tests/test-helpers"
-import { getVersion } from "../../default_versions"
+import { getVersion } from "../../versions/versions"
 
 jest.setTimeout(300000)
 describe("setup-powershell", () => {
diff --git a/src/python/__tests__/python.test.ts b/src/python/__tests__/python.test.ts
@@ -1,6 +1,6 @@
 import { setupPython } from "../python"
 import { cleanupTmpDir, setupTmpDir, testBin } from "../../utils/tests/test-helpers"
-import { getVersion } from "../../default_versions"
+import { getVersion } from "../../versions/versions"
 import { ubuntuVersion } from "../../utils/env/ubuntu_version"
 import ciDetect from "@npmcli/ci-detect"
 import { info } from "ci-log"
diff --git a/src/task/__tests__/task.test.ts b/src/task/__tests__/task.test.ts
@@ -1,7 +1,7 @@
 import { setupTask } from "../task"
 import { cleanupTmpDir, setupTmpDir, testBin } from "../../utils/tests/test-helpers"
 import ciDetect from "@npmcli/ci-detect"
-import { getVersion } from "../../default_versions"
+import { getVersion } from "../../versions/versions"
 
 jest.setTimeout(300000)
 describe("setup-task", () => {
diff --git a/src/utils/env/ubuntu_version.ts b/src/utils/env/ubuntu_version.ts
@@ -1,21 +1,28 @@
+import { warning } from "ci-log"
 import { getUbuntuVersion } from "ubuntu-version"
 import which from "which"
 import { setupAptPack } from "../setup/setupAptPack"
 import { isUbuntu } from "./isUbuntu"
 
 export async function ubuntuVersion(): Promise<number[] | null> {
-  if (isUbuntu()) {
-    if (which.sync("lsb_release", { nothrow: true }) === null) {
-      await setupAptPack("lsb-release")
-    }
-    const versionSplitted = await getUbuntuVersion()
+  try {
+    if (isUbuntu()) {
+      if (which.sync("lsb_release", { nothrow: true }) === null) {
+        await setupAptPack("lsb-release")
+      }
+      const versionSplitted = await getUbuntuVersion()
 
-    if (versionSplitted.length === 0) {
-      throw new Error("Failed to get the ubuntu major version.")
-    }
+      if (versionSplitted.length === 0) {
+        warning("Failed to get the ubuntu major version.")
+        return null
+      }
 
-    return versionSplitted
-  } else {
+      return versionSplitted
+    } else {
+      return null
+    }
+  } catch (err) {
+    warning((err as Error).toString())
     return null
   }
 }
diff --git a/src/utils/setup/setupPipPack.ts b/src/utils/setup/setupPipPack.ts
@@ -7,7 +7,7 @@ import { addPath } from "../env/addEnv"
 import { setupPython } from "../../python/python"
 import { isBinUptoDate } from "./version"
 import { join } from "patha"
-import { getVersion } from "../../default_versions"
+import { getVersion } from "../../versions/versions"
 import { InstallationInfo } from "./setupBin"
 import { setupAptPack } from "./setupAptPack"
 import { setupPacmanPack } from "./setupPacmanPack"
diff --git a/src/versions/default_versions.ts b/src/versions/default_versions.ts
@@ -1,10 +1,9 @@
-import { Inputs, Opts } from "./main"
-import { isArch } from "./utils/env/isArch"
+import { isArch } from "../utils/env/isArch"
 
 // passing "" to a tool installed by a package manager (apt, brew, choco) will result in the default version of that package manager.
 // the directly downloaded tools require a given version ("" doesn't work).
 
-const DefaultVersions: Record<string, string> = {
+export const DefaultVersions: Record<string, string> = {
   llvm: "13.0.0", // https://github.com/llvm/llvm-project/releases
   clangtidy: "13.0.0",
   clangformat: "13.0.0",
@@ -22,7 +21,7 @@ const DefaultVersions: Record<string, string> = {
 /// If an ubuntu versions is not in this map:
 // - the newer ubuntu versions use the first entry (e.g. v20),
 // - the older ones use ""
-const DefaultUbuntuVersion: Record<string, Record<number, string>> = {
+export const DefaultLinuxVersion: Record<string, Record<number, string>> = {
   llvm: {
     22: "13.0.0-ubuntu-20.04",
     20: "13.0.0-ubuntu-20.04",
@@ -69,51 +68,3 @@ const DefaultUbuntuVersion: Record<string, Record<number, string>> = {
     14: "40",
   },
 }
-
-/** Get the default version if passed true or undefined, otherwise return the version itself */
-export function getVersion(name: string, version: string | undefined, osVersion: number[] | null = null) {
-  if (useDefault(version, name)) {
-    // choose the default linux version based on ubuntu version
-    if (process.platform === "linux" && osVersion !== null && name in DefaultUbuntuVersion) {
-      const osVersionMaj = osVersion[0]
-      const newest = parseInt(Object.keys(DefaultUbuntuVersion[name])[0], 10) // newest version with the default
-      if (osVersionMaj >= newest) {
-        return DefaultUbuntuVersion[name][osVersionMaj]
-      } else {
-        return ""
-      }
-    }
-    // anything else
-    return DefaultVersions[name]
-  } else {
-    return version ?? ""
-  }
-}
-
-function useDefault(version: string | undefined, name: string) {
-  return version === "true" || (version === undefined && name in DefaultVersions)
-}
-
-export function syncVersions(opts: Opts, tools: Inputs[]): boolean {
-  for (let i = 0; i < tools.length; i++) {
-    // tools excluding i_tool
-    const otherTools = tools.slice(0, i).concat(tools.slice(i + 1))
-
-    const tool = tools[i]
-
-    if (!useDefault(opts[tool], tool)) {
-      for (let i_other = 0; i_other < otherTools.length; i_other++) {
-        const otherTool = otherTools[i_other]
-        const useDefaultOtherTool = useDefault(opts[otherTool], otherTools[i_other])
-        if (useDefaultOtherTool) {
-          // use the same version if the other tool was requested with the default
-          opts[otherTool] = opts[tool]
-        } else if (opts[tool] !== opts[otherTools[i_other]]) {
-          // error if different from the other given versions
-          return false
-        }
-      }
-    }
-  }
-  return true
-}
diff --git a/src/versions/versions.ts b/src/versions/versions.ts
@@ -0,0 +1,54 @@
+import { Inputs, Opts } from "../main"
+import { DefaultLinuxVersion, DefaultVersions } from "./default_versions"
+
+/** Get the default version if passed true or undefined, otherwise return the version itself */
+export function getVersion(name: string, version: string | undefined, osVersion: number[] | null = null) {
+  if (isDefault(version, name)) {
+    if (process.platform === "linux" && osVersion !== null && name in DefaultLinuxVersion) {
+      return getDefaultLinuxVersion(name, osVersion)
+    }
+    // anything else
+    return DefaultVersions[name]
+  } else {
+    return version ?? ""
+  }
+}
+
+/// choose the default linux version based on ubuntu version
+function getDefaultLinuxVersion(name: string, osVersion: number[]) {
+  const osVersionMaj = osVersion[0]
+  const newest = parseInt(Object.keys(DefaultLinuxVersion[name])[0], 10) // newest version with the default
+  if (osVersionMaj >= newest) {
+    return DefaultLinuxVersion[name][osVersionMaj]
+  } else {
+    return ""
+  }
+}
+
+export function isDefault(version: string | undefined, name: string) {
+  return version === "true" || (version === undefined && name in DefaultVersions)
+}
+
+export function syncVersions(opts: Opts, tools: Inputs[]): boolean {
+  for (let i = 0; i < tools.length; i++) {
+    // tools excluding i_tool
+    const otherTools = tools.slice(0, i).concat(tools.slice(i + 1))
+
+    const tool = tools[i]
+
+    if (!isDefault(opts[tool], tool)) {
+      for (let i_other = 0; i_other < otherTools.length; i_other++) {
+        const otherTool = otherTools[i_other]
+        const useDefaultOtherTool = isDefault(opts[otherTool], otherTools[i_other])
+        if (useDefaultOtherTool) {
+          // use the same version if the other tool was requested with the default
+          opts[otherTool] = opts[tool]
+        } else if (opts[tool] !== opts[otherTools[i_other]]) {
+          // error if different from the other given versions
+          return false
+        }
+      }
+    }
+  }
+  return true
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { syncVersions, getVersion } from "../default_versions"`
	`1`	`+import { syncVersions, getVersion } from "../versions/versions"`
`2`	`2`	`import { getCompilerInfo, Inputs, parseArgs } from "../main"`
`3`	`3`
`4`	`4`	`jest.setTimeout(300000)`