insert options and setting default value working

Author: Bernhard Grünewaldt

customfield_editor_plugin_client/cli_client.py

@@ -3,7 +3,8 @@
 import colorama
 import requests
 from .helper.api_helper import ApiHelper
-from .helper.api_helper_exception import ApiHelperException
+from .helper.api_helper_exceptions import ApiHelperException
+from .helper.api_helper_exceptions import ValidationErrorsException
 from .helper.print_helper import PrintHelper
 from .model.user_input import UserInput
 from .model.user_input_exception import UserInputException
@@ -119,7 +120,7 @@ def main():
                 with open(args.payloadFile) as payloadFile:
                     userOperations.insert_options(args.customFieldId, args.contextId, payloadFile)
             except FileNotFoundError as ex:
-                printHelper.error('payloadFile not found: {0}'.format(args.payloadFile))
+                printHelper.error('payloadFile not found')
                 raise ApiHelperException('payloadFile not found')
 
 
@@ -129,7 +130,7 @@ def main():
         print (ex)
         sys.exit(1)
     except ApiHelperException as ex:
-        print ('')
+        printHelper.pretty(ex.args[0])
         printHelper.error('There seemed to a be problem with your request. Check errors above. EXIT')
         sys.exit(1)
 

customfield_editor_plugin_client/helper/api_helper.py

@@ -1,7 +1,9 @@
 import requests
 import textwrap
 import tabulate
-from .api_helper_exception import ApiHelperException
+from .api_helper_exceptions import ApiHelperException
+from .api_helper_exceptions import ValidationErrorsException
+
 from .print_helper import PrintHelper
 
 class ApiHelper:
@@ -15,22 +17,30 @@ def __init__(self, userInput):
     def post(self, urlpart, payload):
         request_url = self._rest_url(urlpart)
         self.printHelper.step('POST ' + request_url)
-        response = requests.post(request_url, json=payload, auth=(self.userInput.authUserName, self.userInput.authPassword))
-        self._handle_response_errors(response)
         try:
-            return response.json()
-        except ValueError as ex:
-            return {}
+            response = requests.post(request_url, json=payload, auth=(self.userInput.authUserName, self.userInput.authPassword))
+            self._handle_response_errors(response)
+            try:
+                return response.json()
+            except ValueError as ex:
+                return {}
+        except ValidationErrorsException as ex:
+            self.printHelper.warn('Validation Errors')
+            self.printHelper.table(ex.args[0]['errors'])
 
     def put(self, urlpart, payload):
         request_url = self._rest_url(urlpart)
         self.printHelper.step('PUT ' + request_url)
-        response = requests.put(request_url, json=payload, auth=(self.userInput.authUserName, self.userInput.authPassword))
-        self._handle_response_errors(response)
         try:
-            return response.json()
-        except ValueError as ex:
-            return {}
+            response = requests.put(request_url, json=payload, auth=(self.userInput.authUserName, self.userInput.authPassword))
+            self._handle_response_errors(response)
+            try:
+                return response.json()
+            except ValueError as ex:
+                return {}
+        except ValidationErrorsException as ex:
+            self.printHelper.warn('Validation Errors')
+            self.printHelper.table(ex.args[0]['errors'])
 
     def get(self, urlpart):
         request_url = self._rest_base_url() + urlpart
@@ -61,20 +71,14 @@ def _rest_url(self, url_part):
 
     def _handle_response_errors(self, response):
         if response.status_code == 200:
-            self.printHelper.success('request successful')
             return
         elif response.status_code == 204:
-            self.printHelper.success('request successful')
             return
         elif response.status_code == 400:
-            self.printHelper.error(response.json())
-            raise ApiHelperException(401)
+            raise ValidationErrorsException(response.json())
         elif response.status_code == 401:
-            self.printHelper.error('UNAUTHORIZED (401). Authorization failed (wrong or no credentials).')
-            raise ApiHelperException(401)
+            raise ApiHelperException('UNAUTHORIZED (401). Authorization failed (wrong or no credentials).')
         elif response.status_code == 403:
-            self.printHelper.error('FORBIDDEN (403). Insufficient rights - OR - too many failed login attempts. (Log into JIRA in the browser to solve CAPTCHA).')
-            raise ApiHelperException(403)
+            raise ApiHelperException('FORBIDDEN (403). Insufficient rights - OR - too many failed login attempts. (Log into JIRA in the browser to solve CAPTCHA).')
         else:
-            self.printHelper.error('request failed with HTTP {0}'.format(response.status_code))
-            raise ApiHelperException(response.status_code)
+            raise ApiHelperException('request failed with HTTP {0}'.format(response.status_code))

customfield_editor_plugin_client/helper/api_helper_exception.py

@@ -0,0 +1,11 @@
+class ApiHelperException(Exception):
+    def __init__(self, value):
+        self.value = value
+    def __str__(self):
+        return repr(self.value)
+
+class ValidationErrorsException(Exception):
+    def __init__(self, value):
+        self.value = value
+    def __str__(self):
+        return repr(self.value)

customfield_editor_plugin_client/helper/api_helper_exceptions.py

@@ -2,6 +2,8 @@
 import colorama
 import textwrap
 import tabulate
+import pprint
+
 class PrintHelper:
 
     def _success_prefix(self):
@@ -29,5 +31,13 @@ def headline(self, text):
     def action(self, text):
         print(colorama.Fore.MAGENTA + '\n# Action: ' + text)
 
+    def warn(self, text):
+        print(colorama.Fore.YELLOW + '  > ' + text)
+
     def table(self, json):
         print(textwrap.indent(tabulate.tabulate(json, headers="keys"), '  '))
+
+    def pretty(self, json):
+        self._pp = pprint.PrettyPrinter()
+        self._pp.pprint(json)
+        #print(textwrap.indent(, '  '))

customfield_editor_plugin_client/helper/print_helper.py

@@ -1,7 +1,7 @@
 import json
 from customfield_editor_plugin_client.helper.print_helper import PrintHelper
 from customfield_editor_plugin_client.helper.api_helper import ApiHelper
-from customfield_editor_plugin_client.api_helper_exception import ApiHelperException
+from customfield_editor_plugin_client.helper.api_helper_exceptions import ApiHelperException
 
 class UserOperations:
 
@@ -24,19 +24,24 @@ def list_options(self, customfield_id, context_id):
 
     def insert_options(self, customfield_id, context_id, options):
         optionsJson = json.load(options)
-        print (optionsJson)
+        self._print.table(optionsJson)
         if context_id:
             context_infix = context_id
         else:
             context_infix = 'default'
 
         for option in optionsJson:
-            try:
-                response_json = self._api.post('/user/customfields/{0}/contexts/{1}/options'.format(customfield_id, context_infix),
-                                               {
-                                                   "optionvalue": option['optionvalue']
-                                               })
-                #self._print.table(response_json)
-            except ApiHelperException as ex:
-                print (ex)
+            created_option = self._api.post('/user/customfields/{0}/contexts/{1}/options'.format(customfield_id, context_infix),
+                                           {
+                                               "optionvalue": option['optionvalue']
+                                           })
+            if created_option and 'id' in created_option:
+                self._print.pretty(created_option)
+                if 'default' in option:
+                    self._api.post('/user/customfields/{0}/contexts/{1}/options/default'.format(customfield_id, context_infix),
+                                {
+                                    "optionId": created_option['id']
+                                })
+
+
 

customfield_editor_plugin_client/modules/user_operations.py

@@ -1,12 +1,12 @@
 [
   {
-    "optionvalue" : "windows"
+    "optionvalue" : "windows7"
   },
   {
-    "optionvalue" : "linux"
+    "optionvalue" : "linux7"
   },
   {
-    "optionvalue" : "mac",
-    "default": true
+    "optionvalue" : "mac7",
+    "default": "true"
   }
 ]