summaryrefslogtreecommitdiff
path: root/tests/unit/modules/test_vyos_lldp_interfaces.py
blob: 0950991da3921a257933fe8eea9d6d12f23b20e6 (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
# -*- coding: utf-8 -*-
from __future__ import absolute_import, division, print_function


__metaclass__ = type

import json
import os
import unittest

from unittest.mock import MagicMock

from ansible_collections.vyos.rest.plugins.modules.vyos_lldp_interfaces import (
    _iface_base,
    _iface_cmds,
    _normalize,
    build_commands,
    get_running_config,
)


def load_fixture(filename):
    fixtures_dir = os.path.join(os.path.dirname(__file__), "..", "fixtures")
    path = os.path.join(fixtures_dir, filename)
    with open(path) as f:
        return json.load(f)


class VyOSModuleTestCase(unittest.TestCase):
    def setUp(self):
        self.mock_vyos = MagicMock()
        self.mock_vyos.get_config = MagicMock(return_value={})

    def set_running_config(self, data):
        self.mock_vyos.get_config.return_value = data


class TestVyOSLldpInterfacesIfaceBase(unittest.TestCase):

    def test_iface_base(self):
        self.assertEqual(
            _iface_base("eth0"),
            ["service", "lldp", "interface", "eth0"],
        )


class TestVyOSLldpInterfacesGetRunningFixture(VyOSModuleTestCase):

    def setUp(self):
        super().setUp()
        self.fixture = load_fixture("lldp_interfaces_running.json")

    def test_fixture_parses_eth0_mode(self):
        self.set_running_config(self.fixture)
        result = get_running_config(self.mock_vyos)
        eth0 = next((e for e in result if e["name"] == "eth0"), None)
        self.assertIsNotNone(eth0)
        self.assertEqual(eth0["mode"], "disable")

    def test_fixture_parses_elin(self):
        self.set_running_config(self.fixture)
        result = get_running_config(self.mock_vyos)
        eth0 = next(e for e in result if e["name"] == "eth0")
        self.assertEqual(eth0["location"]["elin"], "1234567890")

    def test_fixture_parses_coordinate_based(self):
        self.set_running_config(self.fixture)
        result = get_running_config(self.mock_vyos)
        eth1 = next((e for e in result if e["name"] == "eth1"), None)
        self.assertIsNotNone(eth1)
        cb = eth1["location"]["coordinate_based"]
        self.assertEqual(cb["latitude"], "33.524449N")
        self.assertEqual(cb["longitude"], "22.267255E")
        self.assertEqual(cb["altitude"], 2200)
        self.assertEqual(cb["datum"], "WGS84")


class TestVyOSLldpInterfacesGetRunning(VyOSModuleTestCase):

    def test_empty_returns_empty_list(self):
        self.set_running_config({})
        result = get_running_config(self.mock_vyos)
        self.assertEqual(result, [])

    def test_no_interface_returns_empty(self):
        self.set_running_config({"snmp": "enable"})
        result = get_running_config(self.mock_vyos)
        self.assertEqual(result, [])

    def test_parses_mode(self):
        self.set_running_config(
            {
                "interface": {"eth0": {"mode": "rx-tx"}},
            },
        )
        result = get_running_config(self.mock_vyos)
        self.assertEqual(result[0]["mode"], "rx-tx")

    def test_parses_elin(self):
        self.set_running_config(
            {
                "interface": {"eth0": {"location": {"elin": "9876543210"}}},
            },
        )
        result = get_running_config(self.mock_vyos)
        self.assertEqual(result[0]["location"]["elin"], "9876543210")

    def test_parses_coordinate_based(self):
        self.set_running_config(
            {
                "interface": {
                    "eth0": {
                        "location": {
                            "coordinate-based": {
                                "latitude": "33.524449N",
                                "longitude": "22.267255E",
                                "altitude": "2200",
                                "datum": "WGS84",
                            },
                        },
                    },
                },
            },
        )
        result = get_running_config(self.mock_vyos)
        cb = result[0]["location"]["coordinate_based"]
        self.assertEqual(cb["latitude"], "33.524449N")
        self.assertEqual(cb["altitude"], 2200)

    def test_no_mode_not_in_entry(self):
        self.set_running_config(
            {
                "interface": {"eth0": {"location": {"elin": "1234567890"}}},
            },
        )
        result = get_running_config(self.mock_vyos)
        self.assertNotIn("mode", result[0])


class TestVyOSLldpInterfacesNormalize(unittest.TestCase):

    def test_normalize_mode(self):
        config = [{"name": "eth0", "mode": "disable"}]
        result = _normalize(config)
        self.assertEqual(result["eth0"]["mode"], "disable")

    def test_normalize_elin(self):
        config = [{"name": "eth0", "location": {"elin": "1234567890"}}]
        result = _normalize(config)
        self.assertEqual(result["eth0"]["elin"], "1234567890")

    def test_normalize_coordinate_based(self):
        config = [
            {
                "name": "eth0",
                "location": {
                    "coordinate_based": {
                        "latitude": "33.524449N",
                        "longitude": "22.267255E",
                        "altitude": 2200,
                        "datum": "WGS84",
                    },
                },
            },
        ]
        result = _normalize(config)
        self.assertEqual(result["eth0"]["latitude"], "33.524449N")
        self.assertEqual(result["eth0"]["altitude"], 2200)

    def test_normalize_empty(self):
        result = _normalize([])
        self.assertEqual(result, {})


class TestVyOSLldpInterfacesIfaceCmds(unittest.TestCase):

    def test_set_mode(self):
        want = {"mode": "disable"}
        cmds = _iface_cmds("eth0", want, {})
        self.assertIn(
            ("set", ["service", "lldp", "interface", "eth0", "mode", "disable"]),
            cmds,
        )

    def test_set_elin(self):
        want = {"elin": "1234567890"}
        cmds = _iface_cmds("eth0", want, {})
        self.assertIn(
            ("set", ["service", "lldp", "interface", "eth0", "location", "elin", "1234567890"]),
            cmds,
        )

    def test_set_latitude(self):
        want = {"latitude": "33.524449N", "longitude": "22.267255E"}
        cmds = _iface_cmds("eth0", want, {})
        self.assertIn(
            (
                "set",
                [
                    "service",
                    "lldp",
                    "interface",
                    "eth0",
                    "location",
                    "coordinate-based",
                    "latitude",
                    "33.524449N",
                ],
            ),
            cmds,
        )

    def test_idempotent_mode(self):
        want = {"mode": "disable"}
        have = {"mode": "disable"}
        cmds = _iface_cmds("eth0", want, have)
        self.assertEqual(cmds, [])

    def test_idempotent_elin(self):
        want = {"elin": "1234567890"}
        have = {"elin": "1234567890"}
        cmds = _iface_cmds("eth0", want, have)
        self.assertEqual(cmds, [])

    def test_delete_mode_when_none(self):
        want = {}
        have = {"mode": "disable"}
        cmds = _iface_cmds("eth0", want, have)
        self.assertIn(
            ("delete", ["service", "lldp", "interface", "eth0", "mode"]),
            cmds,
        )


class TestVyOSLldpInterfacesBuildCommands(unittest.TestCase):

    def _have_eth0(self):
        return [
            {
                "name": "eth0",
                "mode": "disable",
                "location": {"elin": "1234567890"},
            },
        ]

    def test_merged_adds_interface(self):
        config = [{"name": "eth0", "mode": "disable"}]
        cmds = build_commands(config, [], "merged")
        self.assertIn(
            ("set", ["service", "lldp", "interface", "eth0", "mode", "disable"]),
            cmds,
        )

    def test_merged_idempotent(self):
        cmds = build_commands(self._have_eth0(), self._have_eth0(), "merged")
        self.assertEqual(cmds, [])

    def test_deleted_no_config_removes_all(self):
        cmds = build_commands([], self._have_eth0(), "deleted")
        self.assertIn(
            ("delete", ["service", "lldp", "interface", "eth0"]),
            cmds,
        )

    def test_deleted_with_config_removes_named(self):
        config = [{"name": "eth0"}]
        cmds = build_commands(config, self._have_eth0(), "deleted")
        self.assertIn(
            ("delete", ["service", "lldp", "interface", "eth0"]),
            cmds,
        )

    def test_deleted_idempotent_when_empty(self):
        cmds = build_commands([], [], "deleted")
        self.assertEqual(cmds, [])

    def test_replaced_idempotent(self):
        cmds = build_commands(self._have_eth0(), self._have_eth0(), "replaced")
        self.assertEqual(cmds, [])

    def test_overridden_removes_unlisted(self):
        config = [{"name": "eth1", "mode": "rx-tx"}]
        cmds = build_commands(config, self._have_eth0(), "overridden")
        self.assertIn(
            ("delete", ["service", "lldp", "interface", "eth0"]),
            cmds,
        )


if __name__ == "__main__":
    unittest.main()