asset

Documentation

Overview

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

Index

• func GenerateUserProvidedAsset(inputName string, question *survey.Question, envVarName string) (string, error)
• func GenerateUserProvidedAssetForPath(inputName string, question *survey.Question, envVarName, pathEnvVarName string) (string, error)
• func PersistToFile(asset WritableAsset, directory string) error
• type Asset
• type Content
• type File
• type FileFetcher
• type Parents
  • func (p Parents) Add(assets ...Asset)
  • func (p Parents) Get(assets ...Asset)
• type State
  • func (s *State) PersistToFile(directory string) error
• type Store
  • func NewStore(dir string) (Store, error)
• type StoreImpl
  • func (s *StoreImpl) Fetch(asset Asset) error
  • func (s *StoreImpl) IsAssetInState(asset Asset) bool
  • func (s *StoreImpl) LoadAssetFromState(asset Asset) error
  • func (s *StoreImpl) Purge(excluded []WritableAsset) error
  • func (s *StoreImpl) Save(dir string) error
• type WritableAsset

Functions

func GenerateUserProvidedAsset

func GenerateUserProvidedAsset(inputName string, question *survey.Question, envVarName string) (string, error)

GenerateUserProvidedAsset queries for input from the user.

func GenerateUserProvidedAssetForPath

func GenerateUserProvidedAssetForPath(inputName string, question *survey.Question, envVarName, pathEnvVarName string) (string, error)

GenerateUserProvidedAssetForPath queries for input from the user. The input can be read from a file specified in an environment variable.

func PersistToFile

func PersistToFile(asset WritableAsset, directory string) error

PersistToFile writes all of the files of the specified asset into the specified directory.

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 parent assets.
	Generate(Parents) 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 File

type File struct {
	// Filename is the name of the file.
	Filename string
	// Data is the contents of the file.
	Data []byte
}

File is a file for an Asset.

type FileFetcher

type FileFetcher interface {
	// FetchByName returns the file with the given name.
	FetchByName(string) (*File, error)
	// FetchByPattern returns the files whose name match the given glob.
	FetchByPattern(pattern string) ([]*File, error)
}

FileFetcher fetches the asset files from disk.

type Parents

type Parents map[reflect.Type]Asset

Parents is the collection of assets upon which another asset is directly dependent.

func (Parents) Add

func (p Parents) Add(assets ...Asset)

Add adds the specified assets to the parents collection.

func (Parents) Get

func (p Parents) Get(assets ...Asset)

Get populates the state of the specified assets with the state stored in the parents collection.

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) error

	// Save dumps the entire state map into a file
	Save(dir string) error

	// Purge deletes the on-disk assets that are consumed already.
	// E.g., install-config.yml will be deleted after fetching 'manifests'.
	Purge(excluded []WritableAsset) error
}

Store is a store for the states of assets.

func NewStore

func NewStore(dir string) (Store, error)

NewStore returns an asset store that implements the Store interface.

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) error

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

func (*StoreImpl) IsAssetInState

func (s *StoreImpl) IsAssetInState(asset Asset) bool

IsAssetInState tests whether the asset is in the state file.

func (*StoreImpl) LoadAssetFromState

func (s *StoreImpl) LoadAssetFromState(asset Asset) error

LoadAssetFromState renders the asset object arguments from the state file contents.

func (*StoreImpl) Purge

func (s *StoreImpl) Purge(excluded []WritableAsset) error

Purge deletes the on-disk assets that are consumed already. E.g., install-config.yml will be deleted after fetching 'manifests'. The target assets are excluded.

func (*StoreImpl) Save

func (s *StoreImpl) Save(dir string) error

Save dumps the entire state map into a file

type WritableAsset

type WritableAsset interface {
	Asset

	// Files returns the files to write.
	Files() []*File

	// Load returns the on-disk asset if it exists.
	// The asset object should be changed only when it's loaded successfully.
	Load(FileFetcher) (found bool, err error)
}

WritableAsset is an Asset that has files that can be written to disk. It can also be loaded from disk.