tools

Documentation

Index

• func CreateCommand(tool Interface) *cobra.Command
• func TempFile(pattern string) (name string, err error)
• type DirectoryBasedToolOpts
  • func (o *DirectoryBasedToolOpts) GetDirectory() string
  • func (o *DirectoryBasedToolOpts) GetDirectoryBasedToolOptions() *DirectoryBasedToolOpts
  • func (o *DirectoryBasedToolOpts) GetFilesInDirectory(files []string) ([]string, error)
  • func (o *DirectoryBasedToolOpts) GetInventory() *inventory.Manifest
  • func (o *DirectoryBasedToolOpts) IsExcluded(file string) bool
  • func (o *DirectoryBasedToolOpts) Register(cmd *cobra.Command)
  • func (o *DirectoryBasedToolOpts) RemoveExcluded(files []string) []string
  • func (o *DirectoryBasedToolOpts) Validate() error
• 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) GetDirectoryBasedToolOptions() *DirectoryBasedToolOpts
  • 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) PrintToolResult(result *Result)
  • func (o *ToolOpts) Register(c *cobra.Command)
  • func (o *ToolOpts) RunDocker(d *DockerTool) ([]byte, error)
  • func (o *ToolOpts) RunTool(tool Interface, printResult bool) (*Result, error)
  • func (o *ToolOpts) SetContextValues(m map[string]string)
  • func (o *ToolOpts) Validate() error

Functions

func CreateCommand

func CreateCommand(tool Interface) *cobra.Command

func TempFile

func TempFile(pattern string) (name string, err error)

Types

type DirectoryBasedToolOpts

type DirectoryBasedToolOpts struct {
	ToolOpts
	Directory         string
	Exclude           []string
	PrintFingerprints bool
	// contains filtered or unexported fields
}

func (*DirectoryBasedToolOpts) GetDirectory

func (o *DirectoryBasedToolOpts) GetDirectory() string

func (*DirectoryBasedToolOpts) GetDirectoryBasedToolOptions

func (o *DirectoryBasedToolOpts) GetDirectoryBasedToolOptions() *DirectoryBasedToolOpts

func (*DirectoryBasedToolOpts) GetFilesInDirectory

func (o *DirectoryBasedToolOpts) GetFilesInDirectory(files []string) ([]string, error)

func (*DirectoryBasedToolOpts) GetInventory

func (o *DirectoryBasedToolOpts) GetInventory() *inventory.Manifest

func (*DirectoryBasedToolOpts) IsExcluded

func (o *DirectoryBasedToolOpts) IsExcluded(file string) bool

func (*DirectoryBasedToolOpts) Register

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

func (*DirectoryBasedToolOpts) RemoveExcluded

func (o *DirectoryBasedToolOpts) RemoveExcluded(files []string) []string

func (*DirectoryBasedToolOpts) Validate

func (o *DirectoryBasedToolOpts) Validate() error

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
	GetDirectoryBasedToolOptions() *DirectoryBasedToolOpts
	Validate() error
	Run() (*Result, error)
	Name() string
}

type Result

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

	Assessment *assessments.Assessment
}

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
	UpdatePR       bool
	ToolVersion    string
	ToolPath       string
	FailThresholds map[string]string
	PrintAsessment bool
	Internal       bool
	SkipDockerPull bool

	ParsedFailThresholds map[string]int
}

func (*ToolOpts) GetDirectoryBasedToolOptions

func (o *ToolOpts) GetDirectoryBasedToolOptions() *DirectoryBasedToolOpts

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) PrintToolResult

func (o *ToolOpts) PrintToolResult(result *Result)

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, printResult bool) (*Result, error)

func (*ToolOpts) SetContextValues

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

func (*ToolOpts) Validate

func (o *ToolOpts) Validate() error