Enhance the client to support uploading an attachment to a ticket (softlayer#735)

joshuakwan · sudorandom · commit 4932cac9c059 · 2016-07-27T20:58:48.000-05:00
* add support to ticket.addAttachedFile as slcli ticket upload * fix the doc * fix the issues in softlayer#735 * move the build of file objects into ticket.py * add tests to the attachment upload function
diff --git a/SoftLayer/CLI/routes.py b/SoftLayer/CLI/routes.py
@@ -199,6 +199,7 @@
     ('ticket:detail', 'SoftLayer.CLI.ticket.detail:cli'),
     ('ticket:list', 'SoftLayer.CLI.ticket.list:cli'),
     ('ticket:update', 'SoftLayer.CLI.ticket.update:cli'),
+    ('ticket:upload', 'SoftLayer.CLI.ticket.upload:cli'),
     ('ticket:subjects', 'SoftLayer.CLI.ticket.subjects:cli'),
     ('ticket:summary', 'SoftLayer.CLI.ticket.summary:cli'),
     ('ticket:attach', 'SoftLayer.CLI.ticket.attach:cli'),
diff --git a/SoftLayer/CLI/ticket/upload.py b/SoftLayer/CLI/ticket/upload.py
@@ -0,0 +1,37 @@
+"""Adds an attachment to an existing ticket."""
+# :license: MIT, see LICENSE for more details.
+
+import os
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import exceptions
+from SoftLayer.CLI import helpers
+
+
+@click.command()
+@click.argument('identifier')
+@click.option('--path', help="The path of the attachment to be uploaded")
+@click.option('--name', help="The name of the attachment shown in the ticket")
+@environment.pass_env
+def cli(env, identifier, path, name):
+    """Adds an attachment to an existing ticket."""
+    mgr = SoftLayer.TicketManager(env.client)
+
+    ticket_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'ticket')
+
+    if path is None:
+        raise exceptions.ArgumentError("Missing argument --path")
+
+    if not os.path.exists(path):
+        raise exceptions.ArgumentError("%s not exist" % path)
+
+    if name is None:
+        name = os.path.basename(path)
+
+    attached_file = mgr.upload_attachment(ticket_id=ticket_id,
+                                          file_path=path,
+                                          file_name=name)
+    env.fout("File attached: \n%s" % attached_file)
diff --git a/SoftLayer/fixtures/SoftLayer_Ticket.py b/SoftLayer/fixtures/SoftLayer_Ticket.py
@@ -48,5 +48,17 @@
     "ticketId": 100
 }
 
+addAttachedFile = {
+    "id": 123,
+    "fileName": "a_file_name",
+    "fileSize": "100",
+    "ticketId": 100,
+    "updateId": 200,
+    "createDate": "2013-08-01T14:14:04-07:00",
+    "modifyDate": "2013-08-01T14:14:04-07:00",
+    "uploaderType": "USER",
+    "uploaderId": "300"
+}
+
 removeAttachedHardware = True
 removeAttachedVirtualGuest = True
diff --git a/SoftLayer/managers/ticket.py b/SoftLayer/managers/ticket.py
@@ -80,6 +80,30 @@ def update_ticket(self, ticket_id=None, body=None):
         """
         return self.ticket.addUpdate({'entry': body}, id=ticket_id)
 
+    def upload_attachment(self, ticket_id=None, file_path=None,
+                          file_name=None):
+        """Upload an attachment to a ticket.
+
+        :param integer ticket_id: the id of the ticket to
+                                  upload the attachment to
+        :param string file_path:
+                                  The path of the attachment to be uploaded
+        :param string file_name:
+                                  The name of the attachment shown
+                                  in the ticket
+        :returns The uploaded attachment
+        """
+        file_content = None
+        with open(file_path, 'rb') as attached_file:
+            file_content = attached_file.read()
+
+        file_object = {
+            "filename": file_name,
+            "data": file_content
+        }
+
+        return self.ticket.addAttachedFile(file_object, id=ticket_id)
+
     def attach_hardware(self, ticket_id=None, hardware_id=None):
         """Attach hardware to a ticket.
 
diff --git a/tests/CLI/modules/ticket_tests.py b/tests/CLI/modules/ticket_tests.py
@@ -167,3 +167,40 @@ def test_ticket_detach_virtual_server(self):
                                 'removeAttachedVirtualGuest',
                                 args=(100,),
                                 identifier=1)
+
+    def test_ticket_upload_no_path(self):
+        result = self.run_command(['ticket', 'upload', '1'])
+
+        self.assertEqual(result.exit_code, 2)
+        self.assertIsInstance(result.exception, exceptions.ArgumentError)
+
+    def test_ticket_upload_invalid_path(self):
+        result = self.run_command(['ticket', 'upload', '1',
+                                   '--path=tests/resources/nonexistent_file',
+                                   '--name=a_file_name'])
+
+        self.assertEqual(result.exit_code, 2)
+        self.assertIsInstance(result.exception, exceptions.ArgumentError)
+
+    def test_ticket_upload_no_name(self):
+        result = self.run_command(['ticket', 'upload', '1',
+                                   '--path=tests/resources/attachment_upload'])
+
+        self.assert_no_fail(result)
+        self.assert_called_with('SoftLayer_Ticket',
+                                'addAttachedFile',
+                                args=({"filename": "attachment_upload",
+                                       "data": b"ticket attached data"},),
+                                identifier=1)
+
+    def test_ticket_upload(self):
+        result = self.run_command(['ticket', 'upload', '1',
+                                   '--path=tests/resources/attachment_upload',
+                                   '--name=a_file_name'])
+
+        self.assert_no_fail(result)
+        self.assert_called_with('SoftLayer_Ticket',
+                                'addAttachedFile',
+                                args=({"filename": "a_file_name",
+                                       "data": b"ticket attached data"},),
+                                identifier=1)
diff --git a/tests/resources/attachment_upload b/tests/resources/attachment_upload
@@ -0,0 +1 @@
+ticket attached data
