1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
"""
Health checks for OpenShift clusters.
"""
import operator
import os
from abc import ABCMeta, abstractmethod, abstractproperty
from importlib import import_module
from ansible.module_utils import six
from ansible.module_utils.six.moves import reduce # pylint: disable=import-error,redefined-builtin
class OpenShiftCheckException(Exception):
"""Raised when a check cannot proceed."""
pass
@six.add_metaclass(ABCMeta)
class OpenShiftCheck(object):
"""A base class for defining checks for an OpenShift cluster environment."""
def __init__(self, execute_module=None, module_executor=None):
if execute_module is module_executor is None:
raise TypeError(
"__init__() takes either execute_module (recommended) "
"or module_executor (deprecated), none given")
self.execute_module = execute_module or module_executor
self.module_executor = self.execute_module
@abstractproperty
def name(self):
"""The name of this check, usually derived from the class name."""
return "openshift_check"
@property
def tags(self):
"""A list of tags that this check satisfy.
Tags are used to reference multiple checks with a single '@tagname'
special check name.
"""
return []
@classmethod
def is_active(cls, task_vars): # pylint: disable=unused-argument
"""Returns true if this check applies to the ansible-playbook run."""
return True
@abstractmethod
def run(self, tmp, task_vars):
"""Executes a check, normally implemented as a module."""
return {}
@classmethod
def subclasses(cls):
"""Returns a generator of subclasses of this class and its subclasses."""
# AUDIT: no-member makes sense due to this having a metaclass
for subclass in cls.__subclasses__(): # pylint: disable=no-member
yield subclass
for subclass in subclass.subclasses():
yield subclass
LOADER_EXCLUDES = (
"__init__.py",
"mixins.py",
)
def load_checks():
"""Dynamically import all check modules for the side effect of registering checks."""
return [
import_module(__package__ + "." + name[:-3])
for name in os.listdir(os.path.dirname(__file__))
if name.endswith(".py") and name not in LOADER_EXCLUDES
]
def get_var(task_vars, *keys, **kwargs):
"""Helper function to get deeply nested values from task_vars.
Ansible task_vars structures are Python dicts, often mapping strings to
other dicts. This helper makes it easier to get a nested value, raising
OpenShiftCheckException when a key is not found or returning a default value
provided as a keyword argument.
"""
try:
value = reduce(operator.getitem, keys, task_vars)
except (KeyError, TypeError):
if "default" in kwargs:
return kwargs["default"]
raise OpenShiftCheckException("'{}' is undefined".format(".".join(map(str, keys))))
return value
|
