Merge pull request #1099 from erick-sapp/finishfish

Security groups request ids

Author: allmightyspiff

SoftLayer/CLI/event_log/__init__.py

@@ -0,0 +1 @@
+"""Event Logs."""

SoftLayer/CLI/event_log/get.py

@@ -0,0 +1,66 @@
+"""Get Event Logs."""
+# :license: MIT, see LICENSE for more details.
+
+import json
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+
+COLUMNS = ['event', 'object', 'type', 'date', 'username']
+
+
+@click.command()
+@click.option('--date-min', '-d',
+              help='The earliest date we want to search for event logs in mm/dd/yyyy format.')
+@click.option('--date-max', '-D',
+              help='The latest date we want to search for event logs in mm/dd/yyyy format.')
+@click.option('--obj-event', '-e',
+              help="The event we want to get event logs for")
+@click.option('--obj-id', '-i',
+              help="The id of the object we want to get event logs for")
+@click.option('--obj-type', '-t',
+              help="The type of the object we want to get event logs for")
+@click.option('--utc-offset', '-z',
+              help="UTC Offset for searching with dates. The default is -0000")
+@click.option('--metadata/--no-metadata', default=False,
+              help="Display metadata if present")
+@environment.pass_env
+def cli(env, date_min, date_max, obj_event, obj_id, obj_type, utc_offset, metadata):
+    """Get Event Logs"""
+    mgr = SoftLayer.EventLogManager(env.client)
+    usrmgr = SoftLayer.UserManager(env.client)
+    request_filter = mgr.build_filter(date_min, date_max, obj_event, obj_id, obj_type, utc_offset)
+    logs = mgr.get_event_logs(request_filter)
+
+    if logs is None:
+        env.fout('None available.')
+        return
+
+    if metadata and 'metadata' not in COLUMNS:
+        COLUMNS.append('metadata')
+
+    table = formatting.Table(COLUMNS)
+    if metadata:
+        table.align['metadata'] = "l"
+
+    for log in logs:
+        user = log['userType']
+        if user == "CUSTOMER":
+            user = usrmgr.get_user(log['userId'], "mask[username]")['username']
+        if metadata:
+            try:
+                metadata_data = json.dumps(json.loads(log['metaData']), indent=4, sort_keys=True)
+                if env.format == "table":
+                    metadata_data = metadata_data.strip("{}\n\t")
+            except ValueError:
+                metadata_data = log['metaData']
+
+            table.add_row([log['eventName'], log['label'], log['objectName'],
+                           log['eventCreateDate'], user, metadata_data])
+        else:
+            table.add_row([log['eventName'], log['label'], log['objectName'],
+                           log['eventCreateDate'], user])
+    env.fout(table)

SoftLayer/CLI/event_log/types.py

@@ -0,0 +1,26 @@
+"""Get Event Log Types."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+
+COLUMNS = ['types']
+
+
+@click.command()
+@environment.pass_env
+def cli(env):
+    """Get Event Log Types"""
+    mgr = SoftLayer.EventLogManager(env.client)
+
+    event_log_types = mgr.get_event_log_types()
+
+    table = formatting.Table(COLUMNS)
+
+    for event_log_type in event_log_types:
+        table.add_row([event_log_type])
+
+    env.fout(table)

SoftLayer/CLI/routes.py

@@ -97,6 +97,10 @@
     ('block:volume-order', 'SoftLayer.CLI.block.order:cli'),
     ('block:volume-set-lun-id', 'SoftLayer.CLI.block.lun:cli'),
 
+    ('event-log', 'SoftLayer.CLI.event_log'),
+    ('event-log:get', 'SoftLayer.CLI.event_log.get:cli'),
+    ('event-log:types', 'SoftLayer.CLI.event_log.types:cli'),
+
     ('file', 'SoftLayer.CLI.file'),
     ('file:access-authorize', 'SoftLayer.CLI.file.access.authorize:cli'),
     ('file:access-list', 'SoftLayer.CLI.file.access.list:cli'),
@@ -256,6 +260,7 @@
      'SoftLayer.CLI.securitygroup.interface:add'),
     ('securitygroup:interface-remove',
      'SoftLayer.CLI.securitygroup.interface:remove'),
+    ('securitygroup:event-log', 'SoftLayer.CLI.securitygroup.event_log:get_by_request_id'),
 
     ('sshkey', 'SoftLayer.CLI.sshkey'),
     ('sshkey:add', 'SoftLayer.CLI.sshkey.add:cli'),

SoftLayer/CLI/securitygroup/event_log.py

@@ -0,0 +1,32 @@
+"""Get event logs relating to security groups"""
+# :license: MIT, see LICENSE for more details.
+
+import json
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+
+COLUMNS = ['event', 'label', 'date', 'metadata']
+
+
+@click.command()
+@click.argument('request_id')
+@environment.pass_env
+def get_by_request_id(env, request_id):
+    """Search for event logs by request id"""
+    mgr = SoftLayer.NetworkManager(env.client)
+
+    logs = mgr.get_event_logs_by_request_id(request_id)
+
+    table = formatting.Table(COLUMNS)
+    table.align['metadata'] = "l"
+
+    for log in logs:
+        metadata = json.dumps(json.loads(log['metaData']), indent=4, sort_keys=True)
+
+        table.add_row([log['eventName'], log['label'], log['eventCreateDate'], metadata])
+
+    env.fout(table)

SoftLayer/CLI/securitygroup/interface.py

@@ -14,6 +14,8 @@
            'interface',
            'ipAddress', ]
 
+REQUEST_COLUMNS = ['requestId']
+
 
 @click.command()
 @click.argument('securitygroup_id')
@@ -90,11 +92,16 @@ def add(env, securitygroup_id, network_component, server, interface):
     mgr = SoftLayer.NetworkManager(env.client)
     component_id = _get_component_id(env, network_component, server, interface)
 
-    success = mgr.attach_securitygroup_component(securitygroup_id,
-                                                 component_id)
-    if not success:
+    ret = mgr.attach_securitygroup_component(securitygroup_id,
+                                             component_id)
+    if not ret:
         raise exceptions.CLIAbort("Could not attach network component")
 
+    table = formatting.Table(REQUEST_COLUMNS)
+    table.add_row([ret['requestId']])
+
+    env.fout(table)
+
 
 @click.command()
 @click.argument('securitygroup_id')
@@ -113,11 +120,16 @@ def remove(env, securitygroup_id, network_component, server, interface):
     mgr = SoftLayer.NetworkManager(env.client)
     component_id = _get_component_id(env, network_component, server, interface)
 
-    success = mgr.detach_securitygroup_component(securitygroup_id,
-                                                 component_id)
-    if not success:
+    ret = mgr.detach_securitygroup_component(securitygroup_id,
+                                             component_id)
+    if not ret:
         raise exceptions.CLIAbort("Could not detach network component")
 
+    table = formatting.Table(REQUEST_COLUMNS)
+    table.add_row([ret['requestId']])
+
+    env.fout(table)
+
 
 def _validate_args(network_component, server, interface):
     use_server = bool(server and interface and not network_component)

SoftLayer/CLI/securitygroup/rule.py

@@ -19,6 +19,9 @@
            'createDate',
            'modifyDate']
 
+REQUEST_BOOL_COLUMNS = ['requestId', 'response']
+REQUEST_RULES_COLUMNS = ['requestId', 'rules']
+
 
 @click.command()
 @click.argument('securitygroup_id')
@@ -109,6 +112,11 @@ def add(env, securitygroup_id, remote_ip, remote_group,
     if not ret:
         raise exceptions.CLIAbort("Failed to add security group rule")
 
+    table = formatting.Table(REQUEST_RULES_COLUMNS)
+    table.add_row([ret['requestId'], str(ret['rules'])])
+
+    env.fout(table)
+
 
 @click.command()
 @click.argument('securitygroup_id')
@@ -149,9 +157,16 @@ def edit(env, securitygroup_id, rule_id, remote_ip, remote_group,
     if protocol:
         data['protocol'] = protocol
 
-    if not mgr.edit_securitygroup_rule(securitygroup_id, rule_id, **data):
+    ret = mgr.edit_securitygroup_rule(securitygroup_id, rule_id, **data)
+
+    if not ret:
         raise exceptions.CLIAbort("Failed to edit security group rule")
 
+    table = formatting.Table(REQUEST_BOOL_COLUMNS)
+    table.add_row([ret['requestId']])
+
+    env.fout(table)
+
 
 @click.command()
 @click.argument('securitygroup_id')
@@ -160,5 +175,13 @@ def edit(env, securitygroup_id, rule_id, remote_ip, remote_group,
 def remove(env, securitygroup_id, rule_id):
     """Remove a rule from a security group."""
     mgr = SoftLayer.NetworkManager(env.client)
-    if not mgr.remove_securitygroup_rule(securitygroup_id, rule_id):
+
+    ret = mgr.remove_securitygroup_rule(securitygroup_id, rule_id)
+
+    if not ret:
         raise exceptions.CLIAbort("Failed to remove security group rule")
+
+    table = formatting.Table(REQUEST_BOOL_COLUMNS)
+    table.add_row([ret['requestId']])
+
+    env.fout(table)

SoftLayer/CLI/user/detail.py

@@ -23,7 +23,7 @@
 @click.option('--logins', '-l', is_flag=True, default=False,
               help="Show login history of this user for the last 30 days")
 @click.option('--events', '-e', is_flag=True, default=False,
-              help="Show audit log for this user.")
+              help="Show event log for this user.")
 @environment.pass_env
 def cli(env, identifier, keys, permissions, hardware, virtual, logins, events):
     """User details."""