analysis

Documentation

Index

• type Analyzer
• type CheckParams
• type Diagnostic
• type Pass
  • func (p *Pass) ReportResult(analysisName string, rule *Rule, message string, detail string)
• type ReadmeInfo
• type Rule
• type Severity
• type TestReporter
  • func (r *TestReporter) Report(d Diagnostic)

Types

type Analyzer

type Analyzer struct {
	Name       string
	Requires   []*Analyzer
	Run        func(pass *Pass) (interface{}, error)
	Rules      []*Rule
	ReadmeInfo ReadmeInfo
}

type CheckParams

type CheckParams struct {
	// ArchiveFile contains the path passed to the validator. can be a file or a url
	ArchiveFile string
	// ArchiveDir contains the path to the extracted files from the ArchiveFile
	ArchiveDir string
	// SourceCodeDir contains the path to the plugin source code
	SourceCodeDir string
	// SourceCodeReference contains the reference passed to the validator as source code, can be a folder or an url
	SourceCodeReference string
	// Checksum contains the checksum passed to the validator as an argument
	Checksum string
	// ArchiveCalculatedMD5 contains the md5 checksum calculated from the archive
	ArchiveCalculatedMD5 string
	// ArchiveCalculatedSHA1 contains the sha1 checksum calculated from the archive
	ArchiveCalculatedSHA1 string
}

type Diagnostic

type Diagnostic struct {
	Severity Severity
	Title    string
	Detail   string
	Context  string `json:"Context,omitempty"`
	Name     string
}

type Pass

type Pass struct {
	AnalyzerName string
	RootDir      string
	CheckParams  CheckParams
	ResultOf     map[*Analyzer]interface{}
	Report       func(string, Diagnostic)
}

func (*Pass) ReportResult

func (p *Pass) ReportResult(analysisName string, rule *Rule, message string, detail string)

type ReadmeInfo

type ReadmeInfo struct {
	Name         string
	Description  string
	Dependencies string
}

type Rule

type Rule struct {
	Name      string
	Disabled  bool
	Severity  Severity
	ReportAll bool
}

type Severity

type Severity string

var (
	Error            Severity = "error"
	Warning          Severity = "warning"
	OK               Severity = "ok"
	SuspectedProblem Severity = "suspected"
	Recommendation   Severity = "recommendation"
)

type TestReporter

type TestReporter struct {
	ReportFunc func(d Diagnostic)
	Invoked    bool
}

func (*TestReporter) Report

func (r *TestReporter) Report(d Diagnostic)