New Command: virtual notifications

Author: caberos

SoftLayer/CLI/routes.py

@@ -54,6 +54,8 @@
     ('virtual:migrate', 'SoftLayer.CLI.virt.migrate:cli'),
     ('virtual:access', 'SoftLayer.CLI.virt.access:cli'),
     ('virtual:monitoring', 'SoftLayer.CLI.virt.monitoring:cli'),
+    ('virtual:notifications', 'SoftLayer.CLI.virt.notifications:cli'),
+    ('virtual:add-notification', 'SoftLayer.CLI.virt.add_notification:cli'),
 
     ('dedicatedhost', 'SoftLayer.CLI.dedicatedhost'),
     ('dedicatedhost:list', 'SoftLayer.CLI.dedicatedhost.list:cli'),

SoftLayer/CLI/virt/add_notification.py

@@ -0,0 +1,31 @@
+"""Create a user virtual notification entry."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+
+
+@click.command(cls=SoftLayer.CLI.command.SLCommand, )
+@click.argument('identifier')
+@click.option('--users', multiple=True,
+              help='UserId to be notified on monitoring failure.')
+@environment.pass_env
+def cli(env, identifier, users):
+    """Create a user virtual notification entry."""
+
+    virtual = SoftLayer.VSManager(env.client)
+
+    table = formatting.KeyValueTable(['Id', 'Hostmane', 'Username', 'Email', 'FirstName', 'Lastname'])
+    table.align['Id'] = 'r'
+    table.align['Username'] = 'l'
+
+    for user in users:
+        notification = virtual.add_notification(identifier, user)
+        table.add_row([notification['id'], notification['guest']['fullyQualifiedDomainName'],
+                       notification['user']['username'], notification['user']['email'],
+                       notification['user']['lastName'], notification['user']['firstName']])
+
+    env.fout(table)

SoftLayer/CLI/virt/notifications.py

@@ -0,0 +1,30 @@
+"""Get all hardware notifications associated with the passed hardware ID."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+
+
+@click.command(cls=SoftLayer.CLI.command.SLCommand, )
+@click.argument('identifier')
+@environment.pass_env
+def cli(env, identifier):
+    """Get all hardware notifications."""
+
+    virtual = SoftLayer.VSManager(env.client)
+
+    notifications = virtual.get_notifications(identifier)
+
+    table = formatting.KeyValueTable(['Domain', 'Hostmane', 'Username', 'Email', 'FirstName', 'Lastname'])
+    table.align['Domain'] = 'r'
+    table.align['Username'] = 'l'
+
+    for notification in notifications:
+        table.add_row([notification['guest']['fullyQualifiedDomainName'], notification['guest']['hostname'],
+                       notification['user']['username'], notification['user']['email'],
+                       notification['user']['lastName'], notification['user']['firstName']])
+
+    env.fout(table)

SoftLayer/fixtures/SoftLayer_User_Customer_Notification_Virtual_Guest.py

@@ -0,0 +1,55 @@
+findByGuestId = [
+    {
+        'guestId': 100,
+        'id': 123,
+        'userId': 147852,
+        'guest': {
+            'domain': 'test.support.com',
+            'fullyQualifiedDomainName': 'adns.test.support.com',
+            'hostname': 'adns',
+            'id': 123,
+            'maxCpu': 4,
+            'maxCpuUnits': 'CORE',
+            'maxMemory': 16384,
+            'startCpus': 4,
+            'statusId': 1001,
+            'uuid': 'b395782d-2144-1f9c-0a90-28a7a5160d81',
+        },
+        'user': {
+            'accountId': 147852,
+            'displayName': 'TESTSUPPORT',
+            'email': 'testsupport@us.ibm.com',
+            'firstName': 'test',
+            'id': 167758,
+            'lastName': 'support',
+            'username': 'test',
+        }
+    }
+]
+
+createObject = {
+    'guestId': 100,
+    'id': 123,
+    'userId': 147852,
+    'guest': {
+        'domain': 'test.support.com',
+        'fullyQualifiedDomainName': 'adns.test.support.com',
+        'hostname': 'adns',
+        'id': 123,
+        'maxCpu': 4,
+        'maxCpuUnits': 'CORE',
+        'maxMemory': 16384,
+        'startCpus': 4,
+        'statusId': 1001,
+        'uuid': 'b395782d-2144-1f9c-0a90-28a7a5160d81',
+    },
+    'user': {
+        'accountId': 147852,
+        'displayName': 'TESTSUPPORT',
+        'email': 'testsupport@us.ibm.com',
+        'firstName': 'test',
+        'id': 167758,
+        'lastName': 'support',
+        'username': 'test',
+    }
+}

SoftLayer/managers/vs.py

@@ -1458,3 +1458,15 @@ def browser_access_log(self, identifier):
         """
         mask = 'createDate,eventType,id,message,sourceIp,sourcePort,username'
         return self.client.call('SoftLayer_Virtual_Guest', 'getBrowserConsoleAccessLogs', mask=mask, id=identifier)
+
+    def get_notifications(self, vs_id):
+        """Returns all virtual notifications."""
+        return self.client.call('SoftLayer_User_Customer_Notification_Virtual_Guest', 'findByGuestId', vs_id)
+
+    def add_notification(self, virtual_id, user_id):
+        """Create a user virtual notification entry"""
+
+        template = {"guestId": virtual_id, "userId": user_id}
+        mask = 'user'
+        return self.client.call('SoftLayer_User_Customer_Notification_Virtual_Guest',
+                                'createObject', template, mask=mask)

docs/cli/vs.rst

@@ -279,6 +279,14 @@ If no timezone is specified, IMS local time (CST) will be assumed, which might n
    :prog: virtual access
    :show-nested:
 
+.. click:: SoftLayer.CLI.virt.notifications:cli
+   :prog: virtual notifications
+   :show-nested:
+
+.. click:: SoftLayer.CLI.virt.add_notification:cli
+   :prog: virtual add-notification
+   :show-nested:
+
 Manages the migration of virutal guests. Supports migrating virtual guests on Dedicated Hosts as well.
 
 Reserved Capacity

tests/CLI/modules/vs/vs_tests.py

@@ -961,3 +961,11 @@ def test_last_transaction_empty(self):
     def test_user_access(self):
         result = self.run_command(['vs', 'access', '100'])
         self.assert_no_fail(result)
+
+    def test_notifications(self):
+        result = self.run_command(['vs', 'notifications', '100'])
+        self.assert_no_fail(result)
+
+    def test_add_notification(self):
+        result = self.run_command(['vs', 'add-notification', '100', '--users', '123456'])
+        self.assert_no_fail(result)

tests/managers/vs/vs_tests.py

@@ -1330,3 +1330,11 @@ def test_browser_access_log(self):
         result = self.vs.browser_access_log(1234)
         self.assertTrue(result)
         self.assert_called_with('SoftLayer_Virtual_Guest', 'getBrowserConsoleAccessLogs', identifier=1234)
+
+    def test_notification(self):
+        self.vs.get_notifications(100)
+        self.assert_called_with('SoftLayer_User_Customer_Notification_Virtual_Guest', 'findByGuestId')
+
+    def test_add_notification(self):
+        self.vs.add_notification(100, 123456)
+        self.assert_called_with('SoftLayer_User_Customer_Notification_Virtual_Guest', 'createObject')