scan

Documentation

Index

• Constants
• Variables
• type Args
  • func (args *Args) SetDefault() error
  • func (args Args) Validate() error
• type Handler
  • func New(args *Args, spinner *spinner.Spinner, config *config.Config, ...) *Handler
  • func (h *Handler) Execute(ctx context.Context) (constant.ExitCode, error)
  • func (h *Handler) GetScanDataFormatter(resp *guardrailsclient.GetScanDataResp) error

Constants

const (
	FormatPretty = "pretty"
	FormatJSON   = "json"
	FormatCSV    = "csv"
	FormatSARIF  = "sarif"
)

Variables

var (
	ErrMissingToken       = errors.New("missing token, please provide your GuardRails CLI token via -—token option or GUARDRAILS_CLI_TOKEN environment variable")
	ErrInvalidFormatParam = errors.New("failed to parse format value")
)

var (
	ErrFailedToSaveOutput = func(err error) error {
		return fmt.Errorf("Couldn't save output, %s", err.Error())
	}
)

Types

type Args

type Args struct {
	Token  string
	Path   string
	Format string
	Output string
	Quiet  bool
}

Args provides arguments for scan command handler.

func (*Args) SetDefault

func (args *Args) SetDefault() error

SetDefault sets default value for some of args variables.

func (Args) Validate

func (args Args) Validate() error

type Handler

type Handler struct {
	Args         *Args
	Spinner      *spinner.Spinner
	Config       *config.Config
	OutputWriter *outputwriter.OutputWriter
	Repository   repository.Repository
	Archiver     archiver.Archiver
	GRClient     grclient.GuardRailsClient
}

Handler contains scan command dependencies.

func New

func New(
	args *Args,
	spinner *spinner.Spinner,
	config *config.Config,
	repo repository.Repository,
	arc archiver.Archiver,
	out *outputwriter.OutputWriter,
	grClient grclient.GuardRailsClient) *Handler

New instantiates new scan command handler.

func (*Handler) Execute

func (h *Handler) Execute(ctx context.Context) (constant.ExitCode, error)

Execute runs scan command.

func (*Handler) GetScanDataFormatter

func (h *Handler) GetScanDataFormatter(resp *guardrailsclient.GetScanDataResp) error

GetScanDataFormatter parses guardrailsclient.GetScanDataResp to chosen format.