engine

README

engine

Documentation

Index

• Constants
• Variables
• func GetDefaultMockPullRequestDetails() *github.PullRequest
• func Lint(file *ReviewpadFile, logger *logrus.Entry) error
• func MockGithubClient(clientOptions []mock.MockBackendOption) *gh.GithubClient
• func MustUnmarshal(data []byte, v interface{})
• func MustWriteBytes(w io.Writer, data []byte)
• type CheckState
• type Env
  • func MockEnvWith(githubClient *gh.GithubClient, interpreter Interpreter, ...) (*Env, error)
  • func NewEvalEnv(ctx context.Context, logger *logrus.Entry, dryRun bool, ...) (*Env, error)
• type ExitStatus
• type GroupKind
• type GroupType
• type Interpreter
• type LoadEnv
• type NormalizeRule
  • func NewNormalizeRule() *NormalizeRule
  • func (n *NormalizeRule) Do(file *ReviewpadFile) (*ReviewpadFile, error)
  • func (n *NormalizeRule) WithModificators(m ...modificator)
  • func (n *NormalizeRule) WithValidators(v ...validator)
• type PadGroup
• type PadImport
• type PadLabel
• type PadPipeline
• type PadRule
• type PadStage
• type PadWorkflow
• type PadWorkflowRule
• type Program
  • func BuildProgram(statements []*Statement) *Program
  • func EvalCommand(command string, env *Env) (*Program, error)
  • func EvalConfigurationFile(file *ReviewpadFile, env *Env) (*Program, error)
  • func (p *Program) GetProgramStatements() []*Statement
• type ReviewpadFile
  • func Load(ctx context.Context, logger *logrus.Entry, githubClient *gh.GithubClient, ...) (*ReviewpadFile, error)
• type Statement
  • func BuildStatement(code string) *Statement
  • func (s *Statement) GetStatementCode() string

Constants

const (
	PROFESSIONAL_EDITION string = "professional"
	TEAM_EDITION         string = "team"
	SILENT_MODE          string = "silent"
	VERBOSE_MODE         string = "verbose"
)

const DefaultMockEventAction = "opened"

const DefaultMockEventName = "pull_request"

const DefaultMockPrID = 1234

Use only for tests

const DefaultMockPrNum = 6

const DefaultMockPrOwner = "foobar"

const DefaultMockPrRepoName = "default-mock-repo"

Variables

var DefaultMockCollector, _ = collector.NewCollector("", "distinctId", "pull_request", "runnerName", nil)

var DefaultMockCtx = context.Background()

Use only for tests

var DefaultMockEventDetails = &handler.EventDetails{
	EventName:   DefaultMockEventName,
	EventAction: DefaultMockEventAction,
}

var DefaultMockEventPayload = &github.CheckRunEvent{}

var DefaultMockLogger = logrus.NewEntry(logrus.New())

var DefaultMockTargetEntity = &handler.TargetEntity{
	Owner:  DefaultMockPrOwner,
	Repo:   DefaultMockPrRepoName,
	Number: DefaultMockPrNum,
	Kind:   handler.PullRequest,
}

Functions

func GetDefaultMockPullRequestDetails

func GetDefaultMockPullRequestDetails() *github.PullRequest

func Lint

func Lint(file *ReviewpadFile, logger *logrus.Entry) error

func MockGithubClient

func MockGithubClient(clientOptions []mock.MockBackendOption) *gh.GithubClient

func MustUnmarshal

func MustUnmarshal(data []byte, v interface{})

func MustWriteBytes

func MustWriteBytes(w io.Writer, data []byte)

Types

type CheckState

type CheckState string

const (
	CheckStateError   CheckState = "error"
	CheckStateFailure CheckState = "failure"
	CheckStatePending CheckState = "pending"
	CheckStateSuccess CheckState = "success"
)

type Env

type Env struct {
	Ctx          context.Context
	DryRun       bool
	GithubClient *gh.GithubClient
	Collector    collector.Collector
	Interpreter  Interpreter
	TargetEntity *handler.TargetEntity
	EventDetails *handler.EventDetails
	Logger       *logrus.Entry
}

func MockEnvWith

func MockEnvWith(githubClient *gh.GithubClient, interpreter Interpreter, targetEntity *handler.TargetEntity, eventDetails *handler.EventDetails) (*Env, error)

func NewEvalEnv

func NewEvalEnv(
	ctx context.Context,
	logger *logrus.Entry,
	dryRun bool,
	githubClient *gh.GithubClient,
	collector collector.Collector,
	targetEntity *handler.TargetEntity,
	interpreter Interpreter,
	eventDetails *handler.EventDetails,
) (*Env, error)

type ExitStatus

type ExitStatus int

const ExitStatusFailure ExitStatus = 1

const ExitStatusSuccess ExitStatus = 0

type GroupKind

type GroupKind string

const GroupKindDeveloper GroupKind = "developer"

type GroupType

type GroupType string

const GroupTypeFilter GroupType = "filter"

const GroupTypeStatic GroupType = "static"

type Interpreter

type Interpreter interface {
	ProcessGroup(name string, kind GroupKind, typeOf GroupType, expr, paramExpr, whereExpr string) error
	ProcessLabel(id, name string) error
	ProcessRule(name, spec string) error
	EvalExpr(kind, expr string) (bool, error)
	ExecProgram(program *Program) (ExitStatus, error)
	ExecStatement(statement *Statement) error
	Report(mode string, safeMode bool) error
	ReportMetrics() error
}

type LoadEnv

type LoadEnv struct {
	Visited map[string]bool
	Stack   map[string]bool
}

type NormalizeRule

type NormalizeRule struct {
	Validators   []validator
	Modificators []modificator
}

func NewNormalizeRule

func NewNormalizeRule() *NormalizeRule

func (*NormalizeRule) Do

func (n *NormalizeRule) Do(file *ReviewpadFile) (*ReviewpadFile, error)

func (*NormalizeRule) WithModificators

func (n *NormalizeRule) WithModificators(m ...modificator)

func (*NormalizeRule) WithValidators

func (n *NormalizeRule) WithValidators(v ...validator)

type PadGroup

type PadGroup struct {
	Name        string `yaml:"name"`
	Description string `yaml:"description"`
	Kind        string `yaml:"kind"`
	Type        string `yaml:"type"`
	Spec        string `yaml:"spec"`
	Param       string `yaml:"param"`
	Where       string `yaml:"where"`
}

type PadImport

type PadImport struct {
	Url string `yaml:"url"`
}

type PadLabel

type PadLabel struct {
	Name        string `yaml:"name"`
	Color       string `yaml:"color"`
	Description string `yaml:"description"`
}

type PadPipeline

type PadPipeline struct {
	Name        string     `yaml:"name"`
	Description string     `yaml:"description"`
	Trigger     string     `yaml:"trigger"`
	Stages      []PadStage `yaml:"stages"`
}

type PadRule

type PadRule struct {
	Name        string `yaml:"name"`
	Kind        string `yaml:"kind"`
	Description string `yaml:"description"`
	Spec        string `yaml:"spec"`
}

type PadStage

type PadStage struct {
	Actions []string `yaml:"actions"`
	Until   string   `yaml:"until"`
}

type PadWorkflow

type PadWorkflow struct {
	Name               string                     `yaml:"name"`
	On                 []handler.TargetEntityKind `yaml:"on"`
	Description        string                     `yaml:"description"`
	AlwaysRun          bool                       `yaml:"always-run"`
	Rules              []PadWorkflowRule          `yaml:"-"`
	Actions            []string                   `yaml:"then"`
	NonNormalizedRules []interface{}              `yaml:"if"`
}

type PadWorkflowRule

type PadWorkflowRule struct {
	Rule         string   `yaml:"rule"`
	ExtraActions []string `yaml:"extra-actions" mapstructure:"extra-actions"`
}

type Program

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

func BuildProgram

func BuildProgram(statements []*Statement) *Program

func EvalCommand

func EvalCommand(command string, env *Env) (*Program, error)

EvalCommand generates the program to be executed when a command is received

func EvalConfigurationFile

func EvalConfigurationFile(file *ReviewpadFile, env *Env) (*Program, error)

EvalConfigurationFile generates the program to be executed Pre-condition Lint(file) == nil

func (*Program) GetProgramStatements

func (p *Program) GetProgramStatements() []*Statement

type ReviewpadFile

type ReviewpadFile struct {
	Version        string              `yaml:"api-version"`
	Edition        string              `yaml:"edition"`
	Mode           string              `yaml:"mode"`
	IgnoreErrors   *bool               `yaml:"ignore-errors"`
	MetricsOnMerge *bool               `yaml:"metrics-on-merge"`
	Imports        []PadImport         `yaml:"imports"`
	Extends        []string            `yaml:"extends"`
	Groups         []PadGroup          `yaml:"groups"`
	Rules          []PadRule           `yaml:"rules"`
	Labels         map[string]PadLabel `yaml:"labels"`
	Workflows      []PadWorkflow       `yaml:"workflows"`
	Pipelines      []PadPipeline       `yaml:"pipelines"`
	Recipes        map[string]*bool    `yaml:"recipes"`
}

func Load

func Load(ctx context.Context, logger *logrus.Entry, githubClient *gh.GithubClient, data []byte) (*ReviewpadFile, error)

type Statement

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

func BuildStatement

func BuildStatement(code string) *Statement

func (*Statement) GetStatementCode

func (s *Statement) GetStatementCode() string