PLC/Methods/AddSliceTag.py

   1 #
   2 # Thierry Parmentelat - INRIA
   3 #
   4 from PLC.Faults import *
   5 from PLC.Method import Method
   6 from PLC.Parameter import Parameter, Mixed
   7 from PLC.Auth import Auth
   8
   9 from PLC.TagTypes import TagType, TagTypes
  10 from PLC.Slices import Slice, Slices
  11 from PLC.Nodes import Node, Nodes
  12 from PLC.SliceTags import SliceTag, SliceTags
  13 from PLC.NodeGroups import NodeGroup, NodeGroups
  14 from PLC.InitScripts import InitScript, InitScripts
  15
  16 class AddSliceTag(Method):
  17     """
  18     Sets the specified tag of the slice to the specified value.
  19     If nodegroup is specified, this applies to all slivers of that group.
  20     If node is specified, this only applies to a sliver.
  21
  22     Admins have full access, including on nodegroups.
  23
  24     Non-admins need to have at least one of the roles
  25     attached to the tagtype. In addition:
  26     (*) Users may only set tags of slices or slivers of which they are members.
  27     (*) PIs may only set tags of slices in their site
  28     (*) techs cannot use this method
  29
  30     Returns the new slice_tag_id (> 0) if successful, faults
  31     otherwise.
  32     """
  33
  34     roles = ['admin', 'pi', 'user', 'node']
  35
  36     accepts = [
  37         Auth(),
  38         Mixed(Slice.fields['slice_id'],
  39               Slice.fields['name']),
  40         Mixed(SliceTag.fields['tag_type_id'],
  41               SliceTag.fields['tagname']),
  42         Mixed(SliceTag.fields['value'],
  43               InitScript.fields['name']),
  44         Mixed(Node.fields['node_id'],
  45               Node.fields['hostname'],
  46               None),
  47         Mixed(NodeGroup.fields['nodegroup_id'],
  48               NodeGroup.fields['groupname'])
  49         ]
  50
  51     returns = Parameter(int, 'New slice_tag_id (> 0) if successful')
  52
  53     def call(self, auth, slice_id_or_name, tag_type_id_or_name, value, node_id_or_hostname = None, nodegroup_id_or_name = None):
  54         slices = Slices(self.api, [slice_id_or_name])
  55         if not slices:
  56             raise PLCInvalidArgument, "No such slice %r"%slice_id_or_name
  57         slice = slices[0]
  58
  59         tag_types = TagTypes(self.api, [tag_type_id_or_name])
  60         if not tag_types:
  61             raise PLCInvalidArgument, "No such tag type %r"%tag_type_id_or_name
  62         tag_type = tag_types[0]
  63
  64         # check authorizations
  65         slice.caller_may_write_tag (self.api,self.caller,tag_type,node_id_or_hostname,nodegroup_id_or_name)
  66
  67         # if initscript is specified, validate value
  68         if tag_type['tagname'] in ['initscript']:
  69             initscripts = InitScripts(self.api, {'enabled': True, 'name': value})
  70             if not initscripts:
  71                 raise PLCInvalidArgument, "No such plc initscript %r"%value
  72
  73         slice_tag = SliceTag(self.api)
  74         slice_tag['slice_id'] = slice['slice_id']
  75         slice_tag['tag_type_id'] = tag_type['tag_type_id']
  76         slice_tag['value'] = unicode(value)
  77
  78         # Sliver attribute if node is specified
  79         if node_id_or_hostname is not None or isinstance(self.caller, Node):
  80             node_id = None
  81             if isinstance(self.caller, Node):
  82                 node = self.caller
  83                 node_id = node['node_id']
  84
  85             if node_id_or_hostname is not None:
  86                 nodes = Nodes(self.api, [node_id_or_hostname])
  87                 if not nodes:
  88                     raise PLCInvalidArgument, "No such node"
  89                 node = nodes[0]
  90                 if node_id <> None and node_id <> node['node_id']:
  91                     raise PLCPermissionDenied, "Not allowed to set another node's sliver attribute"
  92                 else:
  93                     node_id = node['node_id']
  94
  95             system_slice_tags = SliceTags(self.api, {'tagname': 'system', 'value': '1'}).dict('slice_id')
  96             system_slice_ids = system_slice_tags.keys()
  97             if slice['slice_id'] not in system_slice_ids and node_id not in slice['node_ids']:
  98                 raise PLCInvalidArgument, "AddSliceTag: slice %s not on specified node %s nor is it a system slice (%r)"%\
  99                     (slice['name'],node['hostname'],system_slice_ids)
 100             slice_tag['node_id'] = node['node_id']
 101
 102         # Sliver attribute shared accross nodes if nodegroup is sepcified
 103         if nodegroup_id_or_name is not None:
 104             if isinstance(self.caller, Node):
 105                 raise PLCPermissionDenied, "Not allowed to set nodegroup slice attributes"
 106
 107             nodegroups = NodeGroups(self.api, [nodegroup_id_or_name])
 108             if not nodegroups:
 109                 raise PLCInvalidArgument, "No such nodegroup %r"%nodegroup_id_or_name
 110             nodegroup = nodegroups[0]
 111
 112             slice_tag['nodegroup_id'] = nodegroup['nodegroup_id']
 113
 114         # Check if slice attribute already exists
 115         slice_tags_check = SliceTags(self.api, {'slice_id': slice['slice_id'],
 116                                                 'tagname': tag_type['tagname'],
 117                                                 'value': value})
 118         for slice_tag_check in slice_tags_check:
 119             # do not compare between slice tag and sliver tag
 120             if 'node_id' not in slice_tag and slice_tag_check['node_id'] is not None:
 121                 continue
 122             # do not compare between sliver tag and slice tag
 123             if 'node_id' in slice_tag and slice_tag['node_id'] is not None and slice_tag_check['node_id'] is None:
 124                 continue
 125             if 'node_id' in slice_tag and slice_tag['node_id'] == slice_tag_check['node_id']:
 126                 raise PLCInvalidArgument, "Sliver attribute already exists"
 127             if 'nodegroup_id' in slice_tag and slice_tag['nodegroup_id'] == slice_tag_check['nodegroup_id']:
 128                 raise PLCInvalidArgument, "Slice attribute already exists for this nodegroup"
 129             if node_id_or_hostname is None and nodegroup_id_or_name is None:
 130                 raise PLCInvalidArgument, "Slice attribute already exists"
 131
 132         slice_tag.sync()
 133         self.event_objects = {'SliceTag': [slice_tag['slice_tag_id']]}
 134
 135         return slice_tag['slice_tag_id']