sfa/client/sfaadmin.py

   1 #!/usr/bin/python
   2 import os
   3 import sys
   4 import copy
   5 from pprint import pformat, PrettyPrinter
   6 from optparse import OptionParser
   7
   8 from sfa.generic import Generic
   9 from sfa.util.xrn import Xrn
  10 from sfa.storage.record import Record
  11 from sfa.client.sfi import save_records_to_file
  12 from sfa.trust.hierarchy import Hierarchy
  13 from sfa.trust.gid import GID
  14
  15 pprinter = PrettyPrinter(indent=4)
  16
  17 def optparse_listvalue_callback(option, opt, value, parser):
  18     setattr(parser.values, option.dest, value.split(','))
  19
  20 def args(*args, **kwargs):
  21     def _decorator(func):
  22         func.__dict__.setdefault('options', []).insert(0, (args, kwargs))
  23         return func
  24     return _decorator
  25
  26 class Commands(object):
  27     def _get_commands(self):
  28         available_methods = []
  29         for attrib in dir(self):
  30             if callable(getattr(self, attrib)) and not attrib.startswith('_'):
  31                 available_methods.append(attrib)
  32         return available_methods
  33
  34
  35 class RegistryCommands(Commands):
  36     def __init__(self, *args, **kwds):
  37         self.api= Generic.the_flavour().make_api(interface='registry')
  38
  39     def version(self):
  40         """Display the Registry version"""
  41         version = self.api.manager.GetVersion(self.api, {})
  42         pprinter.pprint(version)
  43
  44     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='authority to list (hrn/urn - mandatory)')
  45     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
  46     def list(self, xrn, type=None):
  47         """List names registered at a given authority - possibly filtered by type"""
  48         xrn = Xrn(xrn, type)
  49         records = self.api.manager.List(self.api, xrn.get_hrn())
  50         for record in records:
  51             if not type or record['type'] == type:
  52                 print "%s (%s)" % (record['hrn'], record['type'])
  53
  54
  55     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
  56     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
  57     @args('-o', '--outfile', dest='outfile', metavar='<outfile>', help='save record to file')
  58     @args('-f', '--format', dest='format', metavar='<display>', type='choice',
  59           choices=('text', 'xml', 'simple'), help='display record in different formats')
  60     def show(self, xrn, type=None, format=None, outfile=None):
  61         """Display details for a registered object"""
  62         records = self.api.manager.Resolve(self.api, xrn, type, True)
  63         for record in records:
  64             sfa_record = Record(dict=record)
  65             sfa_record.dump(format)
  66         if outfile:
  67             save_records_to_file(outfile, records)
  68
  69
  70     def _record_dict(self, xrn=None, type=None, url=None, key=None, \
  71                      description=None, slices='', researchers=''):
  72         record_dict = {}
  73         if xrn:
  74             if type:
  75                 xrn = Xrn(xrn, type)
  76             else:
  77                 xrn = Xrn(xrn)
  78             record_dict['urn'] = xrn.get_urn()
  79             record_dict['hrn'] = xrn.get_hrn()
  80             record_dict['type'] = xrn.get_type()
  81         if url:
  82             record_dict['url'] = url
  83         if key:
  84             try:
  85                 pubkey = open(key, 'r').read()
  86             except IOError:
  87                 pubkey = key
  88             record_dict['keys'] = [pubkey]
  89         if slices:
  90             record_dict['slices'] = slices
  91         if researchers:
  92             record_dict['researchers'] = researchers
  93         if description:
  94             record_dict['description'] = description
  95         return record_dict
  96
  97     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
  98     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
  99     @args('-u', '--url', dest='url', metavar='<url>', help='URL', default=None)
 100     @args('-d', '--description', dest='description', metavar='<description>',
 101           help='Description', default=None)
 102     @args('-k', '--key', dest='key', metavar='<key>', help='public key string or file',
 103           default=None)
 104     @args('-s', '--slices', dest='slices', metavar='<slices>', help='slice xrns',
 105           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 106     @args('-r', '--researchers', dest='researchers', metavar='<researchers>', help='slice researchers',
 107           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 108     @args('-p', '--pis', dest='pis', metavar='<PIs>',
 109           help='Principal Investigators/Project Managers ',
 110           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 111     def register(self, xrn, type=None, url=None, description=None, key=None, slices='',
 112                  pis='', researchers=''):
 113         """Create a new Registry recory"""
 114         record_dict = self._record_dict(xrn=xrn, type=type, url=url, key=key,
 115                                         slices=slices, researchers=researchers)
 116         self.api.manager.Register(self.api, record_dict)
 117
 118
 119     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 120     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 121     @args('-u', '--url', dest='url', metavar='<url>', help='URL', default=None)
 122     @args('-d', '--description', dest='description', metavar='<description>',
 123           help='Description', default=None)
 124     @args('-k', '--key', dest='key', metavar='<key>', help='public key string or file',
 125           default=None)
 126     @args('-s', '--slices', dest='slices', metavar='<slices>', help='slice xrns',
 127           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 128     @args('-r', '--researchers', dest='researchers', metavar='<researchers>', help='slice researchers',
 129           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 130     @args('-p', '--pis', dest='pis', metavar='<PIs>',
 131           help='Principal Investigators/Project Managers ',
 132           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 133     def update(self, xrn, type=None, url=None, description=None, key=None, slices='',
 134                pis='', researchers=''):
 135         """Update an existing Registry record"""
 136         record_dict = self._record_dict(xrn=xrn, type=type, url=url, description=description,
 137                                         key=key, slices=slices, researchers=researchers)
 138         self.api.manager.Update(self.api, record_dict)
 139
 140     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 141     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 142     def remove(self, xrn, type=None):
 143         """Remove given object from the registry"""
 144         xrn = Xrn(xrn, type)
 145         self.api.manager.Remove(self.api, xrn)
 146
 147
 148     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 149     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 150     def credential(self, xrn, type=None):
 151         """Invoke GetCredential"""
 152         cred = self.api.manager.GetCredential(self.api, xrn, type, self.api.hrn)
 153         print cred
 154
 155
 156     def import_registry(self):
 157         """Run the importer"""
 158         from sfa.importer import Importer
 159         importer = Importer()
 160         importer.run()
 161
 162     @args('-a', '--all', dest='all', metavar='<all>', action='store_true', default=False,
 163           help='Remove all registry records and all files in %s area' % Hierarchy().basedir)
 164     @args('-c', '--certs', dest='certs', metavar='<certs>', action='store_true', default=False,
 165           help='Remove all cached certs/gids found in %s' % Hierarchy().basedir )
 166     @args('-0', '--no-reinit', dest='reinit', metavar='<reinit>', action='store_false', default=True,
 167           help='Prevents new DB schema from being installed after cleanup')
 168     def nuke(self, all=False, certs=False, reinit=True):
 169         """Cleanup local registry DB, plus various additional filesystem cleanups optionally"""
 170         from sfa.storage.dbschema import DBSchema
 171         from sfa.util.sfalogging import _SfaLogger
 172         logger = _SfaLogger(logfile='/var/log/sfa_import.log', loggername='importlog')
 173         logger.setLevelFromOptVerbose(self.api.config.SFA_API_LOGLEVEL)
 174         logger.info("Purging SFA records from database")
 175         dbschema=DBSchema()
 176         dbschema.nuke()
 177
 178         # for convenience we re-create the schema here, so there's no need for an explicit
 179         # service sfa restart
 180         # however in some (upgrade) scenarios this might be wrong
 181         if reinit:
 182             logger.info("re-creating empty schema")
 183             dbschema.init_or_upgrade()
 184
 185         # remove the server certificate and all gids found in /var/lib/sfa/authorities
 186         if certs:
 187             logger.info("Purging cached certificates")
 188             for (dir, _, files) in os.walk('/var/lib/sfa/authorities'):
 189                 for file in files:
 190                     if file.endswith('.gid') or file == 'server.cert':
 191                         path=dir+os.sep+file
 192                         os.unlink(path)
 193
 194         # just remove all files that do not match 'server.key' or 'server.cert'
 195         if all:
 196             logger.info("Purging registry filesystem cache")
 197             preserved_files = [ 'server.key', 'server.cert']
 198             for (dir,_,files) in os.walk(Hierarchy().basedir):
 199                 for file in files:
 200                     if file in preserved_files: continue
 201                     path=dir+os.sep+file
 202                     os.unlink(path)
 203
 204
 205 class CertCommands(Commands):
 206
 207     def import_gid(self, xrn):
 208         pass
 209
 210     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 211     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 212     @args('-o', '--outfile', dest='outfile', metavar='<outfile>', help='output file', default=None)
 213     def export(self, xrn, type=None, outfile=None):
 214         """Fetch an object's GID from the Registry"""
 215         from sfa.storage.alchemy import dbsession
 216         from sfa.storage.model import RegRecord
 217         hrn = Xrn(xrn).get_hrn()
 218         request=dbsession.query(RegRecord).filter_by(hrn=hrn)
 219         if type: request = request.filter_by(type=type)
 220         record=request.first()
 221         if record:
 222             gid = GID(string=record.gid)
 223         else:
 224             # check the authorities hierarchy
 225             hierarchy = Hierarchy()
 226             try:
 227                 auth_info = hierarchy.get_auth_info(hrn)
 228                 gid = auth_info.gid_object
 229             except:
 230                 print "Record: %s not found" % hrn
 231                 sys.exit(1)
 232         # save to file
 233         if not outfile:
 234             outfile = os.path.abspath('./%s.gid' % gid.get_hrn())
 235         gid.save_to_file(outfile, save_parents=True)
 236
 237     @args('-g', '--gidfile', dest='gid', metavar='<gid>', help='path of gid file to display (mandatory)')
 238     def display(self, gidfile):
 239         """Print contents of a GID file"""
 240         gid_path = os.path.abspath(gidfile)
 241         if not gid_path or not os.path.isfile(gid_path):
 242             print "No such gid file: %s" % gidfile
 243             sys.exit(1)
 244         gid = GID(filename=gid_path)
 245         gid.dump(dump_parents=True)
 246
 247
 248 class AggregateCommands(Commands):
 249
 250     def __init__(self, *args, **kwds):
 251         self.api= Generic.the_flavour().make_api(interface='aggregate')
 252
 253     def version(self):
 254         """Display the Aggregate version"""
 255         version = self.api.manager.GetVersion(self.api, {})
 256         pprinter.pprint(version)
 257
 258     def slices(self):
 259         """List the running slices at this Aggregate"""
 260         print self.api.manager.ListSlices(self.api, [], {})
 261
 262     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 263     def status(self, xrn):
 264         """Display the status of a slice or slivers"""
 265         urn = Xrn(xrn, 'slice').get_urn()
 266         status = self.api.manager.SliverStatus(self.api, urn, [], {})
 267         pprinter.pprint(status)
 268
 269     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn', default=None)
 270     @args('-r', '--rspec-version', dest='rspec_version', metavar='<rspec_version>',
 271           default='GENI', help='version/format of the resulting rspec response')
 272     def resources(self, xrn=None, rspec_version='GENI'):
 273         """Display the available resources at an aggregate
 274 or the resources allocated by a slice"""
 275         options = {'geni_rspec_version': rspec_version}
 276         if xrn:
 277             options['geni_slice_urn'] = xrn
 278         resources = self.api.manager.ListResources(self.api, [], options)
 279         print resources
 280
 281     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
 282     @args('-r', '--rspec', dest='rspec', metavar='<rspec>', help='rspec file (mandatory)')
 283     @args('-u', '--user', dest='user', metavar='<user>', help='hrn/urn of slice user (mandatory)')
 284     @args('-k', '--key', dest='key', metavar='<key>', help="path to user's public key file (mandatory)")
 285     def create(self, xrn, rspec, user, key):
 286         """Allocate slivers"""
 287         xrn = Xrn(xrn, 'slice')
 288         slice_urn=xrn.get_urn()
 289         rspec_string = open(rspec).read()
 290         user_xrn = Xrn(user, 'user')
 291         user_urn = user_xrn.get_urn()
 292         user_key_string = open(key).read()
 293         users = [{'urn': user_urn, 'keys': [user_key_string]}]
 294         options={}
 295         self.api.manager.CreateSliver(self, slice_urn, [], rspec_string, users, options)
 296
 297     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
 298     def delete(self, xrn):
 299         """Delete slivers"""
 300         self.api.manager.DeleteSliver(self.api, xrn, [], {})
 301
 302     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
 303     def start(self, xrn):
 304         """Start slivers"""
 305         self.api.manager.start_slice(self.api, xrn, [])
 306
 307     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
 308     def stop(self, xrn):
 309         """Stop slivers"""
 310         self.api.manager.stop_slice(self.api, xrn, [])
 311
 312     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
 313     def reset(self, xrn):
 314         """Reset sliver"""
 315         self.api.manager.reset_slice(self.api, xrn)
 316
 317
 318 #    @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn', default=None)
 319 #    @args('-r', '--rspec', dest='rspec', metavar='<rspec>', help='request rspec', default=None)
 320 #    def ticket(self, xrn, rspec):
 321 #        pass
 322
 323
 324
 325 class SliceManagerCommands(AggregateCommands):
 326
 327     def __init__(self, *args, **kwds):
 328         self.api= Generic.the_flavour().make_api(interface='slicemgr')
 329
 330
 331 class SfaAdmin:
 332
 333     CATEGORIES = {'certificate': CertCommands,
 334                   'registry': RegistryCommands,
 335                   'aggregate': AggregateCommands,
 336                   'slicemgr': SliceManagerCommands}
 337
 338     def find_category (self, string):
 339         for (k,v) in SfaAdmin.CATEGORIES.items():
 340             if k.startswith(string): return k
 341         for (k,v) in SfaAdmin.CATEGORIES.items():
 342             if k.find(string) >=1: return k
 343         return None
 344
 345     def summary_usage (self, category=None):
 346         print "Usage:", self.script_name + " category action [<options>]"
 347         if category and category in SfaAdmin.CATEGORIES:
 348             categories=[category]
 349         else:
 350             categories=SfaAdmin.CATEGORIES
 351         for c in categories:
 352             cls=SfaAdmin.CATEGORIES[c]
 353             print "==================== category=%s"%c
 354             names=cls.__dict__.keys()
 355             names.sort()
 356             for name in names:
 357                 method=cls.__dict__[name]
 358                 if name.startswith('_'): continue
 359                 margin=15
 360                 format="%%-%ds"%margin
 361                 print "%-15s"%name,
 362                 doc=getattr(method,'__doc__',None)
 363                 if not doc:
 364                     print "<missing __doc__>"
 365                     continue
 366                 lines=[line.strip() for line in doc.split("\n")]
 367                 line1=lines.pop(0)
 368                 print line1
 369                 for extra_line in lines: print margin*" ",extra_line
 370         sys.exit(2)
 371
 372     def main(self):
 373         argv = copy.deepcopy(sys.argv)
 374         self.script_name = argv.pop(0)
 375         # ensure category is specified
 376         if len(argv) < 1:
 377             self.summary_usage()
 378
 379         # ensure category is valid
 380         category_str = argv.pop(0)
 381         category=self.find_category (category_str)
 382         if not category:
 383             self.summary_usage()
 384
 385         usage = "%%prog %s action [options]" % (category)
 386         parser = OptionParser(usage=usage)
 387         command_class =  SfaAdmin.CATEGORIES.get(category, None)
 388         if not command_class:
 389             self.summary_usage(category)
 390
 391         # ensure command is valid
 392         command_instance = command_class()
 393         actions = command_instance._get_commands()
 394         if len(argv) < 1:
 395             action = '__call__'
 396         else:
 397             action = argv.pop(0)
 398
 399         if hasattr(command_instance, action):
 400             command = getattr(command_instance, action)
 401         else:
 402             self.summary_usage(category)
 403
 404         # ensure options are valid
 405         options = getattr(command, 'options', [])
 406         usage = "%%prog %s %s [options]" % (category, action)
 407         parser = OptionParser(usage=usage)
 408         for arg, kwd in options:
 409             parser.add_option(*arg, **kwd)
 410         (opts, cmd_args) = parser.parse_args(argv)
 411         cmd_kwds = vars(opts)
 412
 413         # dont overrride meth
 414         for k, v in cmd_kwds.items():
 415             if v is None:
 416                 del cmd_kwds[k]
 417
 418         # execute command
 419         try:
 420     #        print "invoking %s *=%s **=%s"%(command.__name__,cmd_args, cmd_kwds)
 421             command(*cmd_args, **cmd_kwds)
 422             sys.exit(0)
 423         except TypeError:
 424             print "Possible wrong number of arguments supplied"
 425             print command.__doc__
 426             parser.print_help()
 427             #raise
 428         except Exception:
 429             print "Command failed, please check log for more info"
 430             raise