utils

Documentation

Index

• func ConvertAnyToAny(values ...interface{})
• func ConvertMapToJson(mapIn interface{}) (string, error)
• func ConvertStructToMap(structIn interface{}) (mapOut map[string]interface{}, err error)
• func FindVerifyConfigFileAbsPath(logger *log.MiniLogger, filename string) (absFilename string, err error)
• func IsValidJsonMap(test string) bool
• func IsValidJsonRaw(test []byte) bool
• type CommandFlags
  • func (flags *CommandFlags) String() string
• type CustomValidationFlags
• type DiffCommandFlags
• type LicenseCommandFlags
• type PersistentCommandFlags
• type ValidateCommandFlags
• type VulnerabilityCommandFlags

Functions

func ConvertAnyToAny

func ConvertAnyToAny(values ...interface{})

TODO: function NOT complete, only placeholder type switch

func ConvertMapToJson

func ConvertMapToJson(mapIn interface{}) (string, error)

NOTE: simple wrapper method on json package to standardize parms

func ConvertStructToMap

func ConvertStructToMap(structIn interface{}) (mapOut map[string]interface{}, err error)

func FindVerifyConfigFileAbsPath

func FindVerifyConfigFileAbsPath(logger *log.MiniLogger, filename string) (absFilename string, err error)

func IsValidJsonMap

func IsValidJsonMap(test string) bool

func IsValidJsonRaw

func IsValidJsonRaw(test []byte) bool

Types

type CommandFlags

type CommandFlags struct {
	// Not flags, but "main" package var copies
	Project    string
	Binary     string
	Version    string
	WorkingDir string
	ExecDir    string

	// Configurations
	ConfigSchemaFile           string
	ConfigCustomValidationFile string
	ConfigLicensePolicyFile    string

	// persistent flags (common to all commands)
	PersistentFlags PersistentCommandFlags

	// Diff flags
	DiffFlags DiffCommandFlags

	// License flags
	LicenseFlags LicenseCommandFlags

	// Vulnerability flags
	VulnerabilityFlags VulnerabilityCommandFlags

	// Validate (local) flags
	ValidateFlags           ValidateCommandFlags
	CustomValidationOptions CustomValidationFlags

	// Log indent
	LogOutputIndentCallstack bool
}

var GlobalFlags CommandFlags

Globals

func (*CommandFlags) String

func (flags *CommandFlags) String() string

format and output the MyFlags struct as a string using Go's Stringer interface

type CustomValidationFlags

type CustomValidationFlags struct {
	Composition bool
	License     bool
	Properties  bool
}

type DiffCommandFlags

type DiffCommandFlags struct {
	Colorize    bool
	RevisedFile string
}

type LicenseCommandFlags

type LicenseCommandFlags struct {
	Summary      bool
	ListLineWrap bool
}

type PersistentCommandFlags

type PersistentCommandFlags struct {
	Quiet        bool // suppresses all non-essential (informational) output from a command. Overrides any other log-level commands.
	Trace        bool // trace logging
	Debug        bool // debug logging
	InputFile    string
	OutputFile   string // TODO: TODO: Note: not used by `validate` command, which emits a warning if supplied
	OutputFormat string // e.g., "txt", "csv"", "md" (markdown) (normalized to lowercase)
}

NOTE: These flags are shared by both the list and policy subcommands

type ValidateCommandFlags

type ValidateCommandFlags struct {
	SchemaVariant        string
	ForcedJsonSchemaFile string
	// Uses custom validation flags if "true"; defaults to config. "custom.json"
	CustomValidation bool
	// error result processing
	MaxNumErrors              int
	MaxErrorDescriptionLength int
	ColorizeErrorOutput       bool
	ShowErrorValue            bool
}

type VulnerabilityCommandFlags

type VulnerabilityCommandFlags struct {
	Summary bool
}