rule

Documentation

Index

• Variables
• type Filter
• type NamespaceService
• type Repository
• type Rule
  • func FromV1beta1Proto(proto *sirenv1beta1.Rule) Rule
  • func (r *Rule) ToV1beta1Proto() *sirenv1beta1.Rule
• type RuleFile
• type RuleUploader
• type RuleVariable
• type Service
  • func NewService(repository Repository, templateService TemplateService, ...) *Service
  • func (s *Service) List(ctx context.Context, flt Filter) ([]Rule, error)
  • func (s *Service) Upsert(ctx context.Context, rl *Rule) error
• type TemplateService
• type Transactor
• type Variables

Variables

var (
	ErrDuplicate = errors.New("rule conflicted with existing")
	ErrRelation  = errors.New("provider's namespace does not exist")
)

Types

type Filter

type Filter struct {
	Name         string
	Namespace    string
	GroupName    string
	TemplateName string
	NamespaceID  uint64
}

type NamespaceService

type NamespaceService interface {
	List(context.Context) ([]namespace.Namespace, error)
	Create(context.Context, *namespace.Namespace) error
	Get(context.Context, uint64) (*namespace.Namespace, error)
	Update(context.Context, *namespace.Namespace) error
	Delete(context.Context, uint64) error
}

type Repository

type Repository interface {
	Transactor
	Upsert(context.Context, *Rule) error
	List(context.Context, Filter) ([]Rule, error)
}

type Rule

type Rule struct {
	ID                uint64         `json:"id"`
	Name              string         `json:"name"`
	Enabled           bool           `json:"enabled" validate:"required"`
	GroupName         string         `json:"group_name" validate:"required"`
	Namespace         string         `json:"namespace" validate:"required"`
	Template          string         `json:"template" validate:"required"`
	Variables         []RuleVariable `json:"variables" validate:"required,dive,required"`
	ProviderNamespace uint64         `json:"provider_namespace" validate:"required"`
	CreatedAt         time.Time      `json:"created_at"`
	UpdatedAt         time.Time      `json:"updated_at"`
}

func FromV1beta1Proto

func FromV1beta1Proto(proto *sirenv1beta1.Rule) Rule

func (*Rule) ToV1beta1Proto

func (r *Rule) ToV1beta1Proto() *sirenv1beta1.Rule

type RuleFile

type RuleFile struct {
	ApiVersion        string `yaml:"apiVersion"`
	Entity            string `yaml:"entity"`
	Type              string `yaml:"type"`
	Namespace         string `yaml:"namespace"`
	Provider          string `yaml:"provider"`
	ProviderNamespace string `yaml:"providerNamespace"`
	Rules             map[string]struct {
		Template  string      `yaml:"template"`
		Enabled   bool        `yaml:"enabled"`
		Variables []variables `yaml:"variables"`
	} `yaml:"rules"`
}

type RuleUploader

type RuleUploader interface {
	UpsertRule(ctx context.Context, ns namespace.Namespace, prov provider.Provider, rl *Rule, templateToUpdate *template.Template) error
}

type RuleVariable

type RuleVariable struct {
	Name        string `json:"name" validate:"required"`
	Type        string `json:"type"`
	Value       string `json:"value" validate:"required"`
	Description string `json:"description"`
}

type Service

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

Service handles business logic

func NewService

func NewService(
	repository Repository,
	templateService TemplateService,
	namespaceService NamespaceService,
	ruleUploadersRegistry map[string]RuleUploader,
) *Service

NewService returns repository struct

func (*Service) List

func (s *Service) List(ctx context.Context, flt Filter) ([]Rule, error)

func (*Service) Upsert

func (s *Service) Upsert(ctx context.Context, rl *Rule) error

type TemplateService

type TemplateService interface {
	Upsert(context.Context, *template.Template) error
	List(context.Context, template.Filter) ([]template.Template, error)
	GetByName(context.Context, string) (*template.Template, error)
	Delete(context.Context, string) error
}

type Transactor

type Transactor interface {
	WithTransaction(ctx context.Context) context.Context
	Rollback(ctx context.Context, err error) error
	Commit(ctx context.Context) error
}

type Variables

type Variables struct {
	Variables []variable `json:"variables"`
}