asset

Documentation

Overview

Package asset defines the asset dependencies and implements the graph engine.

Index

• func GetDataByFilename(a Asset, parents map[Asset]*State, filename string) ([]byte, error)
• type Asset
• type Content
• type State
  • func (s *State) PersistToFile(directory string) error
• type Store
• type StoreImpl
  • func (s *StoreImpl) Fetch(asset Asset) (*State, error)
• type UserProvided
  • func (a *UserProvided) Dependencies() []Asset
  • func (a *UserProvided) Generate(map[Asset]*State) (*State, error)
  • func (a *UserProvided) Name() string

Functions

func GetDataByFilename

func GetDataByFilename(a Asset, parents map[Asset]*State, filename string) ([]byte, error)

GetDataByFilename searches the file in the asset.State.Contents, and returns its data. filename is the base name of the file.

Types

type Asset

type Asset interface {
	// Dependencies returns the assets upon which this asset directly depends.
	Dependencies() []Asset

	// Generate generates this asset given the states of its dependent assets.
	Generate(map[Asset]*State) (*State, error)

	// Name returns the human-friendly name of the asset.
	Name() string
}

Asset used to install OpenShift.

type Content

type Content struct {
	Name string // the path on disk for this content.
	Data []byte
}

Content is a generated portion of an Asset.

type State

type State struct {
	Contents []Content
}

State is the state of an Asset.

func (*State) PersistToFile

func (s *State) PersistToFile(directory string) error

PersistToFile persists the data in the State to files. Each Content entry that has a non-empty Name will be persisted to a file with that name.

type Store

type Store interface {
	// Fetch retrieves the state of the given asset, generating it and its
	// dependencies if necessary.
	Fetch(Asset) (*State, error)
}

Store is a store for the states of assets.

type StoreImpl

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

StoreImpl is the implementation of Store.

func (*StoreImpl) Fetch

func (s *StoreImpl) Fetch(asset Asset) (*State, error)

Fetch retrieves the state of the given asset, generating it and its dependencies if necessary.

type UserProvided

type UserProvided struct {
	AssetName      string
	Question       *survey.Question
	EnvVarName     string
	PathEnvVarName string
}

UserProvided generates an asset that is supplied by a user.

func (*UserProvided) Dependencies

func (a *UserProvided) Dependencies() []Asset

Dependencies returns no dependencies.

func (*UserProvided) Generate

func (a *UserProvided) Generate(map[Asset]*State) (*State, error)

Generate queries for input from the user.

func (*UserProvided) Name

func (a *UserProvided) Name() string

Name returns the human-friendly name of the asset.