pipeline

Documentation

Index

• Variables
• func IsInvalidArgument(err error) bool
• func IsNotFound(err error) bool
• type ID
  • func (i ID) Valid() error
• type InMemoryRepository
  • func (r *InMemoryRepository) Create(p *Pipeline) (*Pipeline, error)
  • func (r *InMemoryRepository) Delete(id ID) (*Pipeline, error)
  • func (r *InMemoryRepository) Get(id ID) (*Pipeline, error)
  • func (r *InMemoryRepository) Update(id ID, pipeline *Pipeline) (*Pipeline, error)
• type Job
  • func (j *Job) Valid() error
• type Pipeline
  • func (p *Pipeline) Valid() error
• type Repository
  • func NewRepository() Repository
• type Service
  • func NewService(repo Repository) *Service
  • func (s *Service) Create(p *Pipeline) (*Pipeline, error)
  • func (s *Service) Delete(id ID) (*Pipeline, error)
  • func (s *Service) Get(id ID) (*Pipeline, error)
  • func (s *Service) ID(id string) ID
  • func (s *Service) Update(id ID, p *Pipeline) (*Pipeline, error)

Variables

var (
	// ErrPipelineNotFound for pipeline.
	ErrPipelineNotFound = errors.New("pipeline not found")

	// ErrInvalidPipelineName for pipeline.
	ErrInvalidPipelineName = errors.New("invalid pipeline name")

	// ErrMissingJobs for pipeline.
	ErrMissingJobs = errors.New("missing jobs")

	// ErrInvalidJobName for pipeline.
	ErrInvalidJobName = errors.New("invalid job name")

	// ErrMissingSteps for pipeline.
	ErrMissingSteps = errors.New("missing steps")

	// ErrInvalidID for pipeline.
	ErrInvalidID = errors.New("invalid id")
)

var Module = fx.Options(
	fx.Provide(NewService),
	fx.Provide(NewRepository),
)

Module for fx.

Functions

func IsInvalidArgument

func IsInvalidArgument(err error) bool

IsInvalidArgument for pipeline.

func IsNotFound

func IsNotFound(err error) bool

IsNotFound for pipeline.

Types

type ID

type ID uint64

ID for service.

func (ID) Valid

func (i ID) Valid() error

Valid or error.

type InMemoryRepository

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

InMemoryRepository for pipeline.

func (*InMemoryRepository) Create

func (r *InMemoryRepository) Create(p *Pipeline) (*Pipeline, error)

Create a pipeline and set the identifier.

func (*InMemoryRepository) Delete

func (r *InMemoryRepository) Delete(id ID) (*Pipeline, error)

Delete a pipeline.

func (*InMemoryRepository) Get

func (r *InMemoryRepository) Get(id ID) (*Pipeline, error)

Get a pipeline.

func (*InMemoryRepository) Update

func (r *InMemoryRepository) Update(id ID, pipeline *Pipeline) (*Pipeline, error)

Update a pipeline.

type Job

type Job struct {
	Name  string
	Steps []string
}

Job of the pipeline.

func (*Job) Valid

func (j *Job) Valid() error

Valid job or error.

type Pipeline

type Pipeline struct {
	Name string
	Jobs []*Job
	ID   ID
}

Pipeline to be executed.

func (*Pipeline) Valid

func (p *Pipeline) Valid() error

Valid pipeline or error.

type Repository

type Repository interface {
	// Get a pipeline.
	Get(id ID) (*Pipeline, error)

	// Create a pipeline.
	Create(p *Pipeline) (*Pipeline, error)

	// Update a pipeline.
	Update(id ID, p *Pipeline) (*Pipeline, error)

	// Delete a pipeline.
	Delete(id ID) (*Pipeline, error)
}

Repository for pipeline.

func NewRepository

func NewRepository() Repository

NewRepository for pipeline.

type Service

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

Service coordinates all the pipeline activities.

func NewService

func NewService(repo Repository) *Service

NewService for pipeline.

func (*Service) Create

func (s *Service) Create(p *Pipeline) (*Pipeline, error)

Create a new pipeline.

func (*Service) Delete

func (s *Service) Delete(id ID) (*Pipeline, error)

Update an existing pipeline.

func (*Service) Get

func (s *Service) Get(id ID) (*Pipeline, error)

Get pipeline by id.

func (*Service) ID

func (s *Service) ID(id string) ID

ID from a string.

func (*Service) Update

func (s *Service) Update(id ID, p *Pipeline) (*Pipeline, error)

Update an existing pipeline.