mockgen

Documentation

Index

• Variables
• type ErkFSWriteError
• type ErkInvalidConfig
• type ErkMockDestination
• type ErkMockGenError
• type ErkMultipleFailures
• type ErkUnableToTidy
• type MockGen
  • func (g *MockGen) GenerateMocks(ctx context.Context, config *ensurefile.Config) error
  • func (g *MockGen) TidyMocks(config *ensurefile.Config) error
• type MockGenerator

Variables

var (
	ErrMissingMockConfig = erk.New(ErkInvalidConfig{}, "Missing `mocks` config in .ensure.yml file. For example:\n\n"+ensurefile.ExampleFile)
	ErrMissingPackages   = erk.New(ErkInvalidConfig{},
		"No mocks to generate. Please add some to `mocks.packages` in .ensure.yml file. For example:\n\n"+ensurefile.ExampleFile,
	)
	ErrDuplicatePackagePath = erk.New(ErkInvalidConfig{}, "Found duplicate package path: {{.packagePath}}. Package paths must be unique.")

	ErrMissingPackagePath       = erk.New(ErkInvalidConfig{}, "Missing `path` key for package.")
	ErrMissingPackageInterfaces = erk.New(ErkInvalidConfig{},
		"Package '{{.packagePath}}' has no interfaces to generate. Please add them using the `interfaces` key.",
	)

	ErrMultipleGenerationFailures = erk.New(ErkMultipleFailures{}, "Unable to generate at least one mock")
	ErrMockGenFailed              = erk.New(ErkMockGenError{}, "Could not run mockgen successfully for '{{.packageDescription}}': {{.err}}")

	ErrUnableToCreateDir  = erk.New(ErkFSWriteError{}, "Could not create directory '{{.path}}': {{.err}}")
	ErrUnableToCreateFile = erk.New(ErkFSWriteError{}, "Could not create file '{{.path}}': {{.err}}")
)

var (
	ErrTidyUnableToList    = erk.New(ErkUnableToTidy{}, "Could not list files recursively for '{{.path}}': {{.err}}")
	ErrTidyUnableToCleanup = erk.New(ErkUnableToTidy{}, "Could not delete '{{.path}}': {{.err}}")
)

var ErrInternalPackageOutsideModule = erk.New(ErkMockDestination{},
	"Cannot generate mock of internal package, since package '{{.packagePath}}' is not in the current module '{{.modulePath}}'",
)

Types

type ErkFSWriteError

type ErkFSWriteError struct{ erk.DefaultKind }

type ErkInvalidConfig

type ErkInvalidConfig struct{ erk.DefaultKind }

type ErkMockDestination

type ErkMockDestination struct{ erk.DefaultKind }

type ErkMockGenError

type ErkMockGenError struct{ erk.DefaultKind }

type ErkMultipleFailures

type ErkMultipleFailures struct{ erk.DefaultKind }

type ErkUnableToTidy

type ErkUnableToTidy struct{ erk.DefaultKind }

type MockGen

type MockGen struct {
	CmdRun  runcmd.RunnerIface
	FSWrite fswrite.FSWriteIface
	Logger  *log.Logger
	Cleanup exitcleanup.ExitCleaner
}

func (*MockGen) GenerateMocks

func (g *MockGen) GenerateMocks(ctx context.Context, config *ensurefile.Config) error

GenerateMocks for the provided configuration.

func (*MockGen) TidyMocks

func (g *MockGen) TidyMocks(config *ensurefile.Config) error

TidyMocks removes any files other than those that are expected to exist in the mock directories.

type MockGenerator

type MockGenerator interface {
	GenerateMocks(ctx context.Context, config *ensurefile.Config) error
	TidyMocks(config *ensurefile.Config) error
}