manifest

Documentation

Overview

Package manifest represents internal structure of a release.

Index

• type DependencyName
• type Job
• type Manifest
  • func NewManifestFromBytes(bytes []byte) (Manifest, error)
  • func NewManifestFromPath(path string, fs boshsys.FileSystem) (Manifest, error)
• type Package
  • func (p Package) DependencyName() DependencyName
• type Release
• type SyntaxValidator
  • func NewSyntaxValidator(manifest *Manifest) SyntaxValidator
  • func (v SyntaxValidator) Validate() error

Types

type DependencyName

type DependencyName string

type Job

type Job struct {
	Name string `yaml:"name"`

	// bosh_cli uses fingerprint as job version
	VersionRaw string `yaml:"version"`
	Version    string

	FingerprintRaw string `yaml:"fingerprint"`
	Fingerprint    string

	SHA1Raw string `yaml:"sha1"`
	SHA1    string
}

type Manifest

type Manifest struct {
	Release Release
}

func NewManifestFromBytes

func NewManifestFromBytes(bytes []byte) (Manifest, error)

NewManifestFromBytes returns manifest built from given bytes.

func NewManifestFromPath

func NewManifestFromPath(path string, fs boshsys.FileSystem) (Manifest, error)

NewManifestFromPath returns manifest read from the file system.

type Package

type Package struct {
	Name string `yaml:"name"`

	// bosh_cli uses fingerprint as package version
	VersionRaw string `yaml:"version"`
	Version    string

	FingerprintRaw string `yaml:"fingerprint"`
	Fingerprint    string

	SHA1Raw string `yaml:"sha1"`
	SHA1    string

	DependencyNames []DependencyName `yaml:"dependencies"`
}

func (Package) DependencyName

func (p Package) DependencyName() DependencyName

type Release

type Release struct {
	Name    string `yaml:"name"`
	Version string `yaml:"version"`

	Jobs             []Job     `yaml:"jobs"`
	Packages         []Package `yaml:"packages"`
	CompiledPackages []Package `yaml:"compiled_packages"`

	CommitHash         string `yaml:"commit_hash"`
	UncommittedChanges bool   `yaml:"uncommitted_changes"`
}

type SyntaxValidator

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

SyntaxValidator parses and saves all manifest values to determine their syntactic validity. Determining if individual values make sense in a greater context (within a full release) is outside of scope.

func NewSyntaxValidator

func NewSyntaxValidator(manifest *Manifest) SyntaxValidator

func (SyntaxValidator) Validate

func (v SyntaxValidator) Validate() error