811a6cffc8
In some network setups Jenkins may be hidden behind complex reverse proxy setups that require additional custom headers to be set on each request in order to pass them trough Allow providing such headers using JENKINS_API_EXTRA_HEADERS environment variable Change-Id: If071c5c707f916ba5f4f2c371ec600b7476bf723
272 lines
11 KiB
Python
272 lines
11 KiB
Python
import json
|
|
import socket
|
|
|
|
from mock import patch
|
|
import six
|
|
|
|
from tests.base import JenkinsTestBase
|
|
from tests.helper import build_response_mock
|
|
|
|
import jenkins
|
|
|
|
|
|
def get_mock_urlopen_return_value(a_dict=None):
|
|
if a_dict is None:
|
|
a_dict = {}
|
|
return six.BytesIO(json.dumps(a_dict).encode('utf-8'))
|
|
|
|
|
|
class JenkinsConstructorTest(JenkinsTestBase):
|
|
|
|
def setUp(self):
|
|
super(JenkinsConstructorTest, self).setUp()
|
|
self.req = jenkins.requests.Request('GET', self.base_url)
|
|
self.j._maybe_add_auth()
|
|
|
|
def test_url_with_trailing_slash(self):
|
|
self.assertEqual(self.j.server, self.make_url(''))
|
|
self.assertEqual(self.j.auth(self.req).headers['Authorization'],
|
|
'Basic dGVzdDp0ZXN0')
|
|
self.assertEqual(self.j.crumb, None)
|
|
|
|
def test_url_without_trailing_slash(self):
|
|
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'],
|
|
'Basic dGVzdDp0ZXN0')
|
|
self.assertEqual(j.crumb, None)
|
|
|
|
def test_without_user_or_password(self):
|
|
j = jenkins.Jenkins('{0}'.format(self.base_url))
|
|
j._maybe_add_auth()
|
|
self.assertEqual(j.server, self.make_url(''))
|
|
self.assertEqual(j.auth, None)
|
|
self.assertEqual(j.crumb, None)
|
|
|
|
def test_unicode_password(self):
|
|
j = jenkins.Jenkins('{0}'.format(self.base_url),
|
|
six.u('nonascii'),
|
|
six.u('\xe9\u20ac'))
|
|
j._maybe_add_auth()
|
|
self.assertEqual(j.server, self.make_url(''))
|
|
self.assertEqual(j.auth(self.req).headers['Authorization'],
|
|
'Basic bm9uYXNjaWk6w6nigqw=')
|
|
self.assertEqual(j.crumb, None)
|
|
|
|
def test_long_user_or_password(self):
|
|
long_str = 'a' * 60
|
|
long_str_b64 = 'YWFh' * 20
|
|
|
|
j = jenkins.Jenkins('{0}'.format(self.base_url), long_str, long_str)
|
|
j._maybe_add_auth()
|
|
|
|
auth_header = j.auth(self.req).headers['Authorization']
|
|
self.assertNotIn("\n", auth_header)
|
|
self.assertEqual(auth_header, 'Basic %s' % (
|
|
long_str_b64 + 'Om' + long_str_b64[2:] + 'YQ=='))
|
|
|
|
def test_default_timeout(self):
|
|
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)
|
|
self.assertEqual(j.timeout, 300)
|
|
|
|
|
|
class JenkinsMaybeAddCrumbTest(JenkinsTestBase):
|
|
|
|
@patch('jenkins.requests.Session.send', autospec=True)
|
|
def test_simple(self, session_send_mock):
|
|
session_send_mock.return_value = build_response_mock(
|
|
404, reason="Not Found")
|
|
request = jenkins.requests.Request('http://example.com/job/TestJob')
|
|
|
|
self.j.maybe_add_crumb(request)
|
|
|
|
self.assertEqual(
|
|
session_send_mock.call_args[0][1].url,
|
|
self.make_url('crumbIssuer/api/json'))
|
|
self.assertFalse(self.j.crumb)
|
|
self.assertFalse('.crumb' in request.headers)
|
|
|
|
@patch('jenkins.requests.Session.send', autospec=True)
|
|
def test_with_data(self, session_send_mock):
|
|
session_send_mock.return_value = build_response_mock(
|
|
200, self.crumb_data)
|
|
request = jenkins.requests.Request('GET', 'http://example.com/job/TestJob')
|
|
|
|
self.j.maybe_add_crumb(request)
|
|
|
|
self.assertEqual(
|
|
session_send_mock.call_args[0][1].url,
|
|
self.make_url('crumbIssuer/api/json'))
|
|
self.assertEqual(self.j.crumb, self.crumb_data)
|
|
self.assertEqual(request.headers['.crumb'], self.crumb_data['crumb'])
|
|
|
|
@patch.object(jenkins.Jenkins, 'jenkins_open')
|
|
def test_return_empty_response(self, jenkins_mock):
|
|
"Don't try to create crumb header from an empty response"
|
|
jenkins_mock.side_effect = jenkins.EmptyResponseException("empty response")
|
|
request = jenkins.requests.Request('GET', 'http://example.com/job/TestJob')
|
|
|
|
self.j.maybe_add_crumb(request)
|
|
|
|
self.assertEqual(
|
|
jenkins_mock.call_args[0][0].url,
|
|
self.make_url('crumbIssuer/api/json'))
|
|
self.assertFalse(self.j.crumb)
|
|
self.assertFalse('.crumb' in request.headers)
|
|
|
|
|
|
class JenkinsMaybeAddHeaders(JenkinsTestBase):
|
|
@patch('jenkins.requests.Session.send', autospec=True)
|
|
def test_simple(self, session_send_mock):
|
|
session_send_mock.return_value = build_response_mock(
|
|
404, reason="Not Found")
|
|
request = jenkins.requests.Request('GET', 'http://example.com/job/TestJob')
|
|
|
|
with patch.dict('os.environ', {}):
|
|
j = jenkins.Jenkins(self.base_url, 'test', 'test')
|
|
request = j._session.prepare_request(request)
|
|
|
|
self.assertEqual(request.headers, self.j._session.headers)
|
|
self.assertNotIn("X-Auth", request.headers)
|
|
|
|
@patch('jenkins.requests.Session.send', autospec=True)
|
|
def test_add_header(self, session_send_mock):
|
|
session_send_mock.return_value = build_response_mock(
|
|
404, reason="Not Found")
|
|
request = jenkins.requests.Request('GET', 'http://example.com/job/TestJob')
|
|
|
|
with patch.dict('os.environ', {"JENKINS_API_EXTRA_HEADERS": "X-Auth: 123\nX-Key: 234"}):
|
|
j = jenkins.Jenkins(self.base_url, 'test', 'test')
|
|
request = j._session.prepare_request(request)
|
|
|
|
self.assertEqual(request.headers["X-Auth"], "123")
|
|
self.assertEqual(request.headers["X-Key"], "234")
|
|
|
|
|
|
class JenkinsOpenTest(JenkinsTestBase):
|
|
|
|
@patch('jenkins.requests.Session.send', autospec=True)
|
|
def test_simple(self, session_send_mock):
|
|
data = {'foo': 'bar'}
|
|
session_send_mock.side_effect = iter([
|
|
build_response_mock(200, self.crumb_data),
|
|
build_response_mock(200, data),
|
|
])
|
|
request = jenkins.requests.Request('GET', self.make_url('job/TestJob'))
|
|
|
|
response = self.j.jenkins_open(request)
|
|
|
|
self.assertEqual(
|
|
session_send_mock.call_args[0][1].url,
|
|
self.make_url('job/TestJob'))
|
|
self.assertEqual(response, json.dumps(data))
|
|
self.assertEqual(self.j.crumb, self.crumb_data)
|
|
self.assertEqual(request.headers['.crumb'], self.crumb_data['crumb'])
|
|
|
|
@patch('jenkins.requests.Session.send', autospec=True)
|
|
def test_response_403(self, session_send_mock):
|
|
request = jenkins.requests.Request('GET', self.make_url('job/TestJob'))
|
|
session_send_mock.return_value = build_response_mock(
|
|
401, reason="basic auth failed")
|
|
|
|
with self.assertRaises(jenkins.JenkinsException) as context_manager:
|
|
self.j.jenkins_open(request, add_crumb=False)
|
|
self.assertEqual(
|
|
str(context_manager.exception),
|
|
'Error in request. Possibly authentication failed [401]: '
|
|
'basic auth failed')
|
|
self.assertEqual(
|
|
session_send_mock.call_args[0][1].url,
|
|
self.make_url('job/TestJob'))
|
|
|
|
@patch('jenkins.requests.Session.send', autospec=True)
|
|
def test_response_404(self, session_send_mock):
|
|
request = jenkins.requests.Request('GET', self.make_url('job/TestJob'))
|
|
session_send_mock.return_value = build_response_mock(
|
|
404, reason="basic auth failed")
|
|
|
|
with self.assertRaises(jenkins.NotFoundException) as context_manager:
|
|
self.j.jenkins_open(request, add_crumb=False)
|
|
self.assertEqual(
|
|
str(context_manager.exception),
|
|
'Requested item could not be found')
|
|
self.assertEqual(
|
|
session_send_mock.call_args[0][1].url,
|
|
self.make_url('job/TestJob'))
|
|
|
|
@patch('jenkins.requests.Session.send', autospec=True)
|
|
def test_empty_response(self, session_send_mock):
|
|
request = jenkins.requests.Request('GET', self.make_url('job/TestJob'))
|
|
session_send_mock.return_value = build_response_mock(
|
|
401, reason="basic auth failed")
|
|
|
|
with self.assertRaises(jenkins.JenkinsException) as context_manager:
|
|
self.j.jenkins_open(request, False)
|
|
self.assertEqual(
|
|
str(context_manager.exception),
|
|
'Error in request. Possibly authentication failed [401]: '
|
|
'basic auth failed')
|
|
self.assertEqual(
|
|
session_send_mock.call_args[0][1].url,
|
|
self.make_url('job/TestJob'))
|
|
|
|
@patch('jenkins.requests.Session.send', autospec=True)
|
|
def test_response_501(self, session_send_mock):
|
|
request = jenkins.requests.Request('GET', self.make_url('job/TestJob'))
|
|
session_send_mock.return_value = build_response_mock(
|
|
501, reason="Not implemented")
|
|
|
|
with self.assertRaises(jenkins.req_exc.HTTPError) as context_manager:
|
|
self.j.jenkins_open(request, add_crumb=False)
|
|
self.assertEqual(
|
|
str(context_manager.exception),
|
|
'501 Server Error: Not implemented for url: None')
|
|
self.assertEqual(
|
|
session_send_mock.call_args[0][1].url,
|
|
self.make_url('job/TestJob'))
|
|
|
|
@patch('jenkins.requests.Session.send', autospec=True)
|
|
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)
|
|
request = jenkins.requests.Request('GET', self.make_url('job/TestJob'))
|
|
|
|
with self.assertRaises(jenkins.JenkinsException) as context_manager:
|
|
j.jenkins_open(request, add_crumb=False)
|
|
self.assertEqual(
|
|
str(context_manager.exception),
|
|
'Error in request: timed out')
|
|
self.assertEqual(
|
|
session_send_mock.call_args[0][1].url,
|
|
self.make_url('job/TestJob'))
|
|
|
|
@patch.object(jenkins.Jenkins, 'jenkins_open',
|
|
return_value=json.dumps({'mode': 'NORMAL'}))
|
|
@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')
|
|
self.assertTrue(j.wait_for_normal_op(0))
|
|
|
|
@patch.object(jenkins.Jenkins, 'jenkins_open',
|
|
side_effect=jenkins.EmptyResponseException())
|
|
@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')
|
|
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')
|
|
with self.assertRaises(ValueError) as context_manager:
|
|
j.wait_for_normal_op(-1)
|
|
self.assertEqual(
|
|
str(context_manager.exception),
|
|
"Timeout must be >= 0 not -1")
|