Documentation
¶
Index ¶
- type ApplicationParams
- type CharmParams
- type Factory
- func (factory *Factory) MakeApplication(c *gc.C, params *ApplicationParams) *state.Application
- func (factory *Factory) MakeApplicationReturningPassword(c *gc.C, params *ApplicationParams) (*state.Application, string)
- func (factory *Factory) MakeCAASModel(c *gc.C, params *ModelParams) *state.State
- func (factory *Factory) MakeCharm(c *gc.C, params *CharmParams) *state.Charm
- func (factory *Factory) MakeCharmV2(c *gc.C, params *CharmParams) *state.Charm
- func (factory *Factory) MakeMachine(c *gc.C, params *MachineParams) *state.Machine
- func (factory *Factory) MakeMachineNested(c *gc.C, parentId string, params *MachineParams) *state.Machine
- func (factory *Factory) MakeMachineReturningPassword(c *gc.C, params *MachineParams) (*state.Machine, string)
- func (factory *Factory) MakeMetric(c *gc.C, params *MetricParams) *state.MetricBatch
- func (factory *Factory) MakeModel(c *gc.C, params *ModelParams) *state.State
- func (factory *Factory) MakeModelUser(c *gc.C, params *ModelUserParams) permission.UserAccess
- func (factory *Factory) MakeRelation(c *gc.C, params *RelationParams) *state.Relation
- func (factory *Factory) MakeSpace(c *gc.C, params *SpaceParams) *state.Space
- func (factory *Factory) MakeUnit(c *gc.C, params *UnitParams) *state.Unit
- func (factory *Factory) MakeUnitReturningPassword(c *gc.C, params *UnitParams) (*state.Unit, string)
- func (factory *Factory) MakeUnprovisionedMachineReturningPassword(c *gc.C, params *MachineParams) (*state.Machine, string)
- func (factory *Factory) MakeUser(c *gc.C, params *UserParams) *state.User
- func (*Factory) RandomSuffix(prefix string) string
- type MachineParams
- type MetricParams
- type ModelParams
- type ModelUserParams
- type RelationParams
- type SpaceParams
- type UnitParams
- type UserParams
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApplicationParams ¶
type ApplicationParams struct {
Name string
Charm *state.Charm
CharmOrigin *state.CharmOrigin
Status *status.StatusInfo
ApplicationConfig map[string]interface{}
ApplicationConfigFields environschema.Fields
CharmConfig map[string]interface{}
Storage map[string]state.StorageConstraints
Constraints constraints.Value
EndpointBindings map[string]string
Password string
Placement []*instance.Placement
DesiredScale int
}
ApplicationParams is used when specifying parameters for a new application.
type CharmParams ¶
type CharmParams struct {
Name string
Series string
Revision string
Architecture string
URL string
}
CharmParams defines the parameters for creating a charm.
type Factory ¶
type Factory struct {
// contains filtered or unexported fields
}
func (*Factory) MakeApplication ¶
func (factory *Factory) MakeApplication(c *gc.C, params *ApplicationParams) *state.Application
MakeApplication creates an application with the specified parameters, substituting sane defaults for missing values. If params is not specified, defaults are used.
func (*Factory) MakeApplicationReturningPassword ¶
func (factory *Factory) MakeApplicationReturningPassword(c *gc.C, params *ApplicationParams) (*state.Application, string)
MakeApplication creates an application with the specified parameters, substituting sane defaults for missing values. If params is not specified, defaults are used. It returns the application and its password.
func (*Factory) MakeCAASModel ¶
MakeCAASModel creates a CAAS model with specified params, filling in sane defaults for missing values. If params is nil, defaults are used for all values.
func (*Factory) MakeCharm ¶
MakeCharm creates a charm with the values specified in params. Sensible default values are substituted for missing ones. Supported charms depend on the charm/testing package. Currently supported charms:
all-hooks, category, dummy, format2, logging, monitoring, mysql, mysql-alternative, riak, terracotta, upgrade1, upgrade2, varnish, varnish-alternative, wordpress.
If params is not specified, defaults are used.
func (*Factory) MakeCharmV2 ¶
func (*Factory) MakeMachine ¶
MakeMachine will add a machine with values defined in params. For some values in params, if they are missing, some meaningful empty values will be set. If params is not specified, defaults are used.
func (*Factory) MakeMachineNested ¶
func (factory *Factory) MakeMachineNested(c *gc.C, parentId string, params *MachineParams) *state.Machine
MakeMachineNested will make a machine nested in the machine with ID given.
func (*Factory) MakeMachineReturningPassword ¶
func (factory *Factory) MakeMachineReturningPassword(c *gc.C, params *MachineParams) (*state.Machine, string)
MakeMachineReturningPassword will add a machine with values defined in params. For some values in params, if they are missing, some meaningful empty values will be set. If params is not specified, defaults are used. The machine and its password are returned.
func (*Factory) MakeMetric ¶
func (factory *Factory) MakeMetric(c *gc.C, params *MetricParams) *state.MetricBatch
MakeMetric makes a metric with specified params, filling in sane defaults for missing values. If params is not specified, defaults are used.
func (*Factory) MakeModel ¶
MakeModel creates an model with specified params, filling in sane defaults for missing values. If params is nil, defaults are used for all values.
By default the new model shares the same owner as the calling Factory's model. TODO(ericclaudejones) MakeModel should return the model itself rather than the state.
func (*Factory) MakeModelUser ¶
func (factory *Factory) MakeModelUser(c *gc.C, params *ModelUserParams) permission.UserAccess
MakeModelUser will create a modelUser with values defined by the params. For attributes of ModelUserParams that are the default empty values, some meaningful valid values are used instead. If params is not specified, defaults are used.
func (*Factory) MakeRelation ¶
MakeRelation create a relation with specified params, filling in sane defaults for missing values. If params is not specified, defaults are used.
func (*Factory) MakeSpace ¶
MakeSpace will create a new space with the specified params. If the space name is not set, a unique space name is created.
func (*Factory) MakeUnit ¶
MakeUnit creates an application unit with specified params, filling in sane defaults for missing values. If params is not specified, defaults are used.
If the unit is being added to an IAAS model, then it will be assigned to a machine.
func (*Factory) MakeUnitReturningPassword ¶
func (factory *Factory) MakeUnitReturningPassword(c *gc.C, params *UnitParams) (*state.Unit, string)
MakeUnitReturningPassword creates an application unit with specified params, filling in sane defaults for missing values. If params is not specified, defaults are used. The unit and its password are returned.
If the unit is being added to an IAAS model, then it will be assigned to a machine.
func (*Factory) MakeUnprovisionedMachineReturningPassword ¶
func (factory *Factory) MakeUnprovisionedMachineReturningPassword(c *gc.C, params *MachineParams) (*state.Machine, string)
MakeUnprovisionedMachineReturningPassword will add a machine with values defined in params. For some values in params, if they are missing, some meaningful empty values will be set. If params is not specified, defaults are used. The machine and its password are returned; the machine will not be provisioned.
func (*Factory) MakeUser ¶
MakeUser will create a user with values defined by the params. For attributes of UserParams that are the default empty values, some meaningful valid values are used instead. If params is not specified, defaults are used. If params.NoModelUser is false, the user will also be created in the current model.
func (*Factory) RandomSuffix ¶
RandomSuffix adds a random 5 character suffix to the presented string.
type MachineParams ¶
type MachineParams struct {
Series string
Jobs []state.MachineJob
Password string
Nonce string
Constraints constraints.Value
InstanceId instance.Id
DisplayName string
Characteristics *instance.HardwareCharacteristics
Addresses network.SpaceAddresses
Volumes []state.HostVolumeParams
Filesystems []state.HostFilesystemParams
}
Params for creating a machine.
type MetricParams ¶
type ModelParams ¶
type ModelUserParams ¶
type ModelUserParams struct {
User string
DisplayName string
CreatedBy names.Tag
Access permission.Access
}
ModelUserParams defines the parameters for creating an environment user.
type RelationParams ¶
RelationParams are used to create relations.
type SpaceParams ¶
type UnitParams ¶
type UnitParams struct {
Application *state.Application
Machine *state.Machine
Password string
SetCharmURL bool
Status *status.StatusInfo
Constraints constraints.Value
}
UnitParams are used to create units.