bug 773: allow ns-action without primitive_params
[osm/osmclient.git] / osmclient / scripts / osm.py
index fa35574..fbc14d7 100755 (executable)
@@ -1329,7 +1329,6 @@ def pdu_create(ctx, name, pdu_type, interface, description, vim_account, descrip
         print((inst.message))
         exit(1)
 
-
 ####################
 # UPDATE operations
 ####################
@@ -1655,9 +1654,9 @@ def pdu_delete(ctx, name, force):
         exit(1)
 
 
-####################
+#################
 # VIM operations
-####################
+#################
 
 @cli.command(name='vim-create')
 @click.option('--name',
@@ -2104,7 +2103,7 @@ def sdnc_create(ctx,
         ctx.obj.sdnc.create(name, sdncontroller, wait=wait)
     except ClientException as inst:
         print((inst.message))
-
+        exit(1)
 
 @cli.command(name='sdnc-update', short_help='updates an SDN controller')
 @click.argument('name')
@@ -2204,7 +2203,7 @@ def sdnc_list(ctx, filter):
     except ClientException as inst:
         print((inst.message))
         exit(1)
-    table = PrettyTable(['name', 'id'])
+    table = PrettyTable(['sdnc name', 'id'])
     for sdnc in resp:
         table.add_row([sdnc['name'], sdnc['_id']])
     table.align = 'l'
@@ -2255,6 +2254,7 @@ def project_create(ctx, name):
         ctx.obj.project.create(name, project)
     except ClientException as inst:
         print(inst.message)
+        exit(1)
 
 
 @cli.command(name='project-delete')
@@ -2315,6 +2315,33 @@ def project_show(ctx, name):
     print(table)
 
 
+@cli.command(name='project-update')
+@click.argument('project')
+@click.option('--name',
+              prompt=True,
+              help='new name for the project')
+
+@click.pass_context
+def project_update(ctx, project, name):
+    """
+    Update a project name
+
+    :param ctx:
+    :param project: id or name of the project to modify
+    :param name:  new name for the project
+    :return:
+    """
+
+    project_changes = {}
+    project_changes['name'] = name
+
+    try:
+        check_client_version(ctx.obj, ctx.command.name)
+        ctx.obj.project.update(project, project_changes)
+    except ClientException as inst:
+        print(inst.message)
+
+
 ####################
 # User mgmt operations
 ####################
@@ -2327,11 +2354,11 @@ def project_show(ctx, name):
               confirmation_prompt=True,
               help='user password')
 @click.option('--projects',
-              prompt="Comma separate list of projects",
+              prompt="Comma separate list of projects",
               multiple=True,
               callback=lambda ctx, param, value: ''.join(value).split(',') if all(len(x)==1 for x in value) else value,
               help='list of project ids that the user belongs to')
-@click.option('--project-role-mapping', 'project_role_mappings',
+@click.option('--project-role-mappings', 'project_role_mappings',
               default=None, multiple=True,
               help='creating user project/role(s) mapping')
 @click.pass_context
@@ -2348,22 +2375,26 @@ def user_create(ctx, username, password, projects, project_role_mappings):
     user['username'] = username
     user['password'] = password
     user['projects'] = projects
-    user['project-role-mappings'] = project_role_mappings
+    user['project_role_mappings'] = project_role_mappings
     
     try:
         check_client_version(ctx.obj, ctx.command.name)
         ctx.obj.user.create(username, user)
     except ClientException as inst:
         print(inst.message)
+        exit(1)
 
 
 @cli.command(name='user-update')
 @click.argument('username')
 @click.option('--password',
-              prompt=True,
-              hide_input=True,
-              confirmation_prompt=True,
+              prompt=True,
+              hide_input=True,
+              confirmation_prompt=True,
               help='user password')
+@click.option('--set-username', 'set_username',
+              default=None,
+              help='change username')
 @click.option('--set-project', 'set_project',
               default=None, multiple=True,
               help='create/replace the project,role(s) mapping for this project: \'project,role1,role2,...\'')
@@ -2377,21 +2408,22 @@ def user_create(ctx, username, password, projects, project_role_mappings):
               default=None, multiple=True,
               help='removes project,role(s) mapping: \'project,role1,role2,...\'')
 @click.pass_context
-def user_update(ctx, username, password, set_project, remove_project,
+def user_update(ctx, username, password, set_username, set_project, remove_project,
                 add_project_role, remove_project_role):
     """Update a user information
 
     \b
     USERNAME: name of the user
     PASSWORD: new password
+    SET_USERNAME: new username
     SET_PROJECT: creating mappings for project/role(s)
     REMOVE_PROJECT: deleting mappings for project/role(s)
     ADD_PROJECT_ROLE: adding mappings for project/role(s)
     REMOVE_PROJECT_ROLE: removing mappings for project/role(s)
     """
     user = {}
-    user['username'] = username
     user['password'] = password
+    user['username'] = set_username
     user['set-project'] = set_project
     user['remove-project'] = remove_project
     user['add-project-role'] = add_project_role
@@ -2402,6 +2434,7 @@ def user_update(ctx, username, password, set_project, remove_project,
         ctx.obj.user.update(username, user)
     except ClientException as inst:
         print(inst.message)
+        exit(1)
 
 
 @cli.command(name='user-delete')
@@ -2490,19 +2523,21 @@ def user_show(ctx, name):
 def ns_alarm_create(ctx, name, ns, vnf, vdu, metric, severity,
                     threshold_value, threshold_operator, statistic):
     """creates a new alarm for a NS instance"""
-    ns_instance = ctx.obj.ns.get(ns)
-    alarm = {}
-    alarm['alarm_name'] = name
-    alarm['ns_id'] = ns_instance['_id']
-    alarm['correlation_id'] = ns_instance['_id']
-    alarm['vnf_member_index'] = vnf
-    alarm['vdu_name'] = vdu
-    alarm['metric_name'] = metric
-    alarm['severity'] = severity
-    alarm['threshold_value'] = int(threshold_value)
-    alarm['operation'] = threshold_operator
-    alarm['statistic'] = statistic
-    try:
+    # TODO: Check how to validate threshold_value.
+    # Should it be an integer (1-100), percentage, or decimal (0.01-1.00)?
+    try:
+        ns_instance = ctx.obj.ns.get(ns)
+        alarm = {}
+        alarm['alarm_name'] = name
+        alarm['ns_id'] = ns_instance['_id']
+        alarm['correlation_id'] = ns_instance['_id']
+        alarm['vnf_member_index'] = vnf
+        alarm['vdu_name'] = vdu
+        alarm['metric_name'] = metric
+        alarm['severity'] = severity
+        alarm['threshold_value'] = int(threshold_value)
+        alarm['operation'] = threshold_operator
+        alarm['statistic'] = statistic
         check_client_version(ctx.obj, ctx.command.name)
         ctx.obj.ns.create_alarm(alarm)
     except ClientException as inst:
@@ -2544,16 +2579,18 @@ def ns_alarm_create(ctx, name, ns, vnf, vdu, metric, severity,
 @click.pass_context
 def ns_metric_export(ctx, ns, vnf, vdu, metric, interval):
     """exports a metric to the internal OSM bus, which can be read by other apps"""
-    ns_instance = ctx.obj.ns.get(ns)
-    metric_data = {}
-    metric_data['ns_id'] = ns_instance['_id']
-    metric_data['correlation_id'] = ns_instance['_id']
-    metric_data['vnf_member_index'] = vnf
-    metric_data['vdu_name'] = vdu
-    metric_data['metric_name'] = metric
-    metric_data['collection_unit'] = 'WEEK'
-    metric_data['collection_period'] = 1
-    try:
+    # TODO: Check how to validate interval.
+    # Should it be an integer (seconds), or should a suffix (s,m,h,d,w) also be permitted?
+    try:
+        ns_instance = ctx.obj.ns.get(ns)
+        metric_data = {}
+        metric_data['ns_id'] = ns_instance['_id']
+        metric_data['correlation_id'] = ns_instance['_id']
+        metric_data['vnf_member_index'] = vnf
+        metric_data['vdu_name'] = vdu
+        metric_data['metric_name'] = metric
+        metric_data['collection_unit'] = 'WEEK'
+        metric_data['collection_period'] = 1
         check_client_version(ctx.obj, ctx.command.name)
         if not interval:
             print('{}'.format(ctx.obj.ns.export_metric(metric_data)))
@@ -2742,9 +2779,11 @@ def vcs_list(ctx):
 
 @cli.command(name='ns-action')
 @click.argument('ns_name')
-@click.option('--vnf_name', default=None)
+@click.option('--vnf_name', default=None, help='member-vnf-index if the target is a vnf instead of a ns)')
+@click.option('--vdu_id', default=None, help='vdu-id if the target is a vdu o a vnf')
+@click.option('--vdu_count', default=None, help='number of vdu instance of this vdu_id')
 @click.option('--action_name', prompt=True)
-@click.option('--params', prompt=True)
+@click.option('--params', default=None)
 @click.option('--wait',
               required=False,
               default=False,
@@ -2755,6 +2794,8 @@ def vcs_list(ctx):
 def ns_action(ctx,
               ns_name,
               vnf_name,
+              vdu_id,
+              vdu_count,
               action_name,
               params,
               wait):
@@ -2764,15 +2805,22 @@ def ns_action(ctx,
     """
     try:
         check_client_version(ctx.obj, ctx.command.name)
-        op_data={}
+        op_data = {}
         if vnf_name:
-            op_data['vnf_member_index'] = vnf_name
+            op_data['member_vnf_index'] = vnf_name
+        if vdu_id:
+            op_data['vdu_id'] = vdu_id
+        if vdu_count:
+            op_data['vdu_count_index'] = vdu_count
         op_data['primitive'] = action_name
-        op_data['primitive_params'] = yaml.load(params)
+        if params:
+            op_data['primitive_params'] = yaml.load(params)
+        else:
+            op_data['primitive_params'] = {}
         ctx.obj.ns.exec_op(ns_name, op_name='action', op_data=op_data, wait=wait)
 
     except ClientException as inst:
-        print((inst.message))
+        print(inst.message)
         exit(1)
 
 
@@ -2812,11 +2860,11 @@ def vnf_scale(ctx,
 
 @cli.command(name='role-create', short_help='creates a role')
 @click.argument('name')
-@click.option('--definition',
+@click.option('--permissions',
               default=None,
-              help='role definition using a dictionary')
+              help='role permissions using a dictionary')
 @click.pass_context
-def role_create(ctx, name, definition):
+def role_create(ctx, name, permissions):
     """
     Creates a new role.
 
@@ -2826,24 +2874,28 @@ def role_create(ctx, name, definition):
     """
     try:
         check_client_version(ctx.obj, ctx.command.name)
-        ctx.obj.role.create(name, definition)
+        ctx.obj.role.create(name, permissions)
     except ClientException as inst:
         print(inst.message)
+        exit(1)
 
 
 @cli.command(name='role-update', short_help='updates a role')
 @click.argument('name')
-@click.option('--definition',
+@click.option('--set-name',
               default=None,
-              help='add a new definition to the role')
+              help='change name of rle')
+# @click.option('--permissions',
+#               default=None,
+#               help='provide a yaml format dictionary with incremental changes. Values can be bool or None to delete')
 @click.option('--add',
               default=None,
-              help='add a resource access grant/denial')
+              help='yaml format dictionary with permission: True/False to access grant/denial')
 @click.option('--remove',
               default=None,
-              help='remove a resource access grant/denial')
+              help='yaml format list to remove a permission')
 @click.pass_context
-def role_update(ctx, name, definition, add, remove):
+def role_update(ctx, name, set_name, add, remove):
     """
     Updates a role.
 
@@ -2855,7 +2907,7 @@ def role_update(ctx, name, definition, add, remove):
     """
     try:
         check_client_version(ctx.obj, ctx.command.name)
-        ctx.obj.role.update(name, definition, add, remove)
+        ctx.obj.role.update(name, set_name, None, add, remove)
     except ClientException as inst:
         print(inst.message)
         exit(1)