class TestJenkins(TestCase):
def setUp(self):
super(TestJenkins, self).setUp()
self.jenkins = Jenkins('http://jenkins')
def test_all_jobs(self, requests):
response = {'jobs': [{'name': 'job1', 'color': 'blue'}]}
requests.get.return_value = mock_response(response)
jobs = self.jenkins.all_jobs()
requests.get.assert_called_once_with('http://jenkins/api/python',
verify=True,
proxies={},
auth=None)
self.assertEqual(jobs, [('job1', 'blue')])
def test_get_job_url(self, *args):
url = self.jenkins.job_url('job123')
self.assertEqual('http://jenkins/job/job123', url)
def test_last_result(self, requests, *args):
second_response = Mock(status_code=200)
second_response.content = "{'result': 23}"
requests.get.side_effect = [
mock_response('job_info.txt'), second_response
]
response = self.jenkins.last_result('name')
self.assertEqual(23, response['result'])
self.assertEqual(
(('https://builds.apache.org/job/Solr-Trunk/1783/api/python',),
{'auth': None, 'verify': True, 'proxies': {}}),
requests.get.call_args_list[1]
)
@data(
('job_info', 'job/{0}/api/python'),
('last_build_info', 'job/{0}/lastBuild/api/python'),
('last_build_report', 'job/{0}/lastBuild/testReport/api/python'),
('last_success', 'job/{0}/lastSuccessfulBuild/api/python'),
('get_config_xml', 'job/{0}/config.xml'),
)
def test_get_methods_with_jobname(self, case, requests):
method, url = case
requests.get.return_value = mock_response('{0}.txt'.format(method))
response = getattr(self.jenkins, method)('name')
requests.get.assert_called_once_with(
'http://jenkins/' + url.format('name'),
verify=True,
proxies={},
auth=None)
getattr(self, 'checks_{0}'.format(method))(response)
def test_build_info(self, requests):
url = 'job/name/3/api/python'
requests.get.return_value = mock_response('last_build_info.txt')
self.jenkins.build_info('name', 3)
requests.get.assert_called_once_with(
'http://jenkins/' + url,
verify=True,
proxies={},
auth=None)
def check_result(self, response, route, value):
for key in route:
response = response[key]
self.assertEqual(response, value)
def check_results(self, response, values):
for route, value in values:
self.check_result(response, route, value)
def checks_job_info(self, response):
self.check_results(
response,
[(('color',), 'red'),
(('lastSuccessfulBuild', 'number'), 1778),
(('lastSuccessfulBuild', 'url'),
'https://builds.apache.org/job/Solr-Trunk/1778/'),
])
def checks_last_build_info(self, response):
self.check_results(
response,
[(('timestamp',), 1330941036216L),
(('number',), 1783),
(('result',), 'FAILURE'),
(('changeSet', 'kind'), 'svn'),
])
def checks_last_build_report(self, response):
self.check_results(
response,
[(('duration',), 692.3089),
(('failCount',), 1),
(('suites', 0, 'name'), 'org.apache.solr.BasicFunctionalityTest'),
])
def checks_last_success(self, response):
self.check_results(
response,
[(('result',), 'SUCCESS'),
(('building',), False),
(('artifacts', 0, 'displayPath'),
'apache-solr-4.0-2012-02-29_09-07-30-src.tgz'),
])
def checks_get_config_xml(self, response):
self.assertTrue(response.startswith('<?xml'))
self.assertTrue(response.endswith('</project>'))
# TODO: test job creation, and set_config_xml
@patch('autojenkins.jobs.Jenkins.job_exists')
def test_create(self, job_exists, requests):
job_exists.side_effect = side_effect_job_exists
requests.post.return_value = mock_response()
config_xml = path.join(fixture_path, 'create_copy.txt')
self.jenkins.create('job', config_xml, value='2')
CFG = "<value>2</value><disabled>true</disabled>"
requests.post.assert_called_once_with(
'http://jenkins/createItem',
auth=None,
headers={'Content-Type': 'application/xml'},
params={'name': 'job'},
data=CFG,
proxies={},
verify=True)
@patch('autojenkins.jobs.Jenkins.job_exists')
def test_create_copy(self, job_exists, requests):
job_exists.side_effect = side_effect_job_exists
requests.get.return_value = mock_response('create_copy.txt')
requests.post.return_value = mock_response()
self.jenkins.create_copy('job', 'template', value='2')
CFG = "<value>2</value><disabled>false</disabled>"
requests.post.assert_called_once_with(
'http://jenkins/createItem',
auth=None,
headers={'Content-Type': 'application/xml'},
params={'name': 'job'},
data=CFG,
proxies={},
verify=True)
def test_transfer(self, requests):
requests.get.return_value = mock_response('transfer.txt')
requests.post.return_value = mock_response()
self.jenkins.transfer('job', 'http://jenkins2')
CFG = load_fixture('transfer.txt')
requests.post.assert_called_once_with(
'http://jenkins2/createItem',
auth=None,
headers={'Content-Type': 'application/xml'},
params={'name': 'job'},
data=CFG,
proxies={},
verify=True)
@data(
('build', 'job/{0}/build'),
('delete', 'job/{0}/doDelete'),
('enable', 'job/{0}/enable'),
('disable', 'job/{0}/disable'),
)
@patch('autojenkins.jobs.Jenkins.job_info')
@patch('autojenkins.jobs.Jenkins.job_exists')
def test_post_methods_with_jobname_no_data(self, case, job_exists,
job_info, requests):
method, url = case
# Jenkins API post methods return status 302 upon success
requests.post.return_value = mock_response(status=302)
job_exists.side_effect = side_effect_job_exists
job_info.return_value = {'buildable': True}
response = getattr(self.jenkins, method)('name')
self.assertEqual(302, response.status_code)
requests.post.assert_called_once_with(
'http://jenkins/' + url.format('name'),
auth=None,
proxies={},
verify=True)
def test_set_config_xml(self, requests):
requests.post.return_value = Mock(status_code=200)
CFG = '<config>x</config>'
response = self.jenkins.set_config_xml('name', CFG)
# return value is a pass-trough
self.assertEqual(requests.post.return_value, response)
requests.post.assert_called_once_with(
'http://jenkins/job/name/config.xml',
headers={'Content-Type': 'application/xml'},
data=CFG,
auth=None,
proxies={},
verify=True)
@patch('autojenkins.jobs.time')
@patch('autojenkins.jobs.Jenkins.last_result')
@patch('autojenkins.jobs.Jenkins.wait_for_build')
@patch('autojenkins.jobs.Jenkins.job_exists')
@patch('autojenkins.jobs.Jenkins.job_info')
def test_build_with_wait(self, job_info, job_exists, wait_for_build,
last_result, time, requests):
"""Test building a job synchronously"""
job_exists.side_effect = side_effect_job_exists
job_info.return_value = {'buildable': True}
requests.post.return_value = mock_response(status=302)
last_result.return_value = {'result': 'HELLO'}
result = self.jenkins.build('name', wait=True)
self.assertEqual({'result': 'HELLO'}, result)
requests.post.assert_called_once_with(
'http://jenkins/job/name/build',
auth=None,
proxies={},
verify=True)
last_result.assert_called_once_with('name')
time.sleep.assert_called_once_with(10)
@patch('autojenkins.jobs.time')
@patch('autojenkins.jobs.sys')
@patch('autojenkins.jobs.Jenkins.is_building')
def test_wait_for_build(self, is_building, sys, time, requests):
is_building.side_effect = [True, True, False]
self.jenkins.wait_for_build('name')
self.assertEqual(3, is_building.call_count)
self.assertEqual(2, time.sleep.call_count)
self.assertEqual(((3,), {}), time.sleep.call_args)
@patch('autojenkins.jobs.Jenkins.last_result')
@data(True, False)
def test_is_building(self, building, last_result, _):
last_result.return_value = {'building': building}
result = self.jenkins.is_building('name')
last_result.assert_called_once_with('name')
self.assertEqual(building, result)
def test_404_raises_http_not_found(self, requests):
http404_response = Mock()
http404_response.status_code = 404
requests.get.return_value = http404_response
with self.assertRaises(HttpNotFoundError):
self.jenkins.last_build_info('job123')
def test_500_raises_http_error(self, requests):
http500_response = Mock()
http500_response.status_code = 500
requests.get.return_value = http500_response
with self.assertRaises(HttpStatusError):
self.jenkins.last_build_info('job123')
class TestJenkins(TestCase):
def setUp(self):
super(TestJenkins, self).setUp()
self.jenkins = Jenkins("http://jenkins")
def test_all_jobs(self, requests):
response = {"jobs": [{"name": "job1", "color": "blue"}]}
requests.get.return_value = mock_response(response)
jobs = self.jenkins.all_jobs()
requests.get.assert_called_once_with("http://jenkins/api/python", verify=True, proxies={}, auth=None)
self.assertEqual(jobs, [("job1", "blue")])
def test_get_job_url(self, *args):
url = self.jenkins.job_url("job123")
self.assertEqual("http://jenkins/job/job123", url)
def test_last_result(self, requests, *args):
second_response = Mock(status_code=200)
second_response.content = "{'result': 23}"
requests.get.side_effect = [mock_response("job_info.txt"), second_response]
response = self.jenkins.last_result("name")
self.assertEqual(23, response["result"])
self.assertEqual(
(
("https://builds.apache.org/job/Solr-Trunk/1783/api/python",),
{"auth": None, "verify": True, "proxies": {}},
),
requests.get.call_args_list[1],
)
@data(
("job_info", "job/{0}/api/python"),
("last_build_info", "job/{0}/lastBuild/api/python"),
("last_build_report", "job/{0}/lastBuild/testReport/api/python"),
("last_success", "job/{0}/lastSuccessfulBuild/api/python"),
("get_config_xml", "job/{0}/config.xml"),
)
def test_get_methods_with_jobname(self, case, requests):
method, url = case
requests.get.return_value = mock_response("{0}.txt".format(method))
response = getattr(self.jenkins, method)("name")
requests.get.assert_called_once_with("http://jenkins/" + url.format("name"), verify=True, proxies={}, auth=None)
getattr(self, "checks_{0}".format(method))(response)
def test_build_info(self, requests):
url = "job/name/3/api/python"
requests.get.return_value = mock_response("last_build_info.txt")
self.jenkins.build_info("name", 3)
requests.get.assert_called_once_with("http://jenkins/" + url, verify=True, proxies={}, auth=None)
def check_result(self, response, route, value):
for key in route:
response = response[key]
self.assertEqual(response, value)
def check_results(self, response, values):
for route, value in values:
self.check_result(response, route, value)
def checks_job_info(self, response):
self.check_results(
response,
[
(("color",), "red"),
(("lastSuccessfulBuild", "number"), 1778),
(("lastSuccessfulBuild", "url"), "https://builds.apache.org/job/Solr-Trunk/1778/"),
],
)
def checks_last_build_info(self, response):
self.check_results(
response,
[
(("timestamp",), 1330941036216L),
(("number",), 1783),
(("result",), "FAILURE"),
(("changeSet", "kind"), "svn"),
],
)
def checks_last_build_report(self, response):
self.check_results(
response,
[
(("duration",), 692.3089),
(("failCount",), 1),
(("suites", 0, "name"), "org.apache.solr.BasicFunctionalityTest"),
],
)
def checks_last_success(self, response):
self.check_results(
response,
[
(("result",), "SUCCESS"),
(("building",), False),
(("artifacts", 0, "displayPath"), "apache-solr-4.0-2012-02-29_09-07-30-src.tgz"),
],
)
def checks_get_config_xml(self, response):
self.assertTrue(response.startswith("<?xml"))
self.assertTrue(response.endswith("</project>"))
# TODO: test job creation, and set_config_xml
@patch("autojenkins.jobs.Jenkins.job_exists")
def test_create(self, job_exists, requests):
job_exists.side_effect = side_effect_job_exists
requests.post.return_value = mock_response()
config_xml = path.join(fixture_path, "create_copy.txt")
self.jenkins.create("job", config_xml, value="2")
CFG = "<value>2</value><disabled>true</disabled>"
requests.post.assert_called_once_with(
"http://jenkins/createItem",
auth=None,
headers={"Content-Type": "application/xml"},
params={"name": "job"},
data=CFG,
proxies={},
verify=True,
)
@patch("autojenkins.jobs.Jenkins.job_exists")
def test_create_copy(self, job_exists, requests):
job_exists.side_effect = side_effect_job_exists
requests.get.return_value = mock_response("create_copy.txt")
requests.post.return_value = mock_response()
self.jenkins.create_copy("job", "template", value="2")
CFG = "<value>2</value><disabled>false</disabled>"
requests.post.assert_called_once_with(
"http://jenkins/createItem",
auth=None,
headers={"Content-Type": "application/xml"},
params={"name": "job"},
data=CFG,
proxies={},
verify=True,
)
@patch("autojenkins.jobs.Jenkins.job_exists")
def test_create_copy_forced_job_exists(self, job_exists, requests):
job_exists.side_effect = side_effect_job_exists
requests.get.return_value = mock_response("create_copy.txt")
requests.post.return_value = mock_response()
self.jenkins.create_copy("job", "template", _force=True, value="2")
CFG = "<value>2</value><disabled>false</disabled>"
requests.post.assert_called_once_with(
"http://jenkins/createItem",
auth=None,
headers={"Content-Type": "application/xml"},
params={"name": "job"},
data=CFG,
proxies={},
verify=True,
)
@patch("autojenkins.jobs.Jenkins.job_exists")
def test_create_copy_forced_new_job(self, job_exists, requests):
job_exists.side_effect = side_effect_job_exists
requests.get.return_value = mock_response("create_copy.txt")
requests.post.return_value = mock_response()
self.jenkins.create_copy("name", "template", _force=True, value="2")
CFG = "<value>2</value><disabled>false</disabled>"
requests.post.assert_called_once_with(
"http://jenkins/job/name/config.xml",
headers={"Content-Type": "application/xml"},
data=CFG,
auth=None,
proxies={},
verify=True,
)
def test_transfer(self, requests):
requests.get.return_value = mock_response("transfer.txt")
requests.post.return_value = mock_response()
self.jenkins.transfer("job", "http://jenkins2")
CFG = load_fixture("transfer.txt")
requests.post.assert_called_once_with(
"http://jenkins2/createItem",
auth=None,
headers={"Content-Type": "application/xml"},
params={"name": "job"},
data=CFG,
proxies={},
verify=True,
)
@data(
("build", "job/{0}/build"),
("delete", "job/{0}/doDelete"),
("enable", "job/{0}/enable"),
("disable", "job/{0}/disable"),
)
@patch("autojenkins.jobs.Jenkins.job_info")
@patch("autojenkins.jobs.Jenkins.job_exists")
def test_post_methods_with_jobname_no_data(self, case, job_exists, job_info, requests):
method, url = case
# Jenkins API post methods return status 302 upon success
requests.post.return_value = mock_response(status=302)
job_exists.side_effect = side_effect_job_exists
job_info.return_value = {"buildable": True}
response = getattr(self.jenkins, method)("name")
self.assertEqual(302, response.status_code)
requests.post.assert_called_once_with(
"http://jenkins/" + url.format("name"), auth=None, proxies={}, verify=True
)
def test_set_config_xml(self, requests):
requests.post.return_value = Mock(status_code=200)
CFG = "<config>x</config>"
response = self.jenkins.set_config_xml("name", CFG)
# return value is a pass-trough
self.assertEqual(requests.post.return_value, response)
requests.post.assert_called_once_with(
"http://jenkins/job/name/config.xml",
headers={"Content-Type": "application/xml"},
data=CFG,
auth=None,
proxies={},
verify=True,
)
@patch("autojenkins.jobs.time")
@patch("autojenkins.jobs.Jenkins.last_result")
@patch("autojenkins.jobs.Jenkins.wait_for_build")
@patch("autojenkins.jobs.Jenkins.job_exists")
@patch("autojenkins.jobs.Jenkins.job_info")
def test_build_with_wait(self, job_info, job_exists, wait_for_build, last_result, time, requests):
"""Test building a job synchronously"""
job_exists.side_effect = side_effect_job_exists
job_info.return_value = {"buildable": True}
requests.post.return_value = mock_response(status=302)
last_result.return_value = {"result": "HELLO"}
result = self.jenkins.build("name", wait=True)
self.assertEqual({"result": "HELLO"}, result)
requests.post.assert_called_once_with("http://jenkins/job/name/build", auth=None, proxies={}, verify=True)
last_result.assert_called_once_with("name")
time.sleep.assert_called_once_with(10)
@patch("autojenkins.jobs.time")
@patch("autojenkins.jobs.sys")
@patch("autojenkins.jobs.Jenkins.is_building")
def test_wait_for_build(self, is_building, sys, time, requests):
is_building.side_effect = [True, True, False]
self.jenkins.wait_for_build("name")
self.assertEqual(3, is_building.call_count)
self.assertEqual(2, time.sleep.call_count)
self.assertEqual(((3,), {}), time.sleep.call_args)
@patch("autojenkins.jobs.Jenkins.last_result")
@data(True, False)
def test_is_building(self, building, last_result, _):
last_result.return_value = {"building": building}
result = self.jenkins.is_building("name")
last_result.assert_called_once_with("name")
self.assertEqual(building, result)
def test_404_raises_http_not_found(self, requests):
http404_response = Mock()
http404_response.status_code = 404
requests.get.return_value = http404_response
with self.assertRaises(HttpNotFoundError):
self.jenkins.last_build_info("job123")
def test_500_raises_http_error(self, requests):
http500_response = Mock()
http500_response.status_code = 500
requests.get.return_value = http500_response
with self.assertRaises(HttpStatusError):
self.jenkins.last_build_info("job123")