recipe

Documentation

Index

• Constants
• Variables
• func PushRecipe(ctx context.Context, path string, opts oci.Repository) error
• func SaveRemoteRecipe(ctx context.Context, dest string, opts oci.Repository) error
• type File
  • func NewFile(content []byte) File
  • func (f File) HasBeenModified() bool
• type Metadata
  • func (m *Metadata) Validate() error
• type Recipe
  • func LoadRecipe(path string) (*Recipe, error)
  • func NewRecipe() *Recipe
  • func PullRecipe(ctx context.Context, repo oci.Repository) (*Recipe, error)
  • func (re *Recipe) Execute(engine RenderEngine, values VariableValues, id uuid.UUID) (*Sauce, error)
  • func (re *Recipe) RunTests() []error
  • func (re *Recipe) Save(dest string) error
  • func (re *Recipe) Validate() error
• type RecipeConflict
• type RenderEngine
• type Sauce
  • func LoadSauce(projectDir, recipeName string) (*Sauce, error)
  • func LoadSauces(projectDir string) ([]*Sauce, error)
  • func NewSauce() *Sauce
  • func (s *Sauce) Conflicts(other *Sauce) []RecipeConflict
  • func (s *Sauce) Save(dest string) error
  • func (s *Sauce) Validate() error
• type Test
  • func (t *Test) Validate() error
• type Variable
  • func (v *Variable) Validate() error
• type VariableValidator
  • func (r *VariableValidator) CreateValidatorFunc() func(input string) error
• type VariableValues

Constants

const (
	YAMLExtension          = ".yml"
	RecipeFileName         = "recipe"
	RecipeTemplatesDirName = "templates"
	RecipeTestsDirName     = "tests"
	RecipeTestMetaFileName = "test"
	RecipeTestFilesDirName = "files"
	IgnoreFileName         = ".jalapenoignore"
)

const (
	SaucesFileName = "sauces"

	// The directory name which contains all Jalapeno related files
	// in the project directory
	SauceDirName = ".jalapeno"
)

const (
	HashPrefix = "sha256:"
)

Variables

var (
	ErrNoTestsSpecified    error = errors.New("no tests specified")
	ErrTestWrongFileAmount       = errors.New("recipe rendered different amount of files than expected")
	ErrTestMissingFile           = errors.New("recipe did not render file which was expected")
	ErrTestContentMismatch       = errors.New("the contents of the files did not match")
)

var (
	ErrSauceNotFound = errors.New("sauce not found")
)

var (
	ErrorUnauthorized = errors.New("unauthorized")
)

var TestID uuid.UUID = uuid.Must(uuid.FromString("12345678-1234-5678-1234-567812345678"))

Random hardcoded UUID

Functions

func PushRecipe

func PushRecipe(ctx context.Context, path string, opts oci.Repository) error

func SaveRemoteRecipe

func SaveRemoteRecipe(ctx context.Context, dest string, opts oci.Repository) error

SaveRemoteRecipe pulls a recipe from repository and saves it to dest directory

Types

type File

type File struct {
	Checksum string `yaml:"checksum"` // e.g. "sha256:xxxxxxxxx" w. default algo
	Content  []byte `yaml:"-"`
}

func NewFile

func NewFile(content []byte) File

func (File) HasBeenModified

func (f File) HasBeenModified() bool

type Metadata

type Metadata struct {
	// Version of the recipe metadata API schema. Currently should have value "v1"
	APIVersion string `yaml:"apiVersion"`

	// Name of the recipe
	Name string `yaml:"name"`

	// Version of the recipe. Must be valid [semver](https://semver.org/)
	Version string `yaml:"version"`

	// Description of what the recipe does
	Description string `yaml:"description"`

	// A list of URLs to source code for this recipe
	Sources []string `yaml:"sources,omitempty"`

	// A message which will be showed to an user after a succesful recipe execution.
	// Can be used to guide the user what should be done next in the project directory.
	InitHelp string `yaml:"initHelp,omitempty"`

	// Glob patterns for ignoring generated files from future recipe upgrades. Ignored
	// files will not be regenerated even if their templates change in future versions
	// of the recipe.
	IgnorePatterns []string `yaml:"ignorePatterns,omitempty"`

	// File extension of files in "templates" directory which should be templated.
	// Files not matched by this extension will be copied as-is.
	// If left empty (the default), all files will be templated.
	TemplateExtension string `yaml:"templateExtension,omitempty"`
}

func (*Metadata) Validate

func (m *Metadata) Validate() error

type Recipe

type Recipe struct {
	Metadata  `yaml:",inline"`
	Variables []Variable      `yaml:"vars,omitempty"`
	Templates map[string]File `yaml:"-"`
	Tests     []Test          `yaml:"-"`
}

func LoadRecipe

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

LoadRecipe reads a recipe from a given path

func NewRecipe

func NewRecipe() *Recipe

func PullRecipe

func PullRecipe(ctx context.Context, repo oci.Repository) (*Recipe, error)

func (*Recipe) Execute

func (re *Recipe) Execute(engine RenderEngine, values VariableValues, id uuid.UUID) (*Sauce, error)

Execute executes the recipe and returns a sauce

func (*Recipe) RunTests

func (re *Recipe) RunTests() []error

func (*Recipe) Save

func (re *Recipe) Save(dest string) error

Save saves recipe to given destination

func (*Recipe) Validate

func (re *Recipe) Validate() error

type RecipeConflict

type RecipeConflict struct {
	Path           string
	Sha256Sum      string
	OtherSha256Sum string
}

type RenderEngine

type RenderEngine interface {
	Render(templates map[string][]byte, values map[string]interface{}) (map[string][]byte, error)
}

type Sauce

type Sauce struct {
	Recipe Recipe          `yaml:",inline"`
	Values VariableValues  `yaml:"values,omitempty"`
	Files  map[string]File `yaml:"files"`

	// Random unique ID whose value is determined on first render and stays the same
	// on subsequent re-renders (upgrades) of the sauce. Can be used for example as a seed
	// for template random functions to provide same result on each template
	ID uuid.UUID `yaml:"id"`

	// CheckFrom defines the repository where updates should be checked for the recipe
	CheckFrom string `yaml:"from,omitempty"`
}

Sauce represents a rendered recipe

func LoadSauce

func LoadSauce(projectDir, recipeName string) (*Sauce, error)

func LoadSauces

func LoadSauces(projectDir string) ([]*Sauce, error)

Load all sauces from a project directory. Returns empty slice if the project directory did not contain any sayces

func NewSauce

func NewSauce() *Sauce

func (*Sauce) Conflicts

func (s *Sauce) Conflicts(other *Sauce) []RecipeConflict

Check if the recipe conflicts with another recipe. Recipes conflict if they touch the same files.

func (*Sauce) Save

func (s *Sauce) Save(dest string) error

Save saves sauce to given destination

func (*Sauce) Validate

func (s *Sauce) Validate() error

type Test

type Test struct {
	// Name of the test case. Defined by directory name of the test case
	Name string `yaml:"-"`

	// Values to use to render the recipe templates
	Values VariableValues `yaml:"values"`

	// Snapshots of the rendered templates which were rendered with the values specified in the test
	Files map[string]File `yaml:"-"`

	// If true, test will not fail if the templates generates more files than the test specifies
	IgnoreExtraFiles bool `yaml:"ignoreExtraFiles"`
}

func (*Test) Validate

func (t *Test) Validate() error

type Variable

type Variable struct {
	// The name of the variable. It is also used as unique identifier.
	Name        string `yaml:"name"`
	Description string `yaml:"description,omitempty"`

	// Default value of the variable
	Default string `yaml:"default,omitempty"`

	// If set to true, the prompt will be yes/no question, and the value type will be boolean
	Confirm bool `yaml:"confirm,omitempty"`

	// If set to true, the variable can be left empty
	Optional bool `yaml:"optional,omitempty"`

	// The user selects the value from a list of options
	Options []string `yaml:"options,omitempty"`

	// Validators for the variable
	Validators []VariableValidator `yaml:"validators,omitempty"`

	// Makes the variable conditional based on the result of the expression. The result of the evaluation needs to be a boolean value. Uses https://github.com/antonmedv/expr
	If string `yaml:"if,omitempty"`

	// Set the variable as a table type with columns defined by this property
	Columns []string `yaml:"columns,omitempty"`
}

func (*Variable) Validate

func (v *Variable) Validate() error

type VariableValidator

type VariableValidator struct {
	// Regular expression pattern to match the input against
	Pattern string `yaml:"pattern,omitempty"`

	// If the regular expression validation fails, this help message will be shown to the user
	Help string `yaml:"help,omitempty"`

	// Apply the validator to a column if the variable type is table
	Column string `yaml:"column,omitempty"`
}

func (*VariableValidator) CreateValidatorFunc

func (r *VariableValidator) CreateValidatorFunc() func(input string) error

type VariableValues

type VariableValues map[string]interface{}

VariableValues stores values for each variable