Adopt pbr

Change-Id: Iad928d789ce7acf2e07e56c2b0b8a2a659c5d193

Author: ssbarnea

.gitignore

@@ -21,3 +21,5 @@ lib/
 *.sw?
 /jenkinsapi_tests/systests/coverage.xml
 /.cache
+/AUTHORS
+/ChangeLog

.travis.yml

@@ -11,10 +11,32 @@ env:
 before_install:
 - jdk_switcher use oraclejdk8
 install:
-- pip install -r requirements/dev-requirements.txt
-- python setup.py develop
+- pip install tox-travis
+- python setup.py -q sdist bdist_wheel
 script:
-- make lint
-- make coverage
+- tox
 after_success:
 - codecov
+branches:
+  only:
+  - master
+  - develop
+  - /^(\d+)\.(\d+)\.(\d+)$/
+jobs:
+  include:
+    - stage: release
+      python: 2.7
+      script: python setup.py -q sdist bdist_wheel
+      deploy:
+        provider: releases
+        api_key:
+          secure: Ac6anfwQu0WyVj7q9GqD1OJI3WTM3Lk0xO42oJwh4EphXpRCFGvgE4XjaPxh4qVHlgIw8AQ4Phpm0UYal/XTLVNuJDPHOdOUUxUJdJYQkW3hT2odOSCPU47Xa0/pGHIrgX3gEOTO0hAjziL5c41cGR2wMWFp6/CObIg3+gqtrzk=
+        file_glob: true
+        file:
+        - dist/*
+        - ChangeLog
+        - AUTHORS
+        skip_cleanup: true
+        on:
+          repo: pycontribs/jenkinsapi
+          tags: true

Makefile

@@ -4,7 +4,7 @@ test:
 	py.test -sv jenkinsapi_tests
 
 lint:
-	pep8
+	pycodestyle
 	pylint jenkinsapi/*.py
 
 tox:

examples/how_to/create_credentials.py

@@ -34,6 +34,7 @@
 def get_private_key_from_file():
     return '-----BEGIN RSA PRIVATE KEY-----'
 
+
 my_private_key = get_private_key_from_file()
 
 creds_description2 = 'My_ssh_cred1'

examples/low_level/example_param_build.py

@@ -16,5 +16,6 @@ def foo():
     response = requests.post(url, data=form, headers=headers)
     print(response.text.encode('UTF-8'))
 
+
 if __name__ == '__main__':
     foo()

examples/low_level/post_watcher.py

@@ -22,7 +22,7 @@
 import cgi
 
 PORT = 8081  # <-- change this to be the actual port you want to run on
-I = "localhost"
+INTERFACE = "localhost"
 
 
 class ServerHandler(SimpleHTTPServer.SimpleHTTPRequestHandler):
@@ -55,6 +55,6 @@ def do_POST(self):
 print(
     "Serving at: http://%(interface)s:%(port)s" %
     dict(
-        interface=I or "localhost",
+        interface=INTERFACE or "localhost",
         port=PORT))
 httpd.serve_forever()

jenkinsapi/__init__.py

@@ -2,12 +2,14 @@
 About this library
 ==================
 
-Jenkins is the market leading continuous integration system, originally created by Kohsuke Kawaguchi.
-This API makes Jenkins even easier to use by providing an easy to use conventional python interface.
-
-Jenkins (and It's predecessor Hudson) are fantastic projects - but they are somewhat Java-centric.
-Thankfully the designers have provided an excellent and complete REST interface. This library
-wraps up that interface as more conventional python objects in order to make most Jenkins oriented
+Jenkins is the market leading continuous integration system, originally created
+by Kohsuke Kawaguchi. This API makes Jenkins even easier to use by providing an
+ easy to use conventional python interface.
+
+Jenkins (and It's predecessor Hudson) are fantastic projects - but they are
+somewhat Java-centric. Thankfully the designers have provided an excellent and
+complete REST interface. This library wraps up that interface as more
+conventional python objects in order to make most Jenkins oriented
 tasks simpler.
 
 This library can help you:
@@ -24,8 +26,8 @@
 Installing JenkinsAPI
 =====================
 
-Egg-files for this project are hosted on PyPi. Most Python users should be able to use pip or distribute
-to automatically install this project.
+Egg-files for this project are hosted on PyPi. Most Python users should be able
+to use pip or distribute to automatically install this project.
 
 Most users can do the following:
 
@@ -52,14 +54,16 @@
     utils,
 
     # Files
-    api, artifact, build, config, constants, custom_exceptions, fingerprint, executors, executor,
+    api, artifact, build, config, constants, custom_exceptions,
+    fingerprint, executors, executor,
     jenkins, jenkinsbase, job, node, result_set, result, view
 )
 
 __all__ = [
     "command_line", "utils",
-    "api", "artifact", "build", "config", "constants", "custom_exceptions", "executors", "executor",
-    "fingerprint", "jenkins", "jenkinsbase", "job", "node", "result_set", "result", "view"
+    "api", "artifact", "build", "config", "constants", "custom_exceptions",
+    "executors", "executor", "fingerprint", "jenkins", "jenkinsbase",
+    "job", "node", "result_set", "result", "view"
 ]
 __docformat__ = "epytext"
 # In case of jenkinsapi is not installed in 'develop' mode

jenkinsapi/artifact.py

@@ -111,15 +111,12 @@ def _md5sum(self, fspath, chunksize=2 ** 20):
         used by Jenkins.
         """
         md5 = hashlib.md5()
-        try:
-            with open(fspath, 'rb') as f:
-                for chunk in iter(lambda: f.read(chunksize), ''):
-                    if chunk:
-                        md5.update(chunk)
-                    else:
-                        break
-        except:
-            raise
+        with open(fspath, 'rb') as f:
+            for chunk in iter(lambda: f.read(chunksize), ''):
+                if chunk:
+                    md5.update(chunk)
+                else:
+                    break
         return md5.hexdigest()
 
     def save_to_dir(self, dirpath, strict_validation=False):

jenkinsapi/command_line/jenkinsapi_version.py

@@ -7,5 +7,6 @@
 def main():
     sys.stdout.write(version)
 
+
 if __name__ == '__main__':
     main()

jenkinsapi/job.py

@@ -184,7 +184,8 @@ def invoke(self, securitytoken=None, block=False,
             params['token'] = securitytoken
 
         # Either copy the params dict or make a new one.
-        build_params = dict(build_params.items()) if build_params else {}  # Via POSTed JSON
+        build_params = dict(build_params.items()) \
+            if build_params else {}  # Via POSTed JSON
 
         url = self.get_build_triggerurl()
         if cause:
@@ -719,7 +720,8 @@ def has_queued_build(self, build_params):
     @staticmethod
     def get_full_name_from_url_and_baseurl(url, baseurl):
         """
-        Get the full name for a job (including parent folders) from the job URL.
+        Get the full name for a job (including parent folders) from the
+        job URL.
         """
         path = url.replace(baseurl, '')
         split = path.split('/')

jenkinsapi/jobs.py

@@ -80,7 +80,9 @@ def __getitem__(self, job_name):
         if job_name in self:
             job_data = [job_row for job_row in self._data
                         if job_row['name'] == job_name or
-                        Job.get_full_name_from_url_and_baseurl(job_row['url'], self.jenkins.baseurl) == job_name][0]
+                        Job.get_full_name_from_url_and_baseurl(
+                            job_row['url'],
+                            self.jenkins.baseurl) == job_name][0]
             return Job(job_data['url'], job_data['name'], self.jenkins)
         else:
             raise UnknownJob(job_name)
@@ -108,8 +110,11 @@ def iterkeys(self):
             self._data = self.poll().get('jobs', [])
         for row in self._data:
             yield row['name']
-            if row['name'] != Job.get_full_name_from_url_and_baseurl(row['url'], self.jenkins.baseurl):
-                yield Job.get_full_name_from_url_and_baseurl(row['url'], self.jenkins.baseurl)
+            if row['name'] != \
+                Job.get_full_name_from_url_and_baseurl(row['url'],
+                                                       self.jenkins.baseurl):
+                yield Job.get_full_name_from_url_and_baseurl(
+                    row['url'], self.jenkins.baseurl)
 
     def itervalues(self):
         """

jenkinsapi/utils/krb_requester.py

@@ -17,7 +17,8 @@ def __init__(self, ssl_verify=None, baseurl=None, mutual_auth=OPTIONAL):
         :param ssl_verify: flag indicating if server certificate in HTTPS requests should be
                            verified
         :param baseurl: Jenkins' base URL
-        :param mutual_auth: type of mutual authentication, use one of REQUIRED, OPTIONAL or DISABLED
+        :param mutual_auth: type of mutual authentication, use one of
+                            REQUIRED, OPTIONAL or DISABLED
                             from requests_kerberos package
         """
         args = {}
@@ -30,8 +31,11 @@ def __init__(self, ssl_verify=None, baseurl=None, mutual_auth=OPTIONAL):
 
     def get_request_dict(
             self, params=None, data=None, files=None, headers=None, **kwargs):
-        req_dict = super(KrbRequester, self).get_request_dict(params=params, data=data, files=files,
-                                                              headers=headers)
+        req_dict = super(KrbRequester, self) \
+            .get_request_dict(params=params,
+                              data=data,
+                              files=files,
+                              headers=headers)
         if self.mutual_auth:
             auth = HTTPKerberosAuth(self.mutual_auth)
         else:

jenkinsapi_tests/systests/job_configs.py

@@ -268,7 +268,7 @@
     </hudson.tasks.Fingerprinter>
   </publishers>
   <buildWrappers/>
-</project>""".strip()
+</project>""".strip()  # noqa
 
 JOB_WITH_FILE_AND_PARAMS = """
 <?xml version='1.0' encoding='UTF-8'?>

jenkinsapi_tests/test_utils/random_strings.py

@@ -8,5 +8,6 @@ def random_string(length=10):
     return ''.join(random.choice(string.ascii_lowercase)
                    for i in range(length))
 
+
 if __name__ == '__main__':
     print(random_string())

jenkinsapi_tests/unittests/test_artifact.py

@@ -163,8 +163,7 @@ def test_save_has_valid_local_copy(self, mock_exists):
         artifact = self._artifact
         artifact._verify_download = Mock(return_value=True)
 
-        assert artifact.save('/tmp/artifact.zip') == \
-                         '/tmp/artifact.zip'
+        assert artifact.save('/tmp/artifact.zip') == '/tmp/artifact.zip'
 
         mock_exists.assert_called_once_with('/tmp/artifact.zip')
         artifact._verify_download.assert_called_once_with(
@@ -176,8 +175,7 @@ def test_save_has_invalid_local_copy_dl_again(self, mock_exists):
         artifact._verify_download = Mock(side_effect=[ArtifactBroken, True])
         artifact._do_download = Mock(return_value='/tmp/artifact.zip')
 
-        assert artifact.save('/tmp/artifact.zip', True) == \
-                         '/tmp/artifact.zip'
+        assert artifact.save('/tmp/artifact.zip', True) == '/tmp/artifact.zip'
 
         mock_exists.assert_called_once_with('/tmp/artifact.zip')
         artifact._do_download.assert_called_once_with('/tmp/artifact.zip')
@@ -206,8 +204,7 @@ def test_save_has_no_local_copy(self, mock_exists):
         artifact._do_download = Mock(return_value='/tmp/artifact.zip')
         artifact._verify_download = Mock(return_value=True)
 
-        assert artifact.save('/tmp/artifact.zip') == \
-                         '/tmp/artifact.zip'
+        assert artifact.save('/tmp/artifact.zip') == '/tmp/artifact.zip'
 
         mock_exists.assert_called_once_with('/tmp/artifact.zip')
         artifact._do_download.assert_called_once_with('/tmp/artifact.zip')

jenkinsapi_tests/unittests/test_build.py

@@ -156,12 +156,14 @@ def test_only_ParametersAction_parameters_considered(build):
     params = build.get_params()
     assert params == expected
 
+
 def test_build_env_vars(monkeypatch, build):
     def fake_get_data(cls, tree=None, params=None):
         return configs.BUILD_ENV_VARS
     monkeypatch.setattr(Build, 'get_data', fake_get_data)
     assert build.get_env_vars() == configs.BUILD_ENV_VARS['envMap']
 
+
 def test_build_env_vars_wo_injected_env_vars_plugin(monkeypatch, build):
     def fake_get_data(cls, tree=None, params=None):
         raise requests.HTTPError('404')
@@ -176,6 +178,7 @@ def fake_get_data(cls, tree=None, params=None):
                            'plugin is installed.')
     assert str(record[0].message) == str(expected)
 
+
 def test_build_env_vars_other_exception(monkeypatch, build):
     def fake_get_data(cls, tree=None, params=None):
         raise ValueError()
@@ -186,4 +189,3 @@ def fake_get_data(cls, tree=None, params=None):
             build.get_env_vars()
     assert '' == str(excinfo.value)
     assert len(record) == 0
-

jenkinsapi_tests/unittests/test_job_get_all_builds.py

@@ -192,8 +192,8 @@ def test_get_build_dict(self):
     @mock.patch.object(JenkinsBase, 'get_data', fakeGetDataTree)
     def test_incomplete_builds_list_will_call_jenkins_twice(self):
         # The job data contains only one build, so we expect that the
-        # remaining jobs will be fetched automatically, and to have two calls to
-        # the Jenkins API
+        # remaining jobs will be fetched automatically, and to have two calls
+        # to the Jenkins API
         TestJobGetAllBuilds.__get_data_call_count = 0
         self.j = Job('http://halob:8080/job/foo/', 'foo', self.J)
         self.assertEquals(TestJobGetAllBuilds.__get_data_call_count, 2)

jenkinsapi_tests/unittests/test_misc.py

@@ -6,6 +6,7 @@ def test_jenkinsapi_version():
     package's __version__ property.
     """
     version = jenkinsapi.__version__
-    parts = [int(x) for x in version.split('.')]
+    # only first two parts must be interger, 1.0.dev5 being a valid version.
+    parts = [int(x) for x in version.split('.')[0:2]]
     for part in parts:
         assert part >= 0, "Implausible version number: %r" % version

jenkinsapi_tests/unittests/test_result_set.py

@@ -16,10 +16,10 @@ class TestResultSet(unittest.TestCase):
             'passCount': 0,
             'skipCount': 0,
             'suites': [{'cases': [{'age': 1,
-                                   'className': '<nose.suite.ContextSuite context=jenkinsapi_tests',
+                                   'className': '<nose.suite.ContextSuite context=jenkinsapi_tests',  # noqa
                                    'duration': 0.0,
-                                   'errorDetails': 'Timeout error occured while waiting for Jenkins start.',
-                                   'errorStackTrace': 'Traceback (most recent call last):\n  File "/usr/lib/python2.7/dist-packages/nose/suite.py", line 208, in run\n    self.setUp()\n  File "/usr/lib/python2.7/dist-packages/nose/suite.py", line 291, in setUp\n    self.setupContext(ancestor)\n  File "/usr/lib/python2.7/dist-packages/nose/suite.py", line 314, in setupContext\n    try_run(context, names)\n  File "/usr/lib/python2.7/dist-packages/nose/util.py", line 478, in try_run\n    return func()\n  File "/var/lib/jenkins/jobs/test_jenkinsapi/workspace/jenkinsapi/src/jenkinsapi_tests/systests/__init__.py", line 54, in setUpPackage\n    launcher = JenkinsLauncher(update_war=True, launch=True)\n  File "/var/lib/jenkins/jobs/test_jenkinsapi/workspace/jenkinsapi/src/jenkinsapi_tests/systests/__init__.py", line 20, in __init__\n    self.launch()\n  File "/var/lib/jenkins/jobs/test_jenkinsapi/workspace/jenkinsapi/src/jenkinsapi_tests/systests/__init__.py", line 41, in launch\n    raise Timeout(\'Timeout error occured while waiting for Jenkins start.\')\nTimeout: Timeout error occured while waiting for Jenkins start.\n',
+                                   'errorDetails': 'Timeout error occured while waiting for Jenkins start.',  # noqa
+                                   'errorStackTrace': 'Traceback (most recent call last):\n  File "/usr/lib/python2.7/dist-packages/nose/suite.py", line 208, in run\n    self.setUp()\n  File "/usr/lib/python2.7/dist-packages/nose/suite.py", line 291, in setUp\n    self.setupContext(ancestor)\n  File "/usr/lib/python2.7/dist-packages/nose/suite.py", line 314, in setupContext\n    try_run(context, names)\n  File "/usr/lib/python2.7/dist-packages/nose/util.py", line 478, in try_run\n    return func()\n  File "/var/lib/jenkins/jobs/test_jenkinsapi/workspace/jenkinsapi/src/jenkinsapi_tests/systests/__init__.py", line 54, in setUpPackage\n    launcher = JenkinsLauncher(update_war=True, launch=True)\n  File "/var/lib/jenkins/jobs/test_jenkinsapi/workspace/jenkinsapi/src/jenkinsapi_tests/systests/__init__.py", line 20, in __init__\n    self.launch()\n  File "/var/lib/jenkins/jobs/test_jenkinsapi/workspace/jenkinsapi/src/jenkinsapi_tests/systests/__init__.py", line 41, in launch\n    raise Timeout(\'Timeout error occured while waiting for Jenkins start.\')\nTimeout: Timeout error occured while waiting for Jenkins start.\n',  # noqa
                                    'failedSince': 88,
                                    'name': 'systests>:setup',
                                    'skipped': False,
@@ -30,7 +30,7 @@ class TestResultSet(unittest.TestCase):
                                    'className': 'nose.failure.Failure',
                                    'duration': 0.0,
                                    'errorDetails': 'No module named mock',
-                                   'errorStackTrace': 'Traceback (most recent call last):\n  File "/usr/lib/python2.7/unittest/case.py", line 332, in run\n    testMethod()\n  File "/usr/lib/python2.7/dist-packages/nose/loader.py", line 390, in loadTestsFromName\n    addr.filename, addr.module)\n  File "/usr/lib/python2.7/dist-packages/nose/importer.py", line 39, in importFromPath\n    return self.importFromDir(dir_path, fqname)\n  File "/usr/lib/python2.7/dist-packages/nose/importer.py", line 86, in importFromDir\n    mod = load_module(part_fqname, fh, filename, desc)\n  File "/var/lib/jenkins/jobs/test_jenkinsapi/workspace/jenkinsapi/src/jenkinsapi_tests/unittests/test_build.py", line 1, in <module>\n    import mock\nImportError: No module named mock\n',
+                                   'errorStackTrace': 'Traceback (most recent call last):\n  File "/usr/lib/python2.7/unittest/case.py", line 332, in run\n    testMethod()\n  File "/usr/lib/python2.7/dist-packages/nose/loader.py", line 390, in loadTestsFromName\n    addr.filename, addr.module)\n  File "/usr/lib/python2.7/dist-packages/nose/importer.py", line 39, in importFromPath\n    return self.importFromDir(dir_path, fqname)\n  File "/usr/lib/python2.7/dist-packages/nose/importer.py", line 86, in importFromDir\n    mod = load_module(part_fqname, fh, filename, desc)\n  File "/var/lib/jenkins/jobs/test_jenkinsapi/workspace/jenkinsapi/src/jenkinsapi_tests/unittests/test_build.py", line 1, in <module>\n    import mock\nImportError: No module named mock\n',  # noqa
                                    'failedSince': 88,
                                    'name': 'runTest',
                                    'skipped': False,

jenkinsapi_utils/simple_post_logger.py

@@ -26,6 +26,7 @@ def do_POST(self):
             logging.error(item)
         SimpleHTTPServer.SimpleHTTPRequestHandler.do_GET(self)
 
+
 Handler = ServerHandler
 
 httpd = SocketServer.TCPServer(("", PORT), Handler)

requirements.txt

@@ -0,0 +1,3 @@
+pytz>=2014.4
+requests>=2.3.0
+six>=1.10.0