application

type ApplicationAPI interface {
	AddMachines(machineParams []apiparams.AddMachineParams) ([]apiparams.AddMachinesResult, error)
	AddRelation(endpoints, viaCIDRs []string) (*apiparams.AddRelationResults, error)
	AddUnits(application.AddUnitsParams) ([]string, error)
	Expose(application string) error
	GetAnnotations(tags []string) ([]apiparams.AnnotationsGetResult, error)
	GetConfig(generation model.GenerationVersion, appNames ...string) ([]map[string]interface{}, error)
	GetConstraints(appNames ...string) ([]constraints.Value, error)
	SetAnnotation(annotations map[string]map[string]string) ([]apiparams.ErrorResult, error)
	SetCharm(model.GenerationVersion, application.SetCharmConfig) error
	SetConstraints(application string, constraints constraints.Value) error
	Update(apiparams.ApplicationUpdate) error
	ScaleApplication(application.ScaleApplicationParams) (apiparams.ScaleApplicationResult, error)
}

type ApplicationDestroyRelationAPI interface {
	Close() error
	BestAPIVersion() int
	DestroyRelation(endpoints ...string) error
	DestroyRelationId(relationId int) error
}

type ApplicationInfo struct {
	Charm            string            `yaml:"charm,omitempty" json:"charm,omitempty"`
	Series           string            `yaml:"series,omitempty" json:"series,omitempty"`
	Channel          string            `yaml:"channel,omitempty" json:"channel,omitempty"`
	Constraints      constraints.Value `yaml:"constraints,omitempty" json:"constraints,omitempty"`
	Principal        bool              `yaml:"principal" json:"principal"`
	Exposed          bool              `yaml:"exposed" json:"exposed"`
	Remote           bool              `yaml:"remote" json:"remote"`
	EndpointBindings map[string]string `yaml:"endpoint-bindings,omitempty" json:"endpoint-bindings,omitempty"`
}

type ApplicationsInfoAPI interface {
	Close() error
	BestAPIVersion() int
	ApplicationsInfo([]names.ApplicationTag) ([]params.ApplicationInfoResult, error)
}

type BundleResolver interface {
	URLResolver
	GetBundle(*charm.URL) (charm.Bundle, error)
}

type CharmAPIClient interface {
	CharmUpgradeClient
}

type CharmAdder interface {
	AddLocalCharm(*charm.URL, charm.Charm, bool) (*charm.URL, error)
	AddCharm(*charm.URL, params.Channel, bool) error
	AddCharmWithAuthorization(*charm.URL, params.Channel, *macaroon.Macaroon, bool) error
	AuthorizeCharmstoreEntity(*charm.URL) (*macaroon.Macaroon, error)
}

type CharmClient interface {
	CharmInfo(string) (*charms.CharmInfo, error)
}

type CharmDeployAPI interface {
	CharmInfo(string) (*apicharms.CharmInfo, error)
}

type CharmUpgradeClient interface {
	GetCharmURL(model.GenerationVersion, string) (*charm.URL, error)
	Get(model.GenerationVersion, string) (*params.ApplicationGetResults, error)
	SetCharm(model.GenerationVersion, application.SetCharmConfig) error
}

type DeployAPI interface {
	// TODO(katco): Pair DeployAPI down to only the methods required
	// by the deploy command.
	api.Connection
	CharmAdder
	MeteredDeployAPI
	CharmDeployAPI
	ApplicationAPI
	ModelAPI

	// ApplicationClient
	Deploy(application.DeployArgs) error
	Status(patterns []string) (*apiparams.FullStatus, error)

	ResolveWithChannel(*charm.URL) (*charm.URL, params.Channel, []string, error)

	GetBundle(*charm.URL) (charm.Bundle, error)

	WatchAll() (*api.AllWatcher, error)

	// PlanURL returns the configured URL prefix for the metering plan API.
	PlanURL() string
}

type DeployCommand struct {
	modelcmd.ModelCommandBase
	UnitCommandBase

	// CharmOrBundle is either a charm URL, a path where a charm can be found,
	// or a bundle name.
	CharmOrBundle string

	// BundleOverlay refers to config files that specify additional bundle
	// configuration to be merged with the main bundle.
	BundleOverlayFile []string

	// Channel holds the charmstore channel to use when obtaining
	// the charm to be deployed.
	Channel params.Channel

	// Series is the series of the charm to deploy.
	Series string

	// Force is used to allow a charm to be deployed onto a machine
	// running an unsupported series.
	Force bool

	// DryRun is used to specify that the bundle shouldn't actually be
	// deployed but just output the changes.
	DryRun bool

	ApplicationName string
	ConfigOptions   common.ConfigFlag
	ConstraintsStr  string
	Constraints     constraints.Value
	BindToSpaces    string

	// TODO(axw) move this to UnitCommandBase once we support --storage
	// on add-unit too.
	//
	// Storage is a map of storage constraints, keyed on the storage name
	// defined in charm storage metadata.
	Storage map[string]storage.Constraints

	// BundleStorage maps application names to maps of storage constraints keyed on
	// the storage name defined in that application's charm storage metadata.
	BundleStorage map[string]map[string]storage.Constraints

	// Devices is a mapping of device constraints, keyed on the device name
	// defined in charm devices metadata.
	Devices map[string]devices.Constraints

	// BundleDevices maps application names to maps of device constraints keyed on
	// the device name defined in that application's charm devices metadata.
	BundleDevices map[string]map[string]devices.Constraints

	// Resources is a map of resource name to filename to be uploaded on deploy.
	Resources map[string]string

	Bindings map[string]string
	Steps    []DeployStep

	// UseExisting machines when deploying the bundle.
	UseExisting bool
	// BundleMachines is a mapping for machines in the bundle to machines
	// in the model.
	BundleMachines map[string]string

	// NewAPIRoot stores a function which returns a new API root.
	NewAPIRoot func() (DeployAPI, error)

	// Trust signifies that the charm should be deployed with access to
	// trusted credentials. That is, hooks run by the charm can access
	// cloud credentials and other trusted access credentials.
	Trust bool
	// contains filtered or unexported fields
}

type DeployStep interface {
	// SetFlags sets flags necessary for the deploy step.
	SetFlags(*gnuflag.FlagSet)

	// SetPlanURL sets the plan URL prefix.
	SetPlanURL(planURL string)

	// RunPre runs before the call is made to add the charm to the environment.
	RunPre(DeployStepAPI, *httpbakery.Client, *cmd.Context, DeploymentInfo) error

	// RunPost runs after the call is made to add the charm to the environment.
	// The error parameter is used to notify the step of a previously occurred error.
	RunPost(DeployStepAPI, *httpbakery.Client, *cmd.Context, DeploymentInfo, error) error
}

type DeployStepAPI interface {
	MeteredDeployAPI
}

type DeploymentInfo struct {
	CharmID         charmstore.CharmID
	ApplicationName string
	ModelUUID       string
	CharmInfo       *apicharms.CharmInfo
	ApplicationPlan string
	Force           bool
}

type MeteredDeployAPI interface {
	IsMetered(charmURL string) (bool, error)
	SetMetricCredentials(application string, credentials []byte) error
}

type ModelAPI interface {
	ModelUUID() (string, bool)
	ModelGet() (map[string]interface{}, error)
	Sequences() (map[string]int, error)
}

type ModelConfigGetter interface {
	ModelGet() (map[string]interface{}, error)
}

type ModelExtractor interface {
	GetAnnotations(tags []string) ([]params.AnnotationsGetResult, error)
	GetConstraints(applications ...string) ([]constraints.Value, error)
	GetConfig(generation model.GenerationVersion, applications ...string) ([]map[string]interface{}, error)
	Sequences() (map[string]int, error)
}

type NewCharmAdderFunc func(
	api.Connection,
	*httpbakery.Client,
	string,
	csclientparams.Channel,
) CharmAdder

type RegisterMeteredCharm struct {
	Plan           string
	IncreaseBudget int
	RegisterPath   string
	QueryPath      string
	PlanURL        string
	// contains filtered or unexported fields
}

type RemoveSaasAPI interface {
	Close() error
	BestAPIVersion() int
	DestroyConsumedApplication(...string) ([]params.ErrorResult, error)
}

type ResolveCharmFunc func(
	resolveWithChannel func(*charm.URL) (*charm.URL, csparams.Channel, []string, error),
	url *charm.URL,
) (*charm.URL, csparams.Channel, []string, error)

type ResourceLister interface {
	ListResources([]string) ([]resource.ApplicationResources, error)
}

type SeriesConfig interface {
	// DefaultSeries returns the configured default Ubuntu series for the environment,
	// and whether the default series was explicitly configured on the environment.
	DefaultSeries() (string, bool)
}

type SetRelationSuspendedAPI interface {
	Close() error
	BestAPIVersion() int
	SetRelationSuspended(relationIds []int, suspended bool, message string) error
}

type URLResolver interface {
	ResolveWithChannel(*charm.URL) (*charm.URL, params.Channel, []string, error)
}

type UnitCommandBase struct {
	// PlacementSpec is the raw string command arg value used to specify placement directives.
	PlacementSpec string
	// Placement is the result of parsing the PlacementSpec arg value.
	Placement []*instance.Placement
	NumUnits  int
	// AttachStorage is a list of storage IDs, identifying storage to
	// attach to the unit created by deploy.
	AttachStorage []string
}

type ValidateLXDProfileCharm struct{}