summaryrefslogtreecommitdiffstats
path: root/roles/openshift_health_checker/test/etcd_imagedata_size_test.py
blob: df9d52d416ec30695a31ebc74e4e223ff2886c89 (plain)
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
import pytest

from collections import namedtuple
from openshift_checks.etcd_imagedata_size import EtcdImageDataSize, OpenShiftCheckException
from etcdkeysize import check_etcd_key_size


def fake_etcd_client(root):
    fake_nodes = dict()
    fake_etcd_node(root, fake_nodes)

    clientclass = namedtuple("client", ["read"])
    return clientclass(lambda key, recursive: fake_etcd_result(fake_nodes[key]))


def fake_etcd_result(fake_node):
    resultclass = namedtuple("result", ["leaves"])
    if not fake_node.dir:
        return resultclass([fake_node])

    return resultclass(fake_node.leaves)


def fake_etcd_node(node, visited):
    min_req_fields = ["dir", "key"]
    fields = list(node)
    leaves = []

    if node["dir"] and node.get("leaves"):
        for leaf in node["leaves"]:
            leaves.append(fake_etcd_node(leaf, visited))

    if len(set(min_req_fields) - set(fields)) > 0:
        raise ValueError("fake etcd nodes require at least {} fields.".format(min_req_fields))

    if node.get("leaves"):
        node["leaves"] = leaves

    nodeclass = namedtuple("node", fields)
    nodeinst = nodeclass(**node)
    visited[nodeinst.key] = nodeinst

    return nodeinst


@pytest.mark.parametrize('ansible_mounts,extra_words', [
    ([], ['none']),  # empty ansible_mounts
    ([{'mount': '/mnt'}], ['/mnt']),  # missing relevant mount paths
])
def test_cannot_determine_available_mountpath(ansible_mounts, extra_words):
    task_vars = dict(
        ansible_mounts=ansible_mounts,
    )
    check = EtcdImageDataSize(execute_module=fake_execute_module)

    with pytest.raises(OpenShiftCheckException) as excinfo:
        check.run(tmp=None, task_vars=task_vars)

    for word in 'determine valid etcd mountpath'.split() + extra_words:
        assert word in str(excinfo.value)


@pytest.mark.parametrize('ansible_mounts,tree,size_limit,should_fail,extra_words', [
    (
        # test that default image size limit evals to 1/2 * (total size in use)
        [{
            'mount': '/',
            'size_available': 40 * 10**9,
            'size_total': 80 * 10**9,
        }],
        {"dir": False, "key": "/", "value": "1234"},
        None,
        False,
        [],
    ),
    (
        [{
            'mount': '/',
            'size_available': 40 * 10**9,
            'size_total': 48 * 10**9,
        }],
        {"dir": False, "key": "/", "value": "1234"},
        None,
        False,
        [],
    ),
    (
        # set max size limit for image data to be below total node value
        # total node value is defined as the sum of the value field
        # from every node
        [{
            'mount': '/',
            'size_available': 40 * 10**9,
            'size_total': 48 * 10**9,
        }],
        {"dir": False, "key": "/", "value": "12345678"},
        7,
        True,
        ["exceeds the maximum recommended limit", "0.00 GB"],
    ),
    (
        [{
            'mount': '/',
            'size_available': 48 * 10**9 - 1,
            'size_total': 48 * 10**9,
        }],
        {"dir": False, "key": "/", "value": "1234"},
        None,
        True,
        ["exceeds the maximum recommended limit", "0.00 GB"],
    )
])
def test_check_etcd_key_size_calculates_correct_limit(ansible_mounts, tree, size_limit, should_fail, extra_words):
    def execute_module(module_name, args, tmp=None, task_vars=None):
        if module_name != "etcdkeysize":
            return {
                "changed": False,
            }

        client = fake_etcd_client(tree)
        s, limit_exceeded = check_etcd_key_size(client, tree["key"], args["size_limit_bytes"])

        return {"size_limit_exceeded": limit_exceeded}

    task_vars = dict(
        etcd_max_image_data_size_bytes=size_limit,
        ansible_mounts=ansible_mounts,
        openshift=dict(
            master=dict(etcd_hosts=["localhost"]),
            common=dict(config_base="/var/lib/origin")
        )
    )
    if size_limit is None:
        task_vars.pop("etcd_max_image_data_size_bytes")

    check = EtcdImageDataSize(execute_module=execute_module).run(tmp=None, task_vars=task_vars)

    if should_fail:
        assert check["failed"]

        for word in extra_words:
            assert word in check["msg"]
    else:
        assert not check.get("failed", False)


@pytest.mark.parametrize('ansible_mounts,tree,root_path,expected_size,extra_words', [
    (
        [{
            'mount': '/',
            'size_available': 40 * 10**9,
            'size_total': 80 * 10**9,
        }],
        # test recursive size check on tree with height > 1
        {
            "dir": True,
            "key": "/",
            "leaves": [
                {"dir": False, "key": "/foo1", "value": "1234"},
                {"dir": False, "key": "/foo2", "value": "1234"},
                {"dir": False, "key": "/foo3", "value": "1234"},
                {"dir": False, "key": "/foo4", "value": "1234"},
                {
                    "dir": True,
                    "key": "/foo5",
                    "leaves": [
                        {"dir": False, "key": "/foo/bar1", "value": "56789"},
                        {"dir": False, "key": "/foo/bar2", "value": "56789"},
                        {"dir": False, "key": "/foo/bar3", "value": "56789"},
                        {
                            "dir": True,
                            "key": "/foo/bar4",
                            "leaves": [
                                {"dir": False, "key": "/foo/bar/baz1", "value": "123"},
                                {"dir": False, "key": "/foo/bar/baz2", "value": "123"},
                            ]
                        },
                    ]
                },
            ]
        },
        "/",
        37,
        [],
    ),
    (
        [{
            'mount': '/',
            'size_available': 40 * 10**9,
            'size_total': 80 * 10**9,
        }],
        # test correct sub-tree size calculation
        {
            "dir": True,
            "key": "/",
            "leaves": [
                {"dir": False, "key": "/foo1", "value": "1234"},
                {"dir": False, "key": "/foo2", "value": "1234"},
                {"dir": False, "key": "/foo3", "value": "1234"},
                {"dir": False, "key": "/foo4", "value": "1234"},
                {
                    "dir": True,
                    "key": "/foo5",
                    "leaves": [
                        {"dir": False, "key": "/foo/bar1", "value": "56789"},
                        {"dir": False, "key": "/foo/bar2", "value": "56789"},
                        {"dir": False, "key": "/foo/bar3", "value": "56789"},
                        {
                            "dir": True,
                            "key": "/foo/bar4",
                            "leaves": [
                                {"dir": False, "key": "/foo/bar/baz1", "value": "123"},
                                {"dir": False, "key": "/foo/bar/baz2", "value": "123"},
                            ]
                        },
                    ]
                },
            ]
        },
        "/foo5",
        21,
        [],
    ),
    (
        [{
            'mount': '/',
            'size_available': 40 * 10**9,
            'size_total': 80 * 10**9,
        }],
        # test that a non-existing key is handled correctly
        {
            "dir": False,
            "key": "/",
            "value": "1234",
        },
        "/missing",
        0,
        [],
    ),
    (
        [{
            'mount': '/',
            'size_available': 40 * 10**9,
            'size_total': 80 * 10**9,
        }],
        # test etcd cycle handling
        {
            "dir": True,
            "key": "/",
            "leaves": [
                {"dir": False, "key": "/foo1", "value": "1234"},
                {"dir": False, "key": "/foo2", "value": "1234"},
                {"dir": False, "key": "/foo3", "value": "1234"},
                {"dir": False, "key": "/foo4", "value": "1234"},
                {
                    "dir": True,
                    "key": "/",
                    "leaves": [
                        {"dir": False, "key": "/foo1", "value": "1"},
                    ],
                },
            ]
        },
        "/",
        16,
        [],
    ),
])
def test_etcd_key_size_check_calculates_correct_size(ansible_mounts, tree, root_path, expected_size, extra_words):
    def execute_module(module_name, args, tmp=None, task_vars=None):
        if module_name != "etcdkeysize":
            return {
                "changed": False,
            }

        client = fake_etcd_client(tree)
        size, limit_exceeded = check_etcd_key_size(client, root_path, args["size_limit_bytes"])

        assert size == expected_size
        return {
            "size_limit_exceeded": limit_exceeded,
        }

    task_vars = dict(
        ansible_mounts=ansible_mounts,
        openshift=dict(
            master=dict(etcd_hosts=["localhost"]),
            common=dict(config_base="/var/lib/origin")
        )
    )

    check = EtcdImageDataSize(execute_module=execute_module).run(tmp=None, task_vars=task_vars)
    assert not check.get("failed", False)


def test_etcdkeysize_module_failure():
    def execute_module(module_name, tmp=None, task_vars=None):
        if module_name != "etcdkeysize":
            return {
                "changed": False,
            }

        return {
            "rc": 1,
            "module_stderr": "failure",
        }

    task_vars = dict(
        ansible_mounts=[{
            'mount': '/',
            'size_available': 40 * 10**9,
            'size_total': 80 * 10**9,
        }],
        openshift=dict(
            master=dict(etcd_hosts=["localhost"]),
            common=dict(config_base="/var/lib/origin")
        )
    )

    check = EtcdImageDataSize(execute_module=execute_module).run(tmp=None, task_vars=task_vars)

    assert check["failed"]
    for word in "Failed to retrieve stats":
        assert word in check["msg"]


def fake_execute_module(*args):
    raise AssertionError('this function should not be called')