5 from pprint import pformat, PrettyPrinter
6 from optparse import OptionParser
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
15 pprinter = PrettyPrinter(indent=4)
17 def optparse_listvalue_callback(option, opt, value, parser):
18 setattr(parser.values, option.dest, value.split(','))
20 def args(*args, **kwargs):
22 func.__dict__.setdefault('options', []).insert(0, (args, kwargs))
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
35 class RegistryCommands(Commands):
36 def __init__(self, *args, **kwds):
37 self.api= Generic.the_flavour().make_api(interface='registry')
40 """Display the Registry version"""
41 version = self.api.manager.GetVersion(self.api, {})
42 pprinter.pprint(version)
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"""
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'])
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)
67 save_records_to_file(outfile, records)
70 def _record_dict(self, xrn=None, type=None, url=None, key=None, \
71 description=None, slices='', researchers=''):
78 record_dict['urn'] = xrn.get_urn()
79 record_dict['hrn'] = xrn.get_hrn()
80 record_dict['type'] = xrn.get_type()
82 record_dict['url'] = url
85 pubkey = open(key, 'r').read()
88 record_dict['keys'] = [pubkey]
90 record_dict['slices'] = slices
92 record_dict['researchers'] = researchers
94 record_dict['description'] = description
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',
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)
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',
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)
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"""
145 self.api.manager.Remove(self.api, xrn)
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)
156 def import_registry(self):
157 """Run the importer"""
158 from sfa.importer import Importer
159 importer = Importer()
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")
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
182 logger.info("re-creating empty schema")
183 dbschema.init_or_upgrade()
185 # remove the server certificate and all gids found in /var/lib/sfa/authorities
187 logger.info("Purging cached certificates")
188 for (dir, _, files) in os.walk('/var/lib/sfa/authorities'):
190 if file.endswith('.gid') or file == 'server.cert':
194 # just remove all files that do not match 'server.key' or 'server.cert'
196 logger.info("Purging registry filesystem cache")
197 preserved_files = [ 'server.key', 'server.cert']
198 for (dir,_,files) in os.walk(Hierarchy().basedir):
200 if file in preserved_files: continue
205 class CertCommands(Commands):
207 def import_gid(self, xrn):
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()
222 gid = GID(string=record.gid)
224 # check the authorities hierarchy
225 hierarchy = Hierarchy()
227 auth_info = hierarchy.get_auth_info(hrn)
228 gid = auth_info.gid_object
230 print "Record: %s not found" % hrn
234 outfile = os.path.abspath('./%s.gid' % gid.get_hrn())
235 gid.save_to_file(outfile, save_parents=True)
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
244 gid = GID(filename=gid_path)
245 gid.dump(dump_parents=True)
248 class AggregateCommands(Commands):
250 def __init__(self, *args, **kwds):
251 self.api= Generic.the_flavour().make_api(interface='aggregate')
254 """Display the Aggregate version"""
255 version = self.api.manager.GetVersion(self.api, {})
256 pprinter.pprint(version)
259 """List the running slices at this Aggregate"""
260 print self.api.manager.ListSlices(self.api, [], {})
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)
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}
277 options['geni_slice_urn'] = xrn
278 resources = self.api.manager.ListResources(self.api, [], options)
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]}]
295 self.api.manager.CreateSliver(self, slice_urn, [], rspec_string, users, options)
297 @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
298 def delete(self, xrn):
300 self.api.manager.DeleteSliver(self.api, xrn, [], {})
302 @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
303 def start(self, xrn):
305 self.api.manager.start_slice(self.api, xrn, [])
307 @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
310 self.api.manager.stop_slice(self.api, xrn, [])
312 @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
313 def reset(self, xrn):
315 self.api.manager.reset_slice(self.api, xrn)
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):
325 class SliceManagerCommands(AggregateCommands):
327 def __init__(self, *args, **kwds):
328 self.api= Generic.the_flavour().make_api(interface='slicemgr')
333 CATEGORIES = {'certificate': CertCommands,
334 'registry': RegistryCommands,
335 'aggregate': AggregateCommands,
336 'slicemgr': SliceManagerCommands}
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
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]
350 categories=SfaAdmin.CATEGORIES
352 cls=SfaAdmin.CATEGORIES[c]
353 print "==================== category=%s"%c
354 names=cls.__dict__.keys()
357 method=cls.__dict__[name]
358 if name.startswith('_'): continue
360 format="%%-%ds"%margin
362 doc=getattr(method,'__doc__',None)
363 if not doc: print "<missing __doc__>"
364 lines=[line.strip() for line in doc.split("\n")]
367 for extra_line in lines: print margin*" ",extra_line
371 argv = copy.deepcopy(sys.argv)
372 self.script_name = argv.pop(0)
373 # ensure category is specified
377 # ensure category is valid
378 category_str = argv.pop(0)
379 category=self.find_category (category_str)
383 usage = "%%prog %s action [options]" % (category)
384 parser = OptionParser(usage=usage)
385 command_class = SfaAdmin.CATEGORIES.get(category, None)
386 if not command_class:
387 self.summary_usage(category)
389 # ensure command is valid
390 command_instance = command_class()
391 actions = command_instance._get_commands()
397 if hasattr(command_instance, action):
398 command = getattr(command_instance, action)
400 self.summary_usage(category)
402 # ensure options are valid
403 options = getattr(command, 'options', [])
404 usage = "%%prog %s %s [options]" % (category, action)
405 parser = OptionParser(usage=usage)
406 for arg, kwd in options:
407 parser.add_option(*arg, **kwd)
408 (opts, cmd_args) = parser.parse_args(argv)
409 cmd_kwds = vars(opts)
411 # dont overrride meth
412 for k, v in cmd_kwds.items():
418 # print "invoking %s *=%s **=%s"%(command.__name__,cmd_args, cmd_kwds)
419 command(*cmd_args, **cmd_kwds)
422 print "Possible wrong number of arguments supplied"
423 print command.__doc__
427 print "Command failed, please check log for more info"