director/interfaces.go

package director

import (
	"io"
	"os"
	"time"

	biproperty "github.com/cloudfoundry/bosh-utils/property"
	semver "github.com/cppforlife/go-semi-semantic/version"

	bio "github.com/cloudfoundry/bosh-cli/v7/io"
)

// You only need **one** of these per package!
//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate

//counterfeiter:generate . Director

type Director interface {
	IsAuthenticated() (bool, error)
	WithContext(id string) Director
	Info() (Info, error)

	Locks() ([]Lock, error)

	CurrentTasks(TasksFilter) ([]Task, error)
	RecentTasks(int, TasksFilter) ([]Task, error)
	FindTask(int) (Task, error)
	FindTasksByContextId(string) ([]Task, error)
	CancelTasks(TasksFilter) error

	Events(EventsFilter) ([]Event, error)
	Event(string) (Event, error)

	Deployments() ([]Deployment, error)
	FindDeployment(string) (Deployment, error)
	ListDeployments() ([]DeploymentResp, error)
	ListDeploymentConfigs(name string) (DeploymentConfigs, error)

	Releases() ([]Release, error)
	HasRelease(name, version string, stemcell OSVersionSlug) (bool, error)
	ReleaseHasCompiledPackage(releaseSlug ReleaseSlug, osVersionSlug OSVersionSlug) (bool, error)
	FindRelease(ReleaseSlug) (Release, error)
	FindReleaseSeries(ReleaseSeriesSlug) (ReleaseSeries, error)
	UploadReleaseURL(url, sha1 string, rebase, fix bool) error
	UploadReleaseFile(file UploadFile, rebase, fix bool) error
	MatchPackages(manifest interface{}, compiled bool) ([]string, error)

	Stemcells() ([]Stemcell, error)
	StemcellNeedsUpload(StemcellInfo) (bool, error)
	FindStemcell(StemcellSlug) (Stemcell, error)
	UploadStemcellURL(url, sha1 string, fix bool) error
	UploadStemcellFile(file UploadFile, fix bool) error

	LatestConfig(configType string, name string) (Config, error)
	LatestConfigByID(configID string) (Config, error)
	ListConfigs(limit int, filter ConfigsFilter) ([]Config, error)
	UpdateConfig(configType string, name string, expectedLatestId string, content []byte) (Config, error)
	DeleteConfig(configType string, name string) (bool, error)
	DeleteConfigByID(configID string) (bool, error)
	DiffConfig(configType string, name string, manifest []byte) (ConfigDiff, error)
	DiffConfigByIDOrContent(fromID string, fromContent []byte, toID string, toContent []byte) (ConfigDiff, error)

	LatestCloudConfig(name string) (CloudConfig, error)
	UpdateCloudConfig(name string, manifest []byte) error
	DiffCloudConfig(name string, manifest []byte) (ConfigDiff, error)

	LatestCPIConfig() (CPIConfig, error)
	UpdateCPIConfig([]byte) error
	DiffCPIConfig(manifest []byte, noRedact bool) (ConfigDiff, error)

	LatestRuntimeConfig(name string) (RuntimeConfig, error)
	UpdateRuntimeConfig(name string, manifest []byte) error
	DiffRuntimeConfig(name string, manifest []byte, noRedact bool) (ConfigDiff, error)

	FindOrphanDisk(string) (OrphanDisk, error)
	OrphanDisks() ([]OrphanDisk, error)
	OrphanDisk(string) error

	FindOrphanNetwork(string) (OrphanNetwork, error)
	OrphanNetworks() ([]OrphanNetwork, error)

	EnableResurrection(bool) error
	CleanUp(all bool, dryRun bool, keepOrphanedDisks bool) (CleanUp, error)
	DownloadResourceUnchecked(blobstoreID string, out io.Writer) error

	OrphanedVMs() ([]OrphanedVM, error)

	CertificateExpiry() ([]CertificateExpiryInfo, error)
}

var _ Director = &DirectorImpl{}

type UploadFile interface {
	io.ReadCloser
	Stat() (os.FileInfo, error)
}

type ReleaseMetadata struct {
	Name    string `yaml:"name"`
	Version string `yaml:"version"`
	// other fields ignored
}

//counterfeiter:generate . ReleaseArchive

type ReleaseArchive interface {
	Info() (ReleaseMetadata, error)
	File() (UploadFile, error)
}

type StemcellMetadata struct {
	Name            string         `yaml:"name"`
	OS              string         `yaml:"operating_system"`
	Version         string         `yaml:"version"`
	CloudProperties biproperty.Map `yaml:"cloud_properties"`
	// other fields ignored
}

//counterfeiter:generate . StemcellArchive

type StemcellArchive interface {
	Info() (StemcellMetadata, error)
	File() (UploadFile, error)
}

//counterfeiter:generate . FileReporter

type FileReporter interface {
	TrackUpload(int64, io.ReadCloser) bio.ReadSeekCloser
	TrackDownload(int64, io.Writer) io.Writer
}

//counterfeiter:generate . Deployment

type Deployment interface {
	Name() string
	Manifest() (string, error)
	CloudConfig() (string, error)
	Diff([]byte, bool) (DeploymentDiff, error)

	Releases() ([]Release, error)
	ExportRelease(ReleaseSlug, OSVersionSlug, []string) (ExportReleaseResult, error)

	Teams() ([]string, error)

	Stemcells() ([]Stemcell, error)
	VMInfos() ([]VMInfo, error)
	Instances() ([]Instance, error)
	InstanceInfos() ([]VMInfo, error)

	Errands() ([]Errand, error)
	RunErrand(string, bool, bool, []InstanceGroupOrInstanceSlug) ([]ErrandResult, error)

	ScanForProblems() ([]Problem, error)
	ResolveProblems([]ProblemAnswer, map[string]string) error

	Snapshots() ([]Snapshot, error)
	TakeSnapshots() error
	DeleteSnapshot(string) error
	DeleteSnapshots() error
	DeleteVM(string) error

	Variables() ([]VariableResult, error)

	// Deployment, pool or instance specifics
	Start(slug AllOrInstanceGroupOrInstanceSlug, opts StartOpts) error
	Stop(slug AllOrInstanceGroupOrInstanceSlug, opts StopOpts) error
	Restart(slug AllOrInstanceGroupOrInstanceSlug, opts RestartOpts) error
	Recreate(slug AllOrInstanceGroupOrInstanceSlug, opts RecreateOpts) error

	SetUpSSH(AllOrInstanceGroupOrInstanceSlug, SSHOpts) (SSHResult, error)
	CleanUpSSH(AllOrInstanceGroupOrInstanceSlug, SSHOpts) error

	// Instance specifics
	FetchLogs(AllOrInstanceGroupOrInstanceSlug, []string, string) (LogsResult, error)
	TakeSnapshot(InstanceSlug) error
	Ignore(InstanceSlug, bool) error
	EnableResurrection(InstanceSlug, bool) error

	Update(manifest []byte, opts UpdateOpts) error
	Delete(force bool) error

	AttachDisk(slug InstanceSlug, diskCID string, diskProperties string) error
}

type StartOpts struct {
	Canaries    string
	MaxInFlight string
	Converge    bool
}

type StopOpts struct {
	Canaries    string
	MaxInFlight string
	Force       bool
	SkipDrain   bool
	Hard        bool
	Converge    bool
}

type RestartOpts struct {
	Canaries    string
	MaxInFlight string
	Force       bool
	SkipDrain   bool
	Converge    bool
}

type RecreateOpts struct {
	Canaries    string
	MaxInFlight string
	Force       bool
	Fix         bool
	SkipDrain   bool
	DryRun      bool
	Converge    bool
}

type UpdateOpts struct {
	Recreate                bool
	RecreatePersistentDisks bool
	Fix                     bool
	SkipDrain               SkipDrains
	Canaries                string
	MaxInFlight             string
	DryRun                  bool
	Diff                    DeploymentDiff
	ForceLatestVariables    bool
}

//counterfeiter:generate . ReleaseSeries

type ReleaseSeries interface {
	Name() string
	Delete(force bool) error
	Exists() (bool, error)
}

//counterfeiter:generate . Release

type Release interface {
	Name() string
	Version() semver.Version
	Exists() (bool, error)
	VersionMark(mark string) string
	CommitHashWithMark(mark string) string

	Jobs() ([]Job, error)
	Packages() ([]Package, error)

	Delete(force bool) error
}

//counterfeiter:generate . Stemcell

type Stemcell interface {
	Name() string
	Version() semver.Version
	VersionMark(mark string) string

	OSName() string

	CPI() string
	CID() string

	Delete(force bool) error
}

type TasksFilter struct {
	All        bool
	Deployment string
	Types      []string
	States     []string
}

type Task interface {
	ID() int
	StartedAt() time.Time
	FinishedAt() time.Time

	State() string
	IsError() bool
	User() string
	DeploymentName() string
	ContextID() string

	Description() string
	Result() string

	EventOutput(TaskReporter) error
	CPIOutput(TaskReporter) error
	DebugOutput(TaskReporter) error
	ResultOutput(TaskReporter) error

	Cancel() error
}

//counterfeiter:generate . TaskReporter

type TaskReporter interface {
	TaskStarted(int)
	TaskFinished(int, string)
	TaskOutputChunk(int, []byte)
}

//counterfeiter:generate . OrphanDisk

type OrphanDisk interface {
	CID() string
	Size() uint64

	Deployment() Deployment
	InstanceName() string
	AZName() string

	OrphanedAt() time.Time

	Delete() error
}

//counterfeiter:generate . OrphanNetwork

type OrphanNetwork interface {
	Name() string
	Type() string
	OrphanedAt() time.Time
	CreatedAt() time.Time
	Delete() error
}

type OrphanedVM struct {
	CID            string
	DeploymentName string
	InstanceName   string
	AZName         string
	IPAddresses    []string
	OrphanedAt     time.Time
}

type EventsFilter struct {
	BeforeID   string
	Before     string
	After      string
	Deployment string
	Task       string
	Instance   string
	User       string
	Action     string
	ObjectType string
	ObjectName string
}

//counterfeiter:generate . Event

type Event interface {
	ID() string
	ParentID() string
	Timestamp() time.Time
	User() string
	Action() string
	ObjectType() string
	ObjectName() string
	TaskID() string
	DeploymentName() string
	Instance() string
	Context() map[string]interface{}
	Error() string
}

type CertificateExpiryInfo struct {
	Path     string `json:"certificate_path"`
	Expiry   string `json:"expiry"`
	DaysLeft int    `json:"days_left"`
}

type CleanUp struct {
	Releases         []CleanableRelease
	Stemcells        []Stemcell
	CompiledPackages []CleanableCompiledPackage
	OrphanedDisks    []OrphanDiskResp
	OrphanedVMs      []OrphanedVM
	ExportedReleases []string
	DNSBlobs         []string
}

type CleanableRelease struct {
	Name     string   `json:"name"`
	Versions []string `json:"versions"`
}

type CleanableCompiledPackage struct {
	Name            string `json:"package_name"`
	StemcellOs      string `json:"stemcell_os"`
	StemcellVersion string `json:"stemcell_version"`
}