context

Documentation

Index

• Constants
• type CensoredWriter
  • func NewCensoredWriter(writer io.Writer) *CensoredWriter
  • func (cw *CensoredWriter) SetSensitiveValues(vals []string)
  • func (cw *CensoredWriter) Write(b []byte) (int, error)
• type CommandBuilder
  • func NewTestCommand() CommandBuilder
• type Context
  • func New() *Context
  • func (c *Context) CopyDirectory(srcDir, destDir string, includeBaseDir bool) error
  • func (c *Context) CopyFile(src, dest string) error
  • func (c *Context) IsVerbose() bool
  • func (c *Context) SetSensitiveValues(vals []string)
  • func (c *Context) SetVerbose(value bool)
  • func (c *Context) WriteMixinOutputToFile(filename string, bytes []byte) error
• type PluginDebugContext
  • func NewPluginDebugContext() *PluginDebugContext
• type TestContext
  • func NewTestContext(t *testing.T) *TestContext
  • func (c *TestContext) AddCleanupDir(dir string)
  • func (c *TestContext) AddTestDirectory(srcDir, destDir string)
  • func (c *TestContext) AddTestDriver(src, name string) string
  • func (c *TestContext) AddTestFile(src, dest string) []byte
  • func (c *TestContext) AddTestFileContents(file []byte, dest string) error
  • func (c *TestContext) Cleanup()
  • func (c *TestContext) ClearOutputs()
  • func (c *TestContext) FindBinDir() string
  • func (c *TestContext) GetError() string
  • func (c *TestContext) GetOutput() string
  • func (c *TestContext) UseFilesystem() string

Constants

const (
	// MixinOutputsDir represents the directory where mixin output files are written/read
	MixinOutputsDir = "/cnab/app/porter/outputs"
)

Types

type CensoredWriter

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

CensoredWriter is a writer wrapping the provided io.Writer with logic to censor certain values

func NewCensoredWriter

func NewCensoredWriter(writer io.Writer) *CensoredWriter

NewCensoredWriter returns a new CensoredWriter

func (*CensoredWriter) SetSensitiveValues

func (cw *CensoredWriter) SetSensitiveValues(vals []string)

SetSensitiveValues sets values needing masking for an CensoredWriter

func (*CensoredWriter) Write

func (cw *CensoredWriter) Write(b []byte) (int, error)

Write implements io.Writer's Write method, performing necessary auditing while doing so

type CommandBuilder

type CommandBuilder func(name string, arg ...string) *exec.Cmd

func NewTestCommand

func NewTestCommand() CommandBuilder

type Context

type Context struct {
	Debug        bool
	DebugPlugins bool

	FileSystem         *afero.Afero
	In                 io.Reader
	Out                io.Writer
	Err                io.Writer
	NewCommand         CommandBuilder
	PlugInDebugContext *PluginDebugContext
	// contains filtered or unexported fields
}

func New

func New() *Context

func (*Context) CopyDirectory

func (c *Context) CopyDirectory(srcDir, destDir string, includeBaseDir bool) error

func (*Context) CopyFile

func (c *Context) CopyFile(src, dest string) error

func (*Context) IsVerbose

func (c *Context) IsVerbose() bool

func (*Context) SetSensitiveValues

func (c *Context) SetSensitiveValues(vals []string)

SetSensitiveValues sets the sensitive values needing masking on output/err streams

func (*Context) SetVerbose

func (c *Context) SetVerbose(value bool)

func (*Context) WriteMixinOutputToFile

func (c *Context) WriteMixinOutputToFile(filename string, bytes []byte) error

WriteMixinOutputToFile writes the provided bytes (representing a mixin output) to a file named by the provided filename in Porter's mixin outputs directory

type PluginDebugContext

type PluginDebugContext struct {
	RunPlugInInDebugger    string
	PlugInWorkingDirectory string
	DebuggerPort           string
}

func NewPluginDebugContext

func NewPluginDebugContext() *PluginDebugContext

type TestContext

type TestContext struct {
	*Context

	T *testing.T
	// contains filtered or unexported fields
}

func NewTestContext

func NewTestContext(t *testing.T) *TestContext

NewTestContext initializes a configuration suitable for testing, with the output buffered, and an in-memory file system.

func (*TestContext) AddCleanupDir

func (c *TestContext) AddCleanupDir(dir string)

func (*TestContext) AddTestDirectory

func (c *TestContext) AddTestDirectory(srcDir, destDir string)

func (*TestContext) AddTestDriver

func (c *TestContext) AddTestDriver(src, name string) string

func (*TestContext) AddTestFile

func (c *TestContext) AddTestFile(src, dest string) []byte

func (*TestContext) AddTestFileContents

func (c *TestContext) AddTestFileContents(file []byte, dest string) error

func (*TestContext) Cleanup

func (c *TestContext) Cleanup()

func (*TestContext) ClearOutputs

func (c *TestContext) ClearOutputs()

func (*TestContext) FindBinDir

func (c *TestContext) FindBinDir() string

func (*TestContext) GetError

func (c *TestContext) GetError() string

GetError returns all text printed to stderr.

func (*TestContext) GetOutput

func (c *TestContext) GetOutput() string

GetOutput returns all text printed to stdout.

func (*TestContext) UseFilesystem

func (c *TestContext) UseFilesystem() string

UseFilesystem has porter's context use the OS filesystem instead of an in-memory filesystem Returns the temp porter home directory created for the test