check

Documentation

Index

• func ListFormatFunc(es []codeowners.Entry) string
• type Checker
• type DuplicatedPatternChecker
  • func NewDuplicatedPattern() *DuplicatedPatternChecker
  • func (d *DuplicatedPatternChecker) Check(ctx context.Context, in Input) (Output, error)
  • func (DuplicatedPatternChecker) Name() string
• type FileExistChecker
  • func NewFileExist() *FileExistChecker
  • func (FileExistChecker) Check(ctx context.Context, in Input) (Output, error)
  • func (FileExistChecker) Name() string
• type Input
• type Issue
• type NotOwnedFileChecker
  • func NewNotOwnedFile(cfg NotOwnedFileCheckerConfig) *NotOwnedFileChecker
  • func (c *NotOwnedFileChecker) AppendToGitignoreFile(repoDir string, patterns []string) error
  • func (c *NotOwnedFileChecker) Check(ctx context.Context, in Input) (output Output, err error)
  • func (c *NotOwnedFileChecker) GitCheckStatus(repoDir string) error
  • func (c *NotOwnedFileChecker) GitListFiles(repoDir string) (string, error)
  • func (c *NotOwnedFileChecker) GitRemoveIgnoredFiles(repoDir string) error
  • func (c *NotOwnedFileChecker) GitResetCurrentBranch(repoDir string) error
  • func (c *NotOwnedFileChecker) ListFormatFunc(es []string) string
  • func (NotOwnedFileChecker) Name() string
• type NotOwnedFileCheckerConfig
• type Opt
  • func WithEntry(e codeowners.Entry) Opt
  • func WithSeverity(s SeverityType) Opt
• type Output
  • func (out *Output) ReportIssue(msg string, opts ...Opt) Issue
• type SeverityType
  • func (s SeverityType) String() string
  • func (s *SeverityType) Unmarshal(in string) error
• type ValidOwnerChecker
  • func NewValidOwner(cfg ValidOwnerCheckerConfig, ghClient *github.Client) *ValidOwnerChecker
  • func (v *ValidOwnerChecker) Check(ctx context.Context, in Input) (Output, error)
  • func (ValidOwnerChecker) Name() string
• type ValidOwnerCheckerConfig

Functions

func ListFormatFunc

func ListFormatFunc(es []codeowners.Entry) string

ListFormatFunc is a basic formatter that outputs a bullet point list of the pattern.

Types

type Checker

type Checker interface {
	Check(ctx context.Context, in Input) (Output, error)
	Name() string
}

Checker allows to execute check in a generic way

type DuplicatedPatternChecker

type DuplicatedPatternChecker struct{}

DuplicatedPatternChecker validates if CODEOWNERS file does not contain the duplicated lines with the same file pattern.

func NewDuplicatedPattern

func NewDuplicatedPattern() *DuplicatedPatternChecker

NewDuplicatedPattern returns instance of the DuplicatedPatternChecker

func (*DuplicatedPatternChecker) Check

func (d *DuplicatedPatternChecker) Check(ctx context.Context, in Input) (Output, error)

Check searches for doubles paths(patterns) in CODEOWNERS file.

func (DuplicatedPatternChecker) Name

func (DuplicatedPatternChecker) Name() string

Name returns human readable name of the validator.

type FileExistChecker

type FileExistChecker struct{}

func NewFileExist

func NewFileExist() *FileExistChecker

func (FileExistChecker) Check

func (FileExistChecker) Check(ctx context.Context, in Input) (Output, error)

func (FileExistChecker) Name

func (FileExistChecker) Name() string

type Input

type Input struct {
	RepoDir          string
	CodeownerEntries []codeowners.Entry
}

type Issue

type Issue struct {
	Severity SeverityType // enum // default error
	LineNo   *uint64
	Message  string
}

type NotOwnedFileChecker

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

func NewNotOwnedFile

func NewNotOwnedFile(cfg NotOwnedFileCheckerConfig) *NotOwnedFileChecker

func (*NotOwnedFileChecker) AppendToGitignoreFile

func (c *NotOwnedFileChecker) AppendToGitignoreFile(repoDir string, patterns []string) error

func (*NotOwnedFileChecker) Check

func (c *NotOwnedFileChecker) Check(ctx context.Context, in Input) (output Output, err error)

func (*NotOwnedFileChecker) GitCheckStatus

func (c *NotOwnedFileChecker) GitCheckStatus(repoDir string) error

func (*NotOwnedFileChecker) GitListFiles

func (c *NotOwnedFileChecker) GitListFiles(repoDir string) (string, error)

func (*NotOwnedFileChecker) GitRemoveIgnoredFiles

func (c *NotOwnedFileChecker) GitRemoveIgnoredFiles(repoDir string) error

func (*NotOwnedFileChecker) GitResetCurrentBranch

func (c *NotOwnedFileChecker) GitResetCurrentBranch(repoDir string) error

func (*NotOwnedFileChecker) ListFormatFunc

func (c *NotOwnedFileChecker) ListFormatFunc(es []string) string

ListFormatFunc is a basic formatter that outputs a bullet point list of the pattern.

func (NotOwnedFileChecker) Name

func (NotOwnedFileChecker) Name() string

Name returns human readable name of the validator

type NotOwnedFileCheckerConfig

type NotOwnedFileCheckerConfig struct {
	SkipPatterns []string `envconfig:"optional"`
}

type Opt

type Opt func(*Issue)

func WithEntry

func WithEntry(e codeowners.Entry) Opt

func WithSeverity

func WithSeverity(s SeverityType) Opt

type Output

type Output struct {
	Issues []Issue
}

func (*Output) ReportIssue

func (out *Output) ReportIssue(msg string, opts ...Opt) Issue

type SeverityType

type SeverityType int

const (
	Error SeverityType = iota + 1
	Warning
)

func (SeverityType) String

func (s SeverityType) String() string

func (*SeverityType) Unmarshal

func (s *SeverityType) Unmarshal(in string) error

Unmarshal provides custom parsing of severity type. Implements envconfig.Unmarshal interface.

type ValidOwnerChecker

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

ValidOwnerChecker validates each owner

func NewValidOwner

func NewValidOwner(cfg ValidOwnerCheckerConfig, ghClient *github.Client) *ValidOwnerChecker

NewValidOwner returns new instance of the ValidOwnerChecker

func (*ValidOwnerChecker) Check

func (v *ValidOwnerChecker) Check(ctx context.Context, in Input) (Output, error)

Check check if defined owners are the valid ones. Allowed owner syntax: @username @org/team-name user@example.com source: https://help.github.com/articles/about-code-owners/#codeowners-syntax

Checks: - if owner is one of: github user, org team, email address - if github user then check if have github account - if github user then check if he/she is in organization - if org team then check if exists in organization

func (ValidOwnerChecker) Name

func (ValidOwnerChecker) Name() string

Name returns human readable name of the validator

type ValidOwnerCheckerConfig

type ValidOwnerCheckerConfig struct {
	OrganizationName string
}