def __init__(self):
super(PlansManager, self).__init__()
self.plan_store = DeploymentPlanStore()
self.seed_store = MasterSeedStore()
self.registry_store = ResourceRegistryStore()
self.template_store = TemplateStore()
self.master_template_store = MasterTemplateStore()
self.environment_store = EnvironmentFileStore()
def setUp(self):
super(PlansManagerTestCase, self).setUp()
self.plans_manager = PlansManager()
self.plan_store = DeploymentPlanStore()
self.template_store = TemplateStore()
self.seed_store = MasterSeedStore()
self.registry_store = ResourceRegistryStore()
def setUp(self):
super(PlansManagerTestCase, self).setUp()
self.plans_manager = PlansManager()
self.plan_store = DeploymentPlanStore()
self.template_store = TemplateStore()
self.seed_store = MasterSeedStore()
self.registry_store = ResourceRegistryStore()
self.registry_mapping_store = ResourceRegistryMappingStore()
def __init__(self):
super(PlansManager, self).__init__()
self.plan_store = DeploymentPlanStore()
self.seed_store = MasterSeedStore()
self.registry_store = ResourceRegistryStore()
self.registry_mapping_store = ResourceRegistryMappingStore()
self.template_store = TemplateStore()
self.template_extra_store = TemplateExtraStore()
self.master_template_store = MasterTemplateStore()
self.environment_store = EnvironmentFileStore()
class PlansManager(object):
def __init__(self):
super(PlansManager, self).__init__()
self.plan_store = DeploymentPlanStore()
self.seed_store = MasterSeedStore()
self.registry_store = ResourceRegistryStore()
self.registry_mapping_store = ResourceRegistryMappingStore()
self.template_store = TemplateStore()
self.template_extra_store = TemplateExtraStore()
self.master_template_store = MasterTemplateStore()
self.environment_store = EnvironmentFileStore()
def create_plan(self, name, description):
"""Creates a new plan, persisting it to Tuskar's storage backend.
:type name: str
:type description: str
:return: domain model instance of the created plan
:rtype: tuskar.manager.models.DeploymentPlan
:raises tuskar.storage.exceptions.NameAlreadyUsed: if there is a plan
with the given name
"""
# Create the plan using the template generation code first to
# stub out the master template and environment files correctly.
new_plan = plan.DeploymentPlan(description=description)
# Save the newly created master template and environment to the
# storage layer so they can be associated with the plan.
master_template_contents = composer.compose_template(
new_plan.master_template
)
master_template_file = self.master_template_store.create(
name_utils.master_template_filename(name),
master_template_contents,
)
environment_contents = composer.compose_environment(
new_plan.environment
)
environment_file = self.environment_store.create(
environment_contents
)
# Create the plan in storage, seeding it with the stored files for
# the template and environment.
db_plan = self.plan_store.create(
name,
master_template_uuid=master_template_file.uuid,
environment_uuid=environment_file.uuid,
)
# Return the created plan.
created_plan = self.retrieve_plan(db_plan.uuid)
return created_plan
def delete_plan(self, plan_uuid):
"""Deletes an existing plan.
:type plan_uuid: str
:raises tuskar.storage.exceptions.UnknownUUID: if there is no plan
with the given UUID
"""
self.plan_store.delete(plan_uuid)
def add_role_to_plan(self, plan_uuid, role_uuid):
"""Adds a role to the given plan, storing the changes in Tuskar's
storage.
:type plan_uuid: str
:type role_uuid: str
:return: updated plan model instance
:rtype: tuskar.manager.models.DeploymentPlan
:raises tuskar.storage.exceptions.UnknownUUID: if either the plan
or the role cannot be found
"""
# Load the plan and role from storage
db_plan = self.plan_store.retrieve(plan_uuid)
db_role = self.template_store.retrieve(role_uuid)
# Parse the plan and role template into template objects.
deployment_plan = self._plan_to_template_object(db_plan)
role_template = self._role_to_template_object(db_role)
# See if a master seed template has been set.
try:
db_master_seed = self.seed_store.retrieve_by_name(MASTER_SEED_NAME)
master_seed = parser.parse_template(db_master_seed.contents)
except UnknownName:
master_seed = None
special_properties = None
def _find_role_type(registry):
for path in registry.keys():
if path in db_role.registry_path:
return registry[path]
if master_seed is not None:
try:
db_registry_env = self.registry_store.retrieve_by_name(
RESOURCE_REGISTRY_NAME).contents
except UnknownName:
LOG.error("Could not load resource_registry. Make sure you "
"pass --resource-registry to tuskar-load-roles.")
raise
parsed_registry_env = parser.parse_environment(db_registry_env)
registry = dict((e.filename, e.alias)
for e in parsed_registry_env.registry_entries)
role_type = _find_role_type(registry)
special_properties = template_seed.get_property_map_for_role(
master_seed, role_type)
# Use the combination logic to perform the addition.
role_namespace = name_utils.generate_role_namespace(db_role.name,
db_role.version)
template_filename = (
name_utils.role_template_filename(db_role.name, db_role.version,
db_role.relative_path))
deployment_plan.add_template(role_namespace, role_template,
template_filename,
override_properties=special_properties)
# If there is a master seed, add its top-level elements to the plan.
# These calls are idempotent, so it's safe to call each time a role
# is added.
if master_seed is not None:
template_seed.add_top_level_parameters(
master_seed,
deployment_plan.master_template,
deployment_plan.environment)
template_seed.add_top_level_resources(
master_seed, deployment_plan.master_template)
template_seed.add_top_level_outputs(
master_seed, deployment_plan.master_template)
if role_type is None:
LOG.error(
"Role '%s' not found in seed template." % db_role.name)
raise ValueError(db_role.name)
seed_role = template_seed.find_role_from_type(
master_seed.resources, role_type)
if seed_role is None:
LOG.error(
"Role '%s' of type '%s' not found in seed template." %
(db_role.name, role_type))
raise ValueError(db_role.name)
# These calls are idempotent, but must be called on each role as
# new references may have been added.
template_seed.update_role_resource_references(
deployment_plan.master_template,
seed_role,
db_role.name)
template_seed.update_role_property_references(
deployment_plan.master_template,
seed_role,
role_namespace)
# Update environment file to add top level mappings, which is made
# up of all non-role files present in the resource registry, plus
# required aliases
reg_mapping = self.registry_mapping_store.list()
environment = deployment_plan.environment
for entry in parsed_registry_env.registry_entries:
# check if registry_mapping is in database, if so add to
# environment (later will become environment.yaml)
if any(x.name == entry.filename for x in reg_mapping):
additem = RegistryEntry(entry.alias, entry.filename)
environment.add_registry_entry(additem, unique=True)
# Save the updated plan.
updated = self._save_updated_plan(plan_uuid, deployment_plan)
return updated
def remove_role_from_plan(self, plan_uuid, role_uuid):
"""Removes a role from the given plan.
:type plan_uuid: str
:type role_uuid: str
:raise tuskar.storage.exceptions.UnknownUUID: if the plan or role
doesn't exist
"""
# Load the objects from storage.
db_plan = self.plan_store.retrieve(plan_uuid)
db_role = self.template_store.retrieve(role_uuid)
# Parse the plan into template objects.
deployment_plan = self._plan_to_template_object(db_plan)
# Delete the role from the plan by it's namespace.
role_namespace = name_utils.generate_role_namespace(db_role.name,
db_role.version)
deployment_plan.remove_template(role_namespace)
# Save the updated plan.
updated = self._save_updated_plan(plan_uuid, deployment_plan)
return updated
def retrieve_plan(self, plan_uuid):
"""Loads the given plan.
:type plan_uuid: str
:rtype: tuskar.manager.models.DeploymentPlan
:raises tuskar.storage.exceptions.UnknownUUID: if there is no plan
with the given UUID
"""
# Load the plan from the database.
db_plan = self.plan_store.retrieve(plan_uuid)
# Parse the plan into the template model.
master_template = parser.parse_template(
db_plan.master_template.contents
)
environment = parser.parse_environment(
db_plan.environment_file.contents
)
# Create the Tuskar model for the plan.
deployment_plan = models.DeploymentPlan(
plan_uuid,
db_plan.name,
master_template.description,
created_at=db_plan.created_at,
updated_at=db_plan.updated_at,
)
roles = self._find_roles(environment)
deployment_plan.add_roles(*roles)
params = self._find_parameters(master_template, environment)
deployment_plan.add_parameters(*params)
return deployment_plan
def list_plans(self):
"""Returns a list of all plans stored in Tuskar.
:return: list of plan instances; empty list if there are no plans
:rtype: [tuskar.manager.models.DeploymentPlan]
"""
# Given the expected number of plans being managed by Tuskar (in the
# tens), this should be sufficient. If our scale gets larger, we may
# need a smarter batch operation here than simply iterating over the
# list of all plans. jdob, Aug 7, 2014
plan_uuids = [p.uuid for p in self.plan_store.list()]
plans = [self.retrieve_plan(p) for p in plan_uuids]
return plans
def set_parameter_values(self, plan_uuid, params):
"""Sets the values for a plan's parameters.
:type plan_uuid: str
:type params: [tuskar.manager.models.ParameterValue]
:return: plan instance with the updated values
:rtype: tuskar.manager.models.DeploymentPlan
"""
# Load the plan from the database.
db_plan = self.plan_store.retrieve(plan_uuid)
# Save the values to the parsed environment.
environment = parser.parse_environment(
db_plan.environment_file.contents
)
non_existent_params = []
for param_value in params:
p = environment.find_parameter_by_name(param_value.name)
if p:
p.value = param_value.value
else:
non_existent_params.append(param_value.name)
if non_existent_params:
param_names = ', '.join(non_existent_params)
LOG.error(
'There are no parameters named %(param_names)s'
' in plan %(plan_uuid)s.' %
{'param_names': param_names, 'plan_uuid': plan_uuid})
raise exception.PlanParametersNotExist(
plan_uuid=plan_uuid,
param_names=param_names
)
# Save the updated environment.
env_contents = composer.compose_environment(environment)
self.plan_store.update_environment(plan_uuid, env_contents)
updated_plan = self.retrieve_plan(plan_uuid)
return updated_plan
def package_templates(self, plan_uuid):
"""Packages and returns all of the templates related to the given plan.
The returned dictionary is keyed by filename and contains the contents
of that file (a template or an environment file).
:type plan_uuid: str
:return: mapping of filename to contents for each file in the plan
:rtype: dict
:raises tuskar.storage.exceptions.UnknownUUID: if there is no plan
with the given UUID
"""
# Load and parse the plan.
db_plan = self.plan_store.retrieve(plan_uuid)
master_template = parser.parse_template(
db_plan.master_template.contents
)
environment = parser.parse_environment(
db_plan.environment_file.contents
)
# Compose the plan files and all plan roles and package them into
# a single dictionary.
plan_contents = composer.compose_template(master_template)
env_contents = composer.compose_environment(environment)
files_dict = {
'plan.yaml': plan_contents,
'environment.yaml': env_contents,
}
plan_roles = self._find_roles(environment)
manager = RoleManager()
for role in plan_roles:
contents = composer.compose_template(role.template)
filename = name_utils.role_template_filename(role.name,
role.version,
role.relative_path)
files_dict[filename] = contents
def _add_template_extra_data_for(templates, template_store):
template_extra_data = manager.retrieve_db_role_extra()
for template in templates:
db_template = template_store.retrieve_by_name(template.name)
prefix = os_path.split(db_template.name)[0]
template_extra_paths = utils.resolve_template_extra_data(
db_template, template_extra_data)
extra_data_output = manager.template_extra_data_for_output(
template_extra_paths, prefix)
files_dict.update(extra_data_output)
# also grab any extradata files for the role
_add_template_extra_data_for(plan_roles, self.template_store)
# in addition to provider roles above, return non-role template files
reg_mapping = self.registry_mapping_store.list()
for entry in reg_mapping:
if os_path.splitext(entry.name)[1] in ('.yaml', '.yml'):
# if entry is an alias, don't include it
files_dict[entry.name] = entry.contents
# similarly, also grab extradata files for the non role templates
_add_template_extra_data_for(reg_mapping, self.registry_mapping_store)
return files_dict
def _find_roles(self, environment):
"""Returns a list of roles for a plan (identified by the given
environment).
:type environment: tuskar.templates.heat.Environment
:return: list of role instances; empty list if none are in the
environment
:rtype: [tuskar.manager.models.Role]
"""
def load_role(entry):
# Figure out the role name/version for the given entry.
namespace = ns_utils.remove_resource_alias_namespace(entry.alias)
name, version = name_utils.parse_role_namespace(namespace)
# Load the role from the database and parse into the
# template objects.
db_role = self.template_store.retrieve_by_name(name, int(version))
role = self._role_to_template_object(db_role)
# Convert to the Tuskar domain model.
tuskar_role = models.Role(db_role.uuid, name, version,
role.description, role,
relative_path=db_role.relative_path)
return tuskar_role
reg_mapping = self.registry_mapping_store.list()
roles = [load_role(e) for e in environment.registry_entries
if not any(x.name == e.filename for x in reg_mapping)]
return roles
@staticmethod
def _find_parameters(template, environment):
"""Returns a list of parameters for a plan. The parameters will contain
both metadata about the parameter itself (name, label, description,
etc.) as well as it's current value for the plan.
:type template: tuskar.templates.heat.Template
:type environment: tuskar.templates.heat.Environment
:return: list of parameter instances; empty list if there are no
parameters in the plan
:rtype: [tuskar.manager.models.PlanParameter]
"""
def generate_param(p):
env_param = environment.find_parameter_by_name(p.name)
return models.PlanParameter(
p.name, env_param.value, p.param_type,
p.description, p.label, p.default, p.hidden, p.constraints
)
params = [generate_param(tp) for tp in template.parameters]
return params
@staticmethod
def _plan_to_template_object(db_plan):
master_template = parser.parse_template(
db_plan.master_template.contents
)
environment = parser.parse_environment(
db_plan.environment_file.contents
)
deployment_plan = plan.DeploymentPlan(master_template=master_template,
environment=environment)
return deployment_plan
@staticmethod
def _role_to_template_object(db_role):
role_template = parser.parse_template(db_role.contents)
return role_template
def _save_updated_plan(self, plan_uuid, deployment_plan):
new_template_contents = composer.compose_template(
deployment_plan.master_template
)
new_env_contents = composer.compose_environment(
deployment_plan.environment
)
self.plan_store.update_master_template(plan_uuid,
new_template_contents)
self.plan_store.update_environment(plan_uuid,
new_env_contents)
# Retrieve and return the updated plan
updated_plan = self.retrieve_plan(plan_uuid)
return updated_plan
def load_roles(roles, seed_file=None, resource_registry_path=None,
dry_run=False):
"""Given a list of roles files import them into the
add any to the store. TemplateStore. When dry_run=True is
passed, run through the roles but don't
The returned tuple contains all the role names and then the names split
over where were created and updated. On a dry run the first item will
contain all of the roles found while the second two will be empty lists as
no files were updated or created.
:param roles: A list of yaml files (as strings)
:type roles: [str]
:param seed_file: full path to the template seed that should be used for
plan master templates
:type seed_file: str
:param resource_registry_path: path to the Heat environment which
declares the custom types for Tuskar roles.
:type resource_registry_path: str
:return: Summary of the results as a tuple with the total count and then
the names of the created and updated roles.
:rtype: tuple(list, list, list)
"""
all_roles, created, updated = [], [], []
roles = [(role_name_from_path(r), r) for r in roles]
for name, role_path in roles:
contents = _load_file(role_path)
all_roles.append(name)
if dry_run:
continue
role_created, _ = _create_or_update(name, contents)
if role_created:
created.append(name)
else:
updated.append(name)
if seed_file is not None:
contents = _load_file(seed_file)
seed_created, role = _create_or_update(MASTER_SEED_NAME, contents,
store=MasterSeedStore())
all_roles.append(MASTER_SEED_NAME)
if seed_created:
created.append(MASTER_SEED_NAME)
else:
updated.append(MASTER_SEED_NAME)
if resource_registry_path is not None:
contents = _load_file(resource_registry_path)
store = ResourceRegistryStore()
registry_created, role = _create_or_update(RESOURCE_REGISTRY_NAME,
contents,
store=store)
all_roles.append(RESOURCE_REGISTRY_NAME)
if registry_created:
created.append(RESOURCE_REGISTRY_NAME)
else:
updated.append(RESOURCE_REGISTRY_NAME)
return all_roles, created, updated
class PlansManagerTestCase(TestCase):
def setUp(self):
super(PlansManagerTestCase, self).setUp()
self.plans_manager = PlansManager()
self.plan_store = DeploymentPlanStore()
self.template_store = TemplateStore()
self.seed_store = MasterSeedStore()
self.registry_store = ResourceRegistryStore()
self.registry_mapping_store = ResourceRegistryMappingStore()
def test_create_plan(self):
# Tests
created = self.plans_manager.create_plan('p1', 'desc-1')
# Verify
self.assertTrue(created is not None)
self.assertTrue(isinstance(created, DeploymentPlan))
self.assertTrue(created.uuid is not None)
self.assertEqual('p1', created.name)
self.assertEqual('desc-1', created.description)
self.assertEqual(0, len(created.roles))
self.assertEqual(0, len(created.parameters))
found = self.plans_manager.retrieve_plan(created.uuid)
self.assertTrue(found is not None)
def test_delete_plan(self):
# Setup
created = self.plans_manager.create_plan('p1', 'desc-1')
db_plan = self.plan_store.retrieve(created.uuid)
# Test
self.plans_manager.delete_plan(created.uuid)
# Verify
self.assertRaises(UnknownUUID, self.plans_manager.retrieve_plan,
created.uuid)
env_store = EnvironmentFileStore()
self.assertRaises(UnknownUUID, env_store.retrieve,
db_plan.environment_file.uuid)
master_store = MasterTemplateStore()
self.assertRaises(UnknownUUID, master_store.retrieve,
db_plan.master_template.uuid)
def test_add_role_to_plan(self):
# Setup
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
# Test
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Verify
db_plan = self.plan_store.retrieve(test_plan.uuid)
parsed_plan = parser.parse_template(db_plan.master_template.contents)
self.assertEqual(1, len(parsed_plan.resources))
def test_add_role_to_seeded_plan(self):
# Setup
self.seed_store.create(MASTER_SEED_NAME, TEST_SEED)
self.registry_store.create(RESOURCE_REGISTRY_NAME, RESOURCE_REGISTRY)
# more setup (this is normally called in load_roles)
self.registry_mapping_store.create('required_file.yaml',
'some fake template data')
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
# Test
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Verify
db_plan = self.plan_store.retrieve(test_plan.uuid)
parsed_plan = parser.parse_template(db_plan.master_template.contents)
self.assertEqual(2, len(parsed_plan.resources))
# The role generated in the plan has a different name:
my_role = parsed_plan.find_resource_by_id('r1')
self.assertIsNot(my_role, None)
# The reference to the role in some_config should be updated:
some_config = parsed_plan.find_resource_by_id('some_config')
self.assertIsNot(some_config, None)
config_property = some_config.find_property_by_name('config')
self.assertIsNot(config_property, None)
self.assertEqual(config_property.value,
{'ip_addresses': {
'get_attr': ['r1', 'foo_ip']
}})
# verify both entries are present from RESOURCE_REGISTRY
parsed_env = parser.parse_environment(
db_plan.environment_file.contents)
self.assertEqual(2, len(parsed_env.registry_entries))
def test_add_unknown_role_to_seeded_plan(self):
# Setup
self.seed_store.create(MASTER_SEED_NAME, TEST_SEED)
self.registry_store.create(RESOURCE_REGISTRY_NAME, RESOURCE_REGISTRY)
test_role = self.template_store.create('unknown_role', TEST_TEMPLATE)
test_plan = self.plans_manager.create_plan('p1', 'd1')
# Test
self.assertRaises(ValueError, self.plans_manager.add_role_to_plan,
test_plan.uuid, test_role.uuid)
def test_add_role_of_unknown_type_to_seeded_plan(self):
# Setup
self.seed_store.create(MASTER_SEED_NAME, TEST_SEED)
self.registry_store.create(RESOURCE_REGISTRY_NAME,
RESOURCE_REGISTRY_WRONG_TYPE)
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
# Test
self.assertRaises(ValueError, self.plans_manager.add_role_to_plan,
test_plan.uuid, test_role.uuid)
def test_add_role_to_seeded_plan_without_registry(self):
# Setup
self.seed_store.create(MASTER_SEED_NAME, TEST_SEED)
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
# Resource registry is missing, adding role should fail
self.assertRaises(UnknownName, self.plans_manager.add_role_to_plan,
test_plan.uuid, test_role.uuid)
def test_remove_role_from_plan(self):
# Setup
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Test
self.plans_manager.remove_role_from_plan(test_plan.uuid,
test_role.uuid)
# Verify
db_plan = self.plan_store.retrieve(test_plan.uuid)
parsed_plan = parser.parse_template(db_plan.master_template.contents)
self.assertEqual(0, len(parsed_plan.resources))
def test_retrieve_plan(self):
# Setup
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Test
found = self.plans_manager.retrieve_plan(test_plan.uuid)
# Verify
self.assertTrue(found is not None)
self.assertTrue(isinstance(found, DeploymentPlan))
self.assertEqual(test_plan.uuid, found.uuid)
self.assertEqual('p1', found.name)
self.assertEqual('d1', found.description)
self.assertEqual(1, len(found.roles))
self.assertTrue(isinstance(found.roles[0], Role))
self.assertEqual(4, len(found.parameters)) # 3 + 1 for scaling
self.assertTrue(isinstance(found.parameters[0], PlanParameter))
def test_list_plans(self):
# Setup
self.plans_manager.create_plan('p1', 'd1')
self.plans_manager.create_plan('p2', 'd2')
# Test
all_plans = self.plans_manager.list_plans()
# Verify
self.assertEqual(2, len(all_plans))
all_plans.sort(key=lambda x: x.name)
self.assertEqual('p1', all_plans[0].name)
self.assertEqual('p2', all_plans[1].name)
def test_set_parameter_values(self):
# Setup
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Test
ns = name_utils.generate_role_namespace(test_role.name,
test_role.version)
update_us = [
ParameterValue(ns_utils.apply_template_namespace(ns, 'key_name'),
'test-key'),
ParameterValue(ns_utils.apply_template_namespace(ns, 'image_id'),
'test-image'),
]
updated_plan = self.plans_manager.set_parameter_values(
test_plan.uuid, update_us)
# Verify
self.assertTrue(updated_plan is not None)
self.assertTrue(isinstance(updated_plan, DeploymentPlan))
# Pull it from the database again to make sure it was saved
found = self.plans_manager.retrieve_plan(test_plan.uuid)
found_params = sorted(found.parameters, key=lambda x: x.name)
self.assertEqual(4, len(found_params)) # 3 + 1 for scaling
self.assertEqual(found_params[0].value, '1')
self.assertEqual(found_params[1].value, 'test-image')
self.assertEqual(found_params[2].value, 'm1.small')
self.assertEqual(found_params[3].value, 'test-key')
def test_set_non_existent_parameters(self):
# Setup
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Test
ns = name_utils.generate_role_namespace(test_role.name,
test_role.version)
not_present_in_role_1_name = ns_utils.apply_template_namespace(
ns, 'not_present_in_role_1')
not_present_in_role_2_name = ns_utils.apply_template_namespace(
ns, 'not_present_in_role_2')
update_us = [
ParameterValue(ns_utils.apply_template_namespace(ns, 'key_name'),
'test-key'),
ParameterValue(ns_utils.apply_template_namespace(ns, 'image_id'),
'test-image'),
ParameterValue(not_present_in_role_1_name,
'not-present-in-role-1-value'),
ParameterValue(not_present_in_role_2_name,
'not-present-in-role-2-value'),
]
# Verify
exc = self.assertRaises(exception.PlanParametersNotExist,
self.plans_manager.set_parameter_values,
test_plan.uuid, update_us)
self.assertIn(not_present_in_role_1_name, str(exc))
self.assertIn(not_present_in_role_2_name, str(exc))
# Pull it from the database to make sure it was modified
found = self.plans_manager.retrieve_plan(test_plan.uuid)
found_params = sorted(found.parameters, key=lambda x: x.name)
self.assertEqual(4, len(found_params)) # 3 + 1 for scaling
self.assertEqual(found_params[0].value, '1')
self.assertEqual(found_params[1].value,
'3e6270da-fbf7-4aef-bc78-6d0cfc3ad11b')
self.assertEqual(found_params[2].value, 'm1.small')
self.assertEqual(found_params[3].value, '')
def test_package_templates(self):
# Setup
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Test
templates = self.plans_manager.package_templates(test_plan.uuid)
# Verify
self.assertTrue(isinstance(templates, dict))
self.assertEqual(3, len(templates))
self.assertTrue('plan.yaml' in templates)
parsed_plan = parser.parse_template(templates['plan.yaml'])
self.assertEqual(parsed_plan.description, 'd1')
self.assertTrue('environment.yaml' in templates)
parsed_env = parser.parse_environment(templates['environment.yaml'])
self.assertEqual(1, len(parsed_env.registry_entries))
role_filename = name_utils.role_template_filename('r1', '1', None)
self.assertTrue(role_filename in templates)
parsed_role = parser.parse_template(templates[role_filename])
self.assertEqual(parsed_role.description, 'Test provider resource foo')
def test_package_templates_seeded_plan(self):
# Setup
self.seed_store.create(MASTER_SEED_NAME, TEST_SEED)
self.registry_store.create(RESOURCE_REGISTRY_NAME, RESOURCE_REGISTRY)
# more setup (this is normally called in load_roles)
self.registry_mapping_store.create('required_file.yaml',
'some fake template data')
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Test
templates = self.plans_manager.package_templates(test_plan.uuid)
# Verify
self.assertTrue(isinstance(templates, dict))
self.assertEqual(4, len(templates))
self.assertTrue('plan.yaml' in templates)
parsed_plan = parser.parse_template(templates['plan.yaml'])
self.assertEqual(parsed_plan.description, 'd1')
self.assertTrue('environment.yaml' in templates)
self.assertTrue('required_file.yaml' in templates)
parsed_env = parser.parse_environment(templates['environment.yaml'])
self.assertEqual(2, len(parsed_env.registry_entries))
role_filename = name_utils.role_template_filename('r1', '1', None)
self.assertTrue(role_filename in templates)
parsed_role = parser.parse_template(templates[role_filename])
self.assertEqual(parsed_role.description, 'Test provider resource foo')
def test_find_roles(self):
# Setup
self.seed_store.create(MASTER_SEED_NAME, TEST_SEED)
self.registry_store.create(RESOURCE_REGISTRY_NAME, RESOURCE_REGISTRY)
# more setup (this is normally called in load_roles)
self.registry_mapping_store.create('required_file.yaml',
'some fake template data')
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
# Test
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Verify only one role is found
db_plan = self.plan_store.retrieve(test_plan.uuid)
parsed_env = parser.parse_environment(
db_plan.environment_file.contents)
roles = self.plans_manager._find_roles(parsed_env)
self.assertEqual(1, len(roles))
def _add_test_role(self):
return self.template_store.create('r1',
TEST_TEMPLATE,
registry_path='r1.yaml')
class PlansManagerTestCase(TestCase):
def setUp(self):
super(PlansManagerTestCase, self).setUp()
self.plans_manager = PlansManager()
self.plan_store = DeploymentPlanStore()
self.template_store = TemplateStore()
self.seed_store = MasterSeedStore()
self.registry_store = ResourceRegistryStore()
self.registry_mapping_store = ResourceRegistryMappingStore()
def test_create_plan(self):
# Tests
created = self.plans_manager.create_plan('p1', 'desc-1')
# Verify
self.assertTrue(created is not None)
self.assertTrue(isinstance(created, DeploymentPlan))
self.assertTrue(created.uuid is not None)
self.assertEqual('p1', created.name)
self.assertEqual('desc-1', created.description)
self.assertEqual(0, len(created.roles))
self.assertEqual(0, len(created.parameters))
found = self.plans_manager.retrieve_plan(created.uuid)
self.assertTrue(found is not None)
def test_delete_plan(self):
# Setup
created = self.plans_manager.create_plan('p1', 'desc-1')
db_plan = self.plan_store.retrieve(created.uuid)
# Test
self.plans_manager.delete_plan(created.uuid)
# Verify
self.assertRaises(UnknownUUID,
self.plans_manager.retrieve_plan,
created.uuid)
env_store = EnvironmentFileStore()
self.assertRaises(UnknownUUID, env_store.retrieve,
db_plan.environment_file.uuid)
master_store = MasterTemplateStore()
self.assertRaises(UnknownUUID, master_store.retrieve,
db_plan.master_template.uuid)
def test_add_role_to_plan(self):
# Setup
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
# Test
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Verify
db_plan = self.plan_store.retrieve(test_plan.uuid)
parsed_plan = parser.parse_template(db_plan.master_template.contents)
self.assertEqual(1, len(parsed_plan.resources))
def test_add_role_to_seeded_plan(self):
# Setup
self.seed_store.create(MASTER_SEED_NAME, TEST_SEED)
self.registry_store.create(RESOURCE_REGISTRY_NAME, RESOURCE_REGISTRY)
# more setup (this is normally called in load_roles)
self.registry_mapping_store.create('required_file.yaml',
'some fake template data')
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
# Test
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Verify
db_plan = self.plan_store.retrieve(test_plan.uuid)
parsed_plan = parser.parse_template(db_plan.master_template.contents)
self.assertEqual(2, len(parsed_plan.resources))
# The role generated in the plan has a different name:
my_role = parsed_plan.find_resource_by_id('r1')
self.assertIsNot(my_role, None)
# The reference to the role in some_config should be updated:
some_config = parsed_plan.find_resource_by_id('some_config')
self.assertIsNot(some_config, None)
config_property = some_config.find_property_by_name('config')
self.assertIsNot(config_property, None)
self.assertEqual(config_property.value,
{'ip_addresses':
{'get_attr': ['r1', 'foo_ip']}})
# verify both entries are present from RESOURCE_REGISTRY
parsed_env = parser.parse_environment(
db_plan.environment_file.contents
)
self.assertEqual(2, len(parsed_env.registry_entries))
def test_add_unknown_role_to_seeded_plan(self):
# Setup
self.seed_store.create(MASTER_SEED_NAME, TEST_SEED)
self.registry_store.create(RESOURCE_REGISTRY_NAME, RESOURCE_REGISTRY)
test_role = self.template_store.create('unknown_role', TEST_TEMPLATE)
test_plan = self.plans_manager.create_plan('p1', 'd1')
# Test
self.assertRaises(ValueError, self.plans_manager.add_role_to_plan,
test_plan.uuid, test_role.uuid)
def test_add_role_of_unknown_type_to_seeded_plan(self):
# Setup
self.seed_store.create(MASTER_SEED_NAME, TEST_SEED)
self.registry_store.create(RESOURCE_REGISTRY_NAME,
RESOURCE_REGISTRY_WRONG_TYPE)
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
# Test
self.assertRaises(ValueError, self.plans_manager.add_role_to_plan,
test_plan.uuid, test_role.uuid)
def test_add_role_to_seeded_plan_without_registry(self):
# Setup
self.seed_store.create(MASTER_SEED_NAME, TEST_SEED)
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
# Resource registry is missing, adding role should fail
self.assertRaises(UnknownName,
self.plans_manager.add_role_to_plan,
test_plan.uuid, test_role.uuid)
def test_remove_role_from_plan(self):
# Setup
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Test
self.plans_manager.remove_role_from_plan(test_plan.uuid,
test_role.uuid)
# Verify
db_plan = self.plan_store.retrieve(test_plan.uuid)
parsed_plan = parser.parse_template(db_plan.master_template.contents)
self.assertEqual(0, len(parsed_plan.resources))
def test_retrieve_plan(self):
# Setup
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Test
found = self.plans_manager.retrieve_plan(test_plan.uuid)
# Verify
self.assertTrue(found is not None)
self.assertTrue(isinstance(found, DeploymentPlan))
self.assertEqual(test_plan.uuid, found.uuid)
self.assertEqual('p1', found.name)
self.assertEqual('d1', found.description)
self.assertEqual(1, len(found.roles))
self.assertTrue(isinstance(found.roles[0], Role))
self.assertEqual(4, len(found.parameters)) # 3 + 1 for scaling
self.assertTrue(isinstance(found.parameters[0], PlanParameter))
def test_list_plans(self):
# Setup
self.plans_manager.create_plan('p1', 'd1')
self.plans_manager.create_plan('p2', 'd2')
# Test
all_plans = self.plans_manager.list_plans()
# Verify
self.assertEqual(2, len(all_plans))
all_plans.sort(key=lambda x: x.name)
self.assertEqual('p1', all_plans[0].name)
self.assertEqual('p2', all_plans[1].name)
def test_set_parameter_values(self):
# Setup
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Test
ns = name_utils.generate_role_namespace(test_role.name,
test_role.version)
update_us = [
ParameterValue(ns_utils.apply_template_namespace(ns, 'key_name'),
'test-key'),
ParameterValue(ns_utils.apply_template_namespace(ns, 'image_id'),
'test-image'),
]
updated_plan = self.plans_manager.set_parameter_values(test_plan.uuid,
update_us)
# Verify
self.assertTrue(updated_plan is not None)
self.assertTrue(isinstance(updated_plan, DeploymentPlan))
# Pull it from the database again to make sure it was saved
found = self.plans_manager.retrieve_plan(test_plan.uuid)
found_params = sorted(found.parameters, key=lambda x: x.name)
self.assertEqual(4, len(found_params)) # 3 + 1 for scaling
self.assertEqual(found_params[0].value, '1')
self.assertEqual(found_params[1].value, 'test-image')
self.assertEqual(found_params[2].value, 'm1.small')
self.assertEqual(found_params[3].value, 'test-key')
def test_set_non_existent_parameters(self):
# Setup
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Test
ns = name_utils.generate_role_namespace(test_role.name,
test_role.version)
not_present_in_role_1_name = ns_utils.apply_template_namespace(
ns, 'not_present_in_role_1')
not_present_in_role_2_name = ns_utils.apply_template_namespace(
ns, 'not_present_in_role_2')
update_us = [
ParameterValue(ns_utils.apply_template_namespace(ns, 'key_name'),
'test-key'),
ParameterValue(ns_utils.apply_template_namespace(ns, 'image_id'),
'test-image'),
ParameterValue(not_present_in_role_1_name,
'not-present-in-role-1-value'),
ParameterValue(not_present_in_role_2_name,
'not-present-in-role-2-value'),
]
# Verify
exc = self.assertRaises(exception.PlanParametersNotExist,
self.plans_manager.set_parameter_values,
test_plan.uuid,
update_us)
self.assertIn(not_present_in_role_1_name, str(exc))
self.assertIn(not_present_in_role_2_name, str(exc))
# Pull it from the database to make sure it was modified
found = self.plans_manager.retrieve_plan(test_plan.uuid)
found_params = sorted(found.parameters, key=lambda x: x.name)
self.assertEqual(4, len(found_params)) # 3 + 1 for scaling
self.assertEqual(found_params[0].value, '1')
self.assertEqual(found_params[1].value,
'3e6270da-fbf7-4aef-bc78-6d0cfc3ad11b')
self.assertEqual(found_params[2].value, 'm1.small')
self.assertEqual(found_params[3].value, '')
def test_package_templates(self):
# Setup
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Test
templates = self.plans_manager.package_templates(test_plan.uuid)
# Verify
self.assertTrue(isinstance(templates, dict))
self.assertEqual(3, len(templates))
self.assertTrue('plan.yaml' in templates)
parsed_plan = parser.parse_template(templates['plan.yaml'])
self.assertEqual(parsed_plan.description, 'd1')
self.assertTrue('environment.yaml' in templates)
parsed_env = parser.parse_environment(templates['environment.yaml'])
self.assertEqual(1, len(parsed_env.registry_entries))
role_filename = name_utils.role_template_filename('r1', '1', None)
self.assertTrue(role_filename in templates)
parsed_role = parser.parse_template(templates[role_filename])
self.assertEqual(parsed_role.description, 'Test provider resource foo')
def test_package_templates_seeded_plan(self):
# Setup
self.seed_store.create(MASTER_SEED_NAME, TEST_SEED)
self.registry_store.create(RESOURCE_REGISTRY_NAME, RESOURCE_REGISTRY)
# more setup (this is normally called in load_roles)
self.registry_mapping_store.create('required_file.yaml',
'some fake template data')
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Test
templates = self.plans_manager.package_templates(test_plan.uuid)
# Verify
self.assertTrue(isinstance(templates, dict))
self.assertEqual(4, len(templates))
self.assertTrue('plan.yaml' in templates)
parsed_plan = parser.parse_template(templates['plan.yaml'])
self.assertEqual(parsed_plan.description, 'd1')
self.assertTrue('environment.yaml' in templates)
self.assertTrue('required_file.yaml' in templates)
parsed_env = parser.parse_environment(templates['environment.yaml'])
self.assertEqual(2, len(parsed_env.registry_entries))
role_filename = name_utils.role_template_filename('r1', '1', None)
self.assertTrue(role_filename in templates)
parsed_role = parser.parse_template(templates[role_filename])
self.assertEqual(parsed_role.description, 'Test provider resource foo')
def test_find_roles(self):
# Setup
self.seed_store.create(MASTER_SEED_NAME, TEST_SEED)
self.registry_store.create(RESOURCE_REGISTRY_NAME, RESOURCE_REGISTRY)
# more setup (this is normally called in load_roles)
self.registry_mapping_store.create('required_file.yaml',
'some fake template data')
test_role = self._add_test_role()
test_plan = self.plans_manager.create_plan('p1', 'd1')
# Test
self.plans_manager.add_role_to_plan(test_plan.uuid, test_role.uuid)
# Verify only one role is found
db_plan = self.plan_store.retrieve(test_plan.uuid)
parsed_env = parser.parse_environment(
db_plan.environment_file.contents
)
roles = self.plans_manager._find_roles(parsed_env)
self.assertEqual(1, len(roles))
def _add_test_role(self):
return self.template_store.create('r1', TEST_TEMPLATE,
registry_path='r1.yaml')
def load_roles(roles,
seed_file=None,
resource_registry_path=None,
role_extra=None):
"""Given a list of roles files import them into the
add any to the store. TemplateStore.
The returned tuple contains all the role names and then the names split
over where were created and updated. On a dry run the first item will
contain all of the roles found while the second two will be empty lists as
no files were updated or created.
:param roles: A list of yaml files (as strings)
:type roles: [str]
:param seed_file: full path to the template seed that should be used for
plan master templates
:type seed_file: str
:param resource_registry_path: path to the Heat environment which
declares the custom types for Tuskar roles.
:type resource_registry_path: str
:param role_extra: A list of yaml files (as strings) that may be consumed
(referenced) by any of the role files.
:type roles: [str]
:return: Summary of the results as a tuple with the total count and then
the names of the created and updated roles.
:rtype: tuple(list, list, list)
"""
all_roles, created, updated = [], [], []
def _process_roles(roles, store=None):
for role_name, role_path in roles:
process_role(role_path, role_name, store, all_roles, created,
updated)
roles = [(role_name_from_path(r), r) for r in roles]
_process_roles(roles)
template_extra_store = TemplateExtraStore()
if role_extra is not None:
role_extra = [(utils.resolve_role_extra_name_from_path(re), re)
for re in role_extra]
_process_roles(role_extra, template_extra_store)
if seed_file is not None:
process_role(seed_file, MASTER_SEED_NAME, MasterSeedStore(), all_roles,
created, updated)
if resource_registry_path is not None:
process_role(resource_registry_path, RESOURCE_REGISTRY_NAME,
ResourceRegistryStore(), all_roles, created, updated)
contents = load_file(resource_registry_path)
parsed_env = parser.parse_environment(contents)
mapping_store = ResourceRegistryMappingStore()
dirname = path.dirname(resource_registry_path)
role_paths = [r[1] for r in roles]
for entry in parsed_env.registry_entries:
complete_path = path.join(dirname, entry.filename)
# skip adding if template has already been stored as a role
if (complete_path in role_paths):
continue
if (entry.is_filename()):
process_role(complete_path, entry.filename, mapping_store,
None, created, updated)
else:
# if entry is not a filename, (is an alias) add to mappings
create_or_update(entry.filename, entry.alias, mapping_store)
return all_roles, created, updated
class PlansManager(object):
def __init__(self):
super(PlansManager, self).__init__()
self.plan_store = DeploymentPlanStore()
self.seed_store = MasterSeedStore()
self.registry_store = ResourceRegistryStore()
self.template_store = TemplateStore()
self.master_template_store = MasterTemplateStore()
self.environment_store = EnvironmentFileStore()
def create_plan(self, name, description):
"""Creates a new plan, persisting it to Tuskar's storage backend.
:type name: str
:type description: str
:return: domain model instance of the created plan
:rtype: tuskar.manager.models.DeploymentPlan
:raises tuskar.storage.exceptions.NameAlreadyUsed: if there is a plan
with the given name
"""
# Create the plan using the template generation code first to
# stub out the master template and environment files correctly.
new_plan = plan.DeploymentPlan(description=description)
# Save the newly created master template and environment to the
# storage layer so they can be associated with the plan.
master_template_contents = composer.compose_template(
new_plan.master_template
)
master_template_file = self.master_template_store.create(
name_utils.master_template_filename(name),
master_template_contents,
)
environment_contents = composer.compose_environment(
new_plan.environment
)
environment_file = self.environment_store.create(
environment_contents
)
# Create the plan in storage, seeding it with the stored files for
# the template and environment.
db_plan = self.plan_store.create(
name,
master_template_uuid=master_template_file.uuid,
environment_uuid=environment_file.uuid,
)
# Return the created plan.
created_plan = self.retrieve_plan(db_plan.uuid)
return created_plan
def delete_plan(self, plan_uuid):
"""Deletes an existing plan.
:type plan_uuid: str
:raises tuskar.storage.exceptions.UnknownUUID: if there is no plan
with the given UUID
"""
self.plan_store.delete(plan_uuid)
def add_role_to_plan(self, plan_uuid, role_uuid):
"""Adds a role to the given plan, storing the changes in Tuskar's
storage.
:type plan_uuid: str
:type role_uuid: str
:return: updated plan model instance
:rtype: tuskar.manager.models.DeploymentPlan
:raises tuskar.storage.exceptions.UnknownUUID: if either the plan
or the role cannot be found
"""
# Load the plan and role from storage
db_plan = self.plan_store.retrieve(plan_uuid)
db_role = self.template_store.retrieve(role_uuid)
# Parse the plan and role template into template objects.
deployment_plan = self._plan_to_template_object(db_plan)
role_template = self._role_to_template_object(db_role)
# See if a master seed template has been set.
try:
db_master_seed = self.seed_store.retrieve_by_name(MASTER_SEED_NAME)
master_seed = parser.parse_template(db_master_seed.contents)
except UnknownName:
master_seed = None
special_properties = None
if master_seed is not None:
try:
db_registry_env = self.registry_store.retrieve_by_name(
RESOURCE_REGISTRY_NAME).contents
except UnknownName:
LOG.error("Could not load resource_registry. Make sure you "
"pass --resource-registry to tuskar-load-roles.")
raise
parsed_registry_env = parser.parse_environment(db_registry_env)
registry = dict((role_name_from_path(e.filename), e.alias)
for e in parsed_registry_env.registry_entries)
special_properties = template_seed.get_property_map_for_role(
master_seed, registry[db_role.name])
# Use the combination logic to perform the addition.
role_namespace = name_utils.generate_role_namespace(db_role.name,
db_role.version)
template_filename = name_utils.role_template_filename(db_role.name,
db_role.version)
deployment_plan.add_template(role_namespace, role_template,
template_filename,
override_properties=special_properties)
# If there is a master seed, add its top-level elements to the plan.
# These calls are idempotent, so it's safe to call each time a role
# is added.
if master_seed is not None:
template_seed.add_top_level_parameters(
master_seed,
deployment_plan.master_template,
deployment_plan.environment)
template_seed.add_top_level_resources(
master_seed, deployment_plan.master_template)
template_seed.add_top_level_outputs(
master_seed, deployment_plan.master_template)
try:
role_type = registry[db_role.name]
except KeyError:
LOG.error(
"Role '%s' not found in seed template." % db_role.name)
raise
seed_role = template_seed.find_role_from_type(
master_seed.resources, role_type)
if seed_role is None:
LOG.error(
"Role '%s' of type '%s' not found in seed template." %
(db_role.name, role_type))
raise ValueError(db_role.name)
# These calls are idempotent, but must be called on each role as
# new references may have been added.
template_seed.update_role_resource_references(
deployment_plan.master_template,
seed_role,
plan.generate_group_id(role_namespace))
template_seed.update_role_property_references(
deployment_plan.master_template,
seed_role,
role_namespace)
# Save the updated plan.
updated = self._save_updated_plan(plan_uuid, deployment_plan)
return updated
def remove_role_from_plan(self, plan_uuid, role_uuid):
"""Removes a role from the given plan.
:type plan_uuid: str
:type role_uuid: str
:raise tuskar.storage.exceptions.UnknownUUID: if the plan or role
doesn't exist
"""
# Load the objects from storage.
db_plan = self.plan_store.retrieve(plan_uuid)
db_role = self.template_store.retrieve(role_uuid)
# Parse the plan into template objects.
deployment_plan = self._plan_to_template_object(db_plan)
# Delete the role from the plan by it's namespace.
role_namespace = name_utils.generate_role_namespace(db_role.name,
db_role.version)
deployment_plan.remove_template(role_namespace)
# Save the updated plan.
updated = self._save_updated_plan(plan_uuid, deployment_plan)
return updated
def retrieve_plan(self, plan_uuid):
"""Loads the given plan.
:type plan_uuid: str
:rtype: tuskar.manager.models.DeploymentPlan
:raises tuskar.storage.exceptions.UnknownUUID: if there is no plan
with the given UUID
"""
# Load the plan from the database.
db_plan = self.plan_store.retrieve(plan_uuid)
# Parse the plan into the template model.
master_template = parser.parse_template(
db_plan.master_template.contents
)
environment = parser.parse_environment(
db_plan.environment_file.contents
)
# Create the Tuskar model for the plan.
deployment_plan = models.DeploymentPlan(
plan_uuid,
db_plan.name,
master_template.description,
created_at=db_plan.created_at,
updated_at=db_plan.updated_at,
)
roles = self._find_roles(environment)
deployment_plan.add_roles(*roles)
params = self._find_parameters(master_template, environment)
deployment_plan.add_parameters(*params)
return deployment_plan
def list_plans(self):
"""Returns a list of all plans stored in Tuskar.
:return: list of plan instances; empty list if there are no plans
:rtype: [tuskar.manager.models.DeploymentPlan]
"""
# Given the expected number of plans being managed by Tuskar (in the
# tens), this should be sufficient. If our scale gets larger, we may
# need a smarter batch operation here than simply iterating over the
# list of all plans. jdob, Aug 7, 2014
plan_uuids = [p.uuid for p in self.plan_store.list()]
plans = [self.retrieve_plan(p) for p in plan_uuids]
return plans
def set_parameter_values(self, plan_uuid, params):
"""Sets the values for a plan's parameters.
:type plan_uuid: str
:type params: [tuskar.manager.models.ParameterValue]
:return: plan instance with the updated values
:rtype: tuskar.manager.models.DeploymentPlan
"""
# Load the plan from the database.
db_plan = self.plan_store.retrieve(plan_uuid)
# Save the values to the parsed environment.
environment = parser.parse_environment(
db_plan.environment_file.contents
)
non_existent_params = []
for param_value in params:
p = environment.find_parameter_by_name(param_value.name)
if p:
p.value = param_value.value
else:
non_existent_params.append(param_value.name)
if non_existent_params:
param_names = ', '.join(non_existent_params)
LOG.error(
'There are no parameters named %(param_names)s'
' in plan %(plan_uuid)s.' %
{'param_names': param_names, 'plan_uuid': plan_uuid})
raise exception.PlanParametersNotExist(
plan_uuid=plan_uuid,
param_names=param_names
)
# Save the updated environment.
env_contents = composer.compose_environment(environment)
self.plan_store.update_environment(plan_uuid, env_contents)
updated_plan = self.retrieve_plan(plan_uuid)
return updated_plan
def package_templates(self, plan_uuid):
"""Packages and returns all of the templates related to the given plan.
The returned dictionary is keyed by filename and contains the contents
of that file (a template or an environment file).
:type plan_uuid: str
:return: mapping of filename to contents for each file in the plan
:rtype: dict
:raises tuskar.storage.exceptions.UnknownUUID: if there is no plan
with the given UUID
"""
# Load and parse the plan.
db_plan = self.plan_store.retrieve(plan_uuid)
master_template = parser.parse_template(
db_plan.master_template.contents
)
environment = parser.parse_environment(
db_plan.environment_file.contents
)
# Compose the plan files and all plan roles and package them into
# a single dictionary.
plan_contents = composer.compose_template(master_template)
env_contents = composer.compose_environment(environment)
files_dict = {
'plan.yaml': plan_contents,
'environment.yaml': env_contents,
}
plan_roles = self._find_roles(environment)
for role in plan_roles:
contents = composer.compose_template(role.template)
filename = name_utils.role_template_filename(role.name,
role.version)
files_dict[filename] = contents
return files_dict
def _find_roles(self, environment):
"""Returns a list of roles for a plan (identified by the given
environment).
:type environment: tuskar.templates.heat.Environment
:return: list of role instances; empty list if none are in the
environment
:rtype: [tuskar.manager.models.Role]
"""
def load_role(entry):
# Figure out the role name/version for the given entry.
namespace = ns_utils.remove_resource_alias_namespace(entry.alias)
name, version = name_utils.parse_role_namespace(namespace)
# Load the role from the database and parse into the
# template objects.
db_role = self.template_store.retrieve_by_name(name, int(version))
role = self._role_to_template_object(db_role)
# Convert to the Tuskar domain model.
tuskar_role = models.Role(db_role.uuid, name, version,
role.description, role)
return tuskar_role
roles = [load_role(e) for e in environment.registry_entries]
return roles
@staticmethod
def _find_parameters(template, environment):
"""Returns a list of parameters for a plan. The parameters will contain
both metadata about the parameter itself (name, label, description,
etc.) as well as it's current value for the plan.
:type template: tuskar.templates.heat.Template
:type environment: tuskar.templates.heat.Environment
:return: list of parameter instances; empty list if there are no
parameters in the plan
:rtype: [tuskar.manager.models.PlanParameter]
"""
def generate_param(p):
env_param = environment.find_parameter_by_name(p.name)
return models.PlanParameter(
p.name, env_param.value, p.param_type,
p.description, p.label, p.default, p.hidden
)
params = [generate_param(tp) for tp in template.parameters]
return params
@staticmethod
def _plan_to_template_object(db_plan):
master_template = parser.parse_template(
db_plan.master_template.contents
)
environment = parser.parse_environment(
db_plan.environment_file.contents
)
deployment_plan = plan.DeploymentPlan(master_template=master_template,
environment=environment)
return deployment_plan
@staticmethod
def _role_to_template_object(db_role):
role_template = parser.parse_template(db_role.contents)
return role_template
def _save_updated_plan(self, plan_uuid, deployment_plan):
new_template_contents = composer.compose_template(
deployment_plan.master_template
)
new_env_contents = composer.compose_environment(
deployment_plan.environment
)
self.plan_store.update_master_template(plan_uuid,
new_template_contents)
self.plan_store.update_environment(plan_uuid,
new_env_contents)
# Retrieve and return the updated plan
updated_plan = self.retrieve_plan(plan_uuid)
return updated_plan