from sfa.util.config import Config
from sfa.util.version import version_core
from sfa.util.cache import Cache
+from sfa.util.printable import printable
from sfa.storage.record import Record
def credential_printable (cred):
- credential=Credential(cred=cred)
+ credential = Credential(cred=cred)
result=""
- result += credential.get_summary_tostring()
+ result += credential.pretty_cred()
result += "\n"
rights = credential.get_privileges()
result += "type=%s\n" % credential.type
result += "version=%s\n" % credential.version
- result += "rights=%s\n"%rights
+ result += "rights=%s\n" % rights
return result
def show_credentials (cred_s):
pubkey = options.key
if not check_ssh_key (pubkey):
raise SfaInvalidArgument(name='key',msg="Could not find file, or wrong key format")
- record_dict['keys'] = [pubkey]
+ record_dict['reg-keys'] = [pubkey]
if hasattr(options, 'slices') and options.slices:
record_dict['slices'] = options.slices
- if hasattr(options, 'researchers') and options.researchers:
- record_dict['researcher'] = options.researchers
+ if hasattr(options, 'reg_researchers') and options.reg_researchers is not None:
+ record_dict['reg-researchers'] = options.reg_researchers
if hasattr(options, 'email') and options.email:
record_dict['email'] = options.email
- if hasattr(options, 'pis') and options.pis:
- record_dict['pi'] = options.pis
+ if hasattr(options, 'reg_pis') and options.reg_pis:
+ record_dict['reg-pis'] = options.reg_pis
# handle extra settings
record_dict.update(options.extras)
commands_list=[]
commands_dict={}
-def register_command (args_string, example,aliases=None):
+def declare_command (args_string, example,aliases=None):
def wrap(m):
name=getattr(m,'__name__')
doc=getattr(m,'__doc__',"-- missing doc --")
return new_method
return wrap
+
+def remove_none_fields (record):
+ none_fields=[ k for (k,v) in record.items() if v is None ]
+ for k in none_fields: del record[k]
+
##########
class Sfi:
### suitable if no reasonable command has been provided
def print_commands_help (self, options):
verbose=getattr(options,'verbose')
- format3="%10s %-30s %s"
- format3offset=42
+ format3="%10s %-35s %s"
+ format3offset=47
line=80*'-'
if not verbose:
print format3%("command","cmd_args","description")
sys.exit(2)
# retrieve args_string
- (_, args_string, __,___) = commands_dict[command]
+ (_, args_string, __,canonical) = commands_dict[command]
parser = OptionParser(add_help_option=False,
usage="sfi [sfi_options] %s [cmd_options] %s"
parser.add_option ("-h","--help",dest='help',action='store_true',default=False,
help="Summary of one command usage")
- if command in ("config"):
+ if canonical in ("config"):
parser.add_option('-m', '--myslice', dest='myslice', action='store_true', default=False,
help='how myslice config variables as well')
- if command in ("version"):
+ if canonical in ("version"):
parser.add_option("-l","--local",
action="store_true", dest="version_local", default=False,
help="display version of the local client")
- if command in ("version", "trusted"):
+ if canonical in ("version", "trusted"):
parser.add_option("-R","--registry_interface",
action="store_true", dest="registry_interface", default=False,
help="target the registry interface instead of slice interface")
- if command in ("register", "update"):
+ if canonical in ("register", "update"):
parser.add_option('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
parser.add_option('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
parser.add_option('-e', '--email', dest='email', default="", help="email (mandatory for users)")
default=None)
parser.add_option('-s', '--slices', dest='slices', metavar='<slices>', help='Set/replace slice xrns',
default='', type="str", action='callback', callback=optparse_listvalue_callback)
- parser.add_option('-r', '--researchers', dest='researchers', metavar='<researchers>',
- help='Set/replace slice researchers', default='', type="str", action='callback',
+ parser.add_option('-r', '--researchers', dest='reg_researchers', metavar='<researchers>',
+ help='Set/replace slice researchers - use -r none to reset', default=None, type="str", action='callback',
callback=optparse_listvalue_callback)
- parser.add_option('-p', '--pis', dest='pis', metavar='<PIs>', help='Set/replace Principal Investigators/Project Managers',
+ parser.add_option('-p', '--pis', dest='
reg_pis', metavar='<PIs>', help='Set/replace Principal Investigators/Project Managers',
default='', type="str", action='callback', callback=optparse_listvalue_callback)
parser.add_option ('-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")
# user specifies remote aggregate/sm/component
- if command in ("resources", "describe", "allocate", "provision", "delete", "allocate", "provision",
+ if canonical in ("resources", "describe", "allocate", "provision", "delete", "allocate", "provision",
"action", "shutdown", "renew", "status"):
parser.add_option("-d", "--delegate", dest="delegate", default=None,
action="store_true",
"authority in set of credentials for this call")
# show_credential option
- if command in ("list","resources", "describe", "provision", "allocate", "register","update","remove","delete","status","renew"):
+ if canonical in ("list","resources", "describe", "provision", "allocate", "register","update","remove","delete","status","renew"):
parser.add_option("-C","--credential",dest='show_credential',action='store_true',default=False,
help="show credential(s) used in human-readable form")
+ if canonical in ("renew"):
+ parser.add_option("-l","--as-long-as-possible",dest='alap',action='store_true',default=False,
+ help="renew as long as possible")
# registy filter option
- if command in ("list", "show", "remove"):
+ if canonical in ("list", "show", "remove"):
parser.add_option("-t", "--type", dest="type", type="choice",
help="type filter ([all]|user|slice|authority|node|aggregate)",
choices=("all", "user", "slice", "authority", "node", "aggregate"),
default="all")
- if command in ("show"):
+ if canonical in ("show"):
parser.add_option("-k","--key",dest="keys",action="append",default=[],
help="specify specific keys to be displayed from record")
parser.add_option("-n","--no-details",dest="no_details",action="store_true",default=False,
help="call Resolve without the 'details' option")
- if command in ("resources", "describe"):
+ if canonical in ("resources", "describe"):
# rspec version
parser.add_option("-r", "--rspec-version", dest="rspec_version", default="GENI 3",
help="schema type and version of resulting RSpec")
choices=("all", "resources", "leases"), default="resources")
- if command in ("resources", "describe", "allocate", "provision", "show", "list", "gid"):
+ if canonical in ("resources", "describe", "allocate", "provision", "show", "list", "gid"):
parser.add_option("-o", "--output", dest="file",
help="output XML to file", metavar="FILE", default=None)
- if command in ("show", "list"):
+ if canonical in ("show", "list"):
parser.add_option("-f", "--format", dest="format", type="choice",
help="display format ([text]|xml)", default="text",
choices=("text", "xml"))
parser.add_option("-F", "--fileformat", dest="fileformat", type="choice",
help="output file format ([xml]|xmllist|hrnlist)", default="xml",
choices=("xml", "xmllist", "hrnlist"))
- if command == 'list':
+ if canonical == 'list':
parser.add_option("-r", "--recursive", dest="recursive", action='store_true',
help="list all child records", default=False)
parser.add_option("-v", "--verbose", dest="verbose", action='store_true',
help="gives details, like user keys", default=False)
- if command in ("delegate"):
+ if canonical in ("delegate"):
parser.add_option("-u", "--user",
action="store_true", dest="delegate_user", default=False,
help="delegate your own credentials; default if no other option is provided")
metavar="slice_hrn", help="delegate cred. for slice HRN")
parser.add_option("-a", "--auths", dest='delegate_auths',action='append',default=[],
metavar='auth_hrn', help="delegate cred for auth HRN")
- # this primarily is a shorthand for -a my_hrn
+ # this primarily is a shorthand for -A my_hrn^
parser.add_option("-p", "--pi", dest='delegate_pi', default=None, action='store_true',
- help="delegate your PI credentials, so s.t. like -a your_hrn^")
+ help="delegate your PI credentials, so s.t. like -A your_hrn^")
parser.add_option("-A","--to-authority",dest='delegate_to_authority',action='store_true',default=False,
help="""by default the mandatory argument is expected to be a user,
use this if you mean an authority instead""")
- if command in ("myslice"):
+ if canonical in ("myslice"):
parser.add_option("-p","--password",dest='password',action='store',default=None,
help="specify mainfold password on the command line")
parser.add_option("-s", "--slice", dest="delegate_slices",action='append',default=[],
# Main: parse arguments and dispatch to command
#
def dispatch(self, command, command_options, command_args):
- method=getattr(self, command, None)
+ (doc, args_string, example, canonical) = commands_dict[command]
+ method=getattr(self, canonical, None)
if not method:
- print "Unknown command %s"%command
- return
+ print "sfi: unknown command %s"%command
+ raise SystemExit,"Unknown command %s"%command
return method(command_options, command_args)
def main(self):
self.logger.debug("Command=%s" % self.command)
try:
- self.dispatch(command, command_options, command_args)
+ retcod = self.dispatch(command, command_options, command_args)
except SystemExit:
return 1
except:
self.logger.log_exc ("sfi command %s failed"%command)
return 1
-
- return 0
+ return retcod
####################
def read_config(self):
# init self-signed cert, user credentials and gid
def bootstrap (self):
+ if self.options.verbose:
+ self.logger.info("Initializing SfaClientBootstrap with {}".format(self.reg_url))
client_bootstrap = SfaClientBootstrap (self.user, self.reg_url, self.options.sfi_dir,
logger=self.logger)
# if -k is provided, use this to initialize private key
sys.exit(1)
+ # helper function to analyze raw output
+ # for main : return 0 if everything is fine, something else otherwise (mostly 1 for now)
+ def success (self, raw):
+ return_value=ReturnValue (raw)
+ output=ReturnValue.get_output(return_value)
+ # means everything is fine
+ if not output:
+ return 0
+ # something went wrong
+ print 'ERROR:',output
+ return 1
+
#==========================================================================
# Following functions implement the commands
#
# Registry-related commands
#==========================================================================
- @register_command("","")
+ @declare_command("","")
def config (self, options, args):
"Display contents of current config"
print "# From configuration file %s"%self.config_file
varname="%s_%s"%(section.upper(),name.upper())
value=getattr(self.config_instance,varname)
print "%-20s = %s"%(name,value)
+ # xxx should analyze result
+ return 0
- @register_command("","")
+ @declare_command("","")
def version(self, options, args):
"""
display an SFA server version (GetVersion)
else:
pprinter = PrettyPrinter(indent=4)
pprinter.pprint(version)
+ # xxx should analyze result
+ return 0
- @register_command("authority","")
+ @declare_command("authority","")
def list(self, options, args):
"""
list entries in named authority registry (List)
terminal_render (list, options)
if options.file:
save_records_to_file(options.file, list, options.fileformat)
- return
+ # xxx should analyze result
+ return 0
- @register_command("name","")
+ @declare_command("name","")
def show(self, options, args):
"""
show details about named registry record (Resolve)
else: print record.save_as_xml()
if options.file:
save_records_to_file(options.file, record_dicts, options.fileformat)
- return
+ # xxx should analyze result
+ return 0
# this historically was named 'add', it is now 'register' with an alias for legacy
- @register_command("[xml-filename]","",['add'])
+ @declare_command("[xml-filename]","",['add'])
def register(self, options, args):
"""create new record in registry (Register)
from command line options (recommended)
record_dict['first_name'] = record_dict['hrn']
if 'last_name' not in record_dict:
record_dict['last_name'] = record_dict['hrn']
- return self.registry().Register(record_dict, auth_cred)
+ register = self.registry().Register(record_dict, auth_cred)
+ # xxx looks like the result here is not ReturnValue-compatible
+ #return self.success (register)
+ # xxx should analyze result
+ return 0
- @register_command("[xml-filename]","")
+ @declare_command("[xml-filename]","")
def update(self, options, args):
"""update record into registry (Update)
from command line options (recommended)
# don't translate into an object, as this would possibly distort
# user-provided data; e.g. add an 'email' field to Users
- if record_dict['type'] == "user":
+ if record_dict['type'] in ['user']:
if record_dict['hrn'] == self.user:
cred = self.my_credential_string
else:
cred = self.my_authority_credential_string()
- elif record_dict['type'] in ["slice"]:
+ elif record_dict['type'] in ['slice']:
try:
cred = self.slice_credential_string(record_dict['hrn'])
except ServerException, e:
cred = self.my_authority_credential_string()
else:
raise
- elif record_dict['type'] in ["authority"]:
+ elif record_dict['type'] in ['authority']:
cred = self.my_authority_credential_string()
- elif record_dict['type'] == 'node':
+ elif record_dict['type'] in ['node']:
cred = self.my_authority_credential_string()
else:
raise "unknown record type" + record_dict['type']
if options.show_credential:
show_credentials(cred)
- return self.registry().Update(record_dict, cred)
+ update = self.registry().Update(record_dict, cred)
+ # xxx looks like the result here is not ReturnValue-compatible
+ #return self.success(update)
+ # xxx should analyze result
+ return 0
- @register_command("hrn","")
+ @declare_command("hrn","")
def remove(self, options, args):
"remove registry record by name (Remove)"
auth_cred = self.my_authority_credential_string()
type = '*'
if options.show_credential:
show_credentials(auth_cred)
- return self.registry().Remove(hrn, auth_cred, type)
+ remove = self.registry().Remove(hrn, auth_cred, type)
+ # xxx looks like the result here is not ReturnValue-compatible
+ #return self.success (remove)
+ # xxx should analyze result
+ return 0
# ==================================================================
# Slice-related commands
# ==================================================================
# show rspec for named slice
- @register_command("","")
+ @declare_command("","")
def resources(self, options, args):
"""
discover available resources (ListResources)
api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3'}
else:
api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3'}
- result = server.ListResources (creds, api_options)
- value = ReturnValue.get_value(result)
+ list_resources = server.ListResources (creds, api_options)
+ value = ReturnValue.get_value(list_resources)
if self.options.raw:
- save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
+ save_raw_to_file(list_resources, self.options.raw, self.options.rawformat, self.options.rawbanner)
if options.file is not None:
save_rspec_to_file(value, options.file)
if (self.options.raw is None) and (options.file is None):
display_rspec(value, options.format)
+ return self.success(list_resources)
- return
-
- @register_command("slice_hrn","")
+ @declare_command("slice_hrn","")
def describe(self, options, args):
"""
shows currently allocated/provisioned resources
api_options = {'call_id': unique_call_id(),
'cached': True,
- #'info': options.info,
+ 'info': options.info,
'list_leases': options.list_leases,
'geni_rspec_version': {'type': 'geni', 'version': '3'},
}
api_options['geni_rspec_version'] = version_manager.get_version(options.rspec_version).to_dict()
else:
api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3'}
- urn = Xrn(args[0], type='slice').get_urn()
- result = server.Describe([urn], creds, api_options)
- value = ReturnValue.get_value(result)
+ urn = Xrn(args[0], type='slice').get_urn()
+ remove_none_fields(api_options)
+ describe = server.Describe([urn], creds, api_options)
+ value = ReturnValue.get_value(describe)
if self.options.raw:
- save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
+ save_raw_to_file(describe, self.options.raw, self.options.rawformat, self.options.rawbanner)
if options.file is not None:
save_rspec_to_file(value['geni_rspec'], options.file)
if (self.options.raw is None) and (options.file is None):
- display_rspec(value, options.format)
+ display_rspec(value['geni_rspec'], options.format)
+ return self.success (describe)
- return
-
- @register_command("slice_hrn [<sliver_urn>...]","")
+ @declare_command("slice_hrn [<sliver_urn>...]","")
def delete(self, options, args):
"""
de-allocate and de-provision all or named slivers of the named slice (Delete)
api_options ['call_id'] = unique_call_id()
if options.show_credential:
show_credentials(creds)
- result = server.Delete(sliver_urns, creds, *self.ois(server, api_options ) )
- value = ReturnValue.get_value(result)
+ delete = server.Delete(sliver_urns, creds, *self.ois(server, api_options ) )
+ value = ReturnValue.get_value(delete)
if self.options.raw:
- save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
+ save_raw_to_file(delete, self.options.raw, self.options.rawformat, self.options.rawbanner)
else:
print value
- return value
+ return self.success (delete)
- @register_command("slice_hrn rspec","")
+ @declare_command("slice_hrn rspec","")
def allocate(self, options, args):
"""
allocate resources to the named slice (Allocate)
sfa_users = []
geni_users = []
slice_records = self.registry().Resolve(slice_urn, [self.my_credential_string])
+ remove_none_fields(slice_records[0])
if slice_records and 'reg-researchers' in slice_records[0] and slice_records[0]['reg-researchers']!=[]:
slice_record = slice_records[0]
user_hrns = slice_record['reg-researchers']
api_options['sfa_users'] = sfa_users
api_options['geni_users'] = geni_users
- result = server.Allocate(slice_urn, creds, rspec, api_options)
- value = ReturnValue.get_value(result)
+ allocate = server.Allocate(slice_urn, creds, rspec, api_options)
+ value = ReturnValue.get_value(allocate)
if self.options.raw:
- save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
+ save_raw_to_file(allocate, self.options.raw, self.options.rawformat, self.options.rawbanner)
if options.file is not None:
save_rspec_to_file (value['geni_rspec'], options.file)
if (self.options.raw is None) and (options.file is None):
print value
- return value
-
+ return self.success(allocate)
- @register_command("slice_hrn [<sliver_urn>...]","")
+ @declare_command("slice_hrn [<sliver_urn>...]","")
def provision(self, options, args):
"""
provision all or named already allocated slivers of the named slice (Provision)
users = pg_users_arg(user_records)
api_options['geni_users'] = users
- result = server.Provision(sliver_urns, creds, api_options)
- value = ReturnValue.get_value(result)
+ provision = server.Provision(sliver_urns, creds, api_options)
+ value = ReturnValue.get_value(provision)
if self.options.raw:
- save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
+ save_raw_to_file(provision, self.options.raw, self.options.rawformat, self.options.rawbanner)
if options.file is not None:
save_rspec_to_file (value['geni_rspec'], options.file)
if (self.options.raw is None) and (options.file is None):
print value
- return value
+ return self.success(provision)
- @register_command("slice_hrn","")
+ @declare_command("slice_hrn","")
def status(self, options, args):
"""
retrieve the status of the slivers belonging to the named slice (Status)
api_options['call_id']=unique_call_id()
if options.show_credential:
show_credentials(creds)
- result = server.Status([slice_urn], creds, *self.ois(server,api_options))
- value = ReturnValue.get_value(result)
+ status = server.Status([slice_urn], creds, *self.ois(server,api_options))
+ value = ReturnValue.get_value(status)
if self.options.raw:
- save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
+ save_raw_to_file(status, self.options.raw, self.options.rawformat, self.options.rawbanner)
else:
print value
- # Thierry: seemed to be missing
- return value
+ return self.success (status)
- @register_command("slice_hrn [<sliver_urn>...] action","")
+ @declare_command("slice_hrn [<sliver_urn>...] action","")
def action(self, options, args):
"""
Perform the named operational action on all or named slivers of the named slice
delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
creds.append(delegated_cred)
- result = server.PerformOperationalAction(sliver_urns, creds, action , api_options)
- value = ReturnValue.get_value(result)
+ perform_action = server.PerformOperationalAction(sliver_urns, creds, action , api_options)
+ value = ReturnValue.get_value(perform_action)
if self.options.raw:
- save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
+ save_raw_to_file(perform_action, self.options.raw, self.options.rawformat, self.options.rawbanner)
else:
print value
- return value
-
- @register_command("slice_hrn [<sliver_urn>...] time","")
+ return self.success (perform_action)
+
+ @declare_command("slice_hrn [<sliver_urn>...] time",
+ "\n".join(["sfi renew onelab.ple.heartbeat 2015-04-31",
+ "sfi renew onelab.ple.heartbeat 2015-04-31T14:00:00Z",
+ "sfi renew onelab.ple.heartbeat +5d",
+ "sfi renew onelab.ple.heartbeat +3w",
+ "sfi renew onelab.ple.heartbeat +2m",]))
def renew(self, options, args):
"""
renew slice (Renew)
# options and call_id when supported
api_options = {}
api_options['call_id']=unique_call_id()
+ if options.alap:
+ api_options['geni_extend_alap']=True
if options.show_credential:
show_credentials(creds)
- result = server.Renew(sliver_urns, creds, input_time, *self.ois(server,api_options))
- value = ReturnValue.get_value(result)
+ renew = server.Renew(sliver_urns, creds, input_time, *self.ois(server,api_options))
+ value = ReturnValue.get_value(renew)
if self.options.raw:
- save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
+ save_raw_to_file(renew, self.options.raw, self.options.rawformat, self.options.rawbanner)
else:
print value
- return value
-
+ return self.success(renew)
- @register_command("slice_hrn","")
+ @declare_command("slice_hrn","")
def shutdown(self, options, args):
"""
shutdown named slice (Shutdown)
# creds
slice_cred = self.slice_credential(slice_hrn)
creds = [slice_cred]
- result = server.Shutdown(slice_urn, creds)
- value = ReturnValue.get_value(result)
+ shutdown = server.Shutdown(slice_urn, creds)
+ value = ReturnValue.get_value(shutdown)
if self.options.raw:
- save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
+ save_raw_to_file(shutdown, self.options.raw, self.options.rawformat, self.options.rawbanner)
else:
print value
- return value
-
+ return self.success (shutdown)
- @register_command("[name]","")
+ @declare_command("[name]","")
def gid(self, options, args):
"""
Create a GID (CreateGid)
filename = os.sep.join([self.options.sfi_dir, '%s.gid' % target_hrn])
self.logger.info("writing %s gid to %s" % (target_hrn, filename))
GID(string=gid).save_to_file(filename)
+ # xxx should analyze result
+ return 0
####################
- @register_command("to_hrn","""$ sfi delegate -u -p -s ple.inria.heartbeat -s ple.inria.omftest ple.upmc.slicebrowser
+ @declare_command("to_hrn","""$ sfi delegate -u -p -s ple.inria.heartbeat -s ple.inria.omftest ple.upmc.slicebrowser
will locally create a set of delegated credentials for the benefit of ple.upmc.slicebrowser
the set of credentials in the scope for this call would be
self.logger.info("delegated credential for %s to %s and wrote to %s"%(message,to_hrn,filename))
####################
- @register_command("","""$ less +/myslice sfi_config
+ @declare_command("","""$ less +/myslice sfi_config
[myslice]
backend = http://manifold.pl.sophia.inria.fr:7080
# the HRN that myslice uses, so that we are delegating to
is synonym to sfi myslice as no other command starts with an 'm'
and uses a custom backend for this one call
"""
-) # register_command
+) # declare_command
def myslice (self, options, args):
""" This helper is for refreshing your credentials at myslice; it will
# it is probably not helpful as people would not
# need to run 'sfi delegate' at all anymore
if count_success != count_all: sys.exit(1)
- return
+ # xxx should analyze result
+ return 0
- @register_command("cred","")
+ @declare_command("cred","")
def trusted(self, options, args):
"""
return the trusted certs at this interface (get_trusted_certs)
cert = Certificate(string=trusted_cert)
self.logger.debug('Sfi.trusted -> %r'%cert.get_subject())
print "Certificate:\n%s\n\n"%trusted_cert
- return
-
+ # xxx should analyze result
+ return 0
git://git.onelab.eu / sfa.git / blobdiff