def test_test_check_2(request, test_cfg, site, web):
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")
assert services[0].check_plugin_name == "test_check_2"
assert services[0].item is None
assert services[0].parameters_unresolved == "{}"
assert services[0].service_labels.to_dict() == {}
def reload_config():
# Needs to be done together, even when the checks are not directly needed
import cmk.base.check_api as check_api
config.load_all_checks(check_api.get_check_api_context)
config.load()
config_cache = config.get_config_cache()
config_cache.initialize()
return config_cache
def execute(self, cmd: str, args: List[str]) -> Any:
self._handle_generic_arguments(args)
try:
try:
automation = self._automations[cmd]
except KeyError:
raise MKAutomationError("Automation command '%s' is not implemented." % cmd)
if automation.needs_checks:
with redirect_stdout(open(os.devnull, "w")):
log.setup_console_logging()
config.load_all_agent_based_plugins(
check_api.get_check_api_context,
inventory_plugins.load_legacy_inventory_plugins,
)
if automation.needs_config:
config.load(validate_hosts=False)
result = automation.execute(args)
except (MKAutomationError, MKTimeout) as e:
console.error("%s\n" % e)
if cmk.utils.debug.enabled():
raise
return 1
except Exception as e:
if cmk.utils.debug.enabled():
raise
console.error("%s\n" % e)
return 2
finally:
profiling.output_profile()
out.output(result.serialize())
out.output("\n")
return 0
def execute(self, cmd, args):
# type: (str, List[str]) -> Any
self._handle_generic_arguments(args)
try:
try:
automation = self._automations[cmd]
except KeyError:
raise MKAutomationError(
"Automation command '%s' is not implemented." % cmd)
if automation.needs_checks:
config.load_all_checks(check_api.get_check_api_context)
if automation.needs_config:
config.load(validate_hosts=False)
result = automation.execute(args)
except (MKAutomationError, MKTimeout) as e:
console.error("%s\n" % e)
if cmk.utils.debug.enabled():
raise
return 1
except Exception as e:
if cmk.utils.debug.enabled():
raise
console.error("%s\n" % e)
return 2
finally:
profiling.output_profile()
if cmk.utils.debug.enabled():
console.output(pprint.pformat(result) + "\n")
else:
console.output("%r\n" % (result, ))
return 0
def execute(self, cmd: str, args: List[str]) -> Any:
self._handle_generic_arguments(args)
try:
try:
automation = self._automations[cmd]
except KeyError:
raise MKAutomationError(
"Automation command '%s' is not implemented." % cmd)
if automation.needs_checks:
config.load_all_agent_based_plugins(
check_api.get_check_api_context)
if automation.needs_config:
config.load(validate_hosts=False)
result = automation.execute(args)
except (MKAutomationError, MKTimeout) as e:
console.error("%s\n" % e)
if cmk.utils.debug.enabled():
raise
return 1
except Exception as e:
if cmk.utils.debug.enabled():
raise
console.error("%s\n" % e)
return 2
finally:
profiling.output_profile()
out.output(python_printer.pformat(result))
out.output('\n')
return 0
def _load_config():
# type: () -> None
global _config_loaded
if not _config_loaded:
config.load(validate_hosts=False)
_config_loaded = True
def test_test_check_1(request, test_cfg, site, web):
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"]
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_unresolved == "test_check_1_default_levels"
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
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 update():
config.load_all_checks(check_api.get_check_api_context)
config.load()
config_cache = config.get_config_cache()
update_service_info(config_cache, get_hostnames(config_cache))
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_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_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 == {}
import cmk.base.autochecks
try:
import cmk.base.cee.rrd
except ImportError:
raise RuntimeError("Can only be used with the Checkmk Enterprise Editions")
import cmk.base.config as config
import cmk.base.check_api as check_api
import cmk.utils
import cmk.utils.store as store
import cmk.utils.debug
cmk.utils.debug.enable()
config.load_all_checks(check_api.get_check_api_context)
config.load()
logger = logging.getLogger("RRD INFO Metric Migration")
logger.addHandler(logging.StreamHandler())
logger.setLevel(logging.DEBUG)
CHECKS_USING_DF_INCLUDE = [
"3par_capacity", "3par_cpgs", "3par_cpgs.usage", "3par_system",
"3par_volumes", "ceph_df", "datapower_fs", "db2_logsizes",
"dell_compellent_folder", "df", "df_netapp", "df_netapp32", "df_netscaler",
"df_zos", "emc_datadomain_fs", "emc_isilon_ifs", "emc_isilon_quota",
"emcvnx_raidgroups.capacity", "emcvnx_raidgroups.capacity_contiguous",
"esx_vsphere_counters.ramdisk", "esx_vsphere_datastores",
"fast_lta_silent_cubes.capacity", "fast_lta_volumes", "hitachi_hnas_span",
"hitachi_hnas_volume", "hp_msa_volume.df", "hr_fs", "ibm_svc_mdiskgrp",
"k8s_stats.fs", "libelle_business_shadow.archive_dir", "lvm_vgs",
def _load_config():
global _config_loaded
if not _config_loaded:
config.load(validate_hosts=False)
_config_loaded = True
