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