apis

Documentation

Index

• type IStatus
• type ScanningStatus
  • func Compare(a, b ScanningStatus) ScanningStatus

Types

type IStatus

type IStatus interface {
	Status() ScanningStatus
	IsPassed() bool
	IsFailed() bool
	IsExcluded() bool
	IsSkipped() bool
}

IStatus interface handling status

type ScanningStatus

type ScanningStatus string

const (
	StatusPassed   ScanningStatus = "passed"
	StatusExcluded ScanningStatus = "excluded"
	StatusIgnored  ScanningStatus = "ignored"
	StatusFailed   ScanningStatus = "failed"
	StatusSkipped  ScanningStatus = "skipped"
	StatusUnknown  ScanningStatus = "" // keep this empty

)

func Compare

func Compare(a, b ScanningStatus) ScanningStatus

Compare receive two statuses and returns the more significant one

status level:
	1. failed
	2. excludes
	3. passed
	4. skipped/ignore

e.g.:
Compare(failed, excludes) -> failed
Compare(passed, excludes) -> excludes
Compare(skipped, excludes) -> excludes
Compare(failed, passed) -> failed