dependencies

Documentation

Index

• Constants
• Variables
• func Check(keys []Key) error
• func ClangVersion(path string) (*semver.Version, error)
• func MockAllDeps(t *testing.T)
• func OverwriteGetVersionWith0(dep *Dependency) *semver.Version
• func OverwriteUninstalled(dep *Dependency)
• type Dependencies
• type Dependency
  • func GetDep(key Key) *Dependency
• type Key

Constants

const CIFuzzBazelCommit = "b013aa0f90fe8ac60adfc6d9640a9cfa451dda9e"

CIFuzzBazelCommit is the commit of the https://github.com/CodeIntelligenceTesting/cifuzz-bazel repository that is required by this version of cifuzz.

Keep in sync with examples/bazel/WORKSPACE.

const RulesFuzzingSHA256 = "4beab98d88e4bf2d04da0412d413a1364f95e5eb88963e15e603bee1410fcedf"

Variables

var ErrDeps = errors.New(`Unable to run command due to missing/invalid dependencies.
For installation instruction see:

	https://github.com/CodeIntelligenceTesting/cifuzz#installation

`)

var RulesFuzzingHTTPArchiveRule = fmt.Sprintf(`http_archive(
        name = "rules_fuzzing",
        sha256 = "%s",
        strip_prefix = "rules_fuzzing-ca617e846d0f92e00a903903b0554ea9142e1132",
        urls = ["https://github.com/CodeIntelligenceTesting/rules_fuzzing/archive/ca617e846d0f92e00a903903b0554ea9142e1132.tar.gz"],
    )`, RulesFuzzingSHA256)

Functions

func Check

func Check(keys []Key) error

Check iterates of a list of dependencies and checks if they are fulfilled

func ClangVersion

func ClangVersion(path string) (*semver.Version, error)

ClangVersion returns the version of the clang/clang++ executable at the given path.

func MockAllDeps

func MockAllDeps(t *testing.T)

MockAllDeps marks all the dependencies of this package as installed in the right version

func OverwriteGetVersionWith0

func OverwriteGetVersionWith0(dep *Dependency) *semver.Version

OverwriteGetVersionWith0 marks the specified dependency as installed in version 0.0.0

func OverwriteUninstalled

func OverwriteUninstalled(dep *Dependency)

OverwriteUninstalled marks the specified dependency as uninstalled

Types

type Dependencies

type Dependencies map[Key]*Dependency

type Dependency

type Dependency struct {
	Key        Key
	MinVersion semver.Version
	// these fields are used to implement custom logic to
	// retrieve version or installation information for the
	// specific dependency
	GetVersion func(*Dependency) (*semver.Version, error)
	Installed  func(*Dependency) bool
	// contains filtered or unexported fields
}

Dependency represents a single dependency

func GetDep

func GetDep(key Key) *Dependency

type Key

type Key string

const (
	Bazel          Key = "bazel"
	Clang          Key = "clang"
	CMake          Key = "cmake"
	LLVMCov        Key = "llvm-cov"
	LLVMSymbolizer Key = "llvm-symbolizer"
	LLVMProfData   Key = "llvm-profdata"

	GenHTML Key = "genhtml"

	Java   Key = "java"
	Maven  Key = "mvn"
	Gradle Key = "gradle"

	VisualStudio Key = "Visual Studio"

	MessageVersion = "cifuzz requires %s %s or higher, have %s"
	MessageMissing = "cifuzz requires %s, but it is not installed"
)