internal

Documentation

Index

• Constants
• func GetEolDate(eolID, version string) (string, error)
• func Marshal(v interface{}) ([]byte, error)
• func MatchTOML(expected interface{}) types.GomegaMatcher
• type EntryWriter
  • func (e EntryWriter) Write(source string, destination string) error
• type EnvironmentWriter
  • func NewEnvironmentWriter(options ...EnvironmentWriterOption) EnvironmentWriter
  • func (w EnvironmentWriter) Write(path string, environment map[string]string) error
• type EnvironmentWriterOption
  • func WithEnvironmentWriterLogger(logger bard.Logger) EnvironmentWriterOption
• type ExitHandler
  • func NewExitHandler(options ...ExitHandlerOption) ExitHandler
  • func (e ExitHandler) Error(err error)
  • func (e ExitHandler) Fail()
  • func (e ExitHandler) Pass()
• type ExitHandlerOption
  • func WithExitHandlerExitFunc(exitFunc func(int)) ExitHandlerOption
  • func WithExitHandlerLogger(logger bard.Logger) ExitHandlerOption
  • func WithExitHandlerWriter(writer io.Writer) ExitHandlerOption
• type TOMLWriter
  • func NewTOMLWriter(options ...TOMLWriterOption) TOMLWriter
  • func (t TOMLWriter) Write(path string, value interface{}) error
• type TOMLWriterOption
  • func WithTOMLWriterLogger(logger bard.Logger) TOMLWriterOption

Constants

const (
	// ErrorStatusCode is the status code returned for error.
	ErrorStatusCode = 1

	// FailStatusCode is the status code returned for fail.
	FailStatusCode = 100

	// PassStatusCode is the status code returned for pass.
	PassStatusCode = 0
)

const ModeExecutable = 0100

Functions

func GetEolDate

func GetEolDate(eolID, version string) (string, error)

func Marshal

func Marshal(v interface{}) ([]byte, error)

func MatchTOML

func MatchTOML(expected interface{}) types.GomegaMatcher

Types

type EntryWriter

type EntryWriter struct{}

func (EntryWriter) Write

func (e EntryWriter) Write(source string, destination string) error

type EnvironmentWriter

type EnvironmentWriter struct {
	// contains filtered or unexported fields
}

EnvironmentWriter is an implementation of the libcnb.EnvironmentWriter interface.

func NewEnvironmentWriter

func NewEnvironmentWriter(options ...EnvironmentWriterOption) EnvironmentWriter

NewEnvironmentWriter creates a new instance that writes to the filesystem and writes to the default bard.Logger.

func (EnvironmentWriter) Write

func (w EnvironmentWriter) Write(path string, environment map[string]string) error

Write creates the path directory, and creates a new file for each key with the value as the contents of each file.

type EnvironmentWriterOption

type EnvironmentWriterOption func(writer EnvironmentWriter) EnvironmentWriter

EnvironmentWriterOption is a function for configuring a EnvironmentWriter instance.

func WithEnvironmentWriterLogger

func WithEnvironmentWriterLogger(logger bard.Logger) EnvironmentWriterOption

WithEnvironmentWriterLogger creates an EnvironmentWriterOption that configures the logger.

type ExitHandler

type ExitHandler struct {
	// contains filtered or unexported fields
}

ExitHandler is an implementation of the libcnb.ExitHandler interface.

func NewExitHandler

func NewExitHandler(options ...ExitHandlerOption) ExitHandler

NewExitHandler creates a new instance that calls os.Exit and writes to the default bard.Logger and os.stderr.

func (ExitHandler) Error

func (e ExitHandler) Error(err error)

func (ExitHandler) Fail

func (e ExitHandler) Fail()

func (ExitHandler) Pass

func (e ExitHandler) Pass()

type ExitHandlerOption

type ExitHandlerOption func(handler ExitHandler) ExitHandler

ExitHandlerOption is a function for configuring an ExitHandler instance.

func WithExitHandlerExitFunc

func WithExitHandlerExitFunc(exitFunc func(int)) ExitHandlerOption

WithExitHandler creates an ExitHandlerOption that configures the exit function.

func WithExitHandlerLogger

func WithExitHandlerLogger(logger bard.Logger) ExitHandlerOption

WithExitHandlerLogger creates an ExitHandlerOption that configures the logger.

func WithExitHandlerWriter

func WithExitHandlerWriter(writer io.Writer) ExitHandlerOption

WithExitHandlerWriter creates an ExitHandlerOption that configures the writer.

type TOMLWriter

type TOMLWriter struct {
	// contains filtered or unexported fields
}

TOMLWriter is an implementation of the libcnb.TOMLWriter interface.

func NewTOMLWriter

func NewTOMLWriter(options ...TOMLWriterOption) TOMLWriter

NewTOMLWriter creates a new instance that writes to the filesystem and writes to the default bard.Logger.

func (TOMLWriter) Write

func (t TOMLWriter) Write(path string, value interface{}) error

Write creates the path's parent directories, and creates a new file or truncates an existing file and then marshals the value to the file.

type TOMLWriterOption

type TOMLWriterOption func(writer TOMLWriter) TOMLWriter

TOMLWriterOption is a function for configuring a TOMLWriter instance.

func WithTOMLWriterLogger

func WithTOMLWriterLogger(logger bard.Logger) TOMLWriterOption

WithTOMLWriterLogger creates an TOMLWriterOption that configures the logger.