better usage and input validation depending on action.

user list options implemented

Author: Bernhard Grünewaldt

customfield_editor_plugin_client/cli_client.py

@@ -16,28 +16,55 @@ def main():
     #
     colorama.init(autoreset=True)
     printHelper = PrintHelper()
-    print(colorama.Fore.CYAN + '\n~~ REST API Client for Customfield Editor Plugin ~~ v1.2rc1')
+    print(colorama.Fore.CYAN + '\n~~ REST API Client for Customfield Editor Plugin ~~ v1.2rc1\n')
 
     #
     # CLI PARAMS
     #
     parser = argparse.ArgumentParser(description='Customfield Editor Plugin REST API CLI Client.')
+
+    parser.add_argument("-a", "--action", help='Which action to execute.', choices=['adminListFields', 'adminGrantPermission', 'userListFields', 'userListOptions'])
+    parser.add_argument("-url", "--baseUrl", help='baseUrl to JIRA instance e.g. http://server:port/jira/')
+    parser.add_argument("-user", "--authUsername", help='username for basic auth.')
+    parser.add_argument("-pass", "--authPassword", help='password for basic auth.')
+
+    #
+    # CLI PARAMS depending on action
+    #
     parser.add_argument("-cid", "--customFieldId", type=int, help='The ID of the custom field.')
+    parser.add_argument("-ctx", "--contextId", type=int, help='The ID of the custom field context.')
     parser.add_argument("-ulist", "--userList", nargs='+', help='space separated user names to grant permission')
     parser.add_argument("-glist", "--groupList", nargs='+', help='space separated group names to grant permission')
-    parser.add_argument("-a", "--action", help='Which action to execute.', choices=['adminListFields', 'adminGrantPermission', 'userListFields'], required=True)
-    parser.add_argument("-url", "--baseUrl", help='baseUrl to JIRA instance e.g. http://server:port/jira/', required=True)
-    parser.add_argument("-user", "--authUsername", help='username for basic auth.', required=True)
-    parser.add_argument("-pass", "--authPassword", help='password for basic auth.', required=True)
+
     args = parser.parse_args()
+    if not args.action:
+        printHelper.headline('USAGE')
+        printHelper.step('admin operations')
+        print ('    list fields:')
+        print ('      $> cep-client -a adminListFields -url http://localhost:2990/jira/ -user admin -pass admin')
+        print ('')
+        print ('    grant permissions:')
+        print ('      $> cep-client -a adminGrantPermission --customFieldId 10100 --userList bob steve \ \n'
+               '                    -url http://localhost:2990/jira/ -user admin -pass admin')
+        print ('      OPTIONAL: --groupList with one or more groupnames')
+
+        printHelper.step('user operations')
+        print ('    list fields:')
+        print ('      $> cep-client -a userListFields -url http://localhost:2990/jira/ -user admin -pass admin')
+        print ('')
+        print ('    list options:')
+        print ('      $> cep-client -a userListOptions --customFieldId 10001 -url http://localhost:2990/jira/ -user admin -pass admin')
+        # $> cep-client -a adminGrantPermission --customFieldId 10100 --userList bob steve  -url http://localhost:2990/jira -user admin -pass admin
+        # (optional: --groupList)
+        sys.exit(1)
 
 
     #
     # INITIALIZE HELPERS
     #
     printHelper.step('initializing')
     try:
-        userInput = UserInput(args.baseUrl, args.authUsername, args.authPassword)
+        userInput = UserInput(args)
     except UserInputException as ex:
         printHelper.error('UserInput is invalid.')
         print (ex)
@@ -68,13 +95,11 @@ def main():
         #
         # ADMIN ACTIONS
         #
-        # $> cep-client -a adminListFields -url http://localhost:2990/jira/ -user admin -pass admin
+        #
         if args.action == 'adminListFields':
-
             adminOperations.list_fields()
 
-        #> cep-client -a adminGrantPermission --customFieldId 10100 --userList bob steve  -url http://localhost:2990/jira -user admin -pass admin
-        # (optional: --groupList)
+
         if args.action == 'adminGrantPermission':
             adminOperations.grant_permission(args.customFieldId, args.userList, args.groupList)
 
@@ -85,6 +110,8 @@ def main():
         if args.action == 'userListFields':
             userOperations.list_fields()
 
+        if args.action == 'userListOptions':
+            userOperations.list_options(args.customFieldId, args.contextId)
 
 
     except requests.ConnectionError as ex:

customfield_editor_plugin_client/helper/print_helper.py

@@ -23,6 +23,9 @@ def error(self, text):
     def step(self, text):
         print(colorama.Fore.CYAN + '\n> ' + text)
 
+    def headline(self, text):
+        print(colorama.Fore.MAGENTA + '\n# ' + text)
+
     def action(self, text):
         print(colorama.Fore.MAGENTA + '\n# Action: ' + text)
 

customfield_editor_plugin_client/model/user_input.py

@@ -3,20 +3,49 @@
 
 class UserInput:
 
-    def __init__(self, baseurl, username, password):
-        self.baseUrl = baseurl
-        self.authUserName = username
-        self.authPassword = password
+    def __init__(self, cli_args):
+        self.baseUrl = cli_args.baseUrl
+        self.authUserName = cli_args.authUsername
+        self.authPassword = cli_args.authPassword
+        self.validate_cli_args(cli_args)
 
     @property
-    def baseUrl(self):
-        return self.__baseUrl
+    def authUserName(self):
+        return self._auth_username
+    @authUserName.setter
+    def authUserName(self, value):
+        if not value:
+            raise UserInputException('authUserName needs to be set.')
+        self._auth_username = value
+
+    @property
+    def authPassword(self):
+        return self._auth_password
+    @authPassword.setter
+    def authPassword(self, value):
+        if not value:
+            raise UserInputException('authPassword needs to be set.')
+        self._auth_password = value
 
+    @property
+    def baseUrl(self):
+        return self._base_url
     @baseUrl.setter
     def baseUrl(self, value):
         if not validators.url(value, require_tld=False):
             raise UserInputException('baseUrl needs to be valid URL.')
         if not value.endswith('/'):
             value = value + '/'
+        self._base_url = value
+
+
+    def validate_cli_args(self, cli_args):
+        if cli_args.action == 'adminGrantPermission':
+            self._validate_customfield_id(cli_args.customFieldId)
+
+        if cli_args.action == 'userListOptions':
+            self._validate_customfield_id(cli_args.customFieldId)
 
-        self.__baseUrl = value
+    def _validate_customfield_id(self, id):
+        if id <= 0:
+            raise UserInputException('customFieldId needs to be positive integer.')

customfield_editor_plugin_client/modules/user_operations.py

@@ -10,3 +10,11 @@ def __init__(self, api_helper):
     def list_fields(self):
         response_json = self._api.get('/user/customfields')
         self._print.table(response_json)
+
+    def list_options(self, customfield_id, context_id):
+        if context_id:
+            response_json = self._api.get('/user/customfields/{0}/contexts/{1}/options'.format(customfield_id, context_id))
+        else:
+            response_json = self._api.get('/user/customfields/{0}/contexts/default/options'.format(customfield_id))
+
+        self._print.table(response_json)