lookout

type AnalysisStatus int

type Analyzer struct {
	Client AnalyzerClient
	Config AnalyzerConfig
}

type AnalyzerClient = pb.AnalyzerClient

type AnalyzerComments struct {
	Config   AnalyzerConfig
	Comments []*Comment
}

type AnalyzerCommentsGroups []AnalyzerComments

type AnalyzerConfig struct {
	Name string
	// Addr is gRPC URL.
	// can be defined only in global config, repository-scoped configuration is ignored
	Addr string
	// Disabled repository-scoped configuration can accept only true value, false value is ignored
	Disabled bool
	// Feedback is a url to be linked after each comment
	Feedback string
	// Settings any configuration for an analyzer
	Settings map[string]interface{}
}

type AnalyzerServer = pb.AnalyzerServer

type Change = pb.Change

type ChangeGetter interface {
	// GetChanges returns a ChangeScanner that scans all changes according
	// to the request.
	GetChanges(context.Context, *ChangesRequest) (ChangeScanner, error)
}

type ChangeScanner interface {
	// Next advances the scanner to the next change. It returns true if a new
	// change is found, and false otherwise. After the user is done scanning,
	// Err must be called to check if all changes were consumed or there was an
	// error.
	Next() bool
	// Err returns any error found during scanning.
	Err() error
	// Change returns the current change.
	Change() *Change
	// Close closes the scanner.
	Close() error
}

type ChangesRequest = pb.ChangesRequest

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

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

type Comment = pb.Comment

type CommentsFilterFn func(*Comment) (skip bool, err error)

type CommitRevision = pb.CommitRevision

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

type DataServerHandler struct {
	ChangeGetter ChangeGetter
	FileGetter   FileGetter
}

type Event interface {
	// ID returns the EventID.
	ID() EventID
	// Type returns the EventType, in order to identify the concreate type of
	// the event.
	Type() EventType
	// Revision returns a commit revision, containing the head and the base of
	// the changes.
	Revision() *CommitRevision
	// Validate returns an error if the event is malformed
	Validate() error
	// GetProvider returns the name of the provider that created this event
	GetProvider() string
	// GetOrganizationID returns the organization to which this event's repository
	// belongs to
	GetOrganizationID() string
}

type EventHandler func(context.Context, Event) error

type EventID = pb.EventID

type EventResponse = pb.EventResponse

type EventType = pb.EventType

type File = pb.File

type FileGetter interface {
	// GetFiles returns a FilesScanner that scans all files according
	// to the request.
	GetFiles(context.Context, *FilesRequest) (FileScanner, error)
}

type FileScanner interface {
	// Next advances the scanner to the next file. It returns true if a new
	// file is found, and false otherwise. After the user is done scanning,
	// Err must be called to check if all files were consumed or there was an
	// error.
	Next() bool
	// Err returns any error found during scanning.
	Err() error
	// File returns the current file.
	File() *File
	// Close closes the scanner.
	Close() error
}

type FilesRequest = pb.FilesRequest

type FnChangeScanner struct {
	Scanner ChangeScanner
	Fn      func(*Change) (bool, error)
	OnStart func() error
	// contains filtered or unexported fields
}

type FnFileScanner struct {
	Scanner FileScanner
	Fn      func(*File) (bool, error)
	OnStart func() error
	// contains filtered or unexported fields
}

type Poster interface {
	// Post posts comments about an event.
	// poster should make sure comments weren't posted before if safe is true
	Post(ctx context.Context, e Event, cs []AnalyzerComments, safe bool) error

	// Status sends the current analysis status to the provider
	Status(context.Context, Event, AnalysisStatus) error
}

type PushEvent struct {
	pb.PushEvent
	// OrganizationID is the organization to which this event's repository
	// belongs to
	OrganizationID string
}

type ReferencePointer = pb.ReferencePointer

type RepositoryInfo = pb.RepositoryInfo

type ReviewEvent struct {
	pb.ReviewEvent
	// OrganizationID is the organization to which this event's repository
	// belongs to
	OrganizationID string
}

type Watcher interface {
	// Watch for new events triggering the EventHandler for each new issue,
	// it stops until an error is returned by the EventHandler. Network errors
	// or other temporal errors are handled as non-fatal errors, just logging it.
	Watch(context.Context, EventHandler) error
}