def test_automation_set_autochecks(test_cfg, site: Site):
hostname = HostName("blablahost")
new_items: SetAutochecksTable = {
("df", "xxx"): ("Filesystem xxx", {}, {
"xyz": "123"
}, [hostname]),
("uptime", None): ("Uptime", None, {}, [hostname]),
}
try:
assert isinstance(
_execute_automation(
site,
"set-autochecks",
args=[hostname],
stdin=repr(new_items),
),
results.SetAutochecksResult,
)
autochecks_file = "%s/%s.mk" % (cmk.utils.paths.autochecks_dir,
hostname)
assert os.path.exists(autochecks_file)
data = autochecks.AutochecksStore(hostname).read()
services = [(
(str(s.check_plugin_name), s.item),
s.parameters,
s.service_labels,
) for s in data]
assert sorted(services) == [
(
("df", "xxx"),
{},
{
"xyz": "123"
},
),
(
("uptime", None),
None,
{},
),
]
assert site.file_exists("var/check_mk/autochecks/%s.mk" % hostname)
finally:
if site.file_exists("var/check_mk/autochecks/%s.mk" % hostname):
site.delete_file("var/check_mk/autochecks/%s.mk" % hostname)
def test_test_check_1_all_rule(
request, site: Site, web
): # noqa: F811 # pylint: disable=redefined-outer-name
host_name = "disco-params-test-host"
create_linux_test_host(request, web, site, host_name)
site.write_text_file(
"var/check_mk/agent_output/disco-params-test-host", "<<<test_check_2>>>\n1 2\n"
)
test_check_path = "local/lib/check_mk/base/plugins/agent_based/test_check_2.py"
def cleanup():
if site.file_exists("etc/check_mk/conf.d/test_check_2.mk"):
site.delete_file("etc/check_mk/conf.d/test_check_2.mk")
site.delete_file(test_check_path)
request.addfinalizer(cleanup)
site.write_text_file(
test_check_path,
"""
import pprint
from .agent_based_api.v1 import register, Service
def discover(params, section):
yield Service(item=pprint.pformat(params))
def check(item, section):
return
yield
register.check_plugin(
name="test_check_2",
discovery_function=discover,
discovery_ruleset_name="discover_test_check_2",
discovery_ruleset_type=register.RuleSetType.ALL,
discovery_default_parameters={"default": 42},
check_function=check,
service_name="Foo %s",
)
""",
)
web.activate_changes()
web.discover_services(host_name)
# Verify that the discovery worked as expected
entries = autochecks.AutochecksStore(HostName(host_name)).read()
for entry in entries:
if str(entry.check_plugin_name) == "test_check_2":
assert entry.item == "[Parameters({'default': 42})]"
break
else:
raise AssertionError('"test_check_2" not discovered')
# And now overwrite the setting in the config
site.write_text_file(
"etc/check_mk/conf.d/test_check_2.mk",
"discover_test_check_2 = [{'value': {'levels': (1, 2)}, 'condition': {}}]\n",
)
# rediscover with the setting in the config
site.delete_file(f"var/check_mk/autochecks/{host_name}.mk")
web.discover_services(host_name)
entries = autochecks.AutochecksStore(HostName(host_name)).read()
for entry in entries:
if str(entry.check_plugin_name) == "test_check_2":
assert entry.item == (
"[Parameters({'levels': (1, 2)})," " Parameters({'default': 42})]"
)
break
else:
raise AssertionError('"test_check_2" not discovered')
def test_check_factory_settings(request, site: Site, web):
host_name = "check-variables-test-host"
create_linux_test_host(request, site, host_name)
site.write_text_file(f"var/check_mk/agent_output/{host_name}",
"<<<test_check_3>>>\n1 2\n")
test_check_path = "local/share/check_mk/checks/test_check_3"
def cleanup():
if site.file_exists("etc/check_mk/conf.d/test_check_3.mk"):
site.delete_file("etc/check_mk/conf.d/test_check_3.mk")
site.delete_file(test_check_path)
request.addfinalizer(cleanup)
site.write_text_file(
test_check_path,
"""
factory_settings["test_check_3_default_levels"] = {
"param1": 123,
}
def inventory(info):
return [(None, {})]
def check(item, params, info):
return 0, "OK - %r" % (params, )
check_info["test_check_3"] = {
"check_function" : check,
"inventory_function" : inventory,
"service_description" : "Testcheck 3",
"group" : "asd",
"default_levels_variable" : "test_check_3_default_levels",
}
""",
)
config.load_checks(check_api.get_check_api_context,
["%s/%s" % (site.root, test_check_path)])
config.load(with_conf_d=False)
site.activate_changes_and_wait_for_core_reload()
# Verify that the default variable is in the check context and
# not in the global checks module context
assert "test_check_3_default_levels" not in config.__dict__
assert "test_check_3" in config._check_contexts
assert "test_check_3_default_levels" in config._check_contexts[
"test_check_3"]
web.discover_services(host_name) # Replace with RestAPI call, see CMK-9249
# Verify that the discovery worked as expected
entries = autochecks.AutochecksStore(HostName(host_name)).read()
assert str(entries[0].check_plugin_name) == "test_check_3"
assert entries[0].item is None
assert entries[0].parameters == {}
assert entries[0].service_labels == {}
# Now execute the check function to verify the variable is available
p = site.execute(["cmk", "-nv", host_name],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
stdout, stderr = p.communicate()
assert "OK - {'param1': 123}\n" in stdout, stdout
assert stderr == ""
assert p.returncode == 0
# And now overwrite the setting in the config
site.write_text_file(
"etc/check_mk/conf.d/test_check_3.mk",
"""
checkgroup_parameters.setdefault('asd', [])
checkgroup_parameters['asd'] = [
( {'param2': 'xxx'}, [], ALL_HOSTS, {} ),
] + checkgroup_parameters['asd']
""",
)
# And execute the check again to check for the parameters
p = site.execute(["cmk", "-nv", host_name],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
stdout, stderr = p.communicate()
assert "'param1': 123" in stdout
assert "'param2': 'xxx'" in stdout
assert stderr == ""
assert p.returncode == 0
def test_test_check_1(request, site: Site, web):
host_name = "check-variables-test-host"
create_linux_test_host(request, site, host_name)
site.write_text_file(f"var/check_mk/agent_output/{host_name}",
"<<<test_check_1>>>\n1 2\n")
test_check_path = "local/share/check_mk/checks/test_check_1"
def cleanup():
if site.file_exists("etc/check_mk/conf.d/test_check_1.mk"):
site.delete_file("etc/check_mk/conf.d/test_check_1.mk")
site.delete_file(test_check_path)
request.addfinalizer(cleanup)
site.write_text_file(
test_check_path,
"""
test_check_1_default_levels = 10.0, 20.0
def inventory(info):
return [(None, "test_check_1_default_levels")]
def check(item, params, info):
return 0, "OK - %r" % (test_check_1_default_levels, )
check_info["test_check_1"] = {
"check_function" : check,
"inventory_function" : inventory,
"service_description" : "Testcheck 1",
# "default_levels_variable" : "test_check_1_default_levels"
}
""",
)
config.load_checks(check_api.get_check_api_context,
["%s/%s" % (site.root, test_check_path)])
config.load(with_conf_d=False)
site.activate_changes_and_wait_for_core_reload()
# Verify that the default variable is in the check context and
# not in the global checks module context.
assert "test_check_1_default_levels" not in config.__dict__
assert "test_check_1" in config._check_contexts
assert "test_check_1_default_levels" in config._check_contexts[
"test_check_1"]
assert config._check_contexts["test_check_1"][
"test_check_1_default_levels"] == (10.0, 20.0)
web.discover_services(host_name) # Replace with RestAPI call, see CMK-9249
# Verify that the discovery worked as expected
entries = autochecks.AutochecksStore(HostName(host_name)).read()
assert str(entries[0].check_plugin_name) == "test_check_1"
assert entries[0].item is None
assert entries[0].parameters == (10.0, 20.0)
assert entries[0].service_labels == {}
# Now execute the check function to verify the variable is available
p = site.execute(["cmk", "-nv", host_name],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
stdout, stderr = p.communicate()
assert "OK - (10.0, 20.0)" in stdout
assert stderr == ""
assert p.returncode == 0
# And now overwrite the setting in the config
site.write_text_file("etc/check_mk/conf.d/test_check_1.mk",
"test_check_1_default_levels = 5.0, 30.1\n")
p = site.execute(["cmk", "-nv", host_name],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
stdout, stderr = p.communicate()
assert "OK - (10.0, 20.0)" not in stdout
assert "OK - (5.0, 30.1)" in stdout
assert stderr == ""
assert p.returncode == 0
# rediscover with the setting in the config
site.delete_file(f"var/check_mk/autochecks/{host_name}.mk")
web.discover_services(host_name) # Replace with RestAPI call, see CMK-9249
entries = autochecks.AutochecksStore(HostName(host_name)).read()
assert entries[0].parameters == (5.0, 30.1)
def test_test_check_2(request, site, web):
host_name = "check-variables-test-host"
create_linux_test_host(request, site, host_name)
site.write_text_file(f"var/check_mk/agent_output/{host_name}",
"<<<test_check_2>>>\n1 2\n")
test_check_path = "local/share/check_mk/checks/test_check_2"
def cleanup():
if site.file_exists("etc/check_mk/conf.d/test_check_2.mk"):
site.delete_file("etc/check_mk/conf.d/test_check_2.mk")
site.delete_file(test_check_path)
request.addfinalizer(cleanup)
site.write_text_file(
test_check_path,
"""
discover_service = False
def inventory(info):
if discover_service:
return [(None, {})]
def check(item, params, info):
return 0, "OK, discovered!"
check_info["test_check_2"] = {
"check_function" : check,
"inventory_function" : inventory,
"service_description" : "Testcheck 2",
}
""",
)
config.load_checks(check_api.get_check_api_context,
["%s/%s" % (site.root, test_check_path)])
config.load(with_conf_d=False)
site.activate_changes_and_wait_for_core_reload()
# Verify that the default variable is in the check context and
# not in the global checks module context
assert "discover_service" not in config.__dict__
assert "test_check_2" in config._check_contexts
assert "discover_service" in config._check_contexts["test_check_2"]
web.discover_services(host_name) # Replace with RestAPI call, see CMK-9249
# Should have discovered nothing so far
assert site.read_file(
f"var/check_mk/autochecks/{host_name}.mk") == "[\n]\n"
web.discover_services(host_name) # Replace with RestAPI call, see CMK-9249
# And now overwrite the setting in the config
site.write_text_file("etc/check_mk/conf.d/test_check_2.mk",
"discover_service = True\n")
web.discover_services(host_name) # Replace with RestAPI call, see CMK-9249
# Verify that the discovery worked as expected
entries = autochecks.AutochecksStore(HostName(host_name)).read()
assert str(entries[0].check_plugin_name) == "test_check_2"
assert entries[0].item is None
assert entries[0].parameters == {}
assert entries[0].service_labels == {}