openstack
/
heat
Code Issues Proposed changes

Merge "Move HOT parameters code to a separate module"

This commit is contained in:
Jenkins 2014-03-06 03:18:43 +00:00 committed by Gerrit Code Review
parent d1926ae7fb 0187d01eb8
commit 362e0332ca
5 changed files with 156 additions and 132 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
heat/db/sqlalchemy/migrate_repo/versions/037_migrate_hot_template.py
View File

@ -16,7 +16,7 @@ from sqlalchemy.orm import sessionmaker
from heat.openstack.common.gettextutils import _
from heat.db.sqlalchemy import models
from heat.engine.hot import HOTParamSchema
from heat.engine.hot.parameters import HOTParamSchema
def upgrade(migrate_engine):

131
heat/engine/hot/__init__.py
View File

@ -11,25 +11,15 @@
# License for the specific language governing permissions and limitations
# under the License.
from heat.common import exception
from heat.engine import template
from heat.engine.cfn import template as cfn_template
from heat.engine import parameters
from heat.engine import constraints as constr
from heat.engine.hot import parameters
from heat.openstack.common.gettextutils import _
from heat.openstack.common import log as logging
logger = logging.getLogger(__name__)
PARAM_CONSTRAINTS = (
CONSTRAINTS, DESCRIPTION, LENGTH, RANGE, MIN, MAX,
ALLOWED_VALUES, ALLOWED_PATTERN, CUSTOM_CONSTRAINT,
) = (
'constraints', 'description', 'length', 'range', 'min', 'max',
'allowed_values', 'allowed_pattern', 'custom_constraint',
)
def snake_to_camel(name):
return ''.join([t.capitalize() for t in name.split('_')])
@ -151,121 +141,12 @@ class HOTemplate(template.Template):
def param_schemata(self):
params = self.t.get(self.PARAMETERS, {}).iteritems()
return dict((name, HOTParamSchema.from_dict(schema))
return dict((name, parameters.HOTParamSchema.from_dict(schema))
for name, schema in params)
def parameters(self, stack_identifier, user_params, validate_value=True,
context=None):
return HOTParameters(stack_identifier, self, user_params=user_params,
validate_value=validate_value, context=context)
class HOTParamSchema(parameters.Schema):
"""HOT parameter schema."""
KEYS = (
TYPE, DESCRIPTION, DEFAULT, SCHEMA, CONSTRAINTS,
HIDDEN, LABEL
) = (
'type', 'description', 'default', 'schema', 'constraints',
'hidden', 'label'
)
# For Parameters the type name for Schema.LIST is comma_delimited_list
# and the type name for Schema.MAP is json
TYPES = (
STRING, NUMBER, LIST, MAP,
) = (
'string', 'number', 'comma_delimited_list', 'json',
)
PARAMETER_KEYS = KEYS
@classmethod
def from_dict(cls, schema_dict):
"""
Return a Parameter Schema object from a legacy schema dictionary.
"""
cls._validate_dict(schema_dict)
def constraints():
constraints = schema_dict.get(CONSTRAINTS)
if constraints is None:
return
if not isinstance(constraints, list):
raise constr.InvalidSchemaError(
_("Invalid parameter constraints, expected a list"))
valid_keys = (DESCRIPTION, LENGTH, RANGE, ALLOWED_VALUES,
ALLOWED_PATTERN, CUSTOM_CONSTRAINT)
for constraint in constraints:
cls._check_dict(constraint, valid_keys,
'parameter constraints')
desc = constraint.get(DESCRIPTION)
if RANGE in constraint:
cdef = constraint.get(RANGE)
cls._check_dict(cdef, (MIN, MAX), 'range constraint')
yield constr.Range(parameters.Schema.get_num(MIN, cdef),
parameters.Schema.get_num(MAX, cdef),
desc)
elif LENGTH in constraint:
cdef = constraint.get(LENGTH)
cls._check_dict(cdef, (MIN, MAX), 'length constraint')
yield constr.Length(parameters.Schema.get_num(MIN, cdef),
parameters.Schema.get_num(MAX, cdef),
desc)
elif ALLOWED_VALUES in constraint:
cdef = constraint.get(ALLOWED_VALUES)
yield constr.AllowedValues(cdef, desc)
elif ALLOWED_PATTERN in constraint:
cdef = constraint.get(ALLOWED_PATTERN)
yield constr.AllowedPattern(cdef, desc)
elif CUSTOM_CONSTRAINT in constraint:
cdef = constraint.get(CUSTOM_CONSTRAINT)
yield constr.CustomConstraint(cdef, desc)
else:
raise constr.InvalidSchemaError(
_("No constraint expressed"))
# make update_allowed true by default on TemplateResources
# as the template should deal with this.
return cls(schema_dict[cls.TYPE],
description=schema_dict.get(HOTParamSchema.DESCRIPTION),
default=schema_dict.get(HOTParamSchema.DEFAULT),
constraints=list(constraints()),
hidden=schema_dict.get(HOTParamSchema.HIDDEN, False),
label=schema_dict.get(HOTParamSchema.LABEL))
class HOTParameters(parameters.Parameters):
PSEUDO_PARAMETERS = (
PARAM_STACK_ID, PARAM_STACK_NAME, PARAM_REGION
) = (
'OS::stack_id', 'OS::stack_name', 'OS::region'
)
def set_stack_id(self, stack_identifier):
'''
Set the StackId pseudo parameter value
'''
if stack_identifier is not None:
self.params[self.PARAM_STACK_ID].schema.set_default(
stack_identifier.stack_id)
else:
raise exception.InvalidStackIdentifier()
def _pseudo_parameters(self, stack_identifier):
stack_id = getattr(stack_identifier, 'stack_id', '')
stack_name = getattr(stack_identifier, 'stack_name', '')
yield parameters.Parameter(
self.PARAM_STACK_ID,
parameters.Schema(parameters.Schema.STRING, _('Stack ID'),
default=str(stack_id)))
if stack_name:
yield parameters.Parameter(
self.PARAM_STACK_NAME,
parameters.Schema(parameters.Schema.STRING, _('Stack Name'),
default=stack_name))
return parameters.HOTParameters(stack_identifier, self,
user_params=user_params,
validate_value=validate_value,
context=context)

142
heat/engine/hot/parameters.py Normal file
View File

@ -0,0 +1,142 @@
# vim: tabstop=4 shiftwidth=4 softtabstop=4
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from heat.common import exception
from heat.engine import constraints as constr
from heat.engine import parameters
from heat.openstack.common import log as logging
logger = logging.getLogger(__name__)
PARAM_CONSTRAINTS = (
CONSTRAINTS, DESCRIPTION, LENGTH, RANGE, MIN, MAX,
ALLOWED_VALUES, ALLOWED_PATTERN, CUSTOM_CONSTRAINT,
) = (
'constraints', 'description', 'length', 'range', 'min', 'max',
'allowed_values', 'allowed_pattern', 'custom_constraint',
)
class HOTParamSchema(parameters.Schema):
"""HOT parameter schema."""
KEYS = (
TYPE, DESCRIPTION, DEFAULT, SCHEMA, CONSTRAINTS,
HIDDEN, LABEL
) = (
'type', 'description', 'default', 'schema', 'constraints',
'hidden', 'label'
)
# For Parameters the type name for Schema.LIST is comma_delimited_list
# and the type name for Schema.MAP is json
TYPES = (
STRING, NUMBER, LIST, MAP,
) = (
'string', 'number', 'comma_delimited_list', 'json',
)
PARAMETER_KEYS = KEYS
@classmethod
def from_dict(cls, schema_dict):
"""
Return a Parameter Schema object from a legacy schema dictionary.
"""
cls._validate_dict(schema_dict)
def constraints():
constraints = schema_dict.get(CONSTRAINTS)
if constraints is None:
return
if not isinstance(constraints, list):
raise constr.InvalidSchemaError(
_("Invalid parameter constraints, expected a list"))
valid_keys = (DESCRIPTION, LENGTH, RANGE, ALLOWED_VALUES,
ALLOWED_PATTERN, CUSTOM_CONSTRAINT)
for constraint in constraints:
cls._check_dict(constraint, valid_keys,
'parameter constraints')
desc = constraint.get(DESCRIPTION)
if RANGE in constraint:
cdef = constraint.get(RANGE)
cls._check_dict(cdef, (MIN, MAX), 'range constraint')
yield constr.Range(parameters.Schema.get_num(MIN, cdef),
parameters.Schema.get_num(MAX, cdef),
desc)
elif LENGTH in constraint:
cdef = constraint.get(LENGTH)
cls._check_dict(cdef, (MIN, MAX), 'length constraint')
yield constr.Length(parameters.Schema.get_num(MIN, cdef),
parameters.Schema.get_num(MAX, cdef),
desc)
elif ALLOWED_VALUES in constraint:
cdef = constraint.get(ALLOWED_VALUES)
yield constr.AllowedValues(cdef, desc)
elif ALLOWED_PATTERN in constraint:
cdef = constraint.get(ALLOWED_PATTERN)
yield constr.AllowedPattern(cdef, desc)
elif CUSTOM_CONSTRAINT in constraint:
cdef = constraint.get(CUSTOM_CONSTRAINT)
yield constr.CustomConstraint(cdef, desc)
else:
raise constr.InvalidSchemaError(
_("No constraint expressed"))
# make update_allowed true by default on TemplateResources
# as the template should deal with this.
return cls(schema_dict[cls.TYPE],
description=schema_dict.get(HOTParamSchema.DESCRIPTION),
default=schema_dict.get(HOTParamSchema.DEFAULT),
constraints=list(constraints()),
hidden=schema_dict.get(HOTParamSchema.HIDDEN, False),
label=schema_dict.get(HOTParamSchema.LABEL))
class HOTParameters(parameters.Parameters):
PSEUDO_PARAMETERS = (
PARAM_STACK_ID, PARAM_STACK_NAME, PARAM_REGION
) = (
'OS::stack_id', 'OS::stack_name', 'OS::region'
)
def set_stack_id(self, stack_identifier):
'''
Set the StackId pseudo parameter value
'''
if stack_identifier is not None:
self.params[self.PARAM_STACK_ID].schema.set_default(
stack_identifier.stack_id)
else:
raise exception.InvalidStackIdentifier()
def _pseudo_parameters(self, stack_identifier):
stack_id = getattr(stack_identifier, 'stack_id', '')
stack_name = getattr(stack_identifier, 'stack_name', '')
yield parameters.Parameter(
self.PARAM_STACK_ID,
parameters.Schema(parameters.Schema.STRING, _('Stack ID'),
default=str(stack_id)))
if stack_name:
yield parameters.Parameter(
self.PARAM_STACK_NAME,
parameters.Schema(parameters.Schema.STRING, _('Stack Name'),
default=stack_name))

9
heat/tests/test_hot.py
View File

@ -18,6 +18,7 @@ from heat.engine import function
from heat.engine import parser
from heat.engine import resource
from heat.engine import hot
from heat.engine.hot import parameters as hot_param
from heat.engine import resources
from heat.engine import template
from heat.engine import constraints
@ -706,7 +707,7 @@ class HOTParamValidatorTest(HeatTestCase):
schema = param['db_name']
def v(value):
hot.HOTParamSchema.from_dict(schema).validate(name, value)
hot_param.HOTParamSchema.from_dict(schema).validate(name, value)
return True
value = 'wp'
@ -795,7 +796,7 @@ class HOTParamValidatorTest(HeatTestCase):
schema = param['db_port']
def v(value):
hot.HOTParamSchema.from_dict(schema).validate(name, value)
hot_param.HOTParamSchema.from_dict(schema).validate(name, value)
return True
value = 29999
@ -836,7 +837,7 @@ class HOTParamValidatorTest(HeatTestCase):
schema = param['param1']
def v(value):
hot.HOTParamSchema.from_dict(schema).validate(name, value)
hot_param.HOTParamSchema.from_dict(schema).validate(name, value)
return True
value = "1"
@ -864,7 +865,7 @@ class HOTParamValidatorTest(HeatTestCase):
schema = param['db_port']
err = self.assertRaises(constraints.InvalidSchemaError,
hot.HOTParamSchema.from_dict, schema)
hot_param.HOTParamSchema.from_dict, schema)
self.assertIn(range_desc, str(err))
def test_validate_schema_wrong_key(self):

4
heat/tests/test_properties.py
View File

@ -14,7 +14,7 @@
from heat.engine import constraints
from heat.common import exception
from heat.engine import hot
from heat.engine.hot import parameters as hot_param
from heat.engine import parameters
from heat.engine import properties
from heat.engine import resources
@ -1369,7 +1369,7 @@ class PropertiesTest(testtools.TestCase):
]
}
}
params = dict((n, hot.HOTParamSchema.from_dict(s)) for n, s
params = dict((n, hot_param.HOTParamSchema.from_dict(s)) for n, s
in params_snippet.items())
props_schemata = properties.Properties.schema_from_params(params)