X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=osmclient%2Fscripts%2Fosm.py;h=8cde343bdc70aca54584a49cc8da0355cc71c9e8;hb=refs%2Fchanges%2F07%2F8607%2F1;hp=af8cab9e74474cb51223c2aa948c0769147c29c5;hpb=ac0e5fbbf8103186fe5a18f2420ddca87380552b;p=osm%2Fosmclient.git diff --git a/osmclient/scripts/osm.py b/osmclient/scripts/osm.py index af8cab9..8cde343 100755 --- a/osmclient/scripts/osm.py +++ b/osmclient/scripts/osm.py @@ -152,10 +152,10 @@ def cli_osm(ctx, hostname, user, password, project, verbose): @cli_osm.command(name='ns-list', short_help='list all NS instances') @click.option('--filter', default=None, help='restricts the list to the NS instances matching the filter.') -@click.option('--details', is_flag=True, - help='get more details of current operation in the NS.') +@click.option('--long', is_flag=True, + help='get more details of the NS (project, vim, deployment status, configuration status.') @click.pass_context -def ns_list(ctx, filter,details): +def ns_list(ctx, filter, long): """list all NS instances \b @@ -286,19 +286,25 @@ def ns_list(ctx, filter,details): resp = ctx.obj.ns.list(filter) else: resp = ctx.obj.ns.list() - if details: + if long: table = PrettyTable( ['ns instance name', 'id', + 'date', 'ns state', 'current operation', 'error details', + 'project', + 'vim (inst param)', 'deployment status', 'configuration status']) + project_list = ctx.obj.project.list() + vim_list = ctx.obj.vim.list() else: table = PrettyTable( ['ns instance name', 'id', + 'date', 'ns state', 'current operation', 'error details']) @@ -308,10 +314,27 @@ def ns_list(ctx, filter,details): nsr = ns nsr_name = nsr['name'] nsr_id = nsr['_id'] + date = datetime.fromtimestamp(nsr['create-time']).strftime("%Y-%m-%dT%H:%M:%S") ns_state = nsr['nsState'] - if details: + if long: deployment_status = summarize_deployment_status(nsr['deploymentStatus']) config_status = summarize_config_status(nsr['configurationStatus']) + project_id = nsr.get('_admin').get('projects_read')[0] + project_name = '-' + for p in project_list: + if p['_id'] == project_id: + project_name = p['name'] + break + #project = '{} ({})'.format(project_name, project_id) + project = project_name + vim_id = nsr.get('datacenter') + vim_name = '-' + for v in vim_list: + if v['uuid'] == vim_id: + vim_name = v['name'] + break + #vim = '{} ({})'.format(vim_name, vim_id) + vim = vim_name current_operation = "{} ({})".format(nsr['currentOperation'],nsr['currentOperationID']) error_details = "N/A" if ns_state == "BROKEN" or ns_state == "DEGRADED": @@ -321,6 +344,8 @@ def ns_list(ctx, filter,details): nsr = nsopdata['nsr:nsr'] nsr_name = nsr['name-ref'] nsr_id = nsr['ns-instance-config-ref'] + date = '-' + project = '-' deployment_status = nsr['operational-status'] if 'operational-status' in nsr else 'Not found' ns_state = deployment_status config_status = nsr['config-status'] if 'config-status' in nsr else 'Not found' @@ -329,19 +354,23 @@ def ns_list(ctx, filter,details): if config_status == "config_not_needed": config_status = "configured (no charms)" - if details: + if long: table.add_row( [nsr_name, nsr_id, + date, ns_state, current_operation, wrap_text(text=error_details,width=40), + project, + vim, deployment_status, config_status]) else: table.add_row( [nsr_name, nsr_id, + date, ns_state, current_operation, wrap_text(text=error_details,width=40)]) @@ -350,7 +379,7 @@ def ns_list(ctx, filter,details): print('To get the history of all operations over a NS, run "osm ns-op-list NS_ID"') print('For more details on the current operation, run "osm ns-op-show OPERATION_ID"') -def nsd_list(ctx, filter): +def nsd_list(ctx, filter, long): logger.debug("") if filter: check_client_version(ctx.obj, '--filter') @@ -358,15 +387,28 @@ def nsd_list(ctx, filter): else: resp = ctx.obj.nsd.list() # print(yaml.safe_dump(resp)) - table = PrettyTable(['nsd name', 'id']) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname == 'osmclient.sol005.client.Client': - for ns in resp: - name = ns['name'] if 'name' in ns else '-' - table.add_row([name, ns['_id']]) + if long: + table = PrettyTable(['nsd name', 'id', 'onboarding state', 'operational state', + 'usage state', 'date', 'last update']) + else: + table = PrettyTable(['nsd name', 'id']) + for nsd in resp: + name = nsd.get('name','-') + if long: + onb_state = nsd['_admin'].get('onboardingState','-') + op_state = nsd['_admin'].get('operationalState','-') + usage_state = nsd['_admin'].get('usageState','-') + date = datetime.fromtimestamp(nsd['_admin']['created']).strftime("%Y-%m-%dT%H:%M:%S") + last_update = datetime.fromtimestamp(nsd['_admin']['modified']).strftime("%Y-%m-%dT%H:%M:%S") + table.add_row([name, nsd['_id'], onb_state, op_state, usage_state, date, last_update]) + else: + table.add_row([name, nsd['_id']]) else: - for ns in resp: - table.add_row([ns['name'], ns['id']]) + table = PrettyTable(['nsd name', 'id']) + for nsd in resp: + table.add_row([nsd['name'], nsd['id']]) table.align = 'l' print(table) @@ -374,24 +416,26 @@ def nsd_list(ctx, filter): @cli_osm.command(name='nsd-list', short_help='list all NS packages') @click.option('--filter', default=None, help='restricts the list to the NSD/NSpkg matching the filter') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def nsd_list1(ctx, filter): +def nsd_list1(ctx, filter, long): """list all NSD/NS pkg in the system""" logger.debug("") - nsd_list(ctx, filter) + nsd_list(ctx, filter, long) @cli_osm.command(name='nspkg-list', short_help='list all NS packages') @click.option('--filter', default=None, help='restricts the list to the NSD/NSpkg matching the filter') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def nsd_list2(ctx, filter): +def nsd_list2(ctx, filter, long): """list all NS packages""" logger.debug("") - nsd_list(ctx, filter) + nsd_list(ctx, filter, long) -def vnfd_list(ctx, nf_type, filter): +def vnfd_list(ctx, nf_type, filter, long): logger.debug("") if nf_type: check_client_version(ctx.obj, '--nf_type') @@ -415,13 +459,26 @@ def vnfd_list(ctx, nf_type, filter): else: resp = ctx.obj.vnfd.list() # print(yaml.safe_dump(resp)) - table = PrettyTable(['nfpkg name', 'id']) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname == 'osmclient.sol005.client.Client': + if long: + table = PrettyTable(['nfpkg name', 'id', 'onboarding state', 'operational state', + 'usage state', 'date', 'last update']) + else: + table = PrettyTable(['nfpkg name', 'id']) for vnfd in resp: name = vnfd['name'] if 'name' in vnfd else '-' - table.add_row([name, vnfd['_id']]) + if long: + onb_state = vnfd['_admin'].get('onboardingState','-') + op_state = vnfd['_admin'].get('operationalState','-') + usage_state = vnfd['_admin'].get('usageState','-') + date = datetime.fromtimestamp(vnfd['_admin']['created']).strftime("%Y-%m-%dT%H:%M:%S") + last_update = datetime.fromtimestamp(vnfd['_admin']['modified']).strftime("%Y-%m-%dT%H:%M:%S") + table.add_row([name, vnfd['_id'], onb_state, op_state, usage_state, date, last_update]) + else: + table.add_row([name, vnfd['_id']]) else: + table = PrettyTable(['nfpkg name', 'id']) for vnfd in resp: table.add_row([vnfd['name'], vnfd['id']]) table.align = 'l' @@ -432,41 +489,44 @@ def vnfd_list(ctx, nf_type, filter): @click.option('--nf_type', help='type of NF (vnf, pnf, hnf)') @click.option('--filter', default=None, help='restricts the list to the NF pkg matching the filter') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def vnfd_list1(ctx, nf_type, filter): +def vnfd_list1(ctx, nf_type, filter, long): """list all xNF packages (VNF, HNF, PNF)""" logger.debug("") - vnfd_list(ctx, nf_type, filter) + vnfd_list(ctx, nf_type, filter, long) @cli_osm.command(name='vnfpkg-list', short_help='list all xNF packages (VNF, HNF, PNF)') @click.option('--nf_type', help='type of NF (vnf, pnf, hnf)') @click.option('--filter', default=None, help='restricts the list to the NFpkg matching the filter') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def vnfd_list2(ctx, nf_type, filter): +def vnfd_list2(ctx, nf_type, filter, long): """list all xNF packages (VNF, HNF, PNF)""" logger.debug("") - vnfd_list(ctx, nf_type, filter) + vnfd_list(ctx, nf_type, filter, long) @cli_osm.command(name='nfpkg-list', short_help='list all xNF packages (VNF, HNF, PNF)') @click.option('--nf_type', help='type of NF (vnf, pnf, hnf)') @click.option('--filter', default=None, help='restricts the list to the NFpkg matching the filter') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def nfpkg_list(ctx, nf_type, filter): +def nfpkg_list(ctx, nf_type, filter, long): """list all xNF packages (VNF, HNF, PNF)""" logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) - vnfd_list(ctx, nf_type, filter) + vnfd_list(ctx, nf_type, filter, long) # except ClientException as e: # print(str(e)) # exit(1) -def vnf_list(ctx, ns, filter): +def vnf_list(ctx, ns, filter, long): # try: if ns or filter: if ns: @@ -481,24 +541,23 @@ def vnf_list(ctx, ns, filter): # exit(1) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname == 'osmclient.sol005.client.Client': - table = PrettyTable( - ['vnf id', - 'name', - 'ns id', - 'vnf member index', - 'vnfd name', - 'vim account id', - 'ip address']) + field_names = ['vnf id', 'name', 'ns id', 'vnf member index', + 'vnfd name', 'vim account id', 'ip address'] + if long: + field_names = ['vnf id', 'name', 'ns id', 'vnf member index', + 'vnfd name', 'vim account id', 'ip address', + 'date', 'last update'] + table = PrettyTable(field_names) for vnfr in resp: name = vnfr['name'] if 'name' in vnfr else '-' - table.add_row( - [vnfr['_id'], - name, - vnfr['nsr-id-ref'], - vnfr['member-vnf-index-ref'], - vnfr['vnfd-ref'], - vnfr['vim-account-id'], - vnfr['ip-address']]) + new_row = [vnfr['_id'], name, vnfr['nsr-id-ref'], + vnfr['member-vnf-index-ref'], vnfr['vnfd-ref'], + vnfr['vim-account-id'], vnfr['ip-address']] + if long: + date = datetime.fromtimestamp(vnfr['_admin']['created']).strftime("%Y-%m-%dT%H:%M:%S") + last_update = datetime.fromtimestamp(vnfr['_admin']['modified']).strftime("%Y-%m-%dT%H:%M:%S") + new_row.extend([date, last_update]) + table.add_row(new_row) else: table = PrettyTable( ['vnf name', @@ -522,19 +581,21 @@ def vnf_list(ctx, ns, filter): @click.option('--ns', default=None, help='NS instance id or name to restrict the NF list') @click.option('--filter', default=None, help='restricts the list to the NF instances matching the filter.') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def vnf_list1(ctx, ns, filter): +def vnf_list1(ctx, ns, filter, long): """list all NF instances""" logger.debug("") - vnf_list(ctx, ns, filter) + vnf_list(ctx, ns, filter, long) @cli_osm.command(name='nf-list', short_help='list all NF instances') @click.option('--ns', default=None, help='NS instance id or name to restrict the NF list') @click.option('--filter', default=None, help='restricts the list to the NF instances matching the filter.') +@click.option('--long', is_flag=True, help='get more details') @click.pass_context -def nf_list(ctx, ns, filter): +def nf_list(ctx, ns, filter, long): """list all NF instances \b @@ -588,8 +649,10 @@ def nf_list(ctx, ns, filter): @cli_osm.command(name='ns-op-list', short_help='shows the history of operations over a NS instance') @click.argument('name') +@click.option('--long', is_flag=True, + help='get more details of the NS operation (date, ).') @click.pass_context -def ns_op_list(ctx, name): +def ns_op_list(ctx, name, long): """shows the history of operations over a NS instance NAME: name or ID of the NS instance @@ -614,7 +677,11 @@ def ns_op_list(ctx, name): # print(str(e)) # exit(1) - table = PrettyTable(['id', 'operation', 'action_name', 'operation_params', 'status', 'detail']) + if long: + table = PrettyTable(['id', 'operation', 'action_name', 'operation_params', 'status', 'date', 'last update', 'detail']) + else: + table = PrettyTable(['id', 'operation', 'action_name', 'status', 'date', 'detail']) + #print(yaml.safe_dump(resp)) for op in resp: action_name = "N/A" @@ -629,12 +696,20 @@ def ns_op_list(ctx, name): detail = "In queue. Current position: {}".format(op['queuePosition']) elif op['operationState']=='FAILED' or op['operationState']=='FAILED_TEMP': detail = op['errorMessage'] - table.add_row([op['id'], - op['lcmOperationType'], - action_name, - wrap_text(text=json.dumps(formatParams(op['operationParams']),indent=2),width=70), - op['operationState'], - wrap_text(text=detail,width=50)]) + date = datetime.fromtimestamp(op['startTime']).strftime("%Y-%m-%dT%H:%M:%S") + last_update = datetime.fromtimestamp(op['statusEnteredTime']).strftime("%Y-%m-%dT%H:%M:%S") + if long: + table.add_row([op['id'], + op['lcmOperationType'], + action_name, + wrap_text(text=json.dumps(formatParams(op['operationParams']),indent=2),width=50), + op['operationState'], + date, + last_update, + wrap_text(text=detail,width=50)]) + else: + table.add_row([op['id'], op['lcmOperationType'], action_name, + op['operationState'], date, wrap_text(text=detail,width=50)]) table.align = 'l' print(table) @@ -824,7 +899,7 @@ def nsd_show(ctx, name, literal): table = PrettyTable(['field', 'value']) for k, v in list(resp.items()): - table.add_row([k, json.dumps(v, indent=2)]) + table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)]) table.align = 'l' print(table) @@ -872,7 +947,7 @@ def vnfd_show(ctx, name, literal): table = PrettyTable(['field', 'value']) for k, v in list(resp.items()): - table.add_row([k, json.dumps(v, indent=2)]) + table.add_row([k, wrap_text(text=json.dumps(v, indent=2),width=100)]) table.align = 'l' print(table) @@ -1300,11 +1375,11 @@ def pdu_show(ctx, name, literal, filter): # CREATE operations #################### -def nsd_create(ctx, filename, overwrite): +def nsd_create(ctx, filename, overwrite, skip_charm_build): logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) - ctx.obj.nsd.create(filename, overwrite) + ctx.obj.nsd.create(filename, overwrite=overwrite, skip_charm_build=skip_charm_build) # except ClientException as e: # print(str(e)) # exit(1) @@ -1317,14 +1392,16 @@ def nsd_create(ctx, filename, overwrite): @click.option('--override', 'overwrite', default=None, help='overrides fields in descriptor, format: ' '"key1.key2...=value[;key3...=value;...]"') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='The charm will not be compiled, it is assumed to already exist') @click.pass_context -def nsd_create1(ctx, filename, overwrite): +def nsd_create1(ctx, filename, overwrite, skip_charm_build): """creates a new NSD/NSpkg FILENAME: NSD yaml file or NSpkg tar.gz file """ logger.debug("") - nsd_create(ctx, filename, overwrite) + nsd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build) @cli_osm.command(name='nspkg-create', short_help='creates a new NSD/NSpkg') @@ -1334,21 +1411,23 @@ def nsd_create1(ctx, filename, overwrite): @click.option('--override', 'overwrite', default=None, help='overrides fields in descriptor, format: ' '"key1.key2...=value[;key3...=value;...]"') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='The charm will not be compiled, it is assumed to already exist') @click.pass_context -def nsd_create2(ctx, filename, overwrite): +def nsd_create2(ctx, charm_folder, overwrite, skip_charm_build): """creates a new NSD/NSpkg - FILENAME: NSD yaml file or NSpkg tar.gz file + FILENAME: NSD folder, NSD yaml file or NSpkg tar.gz file """ logger.debug("") - nsd_create(ctx, filename, overwrite) + nsd_create(ctx, charm_folder, overwrite=overwrite, skip_charm_build=skip_charm_build) -def vnfd_create(ctx, filename, overwrite): +def vnfd_create(ctx, filename, overwrite, skip_charm_build): logger.debug("") # try: check_client_version(ctx.obj, ctx.command.name) - ctx.obj.vnfd.create(filename, overwrite) + ctx.obj.vnfd.create(filename, overwrite=overwrite, skip_charm_build=skip_charm_build) # except ClientException as e: # print(str(e)) # exit(1) @@ -1361,14 +1440,16 @@ def vnfd_create(ctx, filename, overwrite): @click.option('--override', 'overwrite', default=None, help='overrides fields in descriptor, format: ' '"key1.key2...=value[;key3...=value;...]"') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='The charm will not be compiled, it is assumed to already exist') @click.pass_context -def vnfd_create1(ctx, filename, overwrite): +def vnfd_create1(ctx, filename, overwrite, skip_charm_build): """creates a new VNFD/VNFpkg FILENAME: VNFD yaml file or VNFpkg tar.gz file """ logger.debug("") - vnfd_create(ctx, filename, overwrite) + vnfd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build) @cli_osm.command(name='vnfpkg-create', short_help='creates a new VNFD/VNFpkg') @@ -1378,14 +1459,16 @@ def vnfd_create1(ctx, filename, overwrite): @click.option('--override', 'overwrite', default=None, help='overrides fields in descriptor, format: ' '"key1.key2...=value[;key3...=value;...]"') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='The charm will not be compiled, it is assumed to already exist') @click.pass_context -def vnfd_create2(ctx, filename, overwrite): +def vnfd_create2(ctx, filename, overwrite, skip_charm_build): """creates a new VNFD/VNFpkg - FILENAME: VNFD yaml file or VNFpkg tar.gz file + FILENAME: NF Package Folder, NF Descriptor yaml file or NFpkg tar.gz file """ logger.debug("") - vnfd_create(ctx, filename, overwrite) + vnfd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build) @cli_osm.command(name='nfpkg-create', short_help='creates a new NFpkg') @@ -1395,14 +1478,16 @@ def vnfd_create2(ctx, filename, overwrite): @click.option('--override', 'overwrite', default=None, help='overrides fields in descriptor, format: ' '"key1.key2...=value[;key3...=value;...]"') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='The charm will not be compiled, it is assumed to already exist') @click.pass_context -def nfpkg_create(ctx, filename, overwrite): +def nfpkg_create(ctx, filename, overwrite, skip_charm_build): """creates a new NFpkg - FILENAME: NF Descriptor yaml file or NFpkg tar.gz file + FILENAME: NF Package Folder, NF Descriptor yaml file or NFpkg tar.gz filems to build """ logger.debug("") - vnfd_create(ctx, filename, overwrite) + vnfd_create(ctx, filename, overwrite=overwrite, skip_charm_build=skip_charm_build) @cli_osm.command(name='ns-create', short_help='creates a new Network Service instance') @@ -1479,13 +1564,13 @@ def nst_create(ctx, filename, overwrite): help='overrides fields in descriptor, format: ' '"key1.key2...=value[;key3...=value;...]"') @click.pass_context -def nst_create1(ctx, filename, overwrite): +def nst_create1(ctx, charm_folder, overwrite): """creates a new Network Slice Template (NST) - FILENAME: NST yaml file or NSTpkg tar.gz file + FILENAME: NST package folder, NST yaml file or NSTpkg tar.gz file """ logger.debug("") - nst_create(ctx, filename, overwrite) + nst_create(ctx, charm_folder, overwrite) @cli_osm.command(name='netslice-template-create', short_help='creates a new Network Slice Template (NST)') @@ -2012,7 +2097,7 @@ def pdu_delete(ctx, name, force): default='openstack', help='VIM type') @click.option('--description', - default='no description', + default=None, help='human readable description') @click.option('--sdn_controller', default=None, help='Name or id of the SDN controller associated to this VIM account') @click.option('--sdn_port_mapping', default=None, help="File describing the port mapping between compute nodes' ports and switch ports") @@ -2213,7 +2298,7 @@ def vim_show(ctx, name): @click.option('--wim_type', help='WIM type') @click.option('--description', - default='no description', + default=None, help='human readable description') @click.option('--wim_port_mapping', default=None, help="File describing the port mapping between DC edge (datacenters, switches, ports) and WAN edge " @@ -2552,7 +2637,7 @@ def sdnc_show(ctx, name): # K8s cluster operations ########################### -@cli_osm.command(name='k8scluster-add') +@cli_osm.command(name='k8scluster-add', short_help='adds a K8s cluster to OSM') @click.argument('name') @click.option('--creds', prompt=True, @@ -2567,7 +2652,7 @@ def sdnc_show(ctx, name): prompt=True, help='list of VIM networks, in JSON inline format, where the cluster is accessible via L3 routing, e.g. "{(k8s_net1:vim_network1) [,(k8s_net2:vim_network2) ...]}"') @click.option('--description', - default='', + default=None, help='human readable description') @click.option('--namespace', default='kube-system', @@ -2657,7 +2742,7 @@ def k8scluster_update(ctx, # exit(1) -@cli_osm.command(name='k8scluster-delete') +@cli_osm.command(name='k8scluster-delete', short_help='deletes a K8s cluster') @click.argument('name') @click.option('--force', is_flag=True, help='forces the deletion from the DB (not recommended)') #@click.option('--wait', @@ -2703,7 +2788,7 @@ def k8scluster_list(ctx, filter, literal): # exit(1) -@cli_osm.command(name='k8scluster-show') +@cli_osm.command(name='k8scluster-show', short_help='shows the details of a K8s cluster') @click.argument('name') @click.option('--literal', is_flag=True, help='print literally, no pretty table') @@ -2733,7 +2818,7 @@ def k8scluster_show(ctx, name, literal): # Repo operations ########################### -@cli_osm.command(name='repo-add') +@cli_osm.command(name='repo-add', short_help='adds a repo to OSM') @click.argument('name') @click.argument('uri') @click.option('--type', @@ -2741,7 +2826,7 @@ def k8scluster_show(ctx, name, literal): prompt=True, help='type of repo (helm-chart for Helm Charts, juju-bundle for Juju Bundles)') @click.option('--description', - default='', + default=None, help='human readable description') #@click.option('--wait', # is_flag=True, @@ -2770,7 +2855,7 @@ def repo_add(ctx, # exit(1) -@cli_osm.command(name='repo-update') +@cli_osm.command(name='repo-update', short_help='updates a repo in OSM') @click.argument('name') @click.option('--newname', help='New name for the repo') @click.option('--uri', help='URI of the repo') @@ -2804,7 +2889,7 @@ def repo_update(ctx, # exit(1) -@cli_osm.command(name='repo-delete') +@cli_osm.command(name='repo-delete', short_help='deletes a repo') @click.argument('name') @click.option('--force', is_flag=True, help='forces the deletion from the DB (not recommended)') #@click.option('--wait', @@ -2849,7 +2934,7 @@ def repo_list(ctx, filter, literal): # exit(1) -@cli_osm.command(name='repo-show') +@cli_osm.command(name='repo-show', short_help='shows the details of a repo') @click.argument('name') @click.option('--literal', is_flag=True, help='print literally, no pretty table') @@ -3262,9 +3347,10 @@ def ns_metric_export(ctx, ns, vnf, vdu, metric, interval): # Other operations #################### -@cli_osm.command(name='version') +@cli_osm.command(name='version', short_help='shows client and server versions') @click.pass_context def get_version(ctx): + """shows client and server versions""" # try: check_client_version(ctx.obj, "version") print ("Server version: {}".format(ctx.obj.get_version())) @@ -3275,15 +3361,17 @@ def get_version(ctx): @cli_osm.command(name='upload-package', short_help='uploads a VNF package or NS package') @click.argument('filename') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='the charm will not be compiled, it is assumed to already exist') @click.pass_context -def upload_package(ctx, filename): - """uploads a VNF package or NS package +def upload_package(ctx, filename, skip_charm_build): + """uploads a vnf package or ns package - FILENAME: VNF or NS package file (tar.gz) + filename: vnf or ns package folder, or vnf or ns package file (tar.gz) """ logger.debug("") # try: - ctx.obj.package.upload(filename) + ctx.obj.package.upload(filename, skip_charm_build=skip_charm_build) fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__ if fullclassname != 'osmclient.sol005.client.Client': ctx.obj.package.wait_for_upload(filename) @@ -3750,9 +3838,14 @@ def package_create(ctx, @click.argument('base-directory', default=".", required=False) +@click.option('--recursive/--no-recursive', + default=True, + help='The activated recursive option will validate the yaml files' + ' within the indicated directory and in its subdirectories') @click.pass_context def package_validate(ctx, - base_directory): + base_directory, + recursive): """ Validate descriptors given a base directory. @@ -3761,7 +3854,7 @@ def package_validate(ctx, """ # try: check_client_version(ctx.obj, ctx.command.name) - results = ctx.obj.package_tool.validate(base_directory) + results = ctx.obj.package_tool.validate(base_directory, recursive) table = PrettyTable() table.field_names = ["TYPE", "PATH", "VALID", "ERROR"] # Print the dictionary generated by the validation function @@ -3783,10 +3876,13 @@ def package_validate(ctx, default=False, is_flag=True, help='skip package validation') +@click.option('--skip-charm-build', default=False, is_flag=True, + help='the charm will not be compiled, it is assumed to already exist') @click.pass_context def package_build(ctx, package_folder, - skip_validation): + skip_validation, + skip_charm_build): """ Build the package NS, VNF given the package_folder. @@ -3795,7 +3891,9 @@ def package_build(ctx, """ # try: check_client_version(ctx.obj, ctx.command.name) - results = ctx.obj.package_tool.build(package_folder, skip_validation) + results = ctx.obj.package_tool.build(package_folder, + skip_validation=skip_validation, + skip_charm_build=skip_charm_build) print(results) # except ClientException as inst: # print("ERROR: {}".format(inst)) @@ -3805,13 +3903,17 @@ def package_build(ctx, def cli(): try: cli_osm() + exit(0) except pycurl.error as exc: print(exc) print('Maybe "--hostname" option or OSM_HOSTNAME environment variable needs to be specified') - exit(1) except ClientException as exc: print("ERROR: {}".format(exc)) - exit(1) + except (FileNotFoundError, PermissionError) as exc: + print("Cannot open file: {}".format(exc)) + except yaml.YAMLError as exc: + print("Invalid YAML format: {}".format(exc)) + exit(1) # TODO capture other controlled exceptions here # TODO remove the ClientException captures from all places, unless they do something different