finishing off user detail features, added some docs

allmightyspiff · allmightyspiff · commit 525492044b9e · 2018-05-08T17:46:10.000-05:00
diff --git a/SoftLayer/CLI/formatting.py b/SoftLayer/CLI/formatting.py
@@ -12,7 +12,7 @@
 import os
 
 import click
-import prettytable
+from prettytable import prettytable
 
 from SoftLayer.CLI import exceptions
 from SoftLayer import utils
@@ -255,7 +255,7 @@ class Table(object):
 
     :param list columns: a list of column names
     """
-    def __init__(self, columns):
+    def __init__(self, columns, title=None):
         duplicated_cols = [col for col, count
                            in collections.Counter(columns).items()
                            if count > 1]
@@ -267,6 +267,7 @@ def __init__(self, columns):
         self.rows = []
         self.align = {}
         self.sortby = None
+        self.title = title
 
     def add_row(self, row):
         """Add a row to the table.
@@ -287,6 +288,7 @@ def to_python(self):
     def prettytable(self):
         """Returns a new prettytable instance."""
         table = prettytable.PrettyTable(self.columns)
+
         if self.sortby:
             if self.sortby in self.columns:
                 table.sortby = self.sortby
@@ -296,6 +298,8 @@ def prettytable(self):
         for a_col, alignment in self.align.items():
             table.align[a_col] = alignment
 
+        if self.title:
+            table.title = self.title
         # Adding rows
         for row in self.rows:
             table.add_row(row)
diff --git a/SoftLayer/CLI/user/detail.py b/SoftLayer/CLI/user/detail.py
@@ -11,15 +11,22 @@
 
 from pprint import pprint as pp
 
-
-
-
-
 @click.command()
 @click.argument('identifier')
-@click.option('--keys', is_flag=True, default=False)
+@click.option('--keys', is_flag=True, default=False,
+              help="Show the users API key.")
+@click.option('--permissions', '-p', is_flag=True, default=False,
+              help="Display permissions assigned to this user. Master users will show no permissions")
+@click.option('--hardware', '-h', is_flag=True, default=False,
+              help="Display hardware this user has access to.")
+@click.option('--virtual', '-v', is_flag=True, default=False,
+              help="Display virtual guests this user has access to.")
+@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.")
 @environment.pass_env
-def cli(env, identifier, keys):
+def cli(env, identifier, keys, permissions, hardware, virtual, logins, events):
     """User details."""
     
     mgr = SoftLayer.UserManager(env.client)
@@ -30,6 +37,27 @@ def cli(env, identifier, keys):
     user = mgr.get_user(user_id, object_mask)
     env.fout(basic_info(user, keys))
 
+    if permissions:
+        perms = mgr.get_user_permissions(user_id)
+        env.fout(print_permissions(perms))
+    if hardware:
+        mask = "id, hardware, dedicatedHosts"
+        access = mgr.get_user(user_id, mask)
+        env.fout(print_dedicated_access(access['dedicatedHosts']))
+        env.fout(print_access(access['hardware'], 'Hardware'))
+    if virtual:
+        mask = "id, virtualGuests"
+        access = mgr.get_user(user_id, mask)
+        env.fout(print_access(access['virtualGuests'], 'Virtual Guests'))
+    if logins:
+        mask = "id, unsuccessfulLogins, successfulLogins"
+        login_log = mgr.get_logins(user_id)
+        env.fout(print_logins(login_log))
+    if events:
+        event_log = mgr.get_events(user_id)
+        env.fout(print_events(event_log))
+        
+
 
 def basic_info(user, keys):
     """Prints a table of basic user information"""
@@ -69,3 +97,56 @@ def basic_info(user, keys):
 
     return table
 
+def print_permissions(permissions):
+    """Prints out a users permissions"""
+
+    table = formatting.Table(['keyName', 'Description'])
+    for perm in permissions:
+        table.add_row([perm['keyName'], perm['name']])
+    return table
+
+def print_access(access, title):
+    """Prints out the hardware or virtual guests a user can access"""
+
+    columns = ['id', 'hostname', 'Primary Public IP', 'Primary Private IP', 'Created']
+    table = formatting.Table(columns, title)
+      
+    for host in access:
+        host_id = host.get('id')
+        host_fqdn = host.get('fullyQualifiedDomainName', '-')
+        host_primary = host.get('primaryIpAddress')
+        host_private = host.get('primaryBackendIpAddress')
+        host_created = host.get('provisionDate')
+        table.add_row([host_id, host_fqdn, host_primary, host_private, host_created])
+    return table
+
+def print_dedicated_access(access):
+    """Prints out the dedicated hosts a user can access"""
+
+    table = formatting.Table(['id', 'Name', 'Cpus', 'Memory', 'Disk', 'Created'], 'Dedicated Access')
+    for host in access:
+        host_id = host.get('id')
+        host_fqdn = host.get('name')
+        host_cpu = host.get('cpuCount')
+        host_mem = host.get('memoryCapacity')
+        host_disk = host.get('diskCapacity')
+        host_created = host.get('createDate')
+        table.add_row([host_id, host_fqdn, host_cpu, host_mem, host_disk, host_created])
+    return table
+
+def print_logins(logins):
+    """Prints out the login history for a user"""
+    table = formatting.Table(['Date', 'IP Address', 'Successufl Login?'])
+    for login in logins:
+        table.add_row([login.get('createDate'), login.get('ipAddress'), login.get('successFlag')])
+    return table
+
+def print_events(events):
+    """Prints out the event log for a user"""
+    columns = ['Date', 'Type', 'IP Address', 'label', 'username']
+    table = formatting.Table(columns)
+    for event in events:
+        table.add_row([event.get('eventCreateDate'), event.get('eventName'), 
+                      event.get('ipAddress'), event.get('label'), event.get('username')])
+    return table
+
diff --git a/SoftLayer/CLI/user/edit_permissions.py b/SoftLayer/CLI/user/edit_permissions.py
@@ -20,7 +20,7 @@
                 help="Permission keyName to set, multiple instances allowed.")
 @environment.pass_env
 def cli(env, identifier, enable, permission):
-    """Enable or Disable specific permissions for a user"""
+    """Enable or Disable specific permissions."""
     
     mgr = SoftLayer.UserManager(env.client)
     user_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'username')
diff --git a/SoftLayer/CLI/user/list.py b/SoftLayer/CLI/user/list.py
@@ -1,4 +1,4 @@
-"""List images."""
+"""List Users."""
 # :license: MIT, see LICENSE for more details.
 
 import click
@@ -29,21 +29,19 @@
     'virtualGuestCount'
 ]
 @click.command()
-@click.option('--name', default=None, help='Filter on user name')
+@click.option('--name', default=None, help='Filter on username')
 @click.option('--columns',
               callback=column_helper.get_formatter(COLUMNS),
               help='Columns to display. [options: %s]' % ', '.join(column.name for column in COLUMNS),
               default=','.join(DEFAULT_COLUMNS),
               show_default=True)
 @environment.pass_env
 def cli(env, name, columns):
-    """List images."""
+    """List Users."""
 
     mgr = SoftLayer.UserManager(env.client)
     users = mgr.list_users()
 
-
-    # pp(users)
     table = formatting.Table(columns.columns)
     for user in users:
         table.add_row([value or formatting.blank()
diff --git a/SoftLayer/CLI/user/permissions.py b/SoftLayer/CLI/user/permissions.py
@@ -11,7 +11,7 @@
 @click.argument('identifier')
 @environment.pass_env
 def cli(env, identifier):
-    """User Permissions."""
+    """User Permissions. TODO change to list all permissions, and which users have them"""
     
     mgr = SoftLayer.UserManager(env.client)
     user_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'username')
diff --git a/SoftLayer/managers/user.py b/SoftLayer/managers/user.py
@@ -8,6 +8,7 @@
 from SoftLayer import exceptions
 from SoftLayer import utils
 
+import datetime
 from operator import itemgetter
 
 
@@ -66,6 +67,60 @@ def remove_permissions(self, user_id, permissions):
         pretty_permissions = format_permission_object(permissions)
         return self.userService.removeBulkPortalPermission(pretty_permissions, id=user_id)
 
+    def get_user_permissions(self, user_id):
+        """Returns a sorted list of a users permissions"""
+        permissions = self.userService.getPermissions(id=user_id)
+        return sorted(permissions, key=itemgetter('keyName'))
+
+    def get_logins(self, user_id, start_date=None):
+        """Gets the login history for a user, default start_date is 30 days ago
+
+        :param int id: User id to get
+        :param string start_date: "%m/%d/%Y %H:%M:%s" formatted string. 
+        :returns: list https://softlayer.github.io/reference/datatypes/SoftLayer_User_Customer_Access_Authentication/
+        Example::
+            get_logins(123, '04/08/2018 0:0:0')
+        """
+
+        if start_date is None:
+            date_object = datetime.date.today() - datetime.timedelta(days=30)
+            start_date = date_object.strftime("%m/%d/%Y 0:0:0")
+
+        date_filter = {
+            'loginAttempts': {
+                'createDate': {
+                    'operation': 'greaterThanDate', 
+                    'options': [{'name': 'date', 'value': [start_date]}]
+                    }
+                }
+            }
+        login_log = self.userService.getLoginAttempts(id=user_id, filter=date_filter)
+        return login_log
+
+    def get_events(self, user_id, start_date=None):
+        """Gets the event log for a specific user, default start_date is 30 days ago
+
+        :param int id: User id to view
+        :param string start_date: "%Y-%m-%dT%H:%M:%s.0000-06:00" formatted string. Anything else wont work
+        :returns: https://softlayer.github.io/reference/datatypes/SoftLayer_Event_Log/
+        """
+
+        if start_date is None:
+            date_object = datetime.date.today() - datetime.timedelta(days=30)
+            start_date = date_object.strftime("%Y-%m-%dT00:00:00.0000-06:00")
+
+        object_filter = {
+            'userId': {
+                'operation': user_id
+            },
+            'eventCreateDate': {
+                'operation': 'greaterThanDate', 
+                'options': [{'name': 'date', 'value': [start_date]}]
+            }
+        }
+
+        return self.client.call('Event_Log', 'getAllObjects', filter=object_filter)
+
     def _get_id_from_username(self, username):
         _mask = "mask[id, username]"
         _filter = {'users' : {'username': utils.query_filter(username)}}
diff --git a/docs/cli/users.rst b/docs/cli/users.rst
@@ -0,0 +1,66 @@
+.. _cli_user:
+
+Users
+=============
+Version 5.6.0 introduces the ability to interact with user accounts from the cli. 
+
+.. _cli_user_list:
+
+user list
+----------
+This command will list all Active users on the account that your user has access to view. 
+There is the option to also filter by username
+
+
+.. _cli_user_detail:
+
+user detail <user>
+-------------------
+Gives a variety of details about a specific user. <user> can be a user id, or username. Will always print a basic set of information about the user, but there are a few extra flags to pull in more detailed information.
+
+user detail <user> -p, --permissions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Will list the permissions the user has. To see a list of all possible permissions, or to change a users permissions, see :ref:`cli_user_permissions`
+
+user detail <user> -h, --hardware
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Will list the Hardware and Dedicated Hosts the user is able to access. 
+
+
+user detail <user> -v, --virtual
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Will list the Virtual Guests the user has access to.
+
+user detail <user> -l, --logins
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Show login history of this user for the last 30 days. IBMId Users will show logins properly, but may not show failed logins. 
+
+user detail <user> -e, --events
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Shows things that are logged in the Event_Log service. Logins, reboots, reloads, and other such actions will show up here.
+
+.. _cli_user_permissions:
+
+user permissions
+----------------
+
+Will list off all permission keyNames, along with wich usernames have that permissions.
+
+user permissions <user>
+^^^^^^^^^^^^^^^^^^^^^^^
+Will list off all permission keyNames, along with which are assigned to that specific user.
+
+.. _cli_user_permissions_edit:
+
+user edit-permissions
+---------------------
+Enable or Disable specific permissions. It is possible to set multiple permissions in one command as well.
+
+::
+
+    $ slcli user edit-permissions USERID --enable -p TICKET_EDIT -p TICKET_ADD -p TICKET_SEARCH
+
+Will enable TICKET_EDIT, TICKET_ADD, and TICKET_SEARCH permissions for the USERID
+
+
+
diff --git a/setup.py b/setup.py
@@ -31,7 +31,7 @@
     },
     install_requires=[
         'six >= 1.7.0',
-        'prettytable >= 0.7.0',
+        'ptable >= 0.9.2',
         'click >= 5',
         'requests >= 2.18.4',
         'prompt_toolkit >= 0.53',
