mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-27 23:21:22 -07:00
Improvements to the jenkins_build module and new jenkins_build_info module (#7204)
* Add detach option so the task doesn't wait until the Jenkins job is finished * Add new time_between_checks to be able to configure the sleep time between requests * New jenkins_build_info to get information about a specific build * Add version_added to the new module * Add changelog fragment for jenkins_build changes * Fix tests that required the python-jenkins module * Remove tests that failed Doesn't really make sense to test that with a mock * Fix pep8 error * Update maintainers for the jenkins_build and jenkins_build_info modules * Improve format and add link to PR * Move version_added documentation to the right file * Fix incorrect examples * Improve text format * Fix incorrect code style * Fix incorrect YAML for documentation * Add version_added documentation to the new options
This commit is contained in:
Juan Manuel Casanova González
GitHub
parent
517e2d48eb
commit
afeeb89af6
6 changed files with 464 additions and 3 deletions
|
|
@ -75,6 +75,11 @@ class JenkinsMock():
|
|||
def get_build_info(self, name, build_number):
|
||||
if name == "host-delete":
|
||||
raise jenkins.JenkinsException("job {0} number {1} does not exist".format(name, build_number))
|
||||
elif name == "create-detached":
|
||||
return {
|
||||
"building": True,
|
||||
"result": None
|
||||
}
|
||||
return {
|
||||
"building": True,
|
||||
"result": "SUCCESS"
|
||||
|
|
@ -222,3 +227,38 @@ class TestJenkinsBuild(unittest.TestCase):
|
|||
"token": "xyz"
|
||||
})
|
||||
jenkins_build.main()
|
||||
|
||||
@patch('ansible_collections.community.general.plugins.modules.jenkins_build.test_dependencies')
|
||||
@patch('ansible_collections.community.general.plugins.modules.jenkins_build.JenkinsBuild.get_jenkins_connection')
|
||||
@patch('ansible_collections.community.general.plugins.modules.jenkins_build.JenkinsBuild.get_build_status')
|
||||
def test_module_create_build_without_detach(self, build_status, jenkins_connection, test_deps):
|
||||
test_deps.return_value = None
|
||||
jenkins_connection.return_value = JenkinsMock()
|
||||
build_status.return_value = JenkinsBuildMock().get_build_status()
|
||||
|
||||
with self.assertRaises(AnsibleExitJson) as return_json:
|
||||
set_module_args({
|
||||
"name": "create-detached",
|
||||
"user": "abc",
|
||||
"token": "xyz"
|
||||
})
|
||||
jenkins_build.main()
|
||||
|
||||
self.assertFalse(return_json.exception.args[0]['changed'])
|
||||
|
||||
@patch('ansible_collections.community.general.plugins.modules.jenkins_build.test_dependencies')
|
||||
@patch('ansible_collections.community.general.plugins.modules.jenkins_build.JenkinsBuild.get_jenkins_connection')
|
||||
def test_module_create_build_detached(self, jenkins_connection, test_deps):
|
||||
test_deps.return_value = None
|
||||
jenkins_connection.return_value = JenkinsMock()
|
||||
|
||||
with self.assertRaises(AnsibleExitJson) as return_json:
|
||||
set_module_args({
|
||||
"name": "create-detached",
|
||||
"user": "abc",
|
||||
"token": "xyz",
|
||||
"detach": True
|
||||
})
|
||||
jenkins_build.main()
|
||||
|
||||
self.assertTrue(return_json.exception.args[0]['changed'])
|
||||
|
|
|
|||
180
tests/unit/plugins/modules/test_jenkins_build_info.py
Normal file
180
tests/unit/plugins/modules/test_jenkins_build_info.py
Normal file
|
|
@ -0,0 +1,180 @@
|
|||
# Copyright (c) Ansible project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
from ansible_collections.community.general.tests.unit.compat import unittest
|
||||
from ansible_collections.community.general.tests.unit.compat.mock import patch
|
||||
from ansible.module_utils import basic
|
||||
from ansible.module_utils.common.text.converters import to_bytes
|
||||
from ansible_collections.community.general.plugins.modules import jenkins_build_info
|
||||
|
||||
import json
|
||||
|
||||
|
||||
def set_module_args(args):
|
||||
"""prepare arguments so that they will be picked up during module creation"""
|
||||
args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
|
||||
basic._ANSIBLE_ARGS = to_bytes(args)
|
||||
|
||||
|
||||
class AnsibleExitJson(Exception):
|
||||
"""Exception class to be raised by module.exit_json and caught by the test case"""
|
||||
pass
|
||||
|
||||
|
||||
class AnsibleFailJson(Exception):
|
||||
"""Exception class to be raised by module.fail_json and caught by the test case"""
|
||||
pass
|
||||
|
||||
|
||||
def exit_json(*args, **kwargs):
|
||||
"""function to patch over exit_json; package return data into an exception"""
|
||||
if 'changed' not in kwargs:
|
||||
kwargs['changed'] = False
|
||||
raise AnsibleExitJson(kwargs)
|
||||
|
||||
|
||||
def fail_json(*args, **kwargs):
|
||||
"""function to patch over fail_json; package return data into an exception"""
|
||||
kwargs['failed'] = True
|
||||
raise AnsibleFailJson(kwargs)
|
||||
|
||||
|
||||
class jenkins:
|
||||
class JenkinsException(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class JenkinsBuildMock():
|
||||
def __init__(self, name, build_number=None):
|
||||
self.name = name
|
||||
self.build_number = build_number
|
||||
|
||||
def get_build_status(self):
|
||||
try:
|
||||
instance = JenkinsMock()
|
||||
response = JenkinsMock.get_build_info(instance, self.name, self.build_number)
|
||||
return response
|
||||
except jenkins.JenkinsException:
|
||||
response = {}
|
||||
response["result"] = "ABSENT"
|
||||
return response
|
||||
except Exception as e:
|
||||
fail_json(msg='Unable to fetch build information, {0}'.format(e))
|
||||
|
||||
|
||||
class JenkinsMock():
|
||||
|
||||
def get_build_info(self, name, build_number):
|
||||
if name == "job-absent":
|
||||
raise jenkins.JenkinsException()
|
||||
|
||||
return {
|
||||
"result": "SUCCESS",
|
||||
"build_info": {}
|
||||
}
|
||||
|
||||
def get_job_info(self, name):
|
||||
if name == "job-absent":
|
||||
raise jenkins.JenkinsException()
|
||||
|
||||
return {
|
||||
"lastBuild": {
|
||||
"number": 123
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
class TestJenkinsBuildInfo(unittest.TestCase):
|
||||
|
||||
def setUp(self):
|
||||
self.mock_module_helper = patch.multiple(basic.AnsibleModule,
|
||||
exit_json=exit_json,
|
||||
fail_json=fail_json)
|
||||
self.mock_module_helper.start()
|
||||
self.addCleanup(self.mock_module_helper.stop)
|
||||
|
||||
@patch('ansible_collections.community.general.plugins.modules.jenkins_build_info.test_dependencies')
|
||||
def test_module_fail_when_required_args_missing(self, test_deps):
|
||||
test_deps.return_value = None
|
||||
with self.assertRaises(AnsibleFailJson):
|
||||
set_module_args({})
|
||||
jenkins_build_info.main()
|
||||
|
||||
@patch('ansible_collections.community.general.plugins.modules.jenkins_build_info.test_dependencies')
|
||||
@patch('ansible_collections.community.general.plugins.modules.jenkins_build_info.JenkinsBuildInfo.get_jenkins_connection')
|
||||
def test_module_get_build_info(self, jenkins_connection, test_deps):
|
||||
test_deps.return_value = None
|
||||
jenkins_connection.return_value = JenkinsMock()
|
||||
|
||||
with self.assertRaises(AnsibleExitJson) as return_json:
|
||||
set_module_args({
|
||||
"name": "job-present",
|
||||
"user": "abc",
|
||||
"token": "xyz",
|
||||
"build_number": 30
|
||||
})
|
||||
jenkins_build_info.main()
|
||||
|
||||
self.assertFalse(return_json.exception.args[0]["changed"])
|
||||
|
||||
@patch('ansible_collections.community.general.plugins.modules.jenkins_build_info.test_dependencies')
|
||||
@patch('ansible_collections.community.general.plugins.modules.jenkins_build_info.JenkinsBuildInfo.get_jenkins_connection')
|
||||
@patch('ansible_collections.community.general.plugins.modules.jenkins_build_info.JenkinsBuildInfo.get_build_status')
|
||||
def test_module_get_build_info_if_build_does_not_exist(self, build_status, jenkins_connection, test_deps):
|
||||
test_deps.return_value = None
|
||||
jenkins_connection.return_value = JenkinsMock()
|
||||
build_status.return_value = JenkinsBuildMock("job-absent", 30).get_build_status()
|
||||
|
||||
with self.assertRaises(AnsibleExitJson) as return_json:
|
||||
set_module_args({
|
||||
"name": "job-absent",
|
||||
"user": "abc",
|
||||
"token": "xyz",
|
||||
"build_number": 30
|
||||
})
|
||||
jenkins_build_info.main()
|
||||
|
||||
self.assertFalse(return_json.exception.args[0]['changed'])
|
||||
self.assertTrue(return_json.exception.args[0]['failed'])
|
||||
self.assertEquals("ABSENT", return_json.exception.args[0]['build_info']['result'])
|
||||
|
||||
@patch('ansible_collections.community.general.plugins.modules.jenkins_build_info.test_dependencies')
|
||||
@patch('ansible_collections.community.general.plugins.modules.jenkins_build_info.JenkinsBuildInfo.get_jenkins_connection')
|
||||
def test_module_get_build_info_get_last_build(self, jenkins_connection, test_deps):
|
||||
test_deps.return_value = None
|
||||
jenkins_connection.return_value = JenkinsMock()
|
||||
|
||||
with self.assertRaises(AnsibleExitJson) as return_json:
|
||||
set_module_args({
|
||||
"name": "job-present",
|
||||
"user": "abc",
|
||||
"token": "xyz"
|
||||
})
|
||||
jenkins_build_info.main()
|
||||
|
||||
self.assertFalse(return_json.exception.args[0]['changed'])
|
||||
self.assertEquals("SUCCESS", return_json.exception.args[0]['build_info']['result'])
|
||||
|
||||
@patch('ansible_collections.community.general.plugins.modules.jenkins_build_info.test_dependencies')
|
||||
@patch('ansible_collections.community.general.plugins.modules.jenkins_build_info.JenkinsBuildInfo.get_jenkins_connection')
|
||||
@patch('ansible_collections.community.general.plugins.modules.jenkins_build_info.JenkinsBuildInfo.get_build_status')
|
||||
def test_module_get_build_info_if_job_does_not_exist(self, build_status, jenkins_connection, test_deps):
|
||||
test_deps.return_value = None
|
||||
jenkins_connection.return_value = JenkinsMock()
|
||||
build_status.return_value = JenkinsBuildMock("job-absent").get_build_status()
|
||||
|
||||
with self.assertRaises(AnsibleExitJson) as return_json:
|
||||
set_module_args({
|
||||
"name": "job-absent",
|
||||
"user": "abc",
|
||||
"token": "xyz"
|
||||
})
|
||||
jenkins_build_info.main()
|
||||
|
||||
self.assertFalse(return_json.exception.args[0]['changed'])
|
||||
self.assertTrue(return_json.exception.args[0]['failed'])
|
||||
self.assertEquals("ABSENT", return_json.exception.args[0]['build_info']['result'])
|
||||
Loading…
Add table
Add a link
Reference in a new issue