certifier

Documentation

Index

• type Certifier
• type CertifierType
• type Emitter
• type ErrHandler
• type QueryComponents

Types

type Certifier

type Certifier interface {
	// CertifyComponent takes a GUAC component and generates processor.documents that are
	// push to the docChannel to be ingested.
	// Note: there is an implicit contract with "QueryComponents" where the compChan type must be the same as
	// the one used by "components"
	CertifyComponent(ctx context.Context, components interface{}, docChannel chan<- *processor.Document) error
}

type CertifierType

type CertifierType string

CertifierType describes the type of the certifier

const (
	CertifierOSV            CertifierType = "OSV"
	CertifierClearlyDefined CertifierType = "CD"
	CertifierScorecard      CertifierType = "scorecard"
)

type Emitter

type Emitter func(*processor.Document) error

Emitter processes a document

type ErrHandler

type ErrHandler func(error) bool

ErrHandler processes an error and returns a boolean representing if the error was able to be gracefully handled

type QueryComponents

type QueryComponents interface {
	// GetComponents runs as a goroutine to get the GUAC components that will be certified by the Certifier interface
	// Note: there is an implicit contract with "CertifyComponent" where the components type must be the same as
	// the one used by "compChan"
	GetComponents(ctx context.Context, compChan chan<- interface{}) error
}