Feature 10476: New client commands and library to manage subscriptions
[osm/osmclient.git] / osmclient / scripts / osm.py
index 12f0576..feb8c2f 100755 (executable)
@@ -4966,6 +4966,128 @@ def ns_metric_export(ctx, ns, vnf, vdu, metric, interval):
     #     exit(1)
 
 
+#################
+# Subscription operations
+#################
+
+
+@cli_osm.command(
+    name="subscription-create",
+    short_help="creates a new subscription to a specific event",
+)
+@click.option(
+    "--event_type",
+    # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
+    type=click.Choice(["ns"], case_sensitive=False),
+    help="event type to be subscribed (for the moment, only ns is supported)",
+)
+@click.option("--event", default=None, help="specific yaml configuration for the event")
+@click.option(
+    "--event_file", default=None, help="specific yaml configuration file for the event"
+)
+@click.pass_context
+def subscription_create(ctx, event_type, event, event_file):
+    """creates a new subscription to a specific event"""
+    logger.debug("")
+    check_client_version(ctx.obj, ctx.command.name)
+    if event_file:
+        if event:
+            raise ClientException(
+                '"--event" option is incompatible with "--event_file" option'
+            )
+        with open(event_file, "r") as cf:
+            event = cf.read()
+    ctx.obj.subscription.create(event_type, event)
+
+
+@cli_osm.command(name="subscription-delete", short_help="deletes a subscription")
+@click.option(
+    "--event_type",
+    # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
+    type=click.Choice(["ns"], case_sensitive=False),
+    help="event type to be subscribed (for the moment, only ns is supported)",
+)
+@click.argument("subscription_id")
+@click.option(
+    "--force", is_flag=True, help="forces the deletion bypassing pre-conditions"
+)
+@click.pass_context
+def subscription_delete(ctx, event_type, subscription_id, force):
+    """deletes a subscription
+
+    SUBSCRIPTION_ID: ID of the subscription to be deleted
+    """
+    logger.debug("")
+    check_client_version(ctx.obj, ctx.command.name)
+    ctx.obj.subscription.delete(event_type, subscription_id, force)
+
+
+@cli_osm.command(name="subscription-list", short_help="list all subscriptions")
+@click.option(
+    "--event_type",
+    # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
+    type=click.Choice(["ns"], case_sensitive=False),
+    help="event type to be subscribed (for the moment, only ns is supported)",
+)
+@click.option(
+    "--filter",
+    default=None,
+    multiple=True,
+    help="restricts the list to the subscriptions matching the filter",
+)
+@click.pass_context
+def subscription_list(ctx, event_type, filter):
+    """list all subscriptions"""
+    logger.debug("")
+    check_client_version(ctx.obj, ctx.command.name)
+    if filter:
+        filter = "&".join(filter)
+    resp = ctx.obj.subscription.list(event_type, filter)
+    table = PrettyTable(["id", "filter", "CallbackUri"])
+    for sub in resp:
+        table.add_row(
+            [
+                sub["_id"],
+                wrap_text(text=json.dumps(sub["filter"], indent=2), width=70),
+                sub["CallbackUri"],
+            ]
+        )
+    table.align = "l"
+    print(table)
+
+
+@cli_osm.command(
+    name="subscription-show", short_help="shows the details of a subscription"
+)
+@click.argument("subscription_id")
+@click.option(
+    "--event_type",
+    # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
+    type=click.Choice(["ns"], case_sensitive=False),
+    help="event type to be subscribed (for the moment, only ns is supported)",
+)
+@click.option(
+    "--filter",
+    multiple=True,
+    help="restricts the information to the fields in the filter",
+)
+@click.pass_context
+def subscription_show(ctx, event_type, subscription_id, filter):
+    """shows the details of a subscription
+
+    SUBSCRIPTION_ID: ID of the subscription
+    """
+    logger.debug("")
+    # try:
+    resp = ctx.obj.subscription.get(subscription_id)
+    table = PrettyTable(["key", "attribute"])
+    for k, v in list(resp.items()):
+        if not filter or k in filter:
+            table.add_row([k, wrap_text(text=json.dumps(v, indent=2), width=100)])
+    table.align = "l"
+    print(table)
+
+
 ####################
 # Other operations
 ####################
@@ -5288,6 +5410,107 @@ def vnf_scale(
     #     exit(1)
 
 
+@cli_osm.command(name="alarm-show", short_help="show alarm details")
+@click.argument("uuid")
+@click.pass_context
+def alarm_show(ctx, uuid):
+    """Show alarm's detail information"""
+
+    check_client_version(ctx.obj, ctx.command.name)
+    resp = ctx.obj.ns.get_alarm(uuid=uuid)
+    alarm_filter = [
+        "uuid",
+        "name",
+        "metric",
+        "statistic",
+        "threshold",
+        "operation",
+        "ns-id",
+        "vnf-id",
+        "vdu_name",
+        "action",
+        "status",
+    ]
+    table = PrettyTable(["key", "attribute"])
+    try:
+        # Arrange and return the response data
+        resp = resp.replace("ObjectId", "")
+        alarm = eval(resp)
+        for key in alarm_filter:
+            if key == "uuid":
+                value = alarm.get(key)
+                key = "alarm-id"
+            elif key == "name":
+                value = alarm.get(key)
+                key = "alarm-name"
+            elif key == "ns-id":
+                value = alarm["tags"].get("ns_id")
+            elif key == "vdu_name":
+                value = alarm["tags"].get("vdu_name")
+            elif key == "status":
+                value = alarm["alarm_status"]
+            else:
+                value = alarm[key]
+            table.add_row([key, wrap_text(text=json.dumps(value, indent=2), width=100)])
+        table.align = "l"
+        print(table)
+    except Exception:
+        print(resp)
+
+
+# List alarm
+@cli_osm.command(name="alarm-list", short_help="list all alarms")
+@click.option(
+    "--ns_id", default=None, required=False, help="List out alarm for given ns id"
+)
+@click.pass_context
+def alarm_list(ctx, ns_id):
+    """list all alarm"""
+
+    check_client_version(ctx.obj, ctx.command.name)
+    project_name = os.getenv("OSM_PROJECT", "admin")
+    resp = ctx.obj.ns.get_alarm(project_name=project_name, ns_id=ns_id)
+
+    table = PrettyTable(
+        ["alarm-id", "metric", "threshold", "operation", "action", "status"]
+    )
+    if resp:
+        # return the response data in a table
+        resp = resp.replace("ObjectId", "")
+        resp = eval(resp)
+        for alarm in resp:
+            table.add_row(
+                [
+                    wrap_text(text=str(alarm["uuid"]), width=38),
+                    alarm["metric"],
+                    alarm["threshold"],
+                    alarm["operation"],
+                    wrap_text(text=alarm["action"], width=25),
+                    alarm["alarm_status"],
+                ]
+            )
+    table.align = "l"
+    print(table)
+
+
+# Update alarm
+@cli_osm.command(name="alarm-update", short_help="Update a alarm")
+@click.argument("uuid")
+@click.option("--threshold", default=None, help="Alarm threshold")
+@click.option("--is_enable", default=None, type=bool, help="enable or disable alarm")
+@click.pass_context
+def alarm_update(ctx, uuid, threshold, is_enable):
+    """
+    Update alarm
+
+    """
+    if not threshold and is_enable is None:
+        raise ClientException(
+            "Please provide option to update i.e threshold or is_enable"
+        )
+    ctx.obj.ns.update_alarm(uuid, threshold, is_enable)
+
+
 ##############################
 # Role Management Operations #
 ##############################