call method
[sfa.git] / sfa / client / sfaadmin.py
index 4ab9545..b7b45d4 100755 (executable)
@@ -11,6 +11,11 @@ from sfa.storage.record import Record
 from sfa.client.sfi import save_records_to_file
 from sfa.trust.hierarchy import Hierarchy
 from sfa.trust.gid import GID
+from sfa.trust.certificate import convert_public_key
+
+from sfa.client.candidates import Candidates
+
+from sfa.client.common import optparse_listvalue_callback, optparse_dictvalue_callback, terminal_render, filter_records
 
 pprinter = PrettyPrinter(indent=4)
 
@@ -19,37 +24,19 @@ try:
 except:
     help_basedir='*unable to locate Hierarchy().basedir'
 
-def optparse_listvalue_callback(option, opt, value, parser):
-    setattr(parser.values, option.dest, value.split(','))
-
 def args(*args, **kwargs):
     def _decorator(func):
         func.__dict__.setdefault('options', []).insert(0, (args, kwargs))
         return func
     return _decorator
 
-### utility to match command-line args to names
-class Candidates:
-    def __init__ (self, names):
-        self.names=names
-    # is an input string acceptable for one of the known names?
-    @staticmethod
-    def fits (input, name):
-        return name.find(input)==0
-    # returns one of the names if the input name has a unique match
-    # or None otherwise
-    def only_match (self, input):
-        matches=[ name for name in self.names if Candidates.fits(input,name) ]
-        if len(matches)==1: return matches[0]
-        else: return None
-
 class Commands(object):
     def _get_commands(self):
-        available_methods = []
+        command_names = []
         for attrib in dir(self):
             if callable(getattr(self, attrib)) and not attrib.startswith('_'):
-                available_methods.append(attrib)
-        return available_methods         
+                command_names.append(attrib)
+        return command_names
 
 
 class RegistryCommands(Commands):
@@ -62,17 +49,21 @@ class RegistryCommands(Commands):
         pprinter.pprint(version)
 
     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='authority to list (hrn/urn - mandatory)') 
-    @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None
+    @args('-t', '--type', dest='type', metavar='<type>', help='object type', default='all'
     @args('-r', '--recursive', dest='recursive', metavar='<recursive>', help='list all child records', 
-          action='store_true', default=False) 
-    def list(self, xrn, type=None, recursive=False):
+          action='store_true', default=False)
+    @args('-v', '--verbose', dest='verbose', action='store_true', default=False)
+    def list(self, xrn, type=None, recursive=False, verbose=False):
         """List names registered at a given authority - possibly filtered by type"""
         xrn = Xrn(xrn, type) 
-        options = {'recursive': recursive}    
-        records = self.api.manager.List(self.api, xrn.get_hrn(), options=options)
-        for record in records:
-            if not type or record['type'] == type:
-                print "%s (%s)" % (record['hrn'], record['type'])
+        options_dict = {'recursive': recursive}
+        records = self.api.manager.List(self.api, xrn.get_hrn(), options=options_dict)
+        list = filter_records(type, records)
+        # terminal_render expects an options object
+        class Options: pass
+        options=Options()
+        options.verbose=verbose
+        terminal_render (list, options)
 
 
     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)') 
@@ -82,7 +73,7 @@ class RegistryCommands(Commands):
           choices=('text', 'xml', 'simple'), help='display record in different formats') 
     def show(self, xrn, type=None, format=None, outfile=None):
         """Display details for a registered object"""
-        records = self.api.manager.Resolve(self.api, xrn, type, True)
+        records = self.api.manager.Resolve(self.api, xrn, type, details=True)
         for record in records:
             sfa_record = Record(dict=record)
             sfa_record.dump(format) 
@@ -93,7 +84,7 @@ class RegistryCommands(Commands):
     def _record_dict(self, xrn=None, type=None, 
                      url=None, description=None, email='', 
                      key=None, 
-                     slices=[], researchers=[], pis=[]):
+                     slices=[], researchers=[], pis=[], extras={}):
         record_dict = {}
         if xrn:
             if type:
@@ -121,8 +112,79 @@ class RegistryCommands(Commands):
             record_dict['email'] = email
         if pis:
             record_dict['pi'] = pis
+        if extras:
+            record_dict.update(extras)
         return record_dict
 
+
+    @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn', default=None)
+    @args('-t', '--type', dest='type', metavar='<type>', help='object type (mandatory)',)
+    @args('-a', '--all', dest='all', metavar='<all>', action='store_true', default=False, help='check all users GID')
+    @args('-v', '--verbose', dest='verbose', metavar='<verbose>', action='store_true', default=False, help='verbose mode: display user\'s hrn ')
+    def check_gid(self, xrn=None, type=None, all=None, verbose=None):
+        """Check the correspondance between the GID and the PubKey"""
+
+        # db records
+        from sfa.storage.alchemy import dbsession
+        from sfa.storage.model import RegRecord
+        db_query = dbsession.query(RegRecord).filter_by(type=type)
+        if xrn and not all:
+            hrn = Xrn(xrn).get_hrn()
+            db_query = db_query.filter_by(hrn=hrn)
+        elif all and xrn:
+            print "Use either -a or -x <xrn>, not both !!!"
+            sys.exit(1)
+        elif not all and not xrn:
+            print "Use either -a or -x <xrn>, one of them is mandatory !!!"
+            sys.exit(1)
+
+        records = db_query.all()
+        if not records:
+            print "No Record found"
+            sys.exit(1)
+
+        OK = []
+        NOK = []
+        ERROR = []
+        NOKEY = []
+        for record in records:
+             # get the pubkey stored in SFA DB
+             if record.reg_keys:
+                 db_pubkey_str = record.reg_keys[0].key
+                 try:
+                   db_pubkey_obj = convert_public_key(db_pubkey_str)
+                 except:
+                   ERROR.append(record.hrn)
+                   continue
+             else:
+                 NOKEY.append(record.hrn)
+                 continue
+
+             # get the pubkey from the gid
+             gid_str = record.gid
+             gid_obj = GID(string = gid_str)
+             gid_pubkey_obj = gid_obj.get_pubkey()
+
+             # Check if gid_pubkey_obj and db_pubkey_obj are the same
+             check = gid_pubkey_obj.is_same(db_pubkey_obj)
+             if check :
+                 OK.append(record.hrn)
+             else:
+                 NOK.append(record.hrn)
+
+        if not verbose:
+            print "Users NOT having a PubKey: %s\n\
+Users having a non RSA PubKey: %s\n\
+Users having a GID/PubKey correpondence OK: %s\n\
+Users having a GID/PubKey correpondence Not OK: %s\n"%(len(NOKEY), len(ERROR), len(OK), len(NOK))
+        else:
+            print "Users NOT having a PubKey: %s and are: \n%s\n\n\
+Users having a non RSA PubKey: %s and are: \n%s\n\n\
+Users having a GID/PubKey correpondence OK: %s and are: \n%s\n\n\
+Users having a GID/PubKey correpondence NOT OK: %s and are: \n%s\n\n"%(len(NOKEY),NOKEY, len(ERROR), ERROR, len(OK), OK, len(NOK), NOK)
+
+
+
     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)') 
     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None) 
     @args('-e', '--email', dest='email', default="",
@@ -133,18 +195,19 @@ class RegistryCommands(Commands):
           help='Description, useful for slices', default=None)
     @args('-k', '--key', dest='key', metavar='<key>', help='public key string or file', 
           default=None)
-    @args('-s', '--slices', dest='slices', metavar='<slices>', help='slice xrns', 
+    @args('-s', '--slices', dest='slices', metavar='<slices>', help='Set/replace slice xrns', 
           default='', type="str", action='callback', callback=optparse_listvalue_callback)
-    @args('-r', '--researchers', dest='researchers', metavar='<researchers>', help='slice researchers', 
+    @args('-r', '--researchers', dest='researchers', metavar='<researchers>', help='Set/replace slice researchers', 
           default='', type="str", action='callback', callback=optparse_listvalue_callback)
     @args('-p', '--pis', dest='pis', metavar='<PIs>', 
-          help='Principal Investigators/Project Managers ', 
+          help='Set/replace Principal Investigators/Project Managers', 
           default='', type="str", action='callback', callback=optparse_listvalue_callback)
+    @args('-X','--extra',dest='extras',default={},type='str',metavar="<EXTRA_ASSIGNS>", action="callback", callback=optparse_dictvalue_callback, nargs=1, help="set extra/testbed-dependent flags, e.g. --extra enabled=true")
     def register(self, xrn, type=None, url=None, description=None, key=None, slices='', 
-                 pis='', researchers='',email=''):
+                 pis='', researchers='',email='', extras={}):
         """Create a new Registry record"""
         record_dict = self._record_dict(xrn=xrn, type=type, url=url, key=key, 
-                                        slices=slices, researchers=researchers, email=email, pis=pis)
+                                        slices=slices, researchers=researchers, email=email, pis=pis, extras=extras)
         self.api.manager.Register(self.api, record_dict)         
 
 
@@ -155,18 +218,20 @@ class RegistryCommands(Commands):
           help='Description', default=None)
     @args('-k', '--key', dest='key', metavar='<key>', help='public key string or file',
           default=None)
-    @args('-s', '--slices', dest='slices', metavar='<slices>', help='slice xrns',
+    @args('-s', '--slices', dest='slices', metavar='<slices>', help='Set/replace slice xrns',
           default='', type="str", action='callback', callback=optparse_listvalue_callback)
-    @args('-r', '--researchers', dest='researchers', metavar='<researchers>', help='slice researchers',
+    @args('-r', '--researchers', dest='researchers', metavar='<researchers>', help='Set/replace slice researchers',
           default='', type="str", action='callback', callback=optparse_listvalue_callback)
     @args('-p', '--pis', dest='pis', metavar='<PIs>',
-          help='Principal Investigators/Project Managers ',
+          help='Set/replace Principal Investigators/Project Managers',
           default='', type="str", action='callback', callback=optparse_listvalue_callback)
+    @args('-X','--extra',dest='extras',default={},type='str',metavar="<EXTRA_ASSIGNS>", action="callback", callback=optparse_dictvalue_callback, nargs=1, help="set extra/testbed-dependent flags, e.g. --extra enabled=true")
     def update(self, xrn, type=None, url=None, description=None, key=None, slices='', 
-               pis='', researchers=''):
+               pis='', researchers='', extras={}):
         """Update an existing Registry record""" 
+        print 'incoming PIS',pis
         record_dict = self._record_dict(xrn=xrn, type=type, url=url, description=description, 
-                                        key=key, slices=slices, researchers=researchers, pis=pis)
+                                        key=key, slices=slices, researchers=researchers, pis=pis, extras=extras)
         self.api.manager.Update(self.api, record_dict)
         
     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)') 
@@ -190,6 +255,12 @@ class RegistryCommands(Commands):
         from sfa.importer import Importer
         importer = Importer()
         importer.run()
+
+    def sync_db(self):
+        """Initialize or upgrade the db"""
+        from sfa.storage.dbschema import DBSchema
+        dbschema=DBSchema()
+        dbschema.init_or_upgrade()
     
     @args('-a', '--all', dest='all', metavar='<all>', action='store_true', default=False,
           help='Remove all registry records and all files in %s area' % help_basedir)
@@ -287,71 +358,51 @@ class AggregateCommands(Commands):
         version = self.api.manager.GetVersion(self.api, {})
         pprinter.pprint(version)
 
-    def slices(self):
-        """List the running slices at this Aggregate"""
-        print self.api.manager.ListSlices(self.api, [], {})
-
     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)') 
     def status(self, xrn):
-        """Display the status of a slice or slivers"""
-        urn = Xrn(xrn, 'slice').get_urn()
-        status = self.api.manager.SliverStatus(self.api, urn, [], {})
+        """Retrieve the status of the slivers belonging to the named slice (Status)"""
+        urns = [Xrn(xrn, 'slice').get_urn()]
+        status = self.api.manager.Status(self.api, urns, [], {})
         pprinter.pprint(status)
  
-    @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn', default=None)
     @args('-r', '--rspec-version', dest='rspec_version', metavar='<rspec_version>', 
           default='GENI', help='version/format of the resulting rspec response')  
-    def resources(self, xrn=None, rspec_version='GENI'):
-        """Display the available resources at an aggregate 
-or the resources allocated by a slice"""  
+    def resources(self, rspec_version='GENI'):
+        """Display the available resources at an aggregate"""  
         options = {'geni_rspec_version': rspec_version}
-        if xrn:
-            options['geni_slice_urn'] = Xrn(xrn, 'slice').get_urn()
         print options
         resources = self.api.manager.ListResources(self.api, [], options)
         print resources
         
+
     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
-    @args('-r', '--rspec', dest='rspec', metavar='<rspec>', help='rspec file (mandatory)')  
-    @args('-u', '--user', dest='user', metavar='<user>', help='hrn/urn of slice user (mandatory)')  
-    @args('-k', '--key', dest='key', metavar='<key>', help="path to user's public key file (mandatory)")  
-    def create(self, xrn, rspec, user, key):
+    @args('-r', '--rspec', dest='rspec', metavar='<rspec>', help='rspec file (mandatory)')
+    def allocate(self, xrn, rspec):
         """Allocate slivers"""
         xrn = Xrn(xrn, 'slice')
         slice_urn=xrn.get_urn()
         rspec_string = open(rspec).read()
-        user_xrn = Xrn(user, 'user')
-        user_urn = user_xrn.get_urn()
-        user_key_string = open(key).read()
-        users = [{'urn': user_urn, 'keys': [user_key_string]}]
         options={}
-        self.api.manager.CreateSliver(self, slice_urn, [], rspec_string, users, options) 
+        manifest = self.api.manager.Allocate(self.api, slice_urn, [], rspec_string, options)
+        print manifest
 
-    @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
-    def delete(self, xrn):
-        """Delete slivers""" 
-        self.api.manager.DeleteSliver(self.api, xrn, [], {})
-    @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
-    def start(self, xrn):
-        """Start slivers"""
-        self.api.manager.start_slice(self.api, xrn, [])
 
     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
-    def stop(self, xrn):
-        """Stop slivers"""
-        self.api.manager.stop_slice(self.api, xrn, [])      
+    def provision(self, xrn):
+        """Provision slivers"""
+        xrn = Xrn(xrn, 'slice')
+        slice_urn=xrn.get_urn()
+        options={}
+        manifest = self.api.manager.provision(self.api, [slice_urn], [], options)
+        print manifest
 
-    @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
-    def reset(self, xrn):
-        """Reset sliver"""
-        self.api.manager.reset_slice(self.api, xrn)
 
 
-#    @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn', default=None)
-#    @args('-r', '--rspec', dest='rspec', metavar='<rspec>', help='request rspec', default=None)
-#    def ticket(self, xrn, rspec):
-#        pass
+    @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
+    def delete(self, xrn):
+        """Delete slivers""" 
+        self.api.manager.Delete(self.api, [xrn], [], {})
 
 
 
@@ -368,15 +419,14 @@ class SfaAdmin:
                   'aggregate': AggregateCommands,
                   'slicemgr': SliceManagerCommands}
 
-    def find_category (self, string):
-        for (k,v) in SfaAdmin.CATEGORIES.items():
-            if k.startswith(string): return k
-        for (k,v) in SfaAdmin.CATEGORIES.items():
-            if k.find(string) >=1: return k
-        return None
+    # returns (name,class) or (None,None)
+    def find_category (self, input):
+        full_name=Candidates (SfaAdmin.CATEGORIES.keys()).only_match(input)
+        if not full_name: return (None,None)
+        return (full_name,SfaAdmin.CATEGORIES[full_name])
 
     def summary_usage (self, category=None):
-        print "Usage:", self.script_name + " category action [<options>]"
+        print "Usage:", self.script_name + " category command [<options>]"
         if category and category in SfaAdmin.CATEGORIES: 
             categories=[category]
         else:
@@ -410,33 +460,32 @@ class SfaAdmin:
             self.summary_usage()
 
         # ensure category is valid
-        category_str = argv.pop(0)
-        category=self.find_category (category_str)
-        if not category:
-            self.summary_usage()
+        category_input = argv.pop(0)
+        (category_name, category_class) = self.find_category (category_input)
+        if not category_name or not category_class:
+            self.summary_usage(category_name)
 
-        usage = "%%prog %s action [options]" % (category)
+        usage = "%%prog %s command [options]" % (category_name)
         parser = OptionParser(usage=usage)
-        command_class =  SfaAdmin.CATEGORIES.get(category, None)
-        if not command_class:
-            self.summary_usage(category)
     
         # ensure command is valid      
-        command_instance = command_class()
-        actions = command_instance._get_commands()
+        category_instance = category_class()
+        commands = category_instance._get_commands()
         if len(argv) < 1:
-            action = '__call__'
+            # xxx what is this about ?
+            command_name = '__call__'
         else:
-            action = argv.pop(0)
+            command_input = argv.pop(0)
+            command_name = Candidates (commands).only_match (command_input)
     
-        if hasattr(command_instance, action):
-            command = getattr(command_instance, action)
+        if command_name and hasattr(category_instance, command_name):
+            command = getattr(category_instance, command_name)
         else:
-            self.summary_usage(category)
+            self.summary_usage(category_name)
 
         # ensure options are valid
         options = getattr(command, 'options', [])
-        usage = "%%prog %s %s [options]" % (category, action)
+        usage = "%%prog %s %s [options]" % (category_name, command_name)
         parser = OptionParser(usage=usage)
         for arg, kwd in options:
             parser.add_option(*arg, **kwd)
@@ -464,30 +513,3 @@ class SfaAdmin:
             print "Command failed, please check log for more info"
             raise
 
-candidates_specs=[
-('create delete reset resources slices start status stop version', 
-  [ ('ver','version'),
-    ('r',None),
-    ('re',None),
-    ('res',None),
-    ('rese','reset'),
-    ('reset','reset'),
-    ('reso','resources'),
-    ('sli','slices'),
-    ('st',None),
-    ('sta',None),
-    ('stop','stop'),
-    ('a',None),
-])
-]
-
-def test_candidates ():
-    for (names, tuples) in candidates_specs:
-        names=names.split()
-        for (input,expected) in tuples:
-            got=Candidates(names).only_match(input)
-            if got==expected: print '.',
-            else: print 'X FAIL','names[',names,'] input',input,'expected',expected,'got',got
-
-if __name__ == '__main__':
-    test_candidates()