mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-26 05:50:36 -07:00
3d03c373ff* jenkins_node: Add set offline message * Implement offline_message parameter for updating a Jenkins node offline cause reason when the state is "disabled" (offline). * Fix enabled, disable and absent node state redirect authorization issues, same as was present for present. * Add unit tests for redirect authorization workarounds. * * Make docs clearer re: offline_message behaviour * Exit with fail_json() instead of raising when create/delete/enable/disable node fail. * * Add changelog fragment * Update changelog fragments. --------- Co-authored-by: Felix Fontein <felix@fontein.de>
843 lines
22 KiB
Python
843 lines
22 KiB
Python
# 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
|
|
|
|
import jenkins
|
|
import json
|
|
|
|
from xml.etree import ElementTree as et
|
|
|
|
import pytest
|
|
|
|
from ansible.module_utils import basic
|
|
from ansible.module_utils.common.text.converters import to_bytes
|
|
from ansible_collections.community.general.tests.unit.compat.mock import patch, call
|
|
from ansible_collections.community.general.plugins.modules import jenkins_node
|
|
from pytest import fixture, raises, mark, param
|
|
|
|
|
|
def xml_equal(x, y):
|
|
# type: (et.Element | str, et.Element | str) -> bool
|
|
if isinstance(x, str):
|
|
x = et.fromstring(x)
|
|
|
|
if isinstance(y, str):
|
|
y = et.fromstring(y)
|
|
|
|
if x.tag != y.tag:
|
|
return False
|
|
|
|
if x.attrib != y.attrib:
|
|
return False
|
|
|
|
if (x.text or "").strip() != (y.text or "").strip():
|
|
return False
|
|
|
|
x_children = list(x)
|
|
y_children = list(y)
|
|
|
|
if len(x_children) != len(y_children):
|
|
return False
|
|
|
|
for x, y in zip(x_children, y_children):
|
|
if not xml_equal(x, y):
|
|
return False
|
|
|
|
return True
|
|
|
|
|
|
def assert_xml_equal(x, y):
|
|
if xml_equal(x, y):
|
|
return True
|
|
|
|
if not isinstance(x, str):
|
|
x = et.tostring(x)
|
|
|
|
if not isinstance(y, str):
|
|
y = et.tostring(y)
|
|
|
|
raise AssertionError("{} != {}".format(x, y))
|
|
|
|
|
|
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):
|
|
def __init__(self, value):
|
|
self.value = value
|
|
|
|
def __getitem__(self, item):
|
|
return self.value[item]
|
|
|
|
|
|
def exit_json(*args, **kwargs):
|
|
if 'changed' not in kwargs:
|
|
kwargs['changed'] = False
|
|
raise AnsibleExitJson(kwargs)
|
|
|
|
|
|
class AnsibleFailJson(Exception):
|
|
pass
|
|
|
|
|
|
def fail_json(*args, **kwargs):
|
|
kwargs['failed'] = True
|
|
raise AnsibleFailJson(kwargs)
|
|
|
|
|
|
@fixture(autouse=True)
|
|
def module():
|
|
with patch.multiple(
|
|
"ansible.module_utils.basic.AnsibleModule",
|
|
exit_json=exit_json,
|
|
fail_json=fail_json,
|
|
):
|
|
yield
|
|
|
|
|
|
@fixture
|
|
def instance():
|
|
with patch("jenkins.Jenkins", autospec=True) as instance:
|
|
yield instance
|
|
|
|
|
|
@fixture
|
|
def get_instance(instance):
|
|
with patch(
|
|
"ansible_collections.community.general.plugins.modules.jenkins_node.JenkinsNode.get_jenkins_instance",
|
|
autospec=True,
|
|
) as mock:
|
|
mock.return_value = instance
|
|
yield mock
|
|
|
|
|
|
def test_get_jenkins_instance_with_user_and_token(instance):
|
|
instance.node_exists.return_value = False
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "absent",
|
|
"url": "https://localhost:8080",
|
|
"user": "admin",
|
|
"token": "password",
|
|
})
|
|
|
|
with pytest.raises(AnsibleExitJson):
|
|
jenkins_node.main()
|
|
|
|
assert instance.call_args == call("https://localhost:8080", "admin", "password")
|
|
|
|
|
|
def test_get_jenkins_instance_with_user(instance):
|
|
instance.node_exists.return_value = False
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "absent",
|
|
"url": "https://localhost:8080",
|
|
"user": "admin",
|
|
})
|
|
|
|
with pytest.raises(AnsibleExitJson):
|
|
jenkins_node.main()
|
|
|
|
assert instance.call_args == call("https://localhost:8080", "admin")
|
|
|
|
|
|
def test_get_jenkins_instance_with_no_credential(instance):
|
|
instance.node_exists.return_value = False
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "absent",
|
|
"url": "https://localhost:8080",
|
|
})
|
|
|
|
with pytest.raises(AnsibleExitJson):
|
|
jenkins_node.main()
|
|
|
|
assert instance.call_args == call("https://localhost:8080")
|
|
|
|
|
|
PRESENT_STATES = ["present", "enabled", "disabled"]
|
|
|
|
|
|
@mark.parametrize(["state"], [param(state) for state in PRESENT_STATES])
|
|
def test_state_present_when_absent(get_instance, instance, state):
|
|
instance.node_exists.return_value = False
|
|
instance.get_node_config.return_value = "<slave />"
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": state,
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert instance.create_node.call_args == call("my-node", launcher=jenkins.LAUNCHER_SSH)
|
|
|
|
assert result.value["created"] is True
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
@mark.parametrize(["state"], [param(state) for state in PRESENT_STATES])
|
|
def test_state_present_when_absent_check_mode(get_instance, instance, state):
|
|
instance.node_exists.return_value = False
|
|
instance.get_node_config.return_value = "<slave />"
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": state,
|
|
"_ansible_check_mode": True,
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert not instance.create_node.called
|
|
|
|
assert result.value["created"] is True
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
@mark.parametrize(["state"], [param(state) for state in PRESENT_STATES])
|
|
def test_state_present_when_absent_redirect_auth_error_handled(
|
|
get_instance, instance, state
|
|
):
|
|
instance.node_exists.side_effect = [False, True]
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.create_node.side_effect = jenkins.JenkinsException
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": state,
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert instance.create_node.call_args == call("my-node", launcher=jenkins.LAUNCHER_SSH)
|
|
|
|
assert result.value["created"] is True
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
@mark.parametrize(["state"], [param(state) for state in PRESENT_STATES])
|
|
def test_state_present_when_absent_other_error_raised(get_instance, instance, state):
|
|
instance.node_exists.side_effect = [False, False]
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.create_node.side_effect = jenkins.JenkinsException
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": state,
|
|
})
|
|
|
|
with raises(AnsibleFailJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert instance.create_node.call_args == call("my-node", launcher=jenkins.LAUNCHER_SSH)
|
|
|
|
assert "Create node failed" in str(result.value)
|
|
|
|
|
|
def test_state_present_when_present(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "present",
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert not instance.create_node.called
|
|
|
|
assert result.value["created"] is False
|
|
assert result.value["changed"] is False
|
|
|
|
|
|
def test_state_absent_when_present(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "absent",
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert instance.delete_node.call_args == call("my-node")
|
|
|
|
assert result.value["deleted"] is True
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
def test_state_absent_when_present_check_mode(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "absent",
|
|
"_ansible_check_mode": True,
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert not instance.delete_node.called
|
|
|
|
assert result.value["deleted"] is True
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
def test_state_absent_when_present_redirect_auth_error_handled(get_instance, instance):
|
|
instance.node_exists.side_effect = [True, False]
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.delete_node.side_effect = jenkins.JenkinsException
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "absent",
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert instance.delete_node.call_args == call("my-node")
|
|
|
|
assert result.value["deleted"] is True
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
def test_state_absent_when_present_other_error_raised(get_instance, instance):
|
|
instance.node_exists.side_effect = [True, True]
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.delete_node.side_effect = jenkins.JenkinsException
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "absent",
|
|
})
|
|
|
|
with raises(AnsibleFailJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert instance.delete_node.call_args == call("my-node")
|
|
|
|
assert "Delete node failed" in str(result.value)
|
|
|
|
|
|
def test_state_absent_when_absent(get_instance, instance):
|
|
instance.node_exists.return_value = False
|
|
instance.get_node_config.return_value = "<slave />"
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "absent",
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert not instance.delete_node.called
|
|
|
|
assert result.value["deleted"] is False
|
|
assert result.value["changed"] is False
|
|
|
|
|
|
def test_state_enabled_when_offline(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.get_node_info.return_value = {"offline": True}
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "enabled",
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert instance.enable_node.call_args == call("my-node")
|
|
|
|
assert result.value["enabled"] is True
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
def test_state_enabled_when_offline_check_mode(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.get_node_info.return_value = {"offline": True}
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "enabled",
|
|
"_ansible_check_mode": True,
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert not instance.enable_node.called
|
|
|
|
assert result.value["enabled"] is True
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
def test_state_enabled_when_offline_redirect_auth_error_handled(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.get_node_info.side_effect = [{"offline": True}, {"offline": False}]
|
|
instance.enable_node.side_effect = jenkins.JenkinsException
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "enabled",
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert instance.enable_node.call_args == call("my-node")
|
|
|
|
assert result.value["enabled"] is True
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
def test_state_enabled_when_offline_other_error_raised(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.get_node_info.side_effect = [{"offline": True}, {"offline": True}]
|
|
instance.enable_node.side_effect = jenkins.JenkinsException
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "enabled",
|
|
})
|
|
|
|
with raises(AnsibleFailJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert instance.enable_node.call_args == call("my-node")
|
|
|
|
assert "Enable node failed" in str(result.value)
|
|
|
|
|
|
def test_state_enabled_when_not_offline(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.get_node_info.return_value = {"offline": False}
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "enabled",
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert not instance.enable_node.called
|
|
|
|
assert result.value["enabled"] is False
|
|
assert result.value["changed"] is False
|
|
|
|
|
|
def test_state_disabled_when_not_offline(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.get_node_info.return_value = {
|
|
"offline": False,
|
|
"offlineCauseReason": "",
|
|
}
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "disabled",
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert instance.disable_node.call_args == call("my-node", "")
|
|
|
|
assert result.value["disabled"] is True
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
def test_state_disabled_when_not_offline_redirect_auth_error_handled(
|
|
get_instance, instance
|
|
):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.get_node_info.side_effect = [
|
|
{
|
|
"offline": False,
|
|
"offlineCauseReason": "",
|
|
},
|
|
{
|
|
"offline": True,
|
|
"offlineCauseReason": "",
|
|
},
|
|
]
|
|
instance.disable_node.side_effect = jenkins.JenkinsException
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "disabled",
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert instance.disable_node.call_args == call("my-node", "")
|
|
|
|
assert result.value["disabled"] is True
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
def test_state_disabled_when_not_offline_other_error_raised(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.get_node_info.side_effect = [
|
|
{
|
|
"offline": False,
|
|
"offlineCauseReason": "",
|
|
},
|
|
{
|
|
"offline": False,
|
|
"offlineCauseReason": "",
|
|
},
|
|
]
|
|
instance.disable_node.side_effect = jenkins.JenkinsException
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "disabled",
|
|
})
|
|
|
|
with raises(AnsibleFailJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert instance.disable_node.call_args == call("my-node", "")
|
|
|
|
assert "Disable node failed" in str(result.value)
|
|
|
|
|
|
def test_state_disabled_when_not_offline_check_mode(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.get_node_info.return_value = {
|
|
"offline": False,
|
|
"offlineCauseReason": "",
|
|
}
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "disabled",
|
|
"_ansible_check_mode": True,
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert not instance.disable_node.called
|
|
|
|
assert result.value["disabled"] is True
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
def test_state_disabled_when_offline(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.get_node_info.return_value = {
|
|
"offline": True,
|
|
"offlineCauseReason": "",
|
|
}
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "disabled",
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert not instance.disable_node.called
|
|
|
|
assert result.value["disabled"] is False
|
|
assert result.value["changed"] is False
|
|
|
|
|
|
def test_configure_num_executors_when_not_configured(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "present",
|
|
"num_executors": 3,
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert instance.reconfig_node.call_args[0][0] == "my-node"
|
|
assert_xml_equal(instance.reconfig_node.call_args[0][1], """
|
|
<slave>
|
|
<numExecutors>3</numExecutors>
|
|
</slave>
|
|
""")
|
|
|
|
assert result.value["configured"] is True
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
def test_configure_num_executors_when_not_equal(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = """
|
|
<slave>
|
|
<numExecutors>3</numExecutors>
|
|
</slave>
|
|
"""
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "present",
|
|
"num_executors": 2,
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert_xml_equal(instance.reconfig_node.call_args[0][1], """
|
|
<slave>
|
|
<numExecutors>2</numExecutors>
|
|
</slave>
|
|
""")
|
|
|
|
assert result.value["configured"] is True
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
def test_configure_num_executors_when_equal(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = """
|
|
<slave>
|
|
<numExecutors>2</numExecutors>
|
|
</slave>
|
|
"""
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "present",
|
|
"num_executors": 2,
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert not instance.reconfig_node.called
|
|
|
|
assert result.value["configured"] is False
|
|
assert result.value["changed"] is False
|
|
|
|
|
|
def test_configure_labels_when_not_configured(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "present",
|
|
"labels": [
|
|
"a",
|
|
"b",
|
|
"c",
|
|
],
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert instance.reconfig_node.call_args[0][0] == "my-node"
|
|
assert_xml_equal(instance.reconfig_node.call_args[0][1], """
|
|
<slave>
|
|
<label>a b c</label>
|
|
</slave>
|
|
""")
|
|
|
|
assert result.value["configured"] is True
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
def test_configure_labels_when_not_equal(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = """
|
|
<slave>
|
|
<label>a b c</label>
|
|
</slave>
|
|
"""
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "present",
|
|
"labels": [
|
|
"a",
|
|
"z",
|
|
"c",
|
|
],
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert instance.reconfig_node.call_args[0][0] == "my-node"
|
|
assert_xml_equal(instance.reconfig_node.call_args[0][1], """
|
|
<slave>
|
|
<label>a z c</label>
|
|
</slave>
|
|
""")
|
|
|
|
assert result.value["configured"] is True
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
def test_configure_labels_when_equal(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = """
|
|
<slave>
|
|
<label>a b c</label>
|
|
</slave>
|
|
"""
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "present",
|
|
"labels": [
|
|
"a",
|
|
"b",
|
|
"c",
|
|
],
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert not instance.reconfig_node.called
|
|
|
|
assert result.value["configured"] is False
|
|
assert result.value["changed"] is False
|
|
|
|
|
|
def test_configure_labels_fail_when_contains_space(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "present",
|
|
"labels": [
|
|
"a error",
|
|
],
|
|
})
|
|
|
|
with raises(AnsibleFailJson):
|
|
jenkins_node.main()
|
|
|
|
assert not instance.reconfig_node.called
|
|
|
|
|
|
@mark.parametrize(["state"], [param(state) for state in ["enabled", "present", "absent"]])
|
|
def test_raises_error_if_offline_message_when_state_not_disabled(get_instance, instance, state):
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": state,
|
|
"offline_message": "This is a message...",
|
|
})
|
|
|
|
with raises(AnsibleFailJson):
|
|
jenkins_node.main()
|
|
|
|
assert not instance.disable_node.called
|
|
|
|
|
|
def test_set_offline_message_when_equal(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.get_node_info.return_value = {
|
|
"offline": True,
|
|
"offlineCauseReason": "This is an old message...",
|
|
}
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "disabled",
|
|
"offline_message": "This is an old message...",
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert not instance.disable_node.called
|
|
|
|
assert result.value["changed"] is False
|
|
|
|
|
|
def test_set_offline_message_when_not_equal_not_offline(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.get_node_info.return_value = {
|
|
"offline": False,
|
|
"offlineCauseReason": "This is an old message...",
|
|
}
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "disabled",
|
|
"offline_message": "This is a new message...",
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert instance.disable_node.call_args == call("my-node", "This is a new message...")
|
|
|
|
assert result.value["changed"] is True
|
|
|
|
|
|
# Not calling disable_node when already offline seems like a sensible thing to do.
|
|
# However, we need to call disable_node to set the offline message, so check that
|
|
# we do even when already offline.
|
|
def test_set_offline_message_when_not_equal_offline(get_instance, instance):
|
|
instance.node_exists.return_value = True
|
|
instance.get_node_config.return_value = "<slave />"
|
|
instance.get_node_info.return_value = {
|
|
"offline": True,
|
|
"offlineCauseReason": "This is an old message...",
|
|
}
|
|
|
|
set_module_args({
|
|
"name": "my-node",
|
|
"state": "disabled",
|
|
"offline_message": "This is a new message...",
|
|
})
|
|
|
|
with raises(AnsibleExitJson) as result:
|
|
jenkins_node.main()
|
|
|
|
assert not instance.disable_node.called
|
|
|
|
assert result.value["changed"] is False
|