PLC/NodeGroups.py

   1 #
   2 # Functions for interacting with the nodegroups table in the database
   3 #
   4 # Mark Huang <mlhuang@cs.princeton.edu>
   5 # Copyright (C) 2006 The Trustees of Princeton University
   6 #
   7 # $Id: NodeGroups.py,v 1.11 2006/10/03 19:25:30 mlhuang Exp $
   8 #
   9
  10 from types import StringTypes
  11
  12 from PLC.Faults import *
  13 from PLC.Parameter import Parameter
  14 from PLC.Debug import profile
  15 from PLC.Table import Row, Table
  16 from PLC.Nodes import Node, Nodes
  17
  18 class NodeGroup(Row):
  19     """
  20     Representation of a row in the nodegroups table. To use, optionally
  21     instantiate with a dict of values. Update as you would a
  22     dict. Commit to the database with sync().
  23     """
  24
  25     table_name = 'nodegroups'
  26     primary_key = 'nodegroup_id'
  27     fields = {
  28         'nodegroup_id': Parameter(int, "Node group identifier"),
  29         'name': Parameter(str, "Node group name", max = 50),
  30         'description': Parameter(str, "Node group description", max = 200),
  31         'node_ids': Parameter([int], "List of nodes in this node group"),
  32         }
  33
  34     def __init__(self, api, fields = {}):
  35         Row.__init__(self, fields)
  36         self.api = api
  37
  38     def validate_name(self, name):
  39         # Remove leading and trailing spaces
  40         name = name.strip()
  41
  42         # Make sure name is not blank after we removed the spaces
  43         if not len(name) > 0:
  44                 raise PLCInvalidArgument, "Invalid node group name"
  45
  46         # Make sure node group does not alredy exist
  47         conflicts = NodeGroups(self.api, [name])
  48         for nodegroup_id in conflicts:
  49             if 'nodegroup_id' not in self or self['nodegroup_id'] != nodegroup_id:
  50                raise PLCInvalidArgument, "Node group name already in use"
  51
  52         return name
  53
  54     def add_node(self, node, commit = True):
  55         """
  56         Add node to existing nodegroup.
  57         """
  58
  59         assert 'nodegroup_id' in self
  60         assert isinstance(node, Node)
  61         assert 'node_id' in node
  62
  63         node_id = node['node_id']
  64         nodegroup_id = self['nodegroup_id']
  65
  66         if node_id not in self['node_ids']:
  67             assert nodegroup_id not in node['nodegroup_ids']
  68
  69             self.api.db.do("INSERT INTO nodegroup_node (nodegroup_id, node_id)" \
  70                            " VALUES(%(nodegroup_id)d, %(node_id)d)",
  71                            locals())
  72
  73             if commit:
  74                 self.api.db.commit()
  75
  76             self['node_ids'].append(node_id)
  77             node['nodegroup_ids'].append(nodegroup_id)
  78
  79     def remove_node(self, node, commit = True):
  80         """
  81         Remove node from existing nodegroup.
  82         """
  83
  84         assert 'nodegroup_id' in self
  85         assert isinstance(node, Node)
  86         assert 'node_id' in node
  87
  88         node_id = node['node_id']
  89         nodegroup_id = self['nodegroup_id']
  90
  91         if node_id in self['node_ids']:
  92             assert nodegroup_id in node['nodegroup_ids']
  93
  94             self.api.db.do("DELETE FROM nodegroup_node" \
  95                            " WHERE nodegroup_id = %(nodegroup_id)d" \
  96                            " AND node_id = %(node_id)d",
  97                            locals())
  98
  99             if commit:
 100                 self.api.db.commit()
 101
 102             self['node_ids'].remove(node_id)
 103             node['nodegroup_ids'].remove(nodegroup_id)
 104
 105     def delete(self, commit = True):
 106         """
 107         Delete existing nodegroup from the database.
 108         """
 109
 110         assert 'nodegroup_id' in self
 111
 112         # Clean up miscellaneous join tables
 113         for table in ['nodegroup_node', 'nodegroups']:
 114             self.api.db.do("DELETE FROM %s" \
 115                            " WHERE nodegroup_id = %d" % \
 116                            (table, self['nodegroup_id']), self)
 117
 118         if commit:
 119             self.api.db.commit()
 120
 121 class NodeGroups(Table):
 122     """
 123     Representation of row(s) from the nodegroups table in the
 124     database.
 125     """
 126
 127     def __init__(self, api, nodegroup_id_or_name_list = None):
 128         self.api = api
 129
 130         sql = "SELECT %s FROM view_nodegroups" % \
 131               ", ".join(NodeGroup.fields)
 132
 133         if nodegroup_id_or_name_list:
 134             # Separate the list into integers and strings
 135             nodegroup_ids = filter(lambda nodegroup_id: isinstance(nodegroup_id, (int, long)),
 136                                    nodegroup_id_or_name_list)
 137             names = filter(lambda name: isinstance(name, StringTypes),
 138                            nodegroup_id_or_name_list)
 139             sql += " WHERE (False"
 140             if nodegroup_ids:
 141                 sql += " OR nodegroup_id IN (%s)" % ", ".join(map(str, nodegroup_ids))
 142             if names:
 143                 sql += " OR name IN (%s)" % ", ".join(api.db.quote(names))
 144             sql += ")"
 145
 146         rows = self.api.db.selectall(sql)
 147
 148         for row in rows:
 149             self[row['nodegroup_id']] = nodegroup = NodeGroup(api, row)
 150             for aggregate in ['node_ids']:
 151                 if not nodegroup.has_key(aggregate) or nodegroup[aggregate] is None:
 152                     nodegroup[aggregate] = []
 153                 else:
 154                     nodegroup[aggregate] = map(int, nodegroup[aggregate].split(','))