tools

Documentation

Index

• func CreateCommand(tool Interface) *cobra.Command
• type DirectoryBasedToolOpts
  • func (o *DirectoryBasedToolOpts) GetDirectory() string
  • func (o *DirectoryBasedToolOpts) Register(cmd *cobra.Command)
• type DockerTool
• type HasCommandTemplate
• type Interface
• type Result
  • func (r *Result) AddFile(path string) *Result
  • func (r *Result) AddValue(name, value string) *Result
  • func (r *Result) Report(tool Interface) error
• type ToolOpts
  • func (o *ToolOpts) GetToolOptions() *ToolOpts
  • func (o *ToolOpts) InstallAPIServerArtifact(name, urlPath string) (*download.Download, error)
  • func (o *ToolOpts) InstallTool(spec *download.Spec) (*download.Download, error)
  • func (o *ToolOpts) Register(c *cobra.Command)
  • func (o *ToolOpts) RunDocker(d *DockerTool) ([]byte, error)
  • func (o *ToolOpts) RunTool(tool Interface) (*Result, error)
  • func (o *ToolOpts) SetContextValues(m map[string]string)

Functions

func CreateCommand

func CreateCommand(tool Interface) *cobra.Command

Types

type DirectoryBasedToolOpts

type DirectoryBasedToolOpts struct {
	ToolOpts
	Directory string
	// contains filtered or unexported fields
}

func (*DirectoryBasedToolOpts) GetDirectory

func (o *DirectoryBasedToolOpts) GetDirectory() string

func (*DirectoryBasedToolOpts) Register

func (o *DirectoryBasedToolOpts) Register(cmd *cobra.Command)

type DockerTool

type DockerTool struct {
	Name       string
	Image      string
	Directory  string
	DockerArgs []string
	Args       []string
}

type HasCommandTemplate

type HasCommandTemplate interface {
	CommandTemplate() *cobra.Command
}

type Interface

type Interface interface {
	options.Interface
	GetToolOptions() *ToolOpts
	Run() (*Result, error)
	Name() string
}

type Result

type Result struct {
	Data         *jnode.Node
	Values       map[string]string
	Directory    string
	Files        *util.StringSet
	PrintPath    []string
	PrintColumns []string

	AssessmentURL string
}

func (*Result) AddFile

func (r *Result) AddFile(path string) *Result

func (*Result) AddValue

func (r *Result) AddValue(name, value string) *Result

func (*Result) Report

func (r *Result) Report(tool Interface) error

type ToolOpts

type ToolOpts struct {
	options.PrintClientOpts
	UploadEnabled bool
	OmitContext   bool
	ToolVersion   string
	ToolPath      string
	Internal      bool
}

func (*ToolOpts) GetToolOptions

func (o *ToolOpts) GetToolOptions() *ToolOpts

func (*ToolOpts) InstallAPIServerArtifact

func (o *ToolOpts) InstallAPIServerArtifact(name, urlPath string) (*download.Download, error)

func (*ToolOpts) InstallTool

func (o *ToolOpts) InstallTool(spec *download.Spec) (*download.Download, error)

func (*ToolOpts) Register

func (o *ToolOpts) Register(c *cobra.Command)

func (*ToolOpts) RunDocker

func (o *ToolOpts) RunDocker(d *DockerTool) ([]byte, error)

func (*ToolOpts) RunTool

func (o *ToolOpts) RunTool(tool Interface) (*Result, error)

func (*ToolOpts) SetContextValues

func (o *ToolOpts) SetContextValues(m map[string]string)