# 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. import os import six from toscaparser.common import exception import toscaparser.elements.interfaces as ifaces from toscaparser.elements.nodetype import NodeType from toscaparser.functions import GetInput from toscaparser.functions import GetProperty from toscaparser.nodetemplate import NodeTemplate from toscaparser.tests.base import TestCase from toscaparser.tosca_template import ToscaTemplate import toscaparser.utils.yamlparser class ToscaTemplateTest(TestCase): '''TOSCA template.''' tosca_tpl = os.path.join( os.path.dirname(os.path.abspath(__file__)), "data/tosca_single_instance_wordpress.yaml") tosca = ToscaTemplate(tosca_tpl) tosca_elk_tpl = os.path.join( os.path.dirname(os.path.abspath(__file__)), "data/tosca_elk.yaml") def test_version(self): self.assertEqual(self.tosca.version, "tosca_simple_yaml_1_0") def test_description(self): expected_description = "TOSCA simple profile with wordpress, " \ "web server and mysql on the same server." self.assertEqual(self.tosca.description, expected_description) def test_inputs(self): self.assertEqual( ['cpus', 'db_name', 'db_port', 'db_pwd', 'db_root_pwd', 'db_user'], sorted([input.name for input in self.tosca.inputs])) input_name = "db_port" expected_description = "Port for the MySQL database." for input in self.tosca.inputs: if input.name == input_name: self.assertEqual(input.description, expected_description) def test_node_tpls(self): '''Test nodetemplate names.''' self.assertEqual( ['mysql_database', 'mysql_dbms', 'server', 'webserver', 'wordpress'], sorted([tpl.name for tpl in self.tosca.nodetemplates])) tpl_name = "mysql_database" expected_type = "tosca.nodes.Database" expected_properties = ['name', 'password', 'user'] expected_capabilities = ['database_endpoint'] expected_requirements = [{'host': {'node': 'mysql_dbms'}}] ''' TODO: needs enhancement in tosca_elk.yaml.. expected_relationshp = ['tosca.relationships.HostedOn'] expected_host = ['mysql_dbms'] ''' expected_interface = [ifaces.LIFECYCLE_SHORTNAME] for tpl in self.tosca.nodetemplates: if tpl_name == tpl.name: '''Test node type.''' self.assertEqual(tpl.type, expected_type) '''Test properties.''' self.assertEqual( expected_properties, sorted(tpl.get_properties().keys())) '''Test capabilities.''' self.assertEqual( expected_capabilities, sorted(tpl.get_capabilities().keys())) '''Test requirements.''' self.assertEqual( expected_requirements, tpl.requirements) '''Test relationship.''' ''' needs enhancements in tosca_elk.yaml self.assertEqual( expected_relationshp, [x.type for x in tpl.relationships.keys()]) self.assertEqual( expected_host, [y.name for y in tpl.relationships.values()]) ''' '''Test interfaces.''' self.assertEqual( expected_interface, [x.type for x in tpl.interfaces]) if tpl.name == 'server': '''Test property value''' props = tpl.get_properties() if props and 'mem_size' in props.keys(): self.assertEqual(props['mem_size'].value, '4096 MB') '''Test capability''' caps = tpl.get_capabilities() self.assertIn('os', caps.keys()) os_props_objs = None os_props = None os_type_prop = None if caps and 'os' in caps.keys(): capability = caps['os'] os_props_objs = capability.get_properties_objects() os_props = capability.get_properties() os_type_prop = capability.get_property_value('type') break self.assertEqual( ['Linux'], [p.value for p in os_props_objs if p.name == 'type']) self.assertEqual( 'Linux', os_props['type'].value if 'type' in os_props else '') self.assertEqual('Linux', os_props['type'].value) self.assertEqual('Linux', os_type_prop) def test_outputs(self): self.assertEqual( ['website_url'], sorted([output.name for output in self.tosca.outputs])) def test_interfaces(self): wordpress_node = [ node for node in self.tosca.nodetemplates if node.name == 'wordpress'][0] interfaces = wordpress_node.interfaces self.assertEqual(2, len(interfaces)) for interface in interfaces: if interface.name == 'create': self.assertEqual(ifaces.LIFECYCLE_SHORTNAME, interface.type) self.assertEqual('wordpress/wordpress_install.sh', interface.implementation) self.assertIsNone(interface.inputs) elif interface.name == 'configure': self.assertEqual(ifaces.LIFECYCLE_SHORTNAME, interface.type) self.assertEqual('wordpress/wordpress_configure.sh', interface.implementation) self.assertEqual(3, len(interface.inputs)) TestCase.skip(self, 'bug #1440247') wp_db_port = interface.inputs['wp_db_port'] self.assertTrue(isinstance(wp_db_port, GetProperty)) self.assertEqual('get_property', wp_db_port.name) self.assertEqual(['SELF', 'database_endpoint', 'port'], wp_db_port.args) result = wp_db_port.result() self.assertTrue(isinstance(result, GetInput)) else: raise AssertionError( 'Unexpected interface: {0}'.format(interface.name)) def test_normative_type_by_short_name(self): # test template with a short name Compute template = os.path.join( os.path.dirname(os.path.abspath(__file__)), "data/test_tosca_normative_type_by_shortname.yaml") tosca_tpl = ToscaTemplate(template) expected_type = "tosca.nodes.Compute" for tpl in tosca_tpl.nodetemplates: self.assertEqual(tpl.type, expected_type) for tpl in tosca_tpl.nodetemplates: compute_type = NodeType(tpl.type) self.assertEqual( sorted(['tosca.capabilities.Container', 'tosca.capabilities.OperatingSystem', 'tosca.capabilities.network.Bindable', 'tosca.capabilities.Scalable']), sorted([c.type for c in compute_type.get_capabilities_objects()])) def test_template_with_no_inputs(self): tosca_tpl = self._load_template('test_no_inputs_in_template.yaml') self.assertEqual(0, len(tosca_tpl.inputs)) def test_template_with_no_outputs(self): tosca_tpl = self._load_template('test_no_outputs_in_template.yaml') self.assertEqual(0, len(tosca_tpl.outputs)) def test_relationship_interface(self): template = ToscaTemplate(self.tosca_elk_tpl) for node_tpl in template.nodetemplates: if node_tpl.name == 'logstash': config_interface = 'Configure' artifact = 'logstash/configure_elasticsearch.py' relation = node_tpl.relationships for key in relation.keys(): rel_tpl = relation.get(key).get_relationship_template() if rel_tpl: interfaces = rel_tpl[0].interfaces for interface in interfaces: self.assertEqual(config_interface, interface.type) self.assertEqual('pre_configure_source', interface.name) self.assertEqual(artifact, interface.implementation) def test_template_macro(self): template = ToscaTemplate(self.tosca_elk_tpl) for node_tpl in template.nodetemplates: if node_tpl.name == 'mongo_server': self.assertEqual( ['disk_size', 'mem_size', 'num_cpus'], sorted(node_tpl.get_capability('host'). get_properties().keys())) def test_template_requirements(self): """Test different formats of requirements The requirements can be defined in few different ways, 1. Requirement expressed as a capability with an implicit relationship. 2. Requirement expressed with explicit relationship. 3. Requirement expressed with a relationship template. 4. Requirement expressed via TOSCA types to provision a node with explicit relationship. 5. Requirement expressed via TOSCA types with a filter. """ tosca_tpl = os.path.join( os.path.dirname(os.path.abspath(__file__)), "data/test_requirements.yaml") tosca = ToscaTemplate(tosca_tpl) for node_tpl in tosca.nodetemplates: if node_tpl.name == 'my_app': expected_relationship = [ ('tosca.relationships.ConnectsTo', 'mysql_database'), ('tosca.relationships.HostedOn', 'my_webserver')] actual_relationship = sorted([ (relation.type, node.name) for relation, node in node_tpl.relationships.items()]) self.assertEqual(expected_relationship, actual_relationship) if node_tpl.name == 'mysql_database': self.assertEqual( [('tosca.relationships.HostedOn', 'my_dbms')], [(relation.type, node.name) for relation, node in node_tpl.relationships.items()]) if node_tpl.name == 'my_server': self.assertEqual( [('tosca.relationships.AttachesTo', 'my_storage')], [(relation.type, node.name) for relation, node in node_tpl.relationships.items()]) def test_template_requirements_not_implemented(self): # TODO(spzala): replace this test with new one once TOSCA types look up # support is implemented. """Requirements that yet need to be implemented The following requirement formats are not yet implemented, due to look up dependency: 1. Requirement expressed via TOSCA types to provision a node with explicit relationship. 2. Requirement expressed via TOSCA types with a filter. """ tpl_snippet_1 = ''' node_templates: mysql_database: type: tosca.nodes.Database description: Requires a particular node type and relationship. To be full-filled via lookup into node repository. requirements: - req1: node: tosca.nodes.DBMS relationship: tosca.relationships.HostedOn ''' tpl_snippet_2 = ''' node_templates: my_webserver: type: tosca.nodes.WebServer description: Requires a particular node type with a filter. To be full-filled via lookup into node repository. requirements: - req1: node: tosca.nodes.Compute target_filter: properties: num_cpus: { in_range: [ 1, 4 ] } mem_size: { greater_or_equal: 2 } capabilities: - tosca.capabilities.OS: properties: architecture: x86_64 type: linux ''' tpl_snippet_3 = ''' node_templates: my_webserver2: type: tosca.nodes.WebServer description: Requires a node type with a particular capability. To be full-filled via lookup into node repository. requirements: - req1: node: tosca.nodes.Compute relationship: tosca.relationships.HostedOn capability: tosca.capabilities.Container ''' self._requirements_not_implemented(tpl_snippet_1, 'mysql_database') self._requirements_not_implemented(tpl_snippet_2, 'my_webserver') self._requirements_not_implemented(tpl_snippet_3, 'my_webserver2') def _requirements_not_implemented(self, tpl_snippet, tpl_name): nodetemplates = (toscaparser.utils.yamlparser. simple_parse(tpl_snippet))['node_templates'] self.assertRaises( NotImplementedError, lambda: NodeTemplate(tpl_name, nodetemplates).relationships) def test_custom_capability_type_definition(self): tpl_snippet = ''' node_templates: test_app: type: tosca.nodes.WebApplication.TestApp capabilities: test_cap: properties: test: 1 ''' # custom definition with capability type definition custom_def = ''' tosca.nodes.WebApplication.TestApp: derived_from: tosca.nodes.WebApplication capabilities: test_cap: type: tosca.capabilities.TestCapability tosca.capabilities.TestCapability: derived_from: tosca.capabilities.Root properties: test: type: integer required: no ''' expected_capabilities = ['test_cap'] nodetemplates = (toscaparser.utils.yamlparser. simple_parse(tpl_snippet))['node_templates'] custom_def = (toscaparser.utils.yamlparser. simple_parse(custom_def)) name = list(nodetemplates.keys())[0] tpl = NodeTemplate(name, nodetemplates, custom_def) self.assertEqual( expected_capabilities, sorted(tpl.get_capabilities().keys())) # custom definition without capability type definition custom_def = ''' tosca.nodes.WebApplication.TestApp: derived_from: tosca.nodes.WebApplication capabilities: test_cap: type: tosca.capabilities.TestCapability ''' custom_def = (toscaparser.utils.yamlparser. simple_parse(custom_def)) tpl = NodeTemplate(name, nodetemplates, custom_def) err = self.assertRaises( exception.InvalidTypeError, lambda: NodeTemplate(name, nodetemplates, custom_def).get_capabilities_objects()) self.assertEqual('Type "tosca.capabilities.TestCapability" is not ' 'a valid type.', six.text_type(err))