core

Documentation

Index

• type IKernelContext
  • func NewKernelContext() IKernelContext
• type IPipeline
• type IPipelineBuilder
  • func NewPipelineBuilder(l logger.ILogger, f IStepFactory, c IKernelContext) IPipelineBuilder
• type IStep
• type IStepFactory
• type KernelContext
  • func (c *KernelContext) Validate(stepName string) error
• type Pipeline
  • func (pl *Pipeline) Run() error
• type PipelineBuilder
  • func (b *PipelineBuilder) Build() IPipeline
  • func (b *PipelineBuilder) WithDefault() IPipelineBuilder
  • func (b *PipelineBuilder) WithStep(stepName string) IPipelineBuilder

Types

type IKernelContext

type IKernelContext interface {
	Validate(stepName string) error
}

func NewKernelContext

func NewKernelContext() IKernelContext

type IPipeline

type IPipeline interface {
	Run() error
}

type IPipelineBuilder

type IPipelineBuilder interface {
	WithStep(stepName string) IPipelineBuilder
	WithDefault() IPipelineBuilder
	Build() IPipeline
}

func NewPipelineBuilder

func NewPipelineBuilder(l logger.ILogger, f IStepFactory, c IKernelContext) IPipelineBuilder

type IStep

type IStep interface {
	Name() string
	// NeedParams() []string // TODO: simpler way?
	// This serves for the use case of when I only want
	// to run a set of steps. And for those steps if I have
	// not defined the required kernel context parameters
	// then it should warn the users. Speficy in the command
	// line arguments or prompt the user? What is more suckless
	Execute() error
}

type IStepFactory

type IStepFactory interface {
	AvailableSteps() []string
	CreateStep(name string, log logger.ILogger, ctx IKernelContext) (IStep, error)
}

type KernelContext

type KernelContext struct {
	TarballURL    string
	DownloadPath  string
	ArchivePath   string
	Directory     string
	SignatureURL  string
	ConfigOptions []string
	OldConfigPath string
	Initramfs     string
	Bootloader    string
	NumJobs       int
}

func (*KernelContext) Validate

func (c *KernelContext) Validate(stepName string) error

type Pipeline

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

func (*Pipeline) Run

func (pl *Pipeline) Run() error

type PipelineBuilder

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

func (*PipelineBuilder) Build

func (b *PipelineBuilder) Build() IPipeline

func (*PipelineBuilder) WithDefault

func (b *PipelineBuilder) WithDefault() IPipelineBuilder

func (*PipelineBuilder) WithStep

func (b *PipelineBuilder) WithStep(stepName string) IPipelineBuilder