Github user mxmrlv commented on a diff in the pull request:
https://github.com/apache/incubator-ariatosca/pull/72#discussion_r104933586
--- Diff: aria/modeling/service.py ---
@@ -0,0 +1,1529 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You 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.
+
+# pylint: disable=no-self-argument, no-member, abstract-method
+
+from sqlalchemy import (
+ Column,
+ Text,
+ Integer
+)
+from sqlalchemy import DateTime
+from sqlalchemy.ext.associationproxy import association_proxy
+from sqlalchemy.ext.declarative import declared_attr
+
+from .bases import InstanceModelMixin
+from ..parser import validation
+from ..utils import collections, formatting, console
+
+from . import (
+ utils,
+ types as modeling_types
+)
+
+
+class ServiceBase(InstanceModelMixin): # pylint:
disable=too-many-public-methods
+ """
+ A service is usually an instance of a :class:`ServiceTemplate`.
+
+ You will usually not create it programmatically, but instead
instantiate it from a service
+ template.
+
+ :ivar name: Name (unique for this ARIA installation)
+ :vartype name: basestring
+ :ivar service_template: Template from which this service was
instantiated (optional)
+ :vartype service_template: :class:`ServiceTemplate`
+ :ivar description: Human-readable description
+ :vartype description: string
+ :ivar meta_data: Custom annotations
+ :vartype meta_data: {basestring: :class:`Metadata`}
+ :ivar node: Nodes
+ :vartype node: [:class:`Node`]
+ :ivar groups: Groups of nodes
+ :vartype groups: [:class:`Group`]
+ :ivar policies: Policies
+ :vartype policies: [:class:`Policy`]
+ :ivar substitution: The entire service can appear as a node
+ :vartype substitution: :class:`Substitution`
+ :ivar inputs: Externally provided parameters
+ :vartype inputs: {basestring: :class:`Parameter`}
+ :ivar outputs: These parameters are filled in after service
installation
+ :vartype outputs: {basestring: :class:`Parameter`}
+ :ivar operations: Custom operations that can be performed on the
service
+ :vartype operations: {basestring: :class:`Operation`}
+ :ivar plugins: Plugins required to be installed
+ :vartype plugins: {basestring: :class:`Plugin`}
+ :ivar created_at: Creation timestamp
+ :vartype created_at: :class:`datetime.datetime`
+ :ivar updated_at: Update timestamp
+ :vartype updated_at: :class:`datetime.datetime`
+
+ :ivar permalink: ??
+ :vartype permalink: basestring
+ :ivar scaling_groups: ??
+ :vartype scaling_groups: {}
+
+ :ivar modifications: Modifications of this service
+ :vartype modifications: [:class:`ServiceModification`]
+ :ivar updates: Updates of this service
+ :vartype updates: [:class:`ServiceUpdate`]
+ :ivar executions: Executions on this service
+ :vartype executions: [:class:`Execution`]
+ """
+
+ __tablename__ = 'service'
+
+ @declared_attr
+ def service_template(cls):
+ return cls.many_to_one_relationship('service_template')
+
+ description = Column(Text)
+
+ @declared_attr
+ def meta_data(cls):
+ # Warning! We cannot use the attr name "metadata" because it's
used by SqlAlchemy!
+ return cls.many_to_many_relationship('metadata', dict_key='name')
+
+ @declared_attr
+ def nodes(cls):
+ return cls.one_to_many_relationship('node')
+
+ @declared_attr
+ def groups(cls):
+ return cls.one_to_many_relationship('group')
+
+ @declared_attr
+ def policies(cls):
+ return cls.one_to_many_relationship('policy')
+
+ @declared_attr
+ def substitution(cls):
+ return cls.one_to_one_relationship('substitution')
+
+ @declared_attr
+ def inputs(cls):
+ return cls.many_to_many_relationship('parameter',
table_prefix='inputs',
+ dict_key='name')
+
+ @declared_attr
+ def outputs(cls):
+ return cls.many_to_many_relationship('parameter',
table_prefix='outputs',
+ dict_key='name')
+
+ @declared_attr
+ def operations(cls):
+ return cls.one_to_many_relationship('operation', dict_key='name')
+
+ @declared_attr
+ def plugins(cls):
+ return cls.many_to_many_relationship('plugin')
+
+ created_at = Column(DateTime, nullable=False, index=True)
+ updated_at = Column(DateTime)
+
+ # region orchestration
+
+ permalink = Column(Text)
+ scaling_groups = Column(modeling_types.Dict)
+
+ # endregion
+
+ # region foreign keys
+
+ __private_fields__ = ['substituion_fk',
+ 'service_template_fk']
+
+ # Service one-to-one to Substitution
+ @declared_attr
+ def substitution_fk(cls):
+ return cls.foreign_key('substitution', nullable=True)
+
+ # Service many-to-one to ServiceTemplate
+ @declared_attr
+ def service_template_fk(cls):
+ return cls.foreign_key('service_template', nullable=True)
+
+ # endregion
+
+ def satisfy_requirements(self, context):
+ satisfied = True
+ for node in self.nodes:
+ if not node.satisfy_requirements(context):
+ satisfied = False
+ return satisfied
+
+ def validate_capabilities(self, context):
+ satisfied = True
+ for node in self.nodes:
+ if not node.validate_capabilities(context):
+ satisfied = False
+ return satisfied
+
+ def find_nodes(self, node_template_name):
+ nodes = []
+ for node in self.nodes:
+ if node.node_template.name == node_template_name:
+ nodes.append(node)
+ return collections.FrozenList(nodes)
+
+ def get_node_ids(self, node_template_name):
+ return collections.FrozenList((node.name for node in
self.find_nodes(node_template_name)))
+
+ def find_groups(self, group_template_name):
+ groups = []
+ for group in self.groups:
+ if group.template_name == group_template_name:
+ groups.append(group)
+ return collections.FrozenList(groups)
+
+ def get_group_ids(self, group_template_name):
+ return collections.FrozenList((group.name
+ for group in
self.find_groups(group_template_name)))
+
+ def is_node_a_target(self, context, target_node):
+ for node in self.nodes:
+ if self._is_node_a_target(context, node, target_node):
+ return True
+ return False
+
+ def _is_node_a_target(self, context, source_node, target_node):
+ if source_node.relationships:
+ for relationship in source_node.relationships:
+ if relationship.target_node_id == target_node.name:
+ return True
+ else:
+ node =
context.modeling.instance.nodes.get(relationship.target_node_id)
+ if node is not None:
+ if self._is_node_a_target(context, node,
target_node):
+ return True
+ return False
+
+ @property
+ def as_raw(self):
+ return collections.OrderedDict((
+ ('description', self.description),
+ ('metadata', formatting.as_raw_dict(self.meta_data)),
+ ('nodes', formatting.as_raw_list(self.nodes)),
+ ('groups', formatting.as_raw_list(self.groups)),
+ ('policies', formatting.as_raw_list(self.policies)),
+ ('substitution', formatting.as_raw(self.substitution)),
+ ('inputs', formatting.as_raw_dict(self.inputs)),
+ ('outputs', formatting.as_raw_dict(self.outputs)),
+ ('operations', formatting.as_raw_list(self.operations))))
+
+ def validate(self, context):
+ utils.validate_dict_values(context, self.meta_data)
+ utils.validate_list_values(context, self.nodes)
+ utils.validate_list_values(context, self.groups)
+ utils.validate_list_values(context, self.policies)
+ if self.substitution is not None:
+ self.substitution.validate(context)
+ utils.validate_dict_values(context, self.inputs)
+ utils.validate_dict_values(context, self.outputs)
+ utils.validate_dict_values(context, self.operations)
+
+ def coerce_values(self, context, container, report_issues):
+ utils.coerce_dict_values(context, container, self.meta_data,
report_issues)
+ utils.coerce_list_values(context, container, self.nodes,
report_issues)
+ utils.coerce_list_values(context, container, self.groups,
report_issues)
+ utils.coerce_list_values(context, container, self.policies,
report_issues)
+ if self.substitution is not None:
+ self.substitution.coerce_values(context, container,
report_issues)
+ utils.coerce_dict_values(context, container, self.inputs,
report_issues)
+ utils.coerce_dict_values(context, container, self.outputs,
report_issues)
+ utils.coerce_dict_values(context, container, self.operations,
report_issues)
+
+ def dump(self, context):
+ if self.description is not None:
+ console.puts(context.style.meta(self.description))
+ utils.dump_dict_values(context, self.meta_data, 'Metadata')
+ for node in self.nodes:
+ node.dump(context)
+ for group in self.groups:
+ group.dump(context)
+ for policy in self.policies:
+ policy.dump(context)
+ if self.substitution is not None:
+ self.substitution.dump(context)
+ utils.dump_dict_values(context, self.inputs, 'Inputs')
+ utils.dump_dict_values(context, self.outputs, 'Outputs')
+ utils.dump_dict_values(context, self.operations, 'Operations')
+
+ def dump_graph(self, context):
+ for node in self.nodes.itervalues():
+ if not self.is_node_a_target(context, node):
+ self._dump_graph_node(context, node)
+
+ def _dump_graph_node(self, context, node):
+ console.puts(context.style.node(node.name))
+ if node.relationships:
+ with context.style.indent:
+ for relationship in node.relationships:
+ relationship_name =
(context.style.node(relationship.template_name)
+ if relationship.template_name is
not None
+ else
context.style.type(relationship.type_name))
+ capability_name =
(context.style.node(relationship.target_capability_name)
+ if
relationship.target_capability_name is not None
+ else None)
+ if capability_name is not None:
+ console.puts('-> {0}
{1}'.format(relationship_name, capability_name))
+ else:
+ console.puts('-> {0}'.format(relationship_name))
+ target_node =
self.nodes.get(relationship.target_node_id)
+ with console.indent(3):
+ self._dump_graph_node(context, target_node)
+
+
+class NodeBase(InstanceModelMixin):
+ """
+ Usually an instance of a :class:`NodeTemplate`.
+
+ Nodes may have zero or more :class:`Relationship` instances to other
nodes.
+
+ :ivar name: Name (unique for this service)
+ :vartype name: basestring
+ :ivar node_template: Template from which this node was instantiated
(optional)
+ :vartype node_template: :class:`NodeTemplate`
+ :ivar type: Node type
+ :vartype type: :class:`Type`
+ :ivar description: Human-readable description
+ :vartype description: string
+ :ivar properties: Associated parameters
+ :vartype properties: {basestring: :class:`Parameter`}
+ :ivar interfaces: Bundles of operations
+ :vartype interfaces: {basestring: :class:`Interface`}
+ :ivar artifacts: Associated files
+ :vartype artifacts: {basestring: :class:`Artifact`}
+ :ivar capabilities: Exposed capabilities
+ :vartype capabilities: {basestring: :class:`Capability`}
+ :ivar outbound_relationships: Relationships to other nodes
+ :vartype outbound_relationships: [:class:`Relationship`]
+ :ivar inbound_relationships: Relationships from other nodes
+ :vartype inbound_relationships: [:class:`Relationship`]
+ :ivar plugins: Plugins required to be installed on the node's host
+ :vartype plugins: {basestring: :class:`Plugin`}
+ :ivar host: Host node (can be self)
+ :vartype host: :class:`Node`
+
+ :ivar runtime_properties: TODO: should be replaced with attributes
+ :vartype runtime_properties: {}
+ :ivar scaling_groups: ??
+ :vartype scaling_groups: []
+ :ivar state: ??
+ :vartype state: basestring
+ :ivar version: ??
+ :vartype version: int
+
+ :ivar service: Containing service
+ :vartype service: :class:`Service`
+ :ivar groups: We are a member of these groups
+ :vartype groups: [:class:`Group`]
+ :ivar policies: Policies enacted on this node
+ :vartype policies: [:class:`Policy`]
+ :ivar substitution_mapping: Our contribution to service substitution
+ :vartype substitution_mapping: :class:`SubstitutionMapping`
+ :ivar tasks: Tasks on this node
+ :vartype tasks: [:class:`Task`]
+ """
+
+ __tablename__ = 'node'
+
+ @declared_attr
+ def node_template(cls):
+ return cls.many_to_one_relationship('node_template')
+
+ @declared_attr
+ def type(cls):
+ return cls.many_to_one_relationship('type')
+
+ description = Column(Text)
+
+ @declared_attr
+ def properties(cls):
+ return cls.many_to_many_relationship('parameter',
table_prefix='properties',
+ dict_key='name')
+
+ @declared_attr
+ def interfaces(cls):
+ return cls.one_to_many_relationship('interface', dict_key='name')
+
+ @declared_attr
+ def artifacts(cls):
+ return cls.one_to_many_relationship('artifact', dict_key='name')
+
+ @declared_attr
+ def capabilities(cls):
+ return cls.one_to_many_relationship('capability', dict_key='name')
+
+ @declared_attr
+ def outbound_relationships(cls):
+ return cls.one_to_many_relationship('relationship',
+ foreign_key='source_node_fk',
+ backreference='source_node')
+
+ @declared_attr
+ def inbound_relationships(cls):
+ return cls.one_to_many_relationship('relationship',
+ foreign_key='target_node_fk',
+ backreference='target_node')
+
+ @declared_attr
+ def plugins(cls):
+ return cls.many_to_many_relationship('plugin')
+
+ @declared_attr
+ def host(cls):
+ return cls.relationship_to_self('host_fk')
+
+ # region orchestration
+
+ runtime_properties = Column(modeling_types.Dict)
+ scaling_groups = Column(modeling_types.List)
+ state = Column(Text, nullable=False)
+ version = Column(Integer, default=1)
+
+ @declared_attr
+ def service_name(cls):
+ return association_proxy('service', 'name')
+
+ @property
+ def ip(self):
+ # TODO: totally broken
+ if not self.host_fk:
+ return None
+ host_node = self.host
+ if 'ip' in host_node.runtime_properties: # pylint:
disable=no-member
+ return host_node.runtime_properties['ip'] # pylint:
disable=no-member
+ host_node = host_node.node_template # pylint: disable=no-member
+ host_ip_property = host_node.properties.get('ip')
+ if host_ip_property:
+ return host_ip_property.value
+ return None
+
+ # endregion
+
+ # region foreign_keys
+
+ __private_fields__ = ['type_fk',
+ 'host_fk',
+ 'service_fk',
+ 'node_template_fk']
+
+ # Node many-to-one to Type
+ @declared_attr
+ def type_fk(cls):
+ return cls.foreign_key('type')
+
+ # Node one-to-one to Node
+ @declared_attr
+ def host_fk(cls):
+ return cls.foreign_key('node', nullable=True)
+
+ # Service one-to-many to Node
+ @declared_attr
+ def service_fk(cls):
+ return cls.foreign_key('service')
+
+ # Node many-to-one to NodeTemplate
+ @declared_attr
+ def node_template_fk(cls):
+ return cls.foreign_key('node_template', nullable=True)
+
+ # endregion
+
+ def satisfy_requirements(self, context):
+ node_template = self.node_template
+ satisfied = True
+ for requirement_template in node_template.requirement_templates:
+ # Find target template
+ target_node_template, target_node_capability = \
+ requirement_template.find_target(context, node_template)
+ if target_node_template is not None:
+ satisfied = self._satisfy_capability(context,
+
target_node_capability,
+ target_node_template,
+ requirement_template)
+ else:
+ context.validation.report('requirement "{0}" of node "{1}"
has no target node '
--- End diff --
there should be unified model for logging, it's weird that some log msgs,
while other report it to the parser's context...
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
