[checkmk-commits] Prepare for visual info registry refactoring

Module: check_mk Branch: master Commit: 133ab3726d810ea0b3d5513a6597253ed092cfa0 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=133ab3726d810e… Author: Lars Michelsen <lm(a)mathias-kettner.de> Date: Wed Jan 30 22:06:11 2019 +0100 Prepare for visual info registry refactoring CMK-1593 Change-Id: Ifba176425488e20346b7bde23fb927af2d2d2589 --- cmk/gui/plugins/visuals/utils.py | 55 +++++++++- tests/unit/cmk/gui/test_visuals.py | 200 +++++++++++++++++++++++++++++++++++++ 2 files changed, 254 insertions(+), 1 deletion(-) diff --git a/cmk/gui/plugins/visuals/utils.py b/cmk/gui/plugins/visuals/utils.py index 20f8729..187fe8c 100644 --- a/cmk/gui/plugins/visuals/utils.py +++ b/cmk/gui/plugins/visuals/utils.py @@ -30,6 +30,7 @@ import abc import time from typing import Dict, List, Tuple, Text, Optional # pylint: disable=unused-import +from cmk.gui.valuespec import ValueSpec # pylint: disable=unused-import import cmk.utils.plugin_registry @@ -42,6 +43,58 @@ from cmk.gui.globals import html _infos = {} +class VisualInfo(object): + """Base class for all visual info classes""" + __metaclass__ = abc.ABCMeta + + @abc.abstractproperty + def ident(self): + # type: () -> str + """The identity of a visual type. One word, may contain alpha numeric characters""" + raise NotImplementedError() + + @abc.abstractproperty + def title(self): + # type: () -> Text + """The human readable GUI title""" + raise NotImplementedError() + + @abc.abstractproperty + def title_plural(self): + # type: () -> Text + """The human readable GUI title for multiple items""" + raise NotImplementedError() + + @abc.abstractproperty + def single_spec(self): + # type: () -> Optional[Tuple[str, ValueSpec]] + """The key / valuespec pairs (choices) to identify a single row""" + raise NotImplementedError() + + def multiple_site_filters(self): + # type: () -> List[str] + """Returns a list of filter identifiers. When one of these filters is + used by a visual, the "site hint" may not be used""" + return [] + + def single_site(self): + # type: () -> bool + """When there is one non single site info used by a visual + don't add the site hint""" + return True + + +class VisualInfoRegistry(cmk.utils.plugin_registry.ClassRegistry): + def plugin_base_class(self): + return VisualInfo + + def plugin_name(self, plugin_class): + return plugin_class().ident + + +visual_info_registry = VisualInfoRegistry() + + def declare_info(infoname, info): _infos[infoname] = info @@ -199,7 +252,7 @@ class Filter(object): @abc.abstractmethod def display(self): - # type: (None) -> None + # type: () -> None raise NotImplementedError() def filter(self, infoname): diff --git a/tests/unit/cmk/gui/test_visuals.py b/tests/unit/cmk/gui/test_visuals.py index 4d198de..c43d252 100644 --- a/tests/unit/cmk/gui/test_visuals.py +++ b/tests/unit/cmk/gui/test_visuals.py @@ -3471,3 +3471,203 @@ def test_registered_filters(load_plugins): bases = [c.__name__ for c in filt.__class__.__bases__] + [filt.__class__.__name__] assert spec["filter_class"] in bases + + +expected_infos = { + 'aggr': { + 'single_spec': [('aggr_name', 'TextUnicode')], + 'title': u'BI Aggregation', + 'title_plural': u'BI Aggregations' + }, + 'aggr_group': { + 'single_spec': [('aggr_group', 'TextUnicode')], + 'title': u'BI Aggregation Group', + 'title_plural': u'BI Aggregation Groups' + }, + 'command': { + 'single_spec': [('command_name', 'TextUnicode')], + 'title': u'Command', + 'title_plural': u'Commands' + }, + 'comment': { + 'single_spec': [('comment_id', 'Integer')], + 'title': u'Comment', + 'title_plural': u'Comments' + }, + 'contact': { + 'single_spec': [('log_contact_name', 'TextUnicode')], + 'title': u'Contact', + 'title_plural': u'Contacts' + }, + 'discovery': { + 'single_spec': None, + 'title': u'Discovery Output', + 'title_plural': u'Discovery Outputs' + }, + 'downtime': { + 'single_spec': [('downtime_id', 'Integer')], + 'title': u'Downtime', + 'title_plural': u'Downtimes' + }, + 'event': { + 'single_spec': [('event_id', 'Integer')], + 'title': u'Event Console Event', + 'title_plural': u'Event Console Events' + }, + 'history': { + 'single_spec': [('event_id', 'Integer'), ('history_line', 'Integer')], + 'title': u'Historic Event Console Event', + 'title_plural': u'Historic Event Console Events' + }, + 'host': { + 'multiple_site_filters': ['hostgroup'], + 'single_spec': [('host', 'TextUnicode')], + 'title': u'Host', + 'title_plural': u'Hosts' + }, + 'hostgroup': { + 'single_site': False, + 'single_spec': [('hostgroup', 'TextUnicode')], + 'title': u'Host Group', + 'title_plural': u'Host Groups' + }, + 'invbackplane': { + 'single_spec': None, + 'title': u'Backplane', + 'title_plural': u'Backplanes' + }, + 'invchassis': { + 'single_spec': None, + 'title': u'Chassis', + 'title_plural': u'Chassis' + }, + 'invcontainer': { + 'single_spec': None, + 'title': u'HW container', + 'title_plural': u'HW containers' + }, + 'invdockercontainers': { + 'single_spec': None, + 'title': u'Docker containers', + 'title_plural': u'Docker containers' + }, + 'invdockerimages': { + 'single_spec': None, + 'title': u'Docker images', + 'title_plural': u'Docker images' + }, + 'invfan': { + 'single_spec': None, + 'title': u'Fan', + 'title_plural': u'Fans' + }, + 'invhist': { + 'single_spec': None, + 'title': u'Inventory History', + 'title_plural': u'Inventory Historys' + }, + 'invinterface': { + 'single_spec': None, + 'title': u'Network interface', + 'title_plural': u'Network interfaces' + }, + 'invmodule': { + 'single_spec': None, + 'title': u'Module', + 'title_plural': u'Modules' + }, + 'invoradataguardstats': { + 'single_spec': None, + 'title': u'Oracle dataguard statistic', + 'title_plural': u'Oracle dataguard statistics' + }, + 'invorainstance': { + 'single_spec': None, + 'title': u'Oracle instance', + 'title_plural': u'Oracle instances' + }, + 'invorarecoveryarea': { + 'single_spec': None, + 'title': u'Oracle recovery area', + 'title_plural': u'Oracle recovery areas' + }, + 'invorasga': { + 'single_spec': None, + 'title': u'Oracle performance', + 'title_plural': u'Oracle performance' + }, + 'invoratablespace': { + 'single_spec': None, + 'title': u'Oracle tablespace', + 'title_plural': u'Oracle tablespaces' + }, + 'invother': { + 'single_spec': None, + 'title': u'Other entity', + 'title_plural': u'Other entities' + }, + 'invpsu': { + 'single_spec': None, + 'title': u'Power supply', + 'title_plural': u'Power supplies' + }, + 'invsensor': { + 'single_spec': None, + 'title': u'Sensor', + 'title_plural': u'Sensors' + }, + 'invstack': { + 'single_spec': None, + 'title': u'Stack', + 'title_plural': u'Stacks' + }, + 'invswpac': { + 'single_spec': None, + 'title': u'Software package', + 'title_plural': u'Software packages' + }, + 'invunknown': { + 'single_spec': None, + 'title': u'Unknown entity', + 'title_plural': u'Unknown entities' + }, + 'log': { + 'single_spec': None, + 'title': u'Log Entry', + 'title_plural': u'Log Entries' + }, + 'service': { + 'multiple_site_filters': ['servicegroup'], + 'single_spec': [('service', 'TextUnicode')], + 'title': u'Service', + 'title_plural': u'Services' + }, + 'servicegroup': { + 'single_site': False, + 'single_spec': [('servicegroup', 'TextUnicode')], + 'title': u'Service Group', + 'title_plural': u'Service Groups' + }, +} + + +def test_registered_infos(load_plugins): + assert sorted(utils._infos.keys()) == sorted(expected_infos.keys()) + + +def test_registered_info_attributes(load_plugins): + for ident, info in utils._infos.items(): + #info = cls() + spec = expected_infos[ident] + + assert info["title"] == spec["title"] + assert info["title_plural"] == spec["title_plural"] + + if spec["single_spec"] is None: + assert info["single_spec"] is None + else: + assert [(e[0], e[1].__class__.__name__) for e in info["single_spec"] + ] == spec["single_spec"] + + assert info.get("multiple_site_filters", []) == spec.get("multiple_site_filters", []) + assert info.get("single_site", True) == spec.get("single_site", True)