finding

package
v0.1.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 19, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsNotExistError added in v0.1.4 

func IsNotExistError(err error) bool

func WrapNotExistError added in v0.1.4 

func WrapNotExistError(err error) error

WrapNotExistError wraps an existing error into a NotExistError to hint on disabling the sandbox when the error is handled.

Types

type ErrorDetails 

type ErrorDetails struct {
	Id       string    `json:"id,omitempty"`
	Name     string    `json:"name,omitempty"`
	Severity *Severity `json:"severity,omitempty"`
}

type ErrorType 

type ErrorType string
const (
	ErrorType_UNKNOWN_ERROR     ErrorType = "UNKNOWN_ERROR"
	ErrorType_COMPILATION_ERROR ErrorType = "COMPILATION_ERROR"
	ErrorType_CRASH             ErrorType = "CRASH"
	ErrorType_WARNING           ErrorType = "WARNING"
	ErrorType_RUNTIME_ERROR     ErrorType = "RUNTIME_ERROR"
)

These constants must have this exact value (in uppercase) to be able to parse JSON-marshalled reports as protobuf reports which use an enum for this field.

type Finding 

type Finding struct {
	Name               string        `json:"name,omitempty"`
	Type               ErrorType     `json:"type,omitempty"`
	InputData          []byte        `json:"input_data,omitempty"`
	Logs               []string      `json:"logs,omitempty"`
	Details            string        `json:"details,omitempty"`
	HumanReadableInput string        `json:"human_readable_input,omitempty"`
	MoreDetails        *ErrorDetails `json:"more_details,omitempty"`
	Tag                uint64        `json:"tag,omitempty"`
	ShortDescription   string        `json:"short_description,omitempty"`
	InputFile          string
}

func ListFindings added in v0.1.4 

func ListFindings(projectDir string) ([]*Finding, error)

ListFindings parses the JSON files of all findings and returns the result.

func LoadFinding added in v0.1.4 

func LoadFinding(projectDir, findingName string) (*Finding, error)

LoadFinding parses the JSON file of the specified finding and returns the result. If the specified finding does not exist, a NotExistError is returned.

func (*Finding) GetDetails 

func (f *Finding) GetDetails() string

func (*Finding) GetInputFile 

func (f *Finding) GetInputFile(projectDir string) string

GetInputFile returns the path where the finding's input file can be found. Note that the InputFile field contains the path to the input file relative to the project directory. The GetInputFile therefore receives the project directory as an argument and returns the absolute path to the input file.

func (*Finding) Save 

func (f *Finding) Save(projectDir string) error

type NotExistError added in v0.1.4 

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

A NotExistError indicates that the specified finding does not exist

func (NotExistError) Error added in v0.1.4 

func (e NotExistError) Error() string

func (NotExistError) Unwrap added in v0.1.4 

func (e NotExistError) Unwrap() error

type Severity 

type Severity struct {
	Description string  `json:"description,omitempty"`
	Score       float32 `json:"score,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.