policy

Documentation

Index

• Variables
• type Actor
• type AutoReleasePolicy
• type BranchRestriction
• type Policies
  • func (p *Policies) Delete(ids ...string) int
  • func (p *Policies) HasPolicies() bool
  • func (p *Policies) SetAutoRelease(branch, env string) string
  • func (p *Policies) SetBranchRestriction(branchRegex string, env string) string
• type Service
  • func (s *Service) ApplyAutoRelease(ctx context.Context, actor Actor, svc, branch, env string) (string, error)
  • func (s *Service) ApplyBranchRestriction(ctx context.Context, actor Actor, svc, branchRegex, env string) (string, error)
  • func (s *Service) CanRelease(ctx context.Context, svc, branch, env string) (bool, error)
  • func (s *Service) Delete(ctx context.Context, actor Actor, svc string, ids []string) (int, error)
  • func (s *Service) Get(ctx context.Context, svc string) (Policies, error)
  • func (s *Service) GetAutoReleases(ctx context.Context, svc, branch string) ([]AutoReleasePolicy, error)

Variables

var (
	// ErrNotParsable indicates that a policies file could not be parsed against
	// the specification.
	ErrNotParsable = errors.New("policies not parsable")
	// ErrUnknownFields indicates that a policies file contains an unknown field.
	ErrUnknownFields = errors.New("policies contains unknown fields")
	// ErrNotFound indicates that policies are not found for a service.
	ErrNotFound = errors.New("not found")
	// ErrConflict indicates that polices are not compatible
	ErrConflict = errors.New("conflict")
)

Types

type Actor

type Actor struct {
	Name  string
	Email string
}

type AutoReleasePolicy

type AutoReleasePolicy struct {
	ID          string `json:"id,omitempty"`
	Branch      string `json:"branch,omitempty"`
	Environment string `json:"environment,omitempty"`
}

type BranchRestriction

type BranchRestriction struct {
	ID          string `json:"id,omitempty"`
	BranchRegex string `json:"branchRegex,omitempty"`
	Environment string `json:"environment,omitempty"`
}

type Policies

type Policies struct {
	Service            string              `json:"service,omitempty"`
	AutoReleases       []AutoReleasePolicy `json:"autoReleases,omitempty"`
	BranchRestrictions []BranchRestriction `json:"branchRestrictions,omitempty"`
}

func (*Policies) Delete

func (p *Policies) Delete(ids ...string) int

Delete deletes any policies with a matching id.

func (*Policies) HasPolicies

func (p *Policies) HasPolicies() bool

HasPolicies returns whether any policies are applied.

func (*Policies) SetAutoRelease

func (p *Policies) SetAutoRelease(branch, env string) string

SetAutoRelease sets an auto-release policy for specified branch and environment.

If an auto-release policy exists for the same environment it is overwritten.

func (*Policies) SetBranchRestriction

func (p *Policies) SetBranchRestriction(branchRegex string, env string) string

SetBranchRestriction sets a branch-restriction policy for specified environment and branch regex.

If a policy exists for the same environment it is overwritten.

type Service

type Service struct {
	Tracer tracing.Tracer
	Git    *git.Service

	MaxRetries int
}

func (*Service) ApplyAutoRelease

func (s *Service) ApplyAutoRelease(ctx context.Context, actor Actor, svc, branch, env string) (string, error)

ApplyAutoRelease applies an auto-release policy for service svc from branch to environment env.

func (*Service) ApplyBranchRestriction

func (s *Service) ApplyBranchRestriction(ctx context.Context, actor Actor, svc, branchRegex, env string) (string, error)

ApplyBranchRestriction applies a branch-restriction policy for service svc to environment env with regular expression branchRegex.

func (*Service) CanRelease

func (s *Service) CanRelease(ctx context.Context, svc, branch, env string) (bool, error)

CanRelease returns whether service svc's branch can be released to env.

func (*Service) Delete

func (s *Service) Delete(ctx context.Context, actor Actor, svc string, ids []string) (int, error)

Delete deletes policies by ID for service svc.

func (*Service) Get

func (s *Service) Get(ctx context.Context, svc string) (Policies, error)

Get gets stored policies for service svc. If no policies are stored ErrNotFound is returned.

func (*Service) GetAutoReleases

func (s *Service) GetAutoReleases(ctx context.Context, svc, branch string) ([]AutoReleasePolicy, error)

GetAutoReleases gets stored auto-release policies for service svc. If no policies are found a nil slice is returned.