checker

type CheckDetail struct {
	Msg  LogMessage
	Type DetailType // Any of DetailWarn, DetailInfo, DetailDebug.
}

type CheckFn func(*CheckRequest) CheckResult

type CheckNameToFnMap map[string]CheckFn

type CheckRequest struct {
	Ctx        context.Context
	RepoClient clients.RepoClient
	Dlogger    DetailLogger
	Repo       clients.Repo
}

type CheckResult struct {
	// Old structure
	Error      error `json:"-"`
	Name       string
	Details    []string
	Confidence int
	Pass       bool

	// UPGRADEv2: New structure. Omitting unchanged Name field
	// for simplicity.
	Version  int           `json:"-"` // Default value of 0 indicates old structure.
	Error2   error         `json:"-"` // Runtime error indicate a filure to run the check.
	Details2 []CheckDetail `json:"-"` // Details of tests and sub-checks
	Score    int           `json:"-"` // {[-1,0...10], -1 = Inconclusive}
	Reason   string        `json:"-"` // A sentence describing the check result (score, etc)
}

type DetailLogger interface {
	Info(desc string, args ...interface{})
	Warn(desc string, args ...interface{})
	Debug(desc string, args ...interface{})

	// Functions to use for moving to SARIF format.
	// UPGRADEv3: to rename.
	Info3(msg *LogMessage)
	Warn3(msg *LogMessage)
	Debug3(msg *LogMessage)
}

type DetailType int

type FileType int

type LogMessage struct {
	Text    string   // A short string explaining why the detail was recorded/logged.
	Path    string   // Fullpath to the file.
	Type    FileType // Type of file.
	Offset  int      // Offset in the file of Path (line for source/text files).
	Snippet string   // Snippet of code
	// UPGRADEv3: to remove.
	Version int // `3` to indicate the detail was logged using new structure.
}

type Runner struct {
	CheckRequest CheckRequest
	CheckName    string
	Repo         string
}