recipe

Documentation

Index

• Constants
• type HTTPClient
• type Recipe
  • func FromPath(path string) (*Recipe, error)
  • func FromRepository(recipeName string, httpClient HTTPClient) (*Recipe, error)
  • func FromURL(url string, httpClient HTTPClient) (*Recipe, int, error)
  • func (r *Recipe) Validate() error
• type Stage
• type Step
• type UnitMetadata

Constants

const AnyOS = "any"

AnyOS is OS string that matches any operating system

Types

type HTTPClient

type HTTPClient interface {
	Get(url string) (resp *http.Response, err error)
}

HTTPClient is an interface that is used for HTTP requests

type Recipe

type Recipe struct {
	OS       string       `yaml:"os",json:"os"`
	Metadata UnitMetadata `yaml:"metadata",json:"metadata"`
	Stages   []Stage      `yaml:"stages",json:"stages"`
}

Recipe stores needed steps to install a gjven piece of functionality

func FromPath

func FromPath(path string) (*Recipe, error)

FromPath creates a Recipe from given file

func FromRepository

func FromRepository(recipeName string, httpClient HTTPClient) (*Recipe, error)

FromRepository downloads a recipe from official recipes repository

func FromURL

func FromURL(url string, httpClient HTTPClient) (*Recipe, int, error)

FromPath downloads a file from given URL and uses it to create a Recipe

func (*Recipe) Validate

func (r *Recipe) Validate() error

Validate checks if the recipe is valid to run on current OS and whether all stages and steps are not empty

type Stage

type Stage struct {
	Metadata UnitMetadata `yaml:"metadata",json:"metadata"`
	Steps    []Step       `yaml:"steps",json:"steps"`
}

Stage represents a logical part of recipe that consists of steps

type Step

type Step struct {
	Metadata UnitMetadata  `yaml:"metadata",json:"metadata"`
	Execute  shell.Command `yaml:"execute",json:"execute"`
	Rollback shell.Command `yaml:"rollback",json:"rollback"`
}

Step contains data about a single shell command, which can be installed or reverted

type UnitMetadata

type UnitMetadata struct {
	Name        string `yaml:"name",json:"name"`
	Description string `yaml:"description",json:"description"`
	URL         string `yaml:"url",json:"url"`
}

UnitMetadata stores metadata for a generic Recipe unit, such as Recipe, Stage or Step