Merge pull request #297 from aminya/cpplint [skip ci]

README.md

@@ -14,15 +14,16 @@ Setting up a **cross-platform** environment for building and testing C++/C proje
 
 `setup-cpp` is **modular** and you can choose to install any of these tools:
 
-| category              | tools                                                                       |
-| --------------------- | --------------------------------------------------------------------------- |
-| compiler and analyzer | llvm, gcc, msvc, apple-clang, vcvarsall, cppcheck, clang-tidy, clang-format |
-| build system          | cmake, ninja, meson, make, task, bazel, cmakelang, cmake-format, cmake-lint |
-| package manager       | vcpkg, conan, choco, brew, nala                                             |
-| cache                 | ccache, sccache                                                             |
-| documentation         | doxygen, graphviz                                                           |
-| coverage              | gcovr, opencppcoverage, kcov                                                |
-| other                 | python, powershell, sevenzip                                                |
+| category        | tools                                                                                                       |
+| --------------- | ----------------------------------------------------------------------------------------------------------- |
+| compiler        | llvm, gcc, msvc, apple-clang, vcvarsall                                                                     |
+| build system    | cmake, ninja, meson, make, task, bazel                                                                      |
+| package manager | vcpkg, conan, choco, brew, nala                                                                             |
+| analyzer/linter | clang-tidy, clang-format, cppcheck, cpplint, flawfinder, lizard, infer, cmakelang, cmake-format, cmake-lint |
+| cache           | ccache, sccache                                                                                             |
+| documentation   | doxygen, graphviz                                                                                           |
+| coverage        | gcovr, opencppcoverage, kcov                                                                                |
+| other           | python, powershell, sevenzip                                                                                |
 
 `setup-cpp` automatically handles the dependencies of the selected tool (e.g., `python` is required for `conan`).
 

action.yml

@@ -55,6 +55,18 @@ inputs:
   cppcheck:
     description: "Wether to install cppcheck (true/false) or the specific version to install."
     required: false
+  cpplint:
+    description: "Wether to install cpplint (true/false) or the specific version to install."
+    required: false
+  flawfinder:
+    description: "Wether to install flawfinder (true/false) or the specific version to install."
+    required: false
+  lizard:
+    description: "Wether to install lizard (true/false) or the specific version to install."
+    required: false
+  infer:
+    description: "Wether to install facebook/infer (true/false) or the specific version to install."
+    required: false
   clang-tidy:
     description: "Wether to install clang-tidy (true/false) or the specific version to install."
     required: false

dist/legacy/github_facebook_infer.json

@@ -0,0 +1 @@
+{"v1.2.0":["infer-osx-x86_64-v1.2.0.tar.xz","infer-osx-arm64-v1.2.0.tar.xz","infer-linux-x86_64-v1.2.0.tar.xz"],"v1.1.0":["infer-linux64-v1.1.0.tar.xz"],"v1.0.0":["infer-osx-v1.0.0.tar.xz","infer-linux64-v1.0.0.tar.xz"],"v0.17.0":["infer-osx-v0.17.0.tar.xz","infer-linux64-v0.17.0.tar.xz"],"v0.16.0":["infer-osx-v0.16.0.tar.xz","infer-linux64-v0.16.0.tar.xz"],"v0.15.0":["infer-osx-v0.15.0.tar.xz","infer-linux64-v0.15.0.tar.xz"],"v0.14.0":["infer-osx-v0.14.0.tar.xz","infer-linux64-v0.14.0.tar.xz"],"v0.13.1":["infer-osx-v0.13.1.tar.xz","infer-linux64-v0.13.1.tar.xz"],"v0.13.0":["infer-osx-v0.13.0.tar.xz","infer-linux64-v0.13.0.tar.xz"],"v0.12.1":["infer-osx-v0.12.1.tar.xz","infer-linux64-v0.12.1.tar.xz"],"v0.12.0":["infer-osx-v0.12.0.tar.xz","infer-linux64-v0.12.0.tar.xz"],"v0.11.0":["infer-osx-v0.11.0.tar.xz","infer-linux64-v0.11.0.tar.xz"],"v0.10.0":["infer-osx-v0.10.0.tar.xz","infer-linux64-v0.10.0.tar.xz"],"v0.9.5":["infer-osx-v0.9.5.tar.xz","infer-linux64-v0.9.5.tar.xz"],"v0.9.4.1":["infer-osx-v0.9.4.1.tar.xz","infer-linux64-v0.9.4.1.tar.xz"],"v0.9.4":["infer-osx-v0.9.4.tar.xz","infer-linux64-v0.9.4.tar.xz"],"v0.9.3":["infer-osx-v0.9.3.tar.xz","infer-linux64-v0.9.3.tar.xz"],"v0.9.2":["infer-osx-v0.9.2.tar.xz","infer-linux64-v0.9.2.tar.xz"],"v0.9.1":["infer-osx-v0.9.1.tar.xz","infer-linux64-v0.9.1.tar.xz"],"v0.9.0":["infer-osx-v0.9.0.tar.xz","infer-linux64-v0.9.0.tar.xz"],"v0.8.1":["infer-osx-v0.8.1.tar.xz","infer-linux64-v0.8.1.tar.xz"],"v0.8.0":["infer-osx-v0.8.0.tar.xz","infer-linux64-v0.8.0.tar.xz"],"v0.7.0":["infer-osx-v0.7.0.tar.xz","infer-linux64-v0.7.0.tar.xz"],"v0.6.0":["infer-osx-v0.6.0.tar.xz","infer-linux64-v0.6.0.tar.xz"],"v0.5.0":["infer-osx-v0.5.0.tar.xz","infer-linux64-v0.5.0.tar.xz"],"v0.4.0":["infer-osx-v0.4.0.tar.xz","infer-linux64-v0.4.0.tar.xz"],"v0.3.0":["infer-osx-v0.3.0.tar.xz","infer-linux64-v0.3.0.tar.xz"]}

dist/modern/github_facebook_infer.json

@@ -0,0 +1 @@
+{"v1.2.0":["infer-osx-x86_64-v1.2.0.tar.xz","infer-osx-arm64-v1.2.0.tar.xz","infer-linux-x86_64-v1.2.0.tar.xz"],"v1.1.0":["infer-linux64-v1.1.0.tar.xz"],"v1.0.0":["infer-osx-v1.0.0.tar.xz","infer-linux64-v1.0.0.tar.xz"],"v0.17.0":["infer-osx-v0.17.0.tar.xz","infer-linux64-v0.17.0.tar.xz"],"v0.16.0":["infer-osx-v0.16.0.tar.xz","infer-linux64-v0.16.0.tar.xz"],"v0.15.0":["infer-osx-v0.15.0.tar.xz","infer-linux64-v0.15.0.tar.xz"],"v0.14.0":["infer-osx-v0.14.0.tar.xz","infer-linux64-v0.14.0.tar.xz"],"v0.13.1":["infer-osx-v0.13.1.tar.xz","infer-linux64-v0.13.1.tar.xz"],"v0.13.0":["infer-osx-v0.13.0.tar.xz","infer-linux64-v0.13.0.tar.xz"],"v0.12.1":["infer-osx-v0.12.1.tar.xz","infer-linux64-v0.12.1.tar.xz"],"v0.12.0":["infer-osx-v0.12.0.tar.xz","infer-linux64-v0.12.0.tar.xz"],"v0.11.0":["infer-osx-v0.11.0.tar.xz","infer-linux64-v0.11.0.tar.xz"],"v0.10.0":["infer-osx-v0.10.0.tar.xz","infer-linux64-v0.10.0.tar.xz"],"v0.9.5":["infer-osx-v0.9.5.tar.xz","infer-linux64-v0.9.5.tar.xz"],"v0.9.4.1":["infer-osx-v0.9.4.1.tar.xz","infer-linux64-v0.9.4.1.tar.xz"],"v0.9.4":["infer-osx-v0.9.4.tar.xz","infer-linux64-v0.9.4.tar.xz"],"v0.9.3":["infer-osx-v0.9.3.tar.xz","infer-linux64-v0.9.3.tar.xz"],"v0.9.2":["infer-osx-v0.9.2.tar.xz","infer-linux64-v0.9.2.tar.xz"],"v0.9.1":["infer-osx-v0.9.1.tar.xz","infer-linux64-v0.9.1.tar.xz"],"v0.9.0":["infer-osx-v0.9.0.tar.xz","infer-linux64-v0.9.0.tar.xz"],"v0.8.1":["infer-osx-v0.8.1.tar.xz","infer-linux64-v0.8.1.tar.xz"],"v0.8.0":["infer-osx-v0.8.0.tar.xz","infer-linux64-v0.8.0.tar.xz"],"v0.7.0":["infer-osx-v0.7.0.tar.xz","infer-linux64-v0.7.0.tar.xz"],"v0.6.0":["infer-osx-v0.6.0.tar.xz","infer-linux64-v0.6.0.tar.xz"],"v0.5.0":["infer-osx-v0.5.0.tar.xz","infer-linux64-v0.5.0.tar.xz"],"v0.4.0":["infer-osx-v0.4.0.tar.xz","infer-linux64-v0.4.0.tar.xz"],"v0.3.0":["infer-osx-v0.3.0.tar.xz","infer-linux64-v0.3.0.tar.xz"]}

package.json

@@ -34,7 +34,7 @@
     "clean": "shx rm -rf ./dist ./packages/*/dist ./exe ./.parcel-cache && shx mkdir -p ./dist/legacy ./dist/modern ./dist/modern ",
     "dev.vite": "cross-env NODE_ENV=development vite build --watch",
     "dev.packages": "turbo dev",
-    "dev": "run-p dev.packages dev.vite",
+    "dev": "run-p build.json dev.packages dev.vite",
     "docs": "shx rm -rf packages/*/README.md && pnpm -r exec readme --path ../../dev/readme/template.md -y && pnpm -r exec ts-readme",
     "format": "run-s lint.dprint",
     "lint": "turbo lint && run-p --aggregate-output --continue-on-error lint.**",

src/cli-options.ts

@@ -33,12 +33,16 @@ All the available tools:
   console.table(
     {
       "compiler and analyzer": {
-        tools: "--llvm, --gcc, --msvc, --apple-clang, --vcvarsall, --cppcheck, --clang-tidy, --clang-format",
+        tools: "--llvm, --gcc, --msvc, --apple-clang, --vcvarsall",
       },
       "build system": {
-        tools: "--cmake, --ninja, --meson, --make, --task, --bazel, --cmakelang, --cmake-lint, --cmake-format",
+        tools: "--cmake, --ninja, --meson, --make, --task, --bazel",
       },
       "package manager": { tools: "--vcpkg, --conan, --choco, --brew, --nala" },
+      "analyzer/linter": {
+        tools:
+          "--clang-tidy, --clang-format, --cppcheck, --cpplint, --flawfinder, --lizard, --infer, , --cmakelang, --cmake-lint, --cmake-format",
+      },
       cache: { tools: "--ccache, --sccache" },
       documentation: { tools: "--doxygen, --graphviz" },
       coverage: { tools: "--gcovr, --opencppcoverage, --kcov" },

src/cpplint/__tests__/cpplint.test.ts

@@ -0,0 +1,12 @@
+import { ubuntuVersion } from "../../utils/env/ubuntu_version.js"
+import { testBin } from "../../utils/tests/test-helpers.js"
+import { getVersion } from "../../versions/versions.js"
+import { setupCpplint } from "../cpplint.js"
+
+jest.setTimeout(300000)
+describe("setup-cpplint", () => {
+  it("should setup cpplint", async () => {
+    const installInfo = await setupCpplint(getVersion("cpplint", "true", await ubuntuVersion()), "", process.arch)
+    await testBin("cpplint", ["--version"], installInfo.binDir)
+  })
+})

src/cpplint/cpplint.ts

@@ -0,0 +1,6 @@
+import { setupPipPack } from "../utils/setup/setupPipPack.js"
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function setupCpplint(version: string | undefined, _setupDir: string, _arch: string) {
+  return setupPipPack("cpplint", version)
+}

src/flawfinder/__tests__/flawfinder.test.ts

@@ -0,0 +1,12 @@
+import { ubuntuVersion } from "../../utils/env/ubuntu_version.js"
+import { testBin } from "../../utils/tests/test-helpers.js"
+import { getVersion } from "../../versions/versions.js"
+import { setupFlawfinder } from "../flawfinder.js"
+
+jest.setTimeout(300000)
+describe("setup-flawfinder", () => {
+  it("should setup flawfinder", async () => {
+    const installInfo = await setupFlawfinder(getVersion("flawfinder", "true", await ubuntuVersion()), "", process.arch)
+    await testBin("flawfinder", ["--version"], installInfo.binDir)
+  })
+})

src/flawfinder/flawfinder.ts

@@ -0,0 +1,6 @@
+import { setupPipPack } from "../utils/setup/setupPipPack.js"
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function setupFlawfinder(version: string | undefined, _setupDir: string, _arch: string) {
+  return setupPipPack("flawfinder", version)
+}

src/infer/__tests__/infer.test.ts

@@ -0,0 +1,38 @@
+import { info } from "ci-log"
+import { isUbuntu } from "../../utils/env/isUbuntu.js"
+import { ubuntuVersion } from "../../utils/env/ubuntu_version.js"
+import { cleanupTmpDir, setupTmpDir, testBin } from "../../utils/tests/test-helpers.js"
+import { getVersion } from "../../versions/versions.js"
+import { setupInfer } from "../infer.js"
+
+jest.setTimeout(300000)
+
+describe("setup-infer", () => {
+  if (process.platform === "win32") {
+    it("should skip infer tests on windows", () => {
+      expect(true).toBe(true)
+    })
+    return
+  }
+
+  let directory: string
+  beforeAll(async () => {
+    directory = await setupTmpDir("infer")
+    process.env.CACHE_TOOLS = "true"
+  })
+
+  it("should setup infer", async () => {
+    /* eslint-disable @typescript-eslint/no-non-null-asserted-optional-chain */
+    if (isUbuntu() && (await ubuntuVersion())?.[0]! <= 20) {
+      info("Skipping infer test on ubuntu 20 and below")
+      return
+    }
+
+    const { binDir } = await setupInfer(getVersion("infer", "true"), directory, process.arch)
+    await testBin("infer", ["--version"], binDir)
+  })
+
+  afterAll(async () => {
+    await cleanupTmpDir("infer")
+  }, 100000)
+})

src/infer/assets-list.ts

@@ -0,0 +1,18 @@
+import { saveGitHubAssetList } from "../utils/asset/fetch-github-assets.ts"
+
+/**
+ * Generate the list of all releases of a GitHub repository and save it to a json file
+ */
+async function main() {
+  // https://github.com/facebook/infer/releases
+  await saveGitHubAssetList(
+    "facebook",
+    "infer",
+    "./src/infer/github_facebook_infer.json",
+  )
+}
+
+main().catch((err) => {
+  console.error(err)
+  process.exit(1)
+})

src/infer/github_facebook_infer.json

@@ -0,0 +1,110 @@
+{
+  "v1.2.0": [
+    "infer-osx-x86_64-v1.2.0.tar.xz",
+    "infer-osx-arm64-v1.2.0.tar.xz",
+    "infer-linux-x86_64-v1.2.0.tar.xz"
+  ],
+  "v1.1.0": [
+    "infer-linux64-v1.1.0.tar.xz"
+  ],
+  "v1.0.0": [
+    "infer-osx-v1.0.0.tar.xz",
+    "infer-linux64-v1.0.0.tar.xz"
+  ],
+  "v0.17.0": [
+    "infer-osx-v0.17.0.tar.xz",
+    "infer-linux64-v0.17.0.tar.xz"
+  ],
+  "v0.16.0": [
+    "infer-osx-v0.16.0.tar.xz",
+    "infer-linux64-v0.16.0.tar.xz"
+  ],
+  "v0.15.0": [
+    "infer-osx-v0.15.0.tar.xz",
+    "infer-linux64-v0.15.0.tar.xz"
+  ],
+  "v0.14.0": [
+    "infer-osx-v0.14.0.tar.xz",
+    "infer-linux64-v0.14.0.tar.xz"
+  ],
+  "v0.13.1": [
+    "infer-osx-v0.13.1.tar.xz",
+    "infer-linux64-v0.13.1.tar.xz"
+  ],
+  "v0.13.0": [
+    "infer-osx-v0.13.0.tar.xz",
+    "infer-linux64-v0.13.0.tar.xz"
+  ],
+  "v0.12.1": [
+    "infer-osx-v0.12.1.tar.xz",
+    "infer-linux64-v0.12.1.tar.xz"
+  ],
+  "v0.12.0": [
+    "infer-osx-v0.12.0.tar.xz",
+    "infer-linux64-v0.12.0.tar.xz"
+  ],
+  "v0.11.0": [
+    "infer-osx-v0.11.0.tar.xz",
+    "infer-linux64-v0.11.0.tar.xz"
+  ],
+  "v0.10.0": [
+    "infer-osx-v0.10.0.tar.xz",
+    "infer-linux64-v0.10.0.tar.xz"
+  ],
+  "v0.9.5": [
+    "infer-osx-v0.9.5.tar.xz",
+    "infer-linux64-v0.9.5.tar.xz"
+  ],
+  "v0.9.4.1": [
+    "infer-osx-v0.9.4.1.tar.xz",
+    "infer-linux64-v0.9.4.1.tar.xz"
+  ],
+  "v0.9.4": [
+    "infer-osx-v0.9.4.tar.xz",
+    "infer-linux64-v0.9.4.tar.xz"
+  ],
+  "v0.9.3": [
+    "infer-osx-v0.9.3.tar.xz",
+    "infer-linux64-v0.9.3.tar.xz"
+  ],
+  "v0.9.2": [
+    "infer-osx-v0.9.2.tar.xz",
+    "infer-linux64-v0.9.2.tar.xz"
+  ],
+  "v0.9.1": [
+    "infer-osx-v0.9.1.tar.xz",
+    "infer-linux64-v0.9.1.tar.xz"
+  ],
+  "v0.9.0": [
+    "infer-osx-v0.9.0.tar.xz",
+    "infer-linux64-v0.9.0.tar.xz"
+  ],
+  "v0.8.1": [
+    "infer-osx-v0.8.1.tar.xz",
+    "infer-linux64-v0.8.1.tar.xz"
+  ],
+  "v0.8.0": [
+    "infer-osx-v0.8.0.tar.xz",
+    "infer-linux64-v0.8.0.tar.xz"
+  ],
+  "v0.7.0": [
+    "infer-osx-v0.7.0.tar.xz",
+    "infer-linux64-v0.7.0.tar.xz"
+  ],
+  "v0.6.0": [
+    "infer-osx-v0.6.0.tar.xz",
+    "infer-linux64-v0.6.0.tar.xz"
+  ],
+  "v0.5.0": [
+    "infer-osx-v0.5.0.tar.xz",
+    "infer-linux64-v0.5.0.tar.xz"
+  ],
+  "v0.4.0": [
+    "infer-osx-v0.4.0.tar.xz",
+    "infer-linux64-v0.4.0.tar.xz"
+  ],
+  "v0.3.0": [
+    "infer-osx-v0.3.0.tar.xz",
+    "infer-linux64-v0.3.0.tar.xz"
+  ]
+}

src/infer/infer.ts

@@ -0,0 +1,85 @@
+import path, { basename, join } from "path"
+import { fileURLToPath } from "url"
+import { info } from "ci-log"
+import { addExeExt } from "patha"
+import { loadAssetList, matchAsset } from "../utils/asset/load-assets.js"
+import { arm64, x86_64 } from "../utils/env/arch.js"
+import { type InstallationInfo, type PackageInfo, setupBin } from "../utils/setup/setupBin.js"
+
+const dirname = typeof __dirname === "string" ? __dirname : path.dirname(fileURLToPath(import.meta.url))
+
+/** Get the platform data for infer */
+async function getInferPackageInfo(version: string, platform: NodeJS.Platform, arch: string): Promise<PackageInfo> {
+  const { keywords, optionalKeywords } = getAssetKeywords(platform, arch)
+
+  // first check the github releases
+  const inferGitHubAssets = await loadAssetList(
+    join(dirname, "github_facebook_infer.json"),
+  )
+  const ghAsset = matchAsset(
+    inferGitHubAssets,
+    {
+      version,
+      keywords,
+      optionalKeywords,
+      filterMapTag(tag) {
+        return tag.replace(/^v/, "")
+      },
+    },
+  )
+
+  if (ghAsset !== undefined) {
+    return {
+      url: `https://github.com/facebook/infer/releases/download/${ghAsset.tag}/${ghAsset.name}`,
+      extractedFolderName: `${basename(ghAsset.name, ".tar.xz")}`,
+      binRelativeDir: "bin",
+      binFileName: addExeExt("infer"),
+    }
+  }
+
+  throw new Error(`No asset found for version ${version} matching ${keywords} and ${optionalKeywords}`)
+}
+
+/** Setup infer */
+export function setupInfer(version: string, setupDir: string, arch: string): Promise<InstallationInfo> {
+  return setupBin("infer", version, getInferPackageInfo, setupDir, arch)
+}
+
+function getAssetKeywords(platform: string, arch: string) {
+  const keywords: string[] = []
+  const optionalKeywords: string[] = []
+
+  switch (platform) {
+    case "linux": {
+      keywords.push("linux")
+
+      if (x86_64.includes(arch)) {
+        optionalKeywords.push("64")
+        optionalKeywords.push("x86_64")
+      } else {
+        info(`Using arch ${arch} for infer`)
+        keywords.push(arch)
+      }
+      break
+    }
+    case "darwin": {
+      keywords.push("osx")
+
+      if (x86_64.includes(arch)) {
+        optionalKeywords.push("x86_64")
+      } else if (arm64.includes(arch)) {
+        // allow falling back to x86_64 if arm64 is not available
+        optionalKeywords.push("arm64")
+      } else {
+        info(`Using arch ${arch} for infer`)
+        keywords.push(arch)
+      }
+      break
+    }
+    default:
+      info(`Using ${platform} ${arch} for infer`)
+      keywords.push(platform, arch)
+      break
+  }
+  return { keywords, optionalKeywords }
+}

src/lizard/__tests__/lizard.test.ts

@@ -0,0 +1,12 @@
+import { ubuntuVersion } from "../../utils/env/ubuntu_version.js"
+import { testBin } from "../../utils/tests/test-helpers.js"
+import { getVersion } from "../../versions/versions.js"
+import { setupLizard } from "../lizard.js"
+
+jest.setTimeout(300000)
+describe("setup-lizard", () => {
+  it("should setup lizard", async () => {
+    const installInfo = await setupLizard(getVersion("lizard", "true", await ubuntuVersion()), "", process.arch)
+    await testBin("lizard", ["--version"], installInfo.binDir)
+  })
+})

src/lizard/lizard.ts

@@ -0,0 +1,6 @@
+import { setupPipPack } from "../utils/setup/setupPipPack.js"
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function setupLizard(version: string | undefined, _setupDir: string, _arch: string) {
+  return setupPipPack("lizard", version)
+}