cmake

Documentation

Index

• type Builder
  • func NewBuilder(opts *BuilderOptions) (*Builder, error)
  • func (b *Builder) Build(fuzzTests []string) ([]*build.Result, error)
  • func (b *Builder) BuildDir() (string, error)
  • func (b *Builder) Configure() error
  • func (b *Builder) ListFuzzTests() ([]string, error)
  • func (b *Builder) Opts() *BuilderOptions
• type BuilderOptions
  • func (opts *BuilderOptions) Validate() error
• type ParallelOptions

Types

type Builder

type Builder struct {
	*BuilderOptions
	// contains filtered or unexported fields
}

func NewBuilder

func NewBuilder(opts *BuilderOptions) (*Builder, error)

func (*Builder) Build

func (b *Builder) Build(fuzzTests []string) ([]*build.Result, error)

Build builds the specified fuzz tests with CMake. The fuzz tests must not contain duplicates.

func (*Builder) BuildDir

func (b *Builder) BuildDir() (string, error)

func (*Builder) Configure

func (b *Builder) Configure() error

Configure calls cmake to "Generate a project buildsystem" (that's the phrasing used by the CMake man page). Note: This is usually a no-op after the directory has been created once, even if cache variables change. However, if a previous invocation of this command failed during CMake generation and the command is run again, the build step would only result in a very unhelpful error message about missing Makefiles. By reinvoking CMake's configuration explicitly here, we either get a helpful error message or the build step will succeed if the user fixed the issue in the meantime.

func (*Builder) ListFuzzTests

func (b *Builder) ListFuzzTests() ([]string, error)

ListFuzzTests lists all fuzz tests defined in the CMake project after Configure has been run.

func (*Builder) Opts

func (b *Builder) Opts() *BuilderOptions

type BuilderOptions

type BuilderOptions struct {
	ProjectDir string
	Args       []string
	Sanitizers []string
	Parallel   ParallelOptions
	Stdout     io.Writer
	Stderr     io.Writer
	BuildOnly  bool

	FindRuntimeDeps bool
}

func (*BuilderOptions) Validate

func (opts *BuilderOptions) Validate() error

type ParallelOptions

type ParallelOptions struct {
	Enabled bool
	NumJobs uint
}