other

Documentation

Index

• Constants
• type Builder
  • func NewBuilder(opts *BuilderOptions) (*Builder, error)
  • func (b *Builder) Build(fuzzTest string) (*build.Result, error)
  • func (b *Builder) Clean() error
• type BuilderOptions
  • func (opts *BuilderOptions) Validate() error

Constants

const (
	// EnvBuildStep states for what a fuzz test is build.
	// e.g. "coverage", "fuzzing"
	EnvBuildStep string = "CIFUZZ_BUILD_STEP"

	// EnvBuildLocation states the path of the executable.
	// Default is identical with FUZZ_TEST.
	EnvBuildLocation string = "CIFUZZ_BUILD_LOCATION"

	// EnvCommand holds the name of the command cifuzz was called with.
	// e.g. "run", "bundle", "remote-run"
	EnvCommand string = "CIFUZZ_COMMAND"

	// EnvFuzzTest holds the name of the fuzz test.
	EnvFuzzTest string = "FUZZ_TEST"

	// EnvFuzzTestCFlags hold the CFLAGS used for building the fuzz test.
	EnvFuzzTestCFlags string = "FUZZ_TEST_CFLAGS"

	// EnvFuzzTestCXXFlags hold the CXXFLAGS used for building the fuzz test.
	EnvFuzzTestCXXFlags string = "FUZZ_TEST_CXXFLAGS"

	// EnvFuzzTestLDFlags hold the LDFLAGS used for building the fuzz test.
	EnvFuzzTestLDFlags string = "FUZZ_TEST_LDFLAGS"
)

Warning: Changing these will lead to a breaking change!

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(fuzzTest string) (*build.Result, error)

Build builds the specified fuzz test via the user-specified build command

func (*Builder) Clean

func (b *Builder) Clean() error

Clean cleans the project's build artifacts user-specified build command.

type BuilderOptions

type BuilderOptions struct {
	ProjectDir   string
	BuildCommand string
	CleanCommand string
	Sanitizers   []string

	RunfilesFinder runfiles.RunfilesFinder
	Stdout         io.Writer
	Stderr         io.Writer
}

func (*BuilderOptions) Validate

func (opts *BuilderOptions) Validate() error