#3 update help messages

Author: LD250

README.md

@@ -32,12 +32,12 @@ Server URL, Username and password may be specified either by the command line ar
 # Available commands:
 ```bash
   {jobs,queue,building,start,info,set_branch,stop,console}
-    jobs                Show all jobs and their status
+    jobs                Show all jobs and their statuses
     queue               Shows builds queue
     building            Build executor status
     start               Start job
     info                Job info
-    set_branch          Job info
+    set_branch          Set SCM branch
     stop                Stop job
-    console             Show job history
+    console             Show console for last build
 ```

jenkins_cli/__init__.py

@@ -1,7 +1,7 @@
 import argparse
 from jenkins import JenkinsException
 
-from jenkins_cli.cli import JenkinsCli, CliException
+from jenkins_cli.cli import JenkinsCli, CliException, get_jobs_legend
 
 
 def main():
@@ -17,7 +17,10 @@ def main():
 
     subparsers = parser.add_subparsers(title='Available commands', dest='jenkins_command')
 
-    jobs_parser = subparsers.add_parser('jobs', help='Show all jobs and their status')
+    jobs_parser = subparsers.add_parser('jobs',
+                                        help='Show all jobs and their statuses',
+                                        formatter_class=argparse.RawTextHelpFormatter,
+                                        description="Status description:\n\n" + "\n".join(get_jobs_legend()))
     jobs_parser.add_argument('-a', help='Show only active jobs', default=False, action='store_true')
 
     subparsers.add_parser('queue', help='Shows builds queue')
@@ -30,15 +33,15 @@ def main():
     start_parser = subparsers.add_parser('info', help='Job info')
     start_parser.add_argument('job_name', help='Job to to get info for')
 
-    set_branch = subparsers.add_parser('set_branch', help='Job info')
+    set_branch = subparsers.add_parser('setbranch', help='Set SCM branch')
     set_branch.add_argument('job_name', help='Job to to set branch')
-    set_branch.add_argument('branch_name', help='Name of the branch')
+    set_branch.add_argument('branch_name', help='Name of the SCM branch')
 
     stop_parser = subparsers.add_parser('stop', help='Stop job')
     stop_parser.add_argument('job_name', help='Job to stop')
 
-    console_parser = subparsers.add_parser('console', help='Show job history')
-    console_parser.add_argument('job_name', help='Job to show history for')
+    console_parser = subparsers.add_parser('console', help='Show console for last build')
+    console_parser.add_argument('job_name', help='Job to show console for')
     console_parser.add_argument('-n', help='Show first n num of the lines only(if n is negative, shows last n lines)', type=int)
     console_parser.add_argument('-i', help='Interactive console', default=False, action='store_true')
 

jenkins_cli/cli.py

@@ -7,15 +7,20 @@
 from xml.etree import ElementTree
 
 STATUSES = {'blue': {'symbol': 'S',
-                     'color': '\033[94m'},
+                     'color': '\033[94m',
+                     'descr': 'Stable'},
             'red': {'symbol': 'F',
-                    'color': '\033[91m'},
+                    'color': '\033[91m',
+                    'descr': 'Failed'},
             'yellow': {'symbol': 'U',
-                       'color': '\033[93m'},
+                       'color': '\033[93m',
+                       'descr': 'Unstable'},
             'disabled': {'symbol': 'D',
-                         'color': '\033[97m'},
+                         'color': '\033[97m',
+                         'descr': 'Disabled'},
             'aborted': {'symbol': 'A',
-                        'color': '\033[97m'}
+                        'color': '\033[97m',
+                        'descr': 'Aborted'}
             }
 
 # 'green': '\033[92m',
@@ -25,6 +30,25 @@
 ANIME_SYMBOL = ['..', '>>']
 
 
+def get_formated_status(job_color, format_pattern="%(color)s%(symbol)s%(run_status)s%(endcollor)s"):
+    color_status = job_color.split('_')
+    color = color_status[0]
+    run_status = color_status[1] if len(color_status) == 2 else None
+    status = STATUSES[color]
+    return format_pattern % {'color': status['color'],
+                             'symbol': status['symbol'],
+                             'descr': status['descr'],
+                             'run_status': ANIME_SYMBOL[run_status == 'anime'],
+                             'endcollor': ENDCOLLOR}
+
+
+def get_jobs_legend():
+    pattern = "%(color)s%(symbol)s..%(endcollor)s -> %(descr)s"
+    legend = [get_formated_status(job_color, pattern) for job_color in STATUSES.keys()]
+    legend.append(".>> -> Build in progress")
+    return legend
+
+
 class CliException(Exception):
     pass
 
@@ -84,11 +108,8 @@ def run_command(self, args):
     def jobs(self, args):
         jobs = self._get_jobs(args)
         for job in jobs:
-            color_status = job['color'].split('_')
-            color = color_status[0]
-            run_status = color_status[1] if len(color_status) == 2 else None
-            status = STATUSES[color]
-            print("%s%s%s%s %s" % (status['color'], status['symbol'], ANIME_SYMBOL[run_status == 'anime'], ENDCOLLOR, job['name']))
+            formated_status = get_formated_status(job['color'])
+            print(formated_status + " " + job['name'])
 
     def _get_jobs(self, args):
         jobs = self.jenkins.get_jobs()