Merge pull request #20 from LD250/build-statuses

Build statuses for solving #3

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

@@ -6,16 +6,47 @@
 import socket
 from xml.etree import ElementTree
 
-COLORS = {'blue': '\033[94m',
-          'green': '\033[92m',
-          'red': '\033[91m',
-          'yellow': '\033[93m',
-          'disabled': '\033[97m',
-          'endcollor': '\033[0m',
-          'aborted': '\033[97m(aborted)',
-          'yellow_anime': '\033[93m(running)',
-          'blue_anime': '\033[94m(running)',
-          'red_anime': '\033[91m(running)'}
+STATUSES = {'blue': {'symbol': 'S',
+                     'color': '\033[94m',
+                     'descr': 'Stable'},
+            'red': {'symbol': 'F',
+                    'color': '\033[91m',
+                    'descr': 'Failed'},
+            'yellow': {'symbol': 'U',
+                       'color': '\033[93m',
+                       'descr': 'Unstable'},
+            'disabled': {'symbol': 'D',
+                         'color': '\033[97m',
+                         'descr': 'Disabled'},
+            'aborted': {'symbol': 'A',
+                        'color': '\033[97m',
+                        'descr': 'Aborted'}
+            }
+
+# 'green': '\033[92m',
+
+
+ENDCOLLOR = '\033[0m'
+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):
@@ -77,7 +108,8 @@ def run_command(self, args):
     def jobs(self, args):
         jobs = self._get_jobs(args)
         for job in jobs:
-            print("%s***%s %s" % (COLORS.get(job['color'], job['color']), COLORS['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()

tests/test_cli.py

@@ -11,7 +11,7 @@
 
 import jenkins
 
-from jenkins_cli.cli import JenkinsCli, CliException, COLORS
+from jenkins_cli.cli import JenkinsCli, CliException, STATUSES, ENDCOLLOR
 
 GIT_SCM_XML = """<?xml version=\'1.0\' encoding=\'UTF-8\'?>\n<project>\n  <actions/>\n  <description></description>\n  <keepDependencies>false</keepDependencies>\n  <properties/>\n  <scm class="hudson.plugins.git.GitSCM" plugin="git@2.4.2">\n    <configVersion>2</configVersion>\n    <userRemoteConfigs>\n      <hudson.plugins.git.UserRemoteConfig>\n        <url>https://github.com/LD250/jenkins-cli-python/</url>\n      </hudson.plugins.git.UserRemoteConfig>\n    </userRemoteConfigs>\n    <branches>\n      <hudson.plugins.git.BranchSpec>\n        <name>cli-tests</name>\n      </hudson.plugins.git.BranchSpec>\n    </branches>\n    <doGenerateSubmoduleConfigurations>false</doGenerateSubmoduleConfigurations>\n    <submoduleCfg class="list"/>\n    <extensions/>\n  </scm>\n  <canRoam>true</canRoam>\n  <disabled>false</disabled>\n  <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>\n  <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>\n  <triggers/>\n  <concurrentBuild>false</concurrentBuild>\n  <builders>\n    <hudson.tasks.Shell>\n      <command></command>\n    </hudson.tasks.Shell>\n    <jenkins.plugins.shiningpanda.builders.VirtualenvBuilder plugin="shiningpanda@0.22">\n      <pythonName>System-CPython-2.7</pythonName>\n      <home></home>\n      <clear>true</clear>\n      <systemSitePackages>false</systemSitePackages>\n      <nature>shell</nature>\n      <command>pip install -U pip\npip install -U setuptools\npip install -U wheel\npip install -r requirements.txt\npip list -o\n\nflake8 jenkins_cli\npython setup.py test</command>\n      <ignoreExitCode>false</ignoreExitCode>\n    </jenkins.plugins.shiningpanda.builders.VirtualenvBuilder>\n  </builders>\n  <publishers/>\n  <buildWrappers/>\n</project>
 """
@@ -135,8 +135,8 @@ def test_jobs(self, patched_get_jobs):
         patched_get_jobs.return_value = jobs
         self.args.a = False
         JenkinsCli(self.args).jobs(self.args)
-        arg1 = "%s***%s Job1" % (COLORS.get(jobs[0]['color'], jobs[0]['color']), COLORS['endcollor'])
-        arg2 = "%s***%s Job2" % (COLORS.get(jobs[1]['color'], jobs[1]['color']), COLORS['endcollor'])
+        arg1 = "%sS..%s Job1" % (STATUSES[jobs[0]['color']]['color'], ENDCOLLOR)
+        arg2 = "%sD..%s Job2" % (STATUSES[jobs[1]['color']]['color'], ENDCOLLOR)
         self.patched_print.assert_has_calls([mock.call(arg1)], [mock.call(arg2)])
         self.patched_print.reset_mock()
         self.args.a = True