Merge branch 'cli-tests'

LD250 · LD250 · commit 31948e1dc110 · 2016-03-11T08:18:31.000+02:00
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,10 @@
+language: "python"
+python:
+    - "2.7"
+    - "3.4"
+    - "3.5"
+install:
+    - pip install flake8 mock==1.3.0
+script:
+    - flake8 
+    - python setup.py test
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1 @@
+include README.md
diff --git a/README.md b/README.md
@@ -1,3 +1,9 @@
+# Jenkins command line interface
+[![PyPI version](https://badge.fury.io/py/jenkins-cli.svg)](https://badge.fury.io/py/jenkins-cli)
+[![Build Status](https://travis-ci.org/LD250/jenkins-cli-python.svg?branch=cli-tests)](https://travis-ci.org/LD250/jenkins-cli-python)
+[![Code Health](https://landscape.io/github/LD250/jenkins-cli-python/cli-tests/landscape.svg?style=flat)](https://landscape.io/github/LD250/jenkins-cli-python/cli-tests)
+[![Requirements Status](https://requires.io/github/LD250/jenkins-cli-python/requirements.svg?branch=cli-tests)](https://requires.io/github/LD250/jenkins-cli-python/requirements/?branch=cli-tests)
+
 # Install:
 ```bash
 git clone https://github.com/LD250/jenkins-cli-python.git
diff --git a/jenkins_cli/__init__.py b/jenkins_cli/__init__.py
@@ -6,7 +6,6 @@
 
 def main():
     parser = argparse.ArgumentParser(prog='jenkins',
-                                     #usage='%(prog)s',
                                      description='Server URL, Username and password may be specified either by the command line arguments '
                                                  'or in configuration file (.jenkins-cli). Command line arguments has the highest priority, '
                                                  'after that the .jenkins-cli file from current folder is taking into account. If there is no'
@@ -19,15 +18,14 @@ 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.add_argument('-d', help='Show disabled jobs', default=False, action='store_true')
+    jobs_parser.add_argument('-a', help='Show only active jobs', default=False, action='store_true')
 
-    q_parser = subparsers.add_parser('queue', help='Shows builds queue')
+    subparsers.add_parser('queue', help='Shows builds queue')
 
-    b_parser = subparsers.add_parser('building', help='Build executor status')
+    subparsers.add_parser('building', help='Build executor status')
 
     start_parser = subparsers.add_parser('start', help='Start job')
     start_parser.add_argument('job_name', help='Job to start', nargs='*')
-    #start_parser.add_argument('-s', help='Silent mode (return only build number)')
 
     start_parser = subparsers.add_parser('info', help='Job info')
     start_parser.add_argument('job_name', help='Job to to get info for')
@@ -54,10 +52,7 @@ def main():
     except CliException as e:
         print(e)
         print("Read jenkins --help")
-#    except Exception as e:
-#        raise e 
 
 
 if __name__ == "__main__":
     main()
-
diff --git a/jenkins_cli/cli.py b/jenkins_cli/cli.py
@@ -1,11 +1,12 @@
+from __future__ import print_function
 import os
-import time
+from time import time
 import datetime
 import jenkins
 import socket
 from xml.etree import ElementTree
 
-colors = {'blue': '\033[94m',
+COLORS = {'blue': '\033[94m',
           'green': '\033[92m',
           'red': '\033[91m',
           'yellow': '\033[93m',
@@ -24,6 +25,14 @@ class CliException(Exception):
 class JenkinsCli(object):
     SETTINGS_FILE_NAME = '.jenkins-cli'
 
+    QUEUE_EMPTY_TEXT = "Building Queue is empty"
+
+    INFO_TEMPLATE = ("Last build name: %s (result: %s)\n"
+                     "Last success build name: %s\n"
+                     "Build started: %s\n"
+                     "Building now: %s\n"
+                     "%s branch set to: %s")
+
     def __init__(self, args, timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
         self.jenkins = self.auth(args.host, args.username, args.password, timeout)
 
@@ -58,23 +67,23 @@ def read_settings_from_file(cls):
         for setting_line in jenkins_settings.split('\n'):
             if "=" in setting_line:
                 key, value = setting_line.split("=", 1)
-                settings_dict[key] = value
+                settings_dict[key.strip()] = value.strip()
         return settings_dict
 
     def run_command(self, args):
         command = args.jenkins_command
         getattr(self, command)(args)
 
     def jobs(self, args):
-        jobs = self.jenkins.get_jobs()
+        jobs = self._get_jobs(args)
         for job in jobs:
-            print("%s***%s %s" % (colors.get(job['color'], job['color']), colors['endcollor'], job['name']))
+            print("%s***%s %s" % (COLORS.get(job['color'], job['color']), COLORS['endcollor'], job['name']))
 
     def _get_jobs(self, args):
         jobs = self.jenkins.get_jobs()
-        if not args.d:
+        if args.a:
             jobs = [j for j in jobs if j.get('color') != 'disabled']
-        jobs = sorted(jobs, key=lambda j: j.get('name'))
+        # jobs = sorted(jobs, key=lambda j: j.get('name'))
         return jobs
 
     def queue(self, args):
@@ -83,58 +92,63 @@ def queue(self, args):
             for job in jobs:
                 print("%s %s" % (job['task']['name'], job['why']))
         else:
-            print("Building Queue is empty")
+            print(self.QUEUE_EMPTY_TEXT)
 
     def _check_job(self, job_name):
         job_name = self.jenkins.get_job_name(job_name)
         if not job_name:
             raise CliException('Job name does not esist')
         return job_name
 
+    def _get_scm_name_and_node(self, xml_root):
+        scm_name = 'UnknownSCM'
+        branch_node = None
+        try:
+            scm = xml_root.find('scm')
+            if scm.attrib['class'] == 'hudson.plugins.mercurial.MercurialSCM':
+                scm_name = 'Mercurial'
+                branch_node = scm.find('revision')
+            elif scm.attrib['class'] == 'hudson.plugins.git.GitSCM':
+                scm_name = 'Git'
+                branch_node = scm.find('branches').find('hudson.plugins.git.BranchSpec').find('name')
+        except AttributeError:
+            pass
+        return (scm_name, branch_node)
+
     def info(self, args):
         job_name = self._check_job(args.job_name)
         job_info = self.jenkins.get_job_info(job_name, 1)
         if not job_info:
             job_info = {}
         last_build = job_info.get('lastBuild', {})
         last_success_build = job_info.get('lastSuccessfulBuild', {})
-        #from pprint import pprint
-        #pprint(job_info)
-        info = ("Last build name: %s (result: %s)\n"
-                "Last success build name: %s\n"
-                "Build started: %s\n"
-                "Building now: %s\n"
-                "Mercurial branch set: %s")
         xml = self.jenkins.get_job_config(job_name)
         root = ElementTree.fromstring(xml.encode('utf-8'))
-        rev = 'Not Known'
-        scm = root.find('scm')
-        if scm is not None:
-            revision = scm.find('revision')
-            if revision is not None:
-                rev = revision.text
-        print(info % (last_build.get('fullDisplayName', 'Not Built'),
-                      last_build.get('result', 'Not Built'),
-                      last_success_build.get('fullDisplayName', 'Not Built'),
-                      datetime.datetime.fromtimestamp(last_build['timestamp'] / 1000) if last_build else 'Not built',
-                      'Yes' if last_build.get('building') else 'No',
-                      rev))
+        scm_name, branch_node = self._get_scm_name_and_node(root)
+        if branch_node is not None:
+            branch_name = branch_node.text
+        else:
+            branch_name = 'Unknown branch'
+        print(self.INFO_TEMPLATE % (last_build.get('fullDisplayName', 'Not Built'),
+                                    last_build.get('result', 'Not Built'),
+                                    last_success_build.get('fullDisplayName', 'Not Built'),
+                                    datetime.datetime.fromtimestamp(last_build['timestamp'] / 1000) if last_build else 'Not Built',
+                                    'Yes' if last_build.get('building') else 'No',
+                                    scm_name,
+                                    branch_name))
 
     def set_branch(self, args):
         job_name = self._check_job(args.job_name)
         xml = self.jenkins.get_job_config(job_name)
         root = ElementTree.fromstring(xml.encode('utf-8'))
-        scm = root.find('scm')
-        new_xml = None
-        if scm is not None:
-            revision = scm.find('revision')
-            if revision is not None:
-                revision.text = args.branch_name
-                new_xml = ElementTree.tostring(root)
-                self.jenkins.reconfig_job(job_name, new_xml)
-                print('Done')
-        if new_xml is None:
-            print("Can not set revision info")
+        scm_name, branch_node = self._get_scm_name_and_node(root)
+        if branch_node is not None:
+            branch_node.text = args.branch_name
+            new_xml = ElementTree.tostring(root)
+            self.jenkins.reconfig_job(job_name, new_xml)
+            print('Done')
+        else:
+            print("Can't set branch name")
 
     def start(self, args):
         for job in args.job_name:
@@ -146,8 +160,11 @@ def stop(self, args):
         job_name = self._check_job(args.job_name)
         info = self.jenkins.get_job_info(job_name)
         build_number = info['lastBuild'].get('number')
-        stop_status = self.jenkins.stop_build(job_name, build_number)
-        print("%s: %s" % (job_name, 'stoped' if not stop_status else stop_status))
+        if build_number and info['lastBuild'].get('building'):
+            stop_status = self.jenkins.stop_build(job_name, build_number)
+            print("%s: %s" % (job_name, 'stopped' if not stop_status else stop_status))
+        else:
+            print("%s job is not running" % job_name)
 
     def console(self, args):
         job_name = self._check_job(args.job_name)
@@ -173,17 +190,19 @@ def console(self, args):
                 build_info = self.jenkins.get_build_info(job_name, build_number)
 
     def building(self, args):
-        args.d = False
+        args.a = True
         jobs = [j for j in self._get_jobs(args) if 'anime' in j['color']]
         if jobs:
             for job in jobs:
                 info = self.jenkins.get_job_info(job['name'])
                 build_number = info['lastBuild'].get('number')
+                eta = "unknown"
+                display_name = job['name']
                 if build_number:
                     build_info = self.jenkins.get_build_info(job['name'], build_number)
-                    eta = (build_info['timestamp'] + build_info['estimatedDuration']) / 1000 - time.time()
-                    print("%s estimated time left %s" % (build_info['fullDisplayName'],
-                                                         datetime.timedelta(seconds=eta)))
+                    eta = (build_info['timestamp'] + build_info['estimatedDuration']) / 1000 - time()
+                    eta = datetime.timedelta(seconds=eta)
+                    display_name = build_info['fullDisplayName']
+                print("%s estimated time left %s" % (display_name, eta))
         else:
             print("Nothing is building now")
-
diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,8 @@
 pbr==1.3.0
 python-jenkins==0.4.12
 six==1.9.0
+tox==2.3.1
+pyfakefs==2.7.0
+mock==1.3.0
+unittest2==1.1.0
+flake8==2.5.4
diff --git a/setup.py b/setup.py
@@ -1,16 +1,27 @@
 import os
+import re
 from setuptools import setup, find_packages
 
 here = os.path.abspath(os.path.dirname(__file__))
 with open(os.path.join(here, 'README.md')) as f:
         README = f.read()
 
-exec(open(os.path.join(here, 'jenkins_cli/version.py')).read())
+version_file_content = open(os.path.join(here, 'jenkins_cli/version.py')).read()
+version_match = re.search(r"^version = ['\"]([^'\"]*)['\"]",
+                          version_file_content, re.M)
+if version_match:
+    version = version_match.group(1)
+else:
+    raise RuntimeError('Unable to find version string.')
 
-requires = ['pbr>=1.3.0',
+requires = ['pbr>=1.6.0',
             'python-jenkins==0.4.12',
             'six>=1.9.0']
 
+tests_require = ['unittest2==1.1.0',
+                 'mock==1.3.0',
+                 'pyfakefs==2.7.0']
+
 setup(
     name='jenkins-cli',
     version=version,
@@ -21,14 +32,19 @@
     license='http://opensource.org/licenses/MIT',
     classifiers=(
       'Natural Language :: English',
+      'Environment :: Console',
+      'Intended Audience :: Developers',
       'Programming Language :: Python',
-      'Programming Language :: Python :: 3',
-      'Programming Language :: Python :: 2',
+      'Programming Language :: Python :: 2.7',
+      'Programming Language :: Python :: 3.4',
+      'Programming Language :: Python :: 3.5',
       'License :: OSI Approved :: MIT License',
     ),
     packages=find_packages(),
     install_requires=requires,
-    entry_points = {
-      'console_scripts' : [ 'jenkins = jenkins_cli:main' ]
+    tests_require=tests_require,
+    test_suite="tests",
+    entry_points={
+      'console_scripts': ['jenkins = jenkins_cli:main']
     }
 )
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/test_cli.py b/tests/test_cli.py
diff --git a/tox.ini b/tox.ini
