jjb
/
python-jenkins
Code Issues Proposed changes

Revert "detect and respect http redirects" 

This reverts commit 4150a83d45.

Change-Id: I972404ff936cbd3c0fe164dcbaa186d5e530736c
This commit is contained in:
Thanh Ha 2018-08-24 13:11:54 -04:00
parent f68b2fb9d6
commit 93515ae07d
No known key found for this signature in database
GPG Key ID: B0CB27E00DA095AA
6 changed files with 22 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
jenkins/__init__.py
View File

@ -287,7 +287,7 @@ class Jenkins(object):
_timeout_warning_issued = False
def __init__(self, url, username=None, password=None,
timeout=socket._GLOBAL_DEFAULT_TIMEOUT, resolve=True):
timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
'''Create handle to Jenkins instance.
All methods will raise :class:`JenkinsException` on failure.
@ -296,7 +296,6 @@ class Jenkins(object):
:param username: Server username, ``str``
:param password: Server password, ``str``
:param timeout: Server connection timeout in secs (default: not set), ``int``
:param resolve: Attempts to resolve and auto-correct API redirection. default: True ``bool``
'''
if url[-1] == '/':
self.server = url
@ -329,25 +328,6 @@ class Jenkins(object):
requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
self._session.verify = False
if resolve:
self._resolve_api()
def _resolve_api(self):
'''Detects if Jenkins api frontend is redirect and corrects it if so
in order to avoid future redirects of each request or failures caused
by the fact that a redirected POST is transformed into a GET.
'''
r = self.jenkins_request(requests.Request('HEAD', self.server), add_crumb=False)
if r.url != self.server or r.status_code in [300, 301, 302, 303]:
if 'Location' in r.headers:
new_url = r.headers['Location']
else:
new_url = r.url
warnings.warn(
"Redirection from %s to %s detected, you may want to update your frontend url." % (
self.server, new_url))
self.server = new_url
def _get_encoded_params(self, params):
for k, v in params.items():
if k in ["name", "msg", "short_name", "from_short_name",

2
tests/base.py
View File

@ -30,7 +30,7 @@ class JenkinsTestBase(TestWithScenarios, unittest.TestCase):
'jenkins.requests_kerberos', None)
self.request_kerberos_module_patcher.start()
self.j = jenkins.Jenkins(self.base_url, 'test', 'test', resolve=False)
self.j = jenkins.Jenkins(self.base_url, 'test', 'test')
def tearDown(self):

23
tests/test_jenkins.py
View File

@ -30,7 +30,7 @@ class JenkinsConstructorTest(JenkinsTestBase):
self.assertEqual(self.j.crumb, None)
def test_url_without_trailing_slash(self):
j = jenkins.Jenkins(self.base_url, 'test', 'test', resolve=False)
j = jenkins.Jenkins(self.base_url, 'test', 'test')
j._maybe_add_auth()
self.assertEqual(j.server, self.make_url(''))
self.assertEqual(j.auth(self.req).headers['Authorization'],
@ -38,7 +38,7 @@ class JenkinsConstructorTest(JenkinsTestBase):
self.assertEqual(j.crumb, None)
def test_without_user_or_password(self):
j = jenkins.Jenkins('{0}'.format(self.base_url), resolve=False)
j = jenkins.Jenkins('{0}'.format(self.base_url))
j._maybe_add_auth()
self.assertEqual(j.server, self.make_url(''))
self.assertEqual(j.auth, None)
@ -47,8 +47,7 @@ class JenkinsConstructorTest(JenkinsTestBase):
def test_unicode_password(self):
j = jenkins.Jenkins('{0}'.format(self.base_url),
six.u('nonascii'),
six.u('\xe9\u20ac'),
resolve=False)
six.u('\xe9\u20ac'))
j._maybe_add_auth()
self.assertEqual(j.server, self.make_url(''))
self.assertEqual(j.auth(self.req).headers['Authorization'],
@ -59,7 +58,7 @@ class JenkinsConstructorTest(JenkinsTestBase):
long_str = 'a' * 60
long_str_b64 = 'YWFh' * 20
j = jenkins.Jenkins('{0}'.format(self.base_url), long_str, long_str, resolve=False)
j = jenkins.Jenkins('{0}'.format(self.base_url), long_str, long_str)
j._maybe_add_auth()
auth_header = j.auth(self.req).headers['Authorization']
@ -68,11 +67,11 @@ class JenkinsConstructorTest(JenkinsTestBase):
long_str_b64 + 'Om' + long_str_b64[2:] + 'YQ=='))
def test_default_timeout(self):
j = jenkins.Jenkins('{0}'.format(self.base_url), resolve=False)
j = jenkins.Jenkins('{0}'.format(self.base_url))
self.assertEqual(j.timeout, socket._GLOBAL_DEFAULT_TIMEOUT)
def test_custom_timeout(self):
j = jenkins.Jenkins('{0}'.format(self.base_url), timeout=300, resolve=False)
j = jenkins.Jenkins('{0}'.format(self.base_url), timeout=300)
self.assertEqual(j.timeout, 300)
@ -207,9 +206,7 @@ class JenkinsOpenTest(JenkinsTestBase):
def test_timeout(self, session_send_mock):
session_send_mock.side_effect = jenkins.URLError(
reason="timed out")
j = jenkins.Jenkins(self.make_url(''), 'test', 'test',
timeout=1,
resolve=False)
j = jenkins.Jenkins(self.make_url(''), 'test', 'test', timeout=1)
request = jenkins.requests.Request('GET', self.make_url('job/TestJob'))
with self.assertRaises(jenkins.JenkinsException) as context_manager:
@ -226,7 +223,7 @@ class JenkinsOpenTest(JenkinsTestBase):
@patch.object(jenkins.Jenkins, 'get_version',
return_value="Version42")
def test_wait_for_normal_op(self, version_mock, jenkins_mock):
j = jenkins.Jenkins('http://example.com', 'test', 'test', resolve=False)
j = jenkins.Jenkins('http://example.com', 'test', 'test')
self.assertTrue(j.wait_for_normal_op(0))
@patch.object(jenkins.Jenkins, 'jenkins_open',
@ -234,11 +231,11 @@ class JenkinsOpenTest(JenkinsTestBase):
@patch.object(jenkins.Jenkins, 'get_version',
side_effect=jenkins.EmptyResponseException())
def test_wait_for_normal_op__empty_response(self, version_mock, jenkins_mock):
j = jenkins.Jenkins('http://example.com', 'test', 'test', resolve=False)
j = jenkins.Jenkins('http://example.com', 'test', 'test')
self.assertFalse(j.wait_for_normal_op(0))
def test_wait_for_normal_op__negative_timeout(self):
j = jenkins.Jenkins('http://example.com', 'test', 'test', resolve=False)
j = jenkins.Jenkins('http://example.com', 'test', 'test')
with self.assertRaises(ValueError) as context_manager:
j.wait_for_normal_op(-1)
self.assertEqual(

4
tests/test_jenkins_sockets.py
View File

@ -22,7 +22,7 @@ class JenkinsRequestTimeoutTests(testtools.TestCase):
def test_jenkins_open_timeout(self):
j = jenkins.Jenkins("http://%s:%s" % self.server.server_address,
None, None, timeout=0.1, resolve=False)
None, None, timeout=0.1)
request = jenkins.requests.Request('GET', 'http://%s:%s/job/TestJob' %
self.server.server_address)
@ -32,7 +32,7 @@ class JenkinsRequestTimeoutTests(testtools.TestCase):
def test_jenkins_open_no_timeout(self):
j = jenkins.Jenkins("http://%s:%s" % self.server.server_address,
None, None, resolve=False)
None, None)
request = jenkins.requests.Request('GET', 'http://%s:%s/job/TestJob' %
self.server.server_address)

6
tests/test_plugins.py
View File

@ -175,7 +175,7 @@ class JenkinsPluginInfoTest(JenkinsPluginsBase):
json.dumps(self.plugin_info_json),
json.dumps(self.updated_plugin_info_json)
]
j = jenkins.Jenkins(self.make_url(''), 'test', 'test', resolve=False)
j = jenkins.Jenkins(self.make_url(''), 'test', 'test')
plugins_info = j.get_plugins()
self.assertEqual(plugins_info["mailer"]["version"],
@ -289,7 +289,7 @@ class PluginsTestScenarios(JenkinsPluginsBase):
equality operator defined for the scenario.
"""
plugin_name = "Jenkins Mailer Plugin"
j = jenkins.Jenkins(self.base_url, 'test', 'test', resolve=False)
j = jenkins.Jenkins(self.base_url, 'test', 'test')
plugin_info = j.get_plugins()[plugin_name]
v1 = plugin_info.get("version")
@ -307,7 +307,7 @@ class PluginsTestScenarios(JenkinsPluginsBase):
type of PluginVersion before comparing provides the same result.
"""
plugin_name = "Jenkins Mailer Plugin"
j = jenkins.Jenkins(self.base_url, 'test', 'test', resolve=False)
j = jenkins.Jenkins(self.base_url, 'test', 'test')
plugin_info = j.get_plugins()[plugin_name]
v1 = plugin_info.get("version")

10
tests/test_script.py
View File

@ -37,7 +37,7 @@ class JenkinsScriptTest(JenkinsTestBase):
def test_install_plugin(self, jenkins_mock):
'''Installation of plugins is done with the run_script method
'''
j = jenkins.Jenkins(self.make_url(''), 'test', 'test', resolve=False)
j = jenkins.Jenkins(self.make_url(''), 'test', 'test')
j.install_plugin("jabber")
self.assertEqual(
jenkins_mock.call_args[0][0].url,
@ -49,7 +49,7 @@ class JenkinsScriptTest(JenkinsTestBase):
def test_install_plugin_with_dependencies(self, run_script_mock, jenkins_mock):
'''Verify install plugins with dependencies
'''
j = jenkins.Jenkins(self.make_url(''), 'test', 'test', resolve=False)
j = jenkins.Jenkins(self.make_url(''), 'test', 'test')
j.install_plugin("jabber")
self.assertEqual(len(run_script_mock.call_args_list), 2)
self.assertEqual(run_script_mock.call_args_list[0][0][0],
@ -65,7 +65,7 @@ class JenkinsScriptTest(JenkinsTestBase):
def test_install_plugin_without_dependencies(self, run_script_mock, jenkins_mock):
'''Verify install plugins without dependencies
'''
j = jenkins.Jenkins(self.make_url(''), 'test', 'test', resolve=False)
j = jenkins.Jenkins(self.make_url(''), 'test', 'test')
j.install_plugin("jabber", include_dependencies=False)
self.assertEqual(len(run_script_mock.call_args_list), 2)
self.assertEqual(run_script_mock.call_args_list[0][0][0],
@ -81,7 +81,7 @@ class JenkinsScriptTest(JenkinsTestBase):
'''Verify install plugin does not need a restart
'''
run_script_mock.return_value = u'Result: false\n'
j = jenkins.Jenkins(self.make_url(''), 'test', 'test', resolve=False)
j = jenkins.Jenkins(self.make_url(''), 'test', 'test')
self.assertFalse(j.install_plugin("jabber"))
@patch.object(jenkins.Jenkins, 'jenkins_open')
@ -90,5 +90,5 @@ class JenkinsScriptTest(JenkinsTestBase):
'''Verify install plugin needs a restart
'''
run_script_mock.return_value = u'Result: true\n'
j = jenkins.Jenkins(self.make_url(''), 'test', 'test', resolve=False)
j = jenkins.Jenkins(self.make_url(''), 'test', 'test')
self.assertTrue(j.install_plugin("jabber"))