setup-cpp/src/__tests__/main.test.ts

Install all the tools required for building and testing C++/C projects.

process.env.SETUP_CPP_SKIP_MAIN = "true"
import { getCompilerInfo } from "../compilers.js"
import { parseArgs } from "../setup-cpp.js"
import { type Inputs, llvmTools } from "../tool.js"
import { getVersion, syncVersions } from "../versions/versions.js"

jest.setTimeout(300000)
describe("getCompilerInfo", () => {
  it("version will be undefined if not provided", () => {
    const { compiler, version } = getCompilerInfo("llvm")
    expect(compiler).toBe("llvm")
    expect(version).toBeUndefined()
  })

  it("extracts version", () => {
    const { compiler, version } = getCompilerInfo("llvm-12.0.0")
    expect(compiler).toBe("llvm")
    expect(version).toBe("12.0.0")
  })

  it("finds a version even if not semver", () => {
    const { compiler, version } = getCompilerInfo("llvm-12")
    expect(compiler).toBe("llvm")
    expect(version).toBe("12")
  })

  it("extracts gcc version", () => {
    const { compiler, version } = getCompilerInfo("gcc-11.2.0")
    expect(compiler).toBe("gcc")
    expect(version).toBe("11.2.0")
  })

  it("extracts apple-clang version", () => {
    const { compiler, version } = getCompilerInfo("apple-clang-14")
    expect(compiler).toBe("apple-clang")
    expect(version).toBe("14")
  })

  it("extracts msvc version", () => {
    const { compiler, version } = getCompilerInfo("msvc-14.16.27023")
    expect(compiler).toBe("msvc")
    expect(version).toBe("14.16.27023")
  })

  it("extracts msvc version with year", () => {
    const { compiler, version } = getCompilerInfo("msvc-2017")
    expect(compiler).toBe("msvc")
    expect(version).toBe("2017")
  })

  it("extracts msvc version with year and version", () => {
    const { compiler, version } = getCompilerInfo("msvc-2017.1")
    expect(compiler).toBe("msvc")
    expect(version).toBe("2017.1")
  })

  it("extracts gcc version with pre-release and build metadata", () => {
    const { compiler, version } = getCompilerInfo("gcc-11.2.0-beta.1+build.123")
    expect(compiler).toBe("gcc")
    expect(version).toBe("11.2.0-beta.1+build.123")
  })

  it("extracts clang version with pre-release", () => {
    const { compiler, version } = getCompilerInfo("clang-15.0.0-rc1")
    expect(compiler).toBe("clang")
    expect(version).toBe("15.0.0-rc1")
  })
})

describe("syncVersion", () => {
  it("Syncs llvm tools versions", () => {
    expect(syncVersions(parseArgs(["--llvm", "14.0.0", "--clangtidy", "true"]), llvmTools as Inputs[])).toBe(true)
    expect(syncVersions(parseArgs(["--llvm", "13.0.0", "--clangtidy", "true"]), llvmTools as Inputs[])).toBe(true)
    expect(syncVersions(parseArgs(["--compiler", "llvm-13.0.0", "--clangtidy", "true"]), llvmTools as Inputs[])).toBe(
      true,
    )
    expect(syncVersions(parseArgs(["--llvm", "13.0.0", "--clangtidy", "12.0.0"]), llvmTools as Inputs[])).toBe(false)

    const opts1 = parseArgs(["--llvm", "14.0.0", "--clangtidy", "true"])
    expect(syncVersions(opts1, llvmTools as Inputs[])).toBe(true)
    expect(opts1.llvm).toBe("14.0.0")
    expect(opts1.clangtidy).toBe("14.0.0")
    expect(opts1.clangformat).toBe(undefined)

    const opts2 = parseArgs(["--clangtidy", "15.0.0", "--clangformat", "true"])
    expect(syncVersions(opts2, llvmTools as Inputs[])).toBe(true)
    expect(opts2.llvm).toBe(undefined)
    expect(opts2.clangtidy).toBe("15.0.0")
    expect(opts2.clangformat).toBe("15.0.0")

    const opts3 = parseArgs(["--llvm", "true", "--clangformat", "true"])
    expect(syncVersions(opts3, llvmTools as Inputs[])).toBe(true)
    expect(opts3.llvm).toBe("true")
    expect(opts3.clangformat).toBe("true")
    expect(opts3.clangtidy).toBe(undefined)

    const opts4 = parseArgs(["--compiler", "llvm-13.0.0", "--clangtidy", "true"])
    expect(syncVersions(opts4, [...llvmTools, "compiler"] as Inputs[], getCompilerInfo("llvm-13.0.0"))).toBe(true)
    expect(opts4.compiler).toBe("llvm-13.0.0")
    expect(opts4.clangtidy).toBe("13.0.0")
    expect(opts4.clangformat).toBe(undefined)

    const opts5 = parseArgs(["--compiler", "gcc-13", "--clangtidy", "true"])
    expect(syncVersions(opts5, [...llvmTools, "compiler"] as Inputs[], getCompilerInfo("gcc-13"))).toBe(true)
    expect(opts5.compiler).toBe("gcc-13")
    expect(opts5.clangtidy).toBe("true")
    expect(opts5.clangformat).toBe(undefined)
  })
})

describe("getVersion", () => {
  it("gcovr", () => {
    expect(getVersion("gcovr", "5.0")).toBe("5.0")
    if (process.platform === "linux") {
      expect(getVersion("gcovr", "true", [22, 4])).toBe("")
      expect(getVersion("gcovr", "true", [20, 4])).toBe("")
      expect(getVersion("gcovr", "true", [18, 4])).toBe("5.0")
    }
  })

  it("llvm", () => {
    expect(getVersion("llvm", "13.0.0")).toBe("13.0.0")
  })
})