def test_cfg_fixture(web, site): # noqa: F811 # pylint: disable=redefined-outer-name
site.ensure_running()
print("Applying default config")
web.add_host("modes-test-host", attributes={
"ipaddress": "127.0.0.1",
})
web.add_host("modes-test-host2",
attributes={
"ipaddress": "127.0.0.1",
"tag_criticality": "test",
})
web.add_host("modes-test-host3",
attributes={
"ipaddress": "127.0.0.1",
"tag_criticality": "test",
})
web.add_host("modes-test-host4",
attributes={
"ipaddress": "127.0.0.1",
"tag_criticality": "offline",
})
site.write_file(
"etc/check_mk/conf.d/modes-test-host.mk",
"datasource_programs.append(('cat ~/var/check_mk/agent_output/<HOST>', [], ALL_HOSTS))\n"
)
site.makedirs("var/check_mk/agent_output/")
site.write_file("var/check_mk/agent_output/modes-test-host",
get_standard_linux_agent_output())
site.write_file("var/check_mk/agent_output/modes-test-host2",
get_standard_linux_agent_output())
site.write_file("var/check_mk/agent_output/modes-test-host3",
get_standard_linux_agent_output())
web.discover_services("modes-test-host")
web.discover_services("modes-test-host2")
web.discover_services("modes-test-host3")
try:
web.activate_changes()
yield None
finally:
#
# Cleanup code
#
print("Cleaning up test config")
site.delete_dir("var/check_mk/agent_output")
site.delete_file("etc/check_mk/conf.d/modes-test-host.mk")
web.delete_host("modes-test-host")
web.delete_host("modes-test-host2")
web.delete_host("modes-test-host3")
web.delete_host("modes-test-host4")
web.activate_changes()
def test_test_check_1_merged_rule(request, site, web): # noqa: F811 # pylint: disable=redefined-outer-name
test_check_path = "local/lib/check_mk/base/plugins/agent_based/test_check_1.py"
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")
if site.file_exists("var/check_mk/autochecks/modes-test-host.mk"):
site.delete_file("var/check_mk/autochecks/modes-test-host.mk")
site.delete_file(test_check_path)
request.addfinalizer(cleanup)
site.write_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_1",
discovery_function=discover,
discovery_ruleset_name="discover_test_check_1",
discovery_ruleset_type=register.RuleSetType.MERGED,
discovery_default_parameters={"default": 42},
check_function=check,
service_name="Foo %s",
)
""")
site.write_file("var/check_mk/agent_output/modes-test-host", "<<<test_check_1>>>\n1 2\n")
config.load_all_agent_based_plugins(check_api.get_check_api_context)
config.load(with_conf_d=False)
web.discover_services("modes-test-host")
# Verify that the discovery worked as expected
services = autochecks.parse_autochecks_file("modes-test-host", config.service_description)
for service in services:
if str(service.check_plugin_name) == "test_check_1":
assert service.item == "Parameters({'default': 42})"
break
else:
assert False, '"test_check_1" not discovered'
# And now overwrite the setting in the config
site.write_file("etc/check_mk/conf.d/test_check_1.mk",
"discover_test_check_1 = [{'value': {'levels': (1, 2)}, 'condition': {}}]\n")
# rediscover with the setting in the config
site.delete_file("var/check_mk/autochecks/modes-test-host.mk")
web.discover_services("modes-test-host")
services = autochecks.parse_autochecks_file("modes-test-host", config.service_description)
for service in services:
if str(service.check_plugin_name) == "test_check_1":
assert service.item == "Parameters({'default': 42, 'levels': (1, 2)})"
break
else:
assert False, '"test_check_1" not discovered'
def test_test_check_1(request, test_cfg, site, web): # noqa: F811 # pylint: disable=redefined-outer-name
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")
if site.file_exists("var/check_mk/autochecks/modes-test-host.mk"):
site.delete_file("var/check_mk/autochecks/modes-test-host.mk")
site.delete_file(test_check_path)
request.addfinalizer(cleanup)
site.write_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"
}
""")
site.write_file("var/check_mk/agent_output/modes-test-host",
"<<<test_check_1>>>\n1 2\n")
config.load_checks(check_api.get_check_api_context,
["%s/%s" % (site.root, test_check_path)])
config.load(with_conf_d=False)
# 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("modes-test-host")
# Verify that the discovery worked as expected
services = autochecks.parse_autochecks_file("modes-test-host",
config.service_description)
assert services[0].check_plugin_name == "test_check_1"
assert services[0].item is None
assert services[0].parameters == (10.0, 20.0)
assert services[0].service_labels.to_dict() == {}
# Now execute the check function to verify the variable is available
p = site.execute(["cmk", "-nv", "modes-test-host"],
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_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", "modes-test-host"],
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("var/check_mk/autochecks/modes-test-host.mk")
web.discover_services("modes-test-host")
services = autochecks.parse_autochecks_file("modes-test-host",
config.service_description)
assert services[0].parameters == (5.0, 30.1)
def test_check_factory_settings(request, test_cfg, site, web): # noqa: F811 # pylint: disable=redefined-outer-name
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")
if site.file_exists("var/check_mk/autochecks/modes-test-host.mk"):
site.delete_file("var/check_mk/autochecks/modes-test-host.mk")
site.delete_file(test_check_path)
request.addfinalizer(cleanup)
site.write_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",
}
""")
site.write_file("var/check_mk/agent_output/modes-test-host",
"<<<test_check_3>>>\n1 2\n")
config.load_checks(check_api.get_check_api_context,
["%s/%s" % (site.root, test_check_path)])
# 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("modes-test-host")
# Verify that the discovery worked as expected
services = autochecks.parse_autochecks_file("modes-test-host",
config.service_description)
assert services[0].check_plugin_name == "test_check_3"
assert services[0].item is None
assert services[0].parameters == {}
assert services[0].service_labels.to_dict() == {}
# Now execute the check function to verify the variable is available
p = site.execute(["cmk", "-nv", "modes-test-host"],
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_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", "modes-test-host"],
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_2(request, test_cfg, site, web): # noqa: F811 # pylint: disable=redefined-outer-name
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")
if site.file_exists("var/check_mk/autochecks/modes-test-host.mk"):
site.delete_file("var/check_mk/autochecks/modes-test-host.mk")
site.delete_file(test_check_path)
request.addfinalizer(cleanup)
site.write_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",
}
""")
site.write_file("var/check_mk/agent_output/modes-test-host",
"<<<test_check_2>>>\n1 2\n")
config.load_checks(check_api.get_check_api_context,
["%s/%s" % (site.root, test_check_path)])
config.load(with_conf_d=False)
# 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("modes-test-host")
# Should have discovered nothing so far
assert site.read_file(
"var/check_mk/autochecks/modes-test-host.mk") == "[\n]\n"
web.discover_services("modes-test-host")
# And now overwrite the setting in the config
site.write_file("etc/check_mk/conf.d/test_check_2.mk",
"discover_service = True\n")
web.discover_services("modes-test-host")
# Verify that the discovery worked as expected
services = autochecks.parse_autochecks_file("modes-test-host",
config.service_description)
assert services[0].check_plugin_name == "test_check_2"
assert services[0].item is None
assert services[0].parameters == {}
assert services[0].service_labels.to_dict() == {}
def test_test_check_1_all_rule(request, 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_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_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
services = autochecks.parse_autochecks_file(host_name, config.service_description)
for service in services:
if str(service.check_plugin_name) == "test_check_2":
assert service.item == "[Parameters({'default': 42})]"
break
else:
assert False, '"test_check_2" not discovered'
# And now overwrite the setting in the config
site.write_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)
services = autochecks.parse_autochecks_file(host_name, config.service_description)
for service in services:
if str(service.check_plugin_name) == "test_check_2":
assert service.item == ("[Parameters({'levels': (1, 2)}),"
" Parameters({'default': 42})]")
break
else:
assert False, '"test_check_2" not discovered'
