Test Failed
Pull Request — master (#56)
by Vinicius
07:13
created

TestMain.test_endpoint_enable_liveness()   A

Complexity

Conditions 1

Size

Total Lines 13
Code Lines 12

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 12
nop 1
dl 0
loc 13
rs 9.8
c 0
b 0
f 0
1
"""Test Main methods."""
2
from unittest import TestCase
3
from unittest.mock import MagicMock, call, patch
4
5
from kytos.lib.helpers import (get_controller_mock, get_kytos_event_mock,
6
                               get_switch_mock, get_test_client)
7
8
from kytos.core.events import KytosEvent
9
from napps.kytos.of_lldp.utils import get_cookie
10
from tests.helpers import get_topology_mock
11
12
13
@patch('napps.kytos.of_lldp.managers.LivenessManager.consume_hello_if_enabled')
14
@patch('napps.kytos.of_lldp.loop_manager.LoopManager.process_if_looped')
15
@patch('kytos.core.buffers.KytosEventBuffer.aput')
16
@patch('kytos.core.controller.Controller.get_switch_by_dpid')
17
@patch('napps.kytos.of_lldp.main.Main._unpack_non_empty')
18
@patch('napps.kytos.of_lldp.main.UBInt32')
19
@patch('napps.kytos.of_lldp.main.DPID')
20
@patch('napps.kytos.of_lldp.main.LLDP')
21
@patch('napps.kytos.of_lldp.main.Ethernet')
22
async def test_on_ofpt_packet_in(*args):
23
    """Test on_ofpt_packet_in."""
24
    (mock_ethernet, mock_lldp, mock_dpid, mock_ubint32,
25
     mock_unpack_non_empty, mock_get_switch_by_dpid,
26
     _, mock_process_looped, mock_consume_hello_if_enabled) = args
27
28
    # pylint: disable=bad-option-value, import-outside-toplevel
29
    from napps.kytos.of_lldp.main import Main
30
    Main.get_liveness_controller = MagicMock()
31
    topology = get_topology_mock()
32
    controller = get_controller_mock()
33
    controller.switches = topology.switches
34
    napp = Main(controller)
35
36
    switch = get_switch_mock("00:00:00:00:00:00:00:01", 0x04)
37
    message = MagicMock(in_port=1, data='data')
38
    event = KytosEvent('ofpt_packet_in', content={'source': switch.connection,
39
                       'message': message})
40
41
    mocked, ethernet, lldp, dpid, port_b = [MagicMock() for _ in range(5)]
42
    mocked.value = 1
43
    mock_ubint32.return_value = mocked
44
    ethernet.ether_type = 0x88CC
45
    ethernet.data = 'eth_data'
46
    lldp.chassis_id.sub_value = 'chassis_id'
47
    lldp.port_id.sub_value = 'port_id'
48
    dpid.value = "00:00:00:00:00:00:00:02"
49
    port_b.value = 2
50
51
    mock_unpack_non_empty.side_effect = [ethernet, lldp, dpid, port_b]
52
    mock_get_switch_by_dpid.return_value = get_switch_mock(dpid.value,
53
                                                           0x04)
54
    await napp.on_ofpt_packet_in(event)
55
56
    calls = [call(mock_ethernet, message.data),
57
             call(mock_lldp, ethernet.data),
58
             call(mock_dpid, lldp.chassis_id.sub_value),
59
             call(mock_ubint32, lldp.port_id.sub_value)]
60
    mock_unpack_non_empty.assert_has_calls(calls)
61
    mock_process_looped.assert_called()
62
    assert mock_consume_hello_if_enabled.call_count == 1
63
    assert controller.buffers.app.aput.call_count == 1
64
65
66
# pylint: disable=protected-access,too-many-public-methods
67
class TestMain(TestCase):
68
    """Tests for the Main class."""
69
70
    def setUp(self):
71
        """Execute steps before each tests."""
72
        self.server_name_url = 'http://127.0.0.1:8181/api/kytos/of_lldp'
73
74
        patch('kytos.core.helpers.run_on_thread', lambda x: x).start()
75
        # pylint: disable=bad-option-value, import-outside-toplevel
76
        from napps.kytos.of_lldp.main import Main
77
        self.addCleanup(patch.stopall)
78
        Main.get_liveness_controller = MagicMock()
79
        self.topology = get_topology_mock()
80
        controller = get_controller_mock()
81
        controller.switches = self.topology.switches
82
83
        self.napp = Main(controller)
84
85
    def get_topology_interfaces(self):
86
        """Return interfaces present in topology."""
87
        interfaces = []
88
        for switch in list(self.topology.switches.values()):
89
            interfaces += list(switch.interfaces.values())
90
        return interfaces
91
92
    @patch('napps.kytos.of_lldp.main.of_msg_prio')
93
    @patch('kytos.core.buffers.KytosEventBuffer.put')
94
    @patch('napps.kytos.of_lldp.main.KytosEvent')
95
    @patch('napps.kytos.of_lldp.main.VLAN')
96
    @patch('napps.kytos.of_lldp.main.Ethernet')
97
    @patch('napps.kytos.of_lldp.main.DPID')
98
    @patch('napps.kytos.of_lldp.main.LLDP')
99
    def test_execute(self, *args):
100
        """Test execute method."""
101
        (_, _, mock_ethernet, _, mock_kytos_event,
102
         mock_buffer_put, mock_of_msg_prio) = args
103
104
        ethernet = MagicMock()
105
        ethernet.pack.return_value = 'pack'
106
        interfaces = self.get_topology_interfaces()
107
        po_args = [(interface.switch.connection.protocol.version,
108
                    interface.port_number, 'pack') for interface in interfaces]
109
110
        mock_ethernet.return_value = ethernet
111
        mock_kytos_event.side_effect = po_args
112
113
        mock_publish_stopped = MagicMock()
114
        self.napp.try_to_publish_stopped_loops = mock_publish_stopped
115
        self.napp.execute()
116
117
        mock_of_msg_prio.assert_called()
118
        mock_buffer_put.assert_has_calls([call(arg)
119
                                          for arg in po_args])
120
        mock_publish_stopped.assert_called()
121
122
    @patch('requests.delete')
123
    @patch('requests.post')
124
    def test_handle_lldp_flows(self, mock_post, mock_delete):
125
        """Test handle_lldp_flow method."""
126
        dpid = "00:00:00:00:00:00:00:01"
127
        switch = get_switch_mock("00:00:00:00:00:00:00:01", 0x04)
128
        self.napp.controller.switches = {dpid: switch}
129
        event_post = get_kytos_event_mock(name='kytos/topology.switch.enabled',
130
                                          content={'dpid': dpid})
131
132
        event_del = get_kytos_event_mock(name='kytos/topology.switch.disabled',
133
                                         content={'dpid': dpid})
134
135
        self.napp.handle_lldp_flows(event_post)
136
        mock_post.assert_called()
137
138
        self.napp.handle_lldp_flows(event_del)
139
        mock_delete.assert_called()
140
141
    @patch("time.sleep")
142
    @patch("requests.post")
143
    def test_handle_lldp_flows_retries(self, mock_post, _):
144
        """Test handle_lldp_flow method retries."""
145
        dpid = "00:00:00:00:00:00:00:01"
146
        switch = get_switch_mock("00:00:00:00:00:00:00:01", 0x04)
147
        self.napp.controller.switches = {dpid: switch}
148
        event_post = get_kytos_event_mock(name="kytos/topology.switch.enabled",
149
                                          content={"dpid": dpid})
150
151
        mock = MagicMock()
152
        mock.request.method = "POST"
153
        mock.status_code = 500
154
        mock.text = "some_err"
155
        mock_post.return_value = mock
156
        self.napp._handle_lldp_flows(event_post)
157
        self.assertTrue(mock_post.call_count, 3)
158
159
    @patch('napps.kytos.of_lldp.main.PO13')
160
    @patch('napps.kytos.of_lldp.main.PO10')
161
    @patch('napps.kytos.of_lldp.main.AO13')
162
    @patch('napps.kytos.of_lldp.main.AO10')
163
    def test_build_lldp_packet_out(self, *args):
164
        """Test _build_lldp_packet_out method."""
165
        (mock_ao10, mock_ao13, mock_po10, mock_po13) = args
166
167
        ao10 = MagicMock()
168
        ao13 = MagicMock()
169
        po10 = MagicMock()
170
        po10.actions = []
171
        po13 = MagicMock()
172
        po13.actions = []
173
174
        mock_ao10.return_value = ao10
175
        mock_ao13.return_value = ao13
176
        mock_po10.return_value = po10
177
        mock_po13.return_value = po13
178
179
        packet_out10 = self.napp._build_lldp_packet_out(0x01, 1, 'data1')
180
        packet_out13 = self.napp._build_lldp_packet_out(0x04, 2, 'data2')
181
        packet_out14 = self.napp._build_lldp_packet_out(0x05, 3, 'data3')
182
183
        self.assertEqual(packet_out10.data, 'data1')
184
        self.assertEqual(packet_out10.actions, [ao10])
185
        self.assertEqual(packet_out10.actions[0].port, 1)
186
187
        self.assertEqual(packet_out13.data, 'data2')
188
        self.assertEqual(packet_out13.actions, [ao13])
189
        self.assertEqual(packet_out13.actions[0].port, 2)
190
191
        self.assertIsNone(packet_out14)
192
193
    @patch('napps.kytos.of_lldp.main.settings')
194
    @patch('napps.kytos.of_lldp.main.EtherType')
195
    @patch('napps.kytos.of_lldp.main.Port13')
196
    @patch('napps.kytos.of_lldp.main.Port10')
197
    def test_build_lldp_flow(self, *args):
198
        """Test _build_lldp_flow method."""
199
        (mock_v0x01_port, mock_v0x04_port, mock_ethertype,
200
         mock_settings) = args
201
        self.napp.vlan_id = None
202
        mock_v0x01_port.OFPP_CONTROLLER = 123
203
        mock_v0x04_port.OFPP_CONTROLLER = 1234
204
205
        mock_ethertype.LLDP = 10
206
        mock_settings.FLOW_VLAN_VID = None
207
        mock_settings.FLOW_PRIORITY = 1500
208
        mock_settings.TABLE_ID = 0
209
        dpid = "00:00:00:00:00:00:00:01"
210
211
        flow = {}
212
        match = {}
213
        flow['priority'] = 1500
214
        flow['table_id'] = 0
215
        match['dl_type'] = 10
216
217
        flow['match'] = match
218
        expected_flow_v0x01 = flow.copy()
219
        expected_flow_v0x04 = flow.copy()
220
        expected_flow_v0x01['cookie'] = get_cookie(dpid)
221
        expected_flow_v0x01['cookie_mask'] = 0xffffffffffffffff
222
        expected_flow_v0x04['cookie'] = get_cookie(dpid)
223
        expected_flow_v0x04['cookie_mask'] = 0xffffffffffffffff
224
225
        expected_flow_v0x01['actions'] = [{'action_type': 'output',
226
                                           'port': 123}]
227
228
        expected_flow_v0x04['actions'] = [{'action_type': 'output',
229
                                           'port': 1234}]
230
231
        flow_mod10 = self.napp._build_lldp_flow(0x01, get_cookie(dpid))
232
        flow_mod13 = self.napp._build_lldp_flow(0x04, get_cookie(dpid))
233
234
        self.assertDictEqual(flow_mod10, expected_flow_v0x01)
235
        self.assertDictEqual(flow_mod13, expected_flow_v0x04)
236
237
    def test_unpack_non_empty(self):
238
        """Test _unpack_non_empty method."""
239
        desired_class = MagicMock()
240
        data = MagicMock()
241
        data.value = 'data'
242
243
        obj = self.napp._unpack_non_empty(desired_class, data)
244
245
        obj.unpack.assert_called_with('data')
246
247
    def test_get_data(self):
248
        """Test _get_data method."""
249
        req = MagicMock()
250
        interfaces = ['00:00:00:00:00:00:00:01:1', '00:00:00:00:00:00:00:01:2']
251
        req.get_json.return_value = {'interfaces': interfaces}
252
253
        data = self.napp._get_data(req)
254
255
        self.assertEqual(data, interfaces)
256
257
    def test_load_liveness(self) -> None:
258
        """Test load_liveness."""
259
        self.napp.load_liveness()
260
        count = self.napp.liveness_controller.get_enabled_interfaces.call_count
261
        assert count == 1
262
263
    def test_handle_topology_loaded(self) -> None:
264
        """Test handle_topology_loaded."""
265
        event = KytosEvent("kytos/topology.topology_loaded",
266
                           content={"topology": {}})
267
        self.napp.load_liveness = MagicMock()
268
        self.napp.loop_manager.handle_topology_loaded = MagicMock()
269
        self.napp.handle_topology_loaded(event)
270
        assert self.napp.loop_manager.handle_topology_loaded.call_count == 1
271
        assert self.napp.load_liveness.call_count == 1
272
273
    def test_publish_liveness_status(self) -> None:
274
        """Test publish_liveness_status."""
275
        self.napp.controller.buffers.app.put = MagicMock()
276
        event_suffix, interfaces = "up", [MagicMock(id=1), MagicMock(id=2)]
277
        self.napp.publish_liveness_status(event_suffix, interfaces)
278
        assert self.napp.controller.buffers.app.put.call_count == 1
279
        event = self.napp.controller.buffers.app.put.call_args[0][0]
280
        assert event.name == f"kytos/of_lldp.liveness.{event_suffix}"
281
        assert event.content["interfaces"] == interfaces
282
283
    def test_get_interfaces(self):
284
        """Test _get_interfaces method."""
285
        expected_interfaces = self.get_topology_interfaces()
286
287
        interfaces = self.napp._get_interfaces()
288
289
        self.assertEqual(interfaces, expected_interfaces)
290
291
    def test_get_interfaces_dict(self):
292
        """Test _get_interfaces_dict method."""
293
        interfaces = self.napp._get_interfaces()
294
        expected_interfaces = {inter.id: inter for inter in interfaces}
295
296
        interfaces_dict = self.napp._get_interfaces_dict(interfaces)
297
298
        self.assertEqual(interfaces_dict, expected_interfaces)
299
300
    def test_get_lldp_interfaces(self):
301
        """Test _get_lldp_interfaces method."""
302
        lldp_interfaces = self.napp._get_lldp_interfaces()
303
304
        expected_interfaces = ['00:00:00:00:00:00:00:01:1',
305
                               '00:00:00:00:00:00:00:01:2',
306
                               '00:00:00:00:00:00:00:02:1',
307
                               '00:00:00:00:00:00:00:02:2',
308
                               '00:00:00:00:00:00:00:03:1',
309
                               '00:00:00:00:00:00:00:03:2']
310
311
        self.assertEqual(lldp_interfaces, expected_interfaces)
312
313
    def test_rest_get_lldp_interfaces(self):
314
        """Test get_lldp_interfaces method."""
315
        api = get_test_client(self.napp.controller, self.napp)
316
        url = f'{self.server_name_url}/v1/interfaces'
317
        response = api.open(url, method='GET')
318
319
        expected_data = {"interfaces": ['00:00:00:00:00:00:00:01:1',
320
                                        '00:00:00:00:00:00:00:01:2',
321
                                        '00:00:00:00:00:00:00:02:1',
322
                                        '00:00:00:00:00:00:00:02:2',
323
                                        '00:00:00:00:00:00:00:03:1',
324
                                        '00:00:00:00:00:00:00:03:2']}
325
        self.assertEqual(response.json, expected_data)
326
        self.assertEqual(response.status_code, 200)
327
328
    def test_enable_disable_lldp_200(self):
329
        """Test 200 response for enable_lldp and disable_lldp methods."""
330
        data = {"interfaces": ['00:00:00:00:00:00:00:01:1',
331
                               '00:00:00:00:00:00:00:01:2',
332
                               '00:00:00:00:00:00:00:02:1',
333
                               '00:00:00:00:00:00:00:02:2',
334
                               '00:00:00:00:00:00:00:03:1',
335
                               '00:00:00:00:00:00:00:03:2']}
336
337
        api = get_test_client(self.napp.controller, self.napp)
338
        self.napp.publish_liveness_status = MagicMock()
339
340
        url = f'{self.server_name_url}/v1/interfaces/disable'
341
        disable_response = api.open(url, method='POST', json=data)
342
        assert self.napp.liveness_controller.disable_interfaces.call_count == 1
343
        assert self.napp.publish_liveness_status.call_count == 1
344
345
        url = f'{self.server_name_url}/v1/interfaces/enable'
346
        enable_response = api.open(url, method='POST', json=data)
347
348
        self.assertEqual(disable_response.status_code, 200)
349
        self.assertEqual(enable_response.status_code, 200)
350
351
    def test_enable_disable_lldp_404(self):
352
        """Test 404 response for enable_lldp and disable_lldp methods."""
353
        data = {"interfaces": []}
354
355
        self.napp.controller.switches = {}
356
        api = get_test_client(self.napp.controller, self.napp)
357
358
        url = f'{self.server_name_url}/v1/interfaces/disable'
359
        disable_response = api.open(url, method='POST', json=data)
360
361
        url = f'{self.server_name_url}/v1/interfaces/enable'
362
        enable_response = api.open(url, method='POST', json=data)
363
364
        self.assertEqual(disable_response.status_code, 404)
365
        self.assertEqual(enable_response.status_code, 404)
366
367
    def test_enable_disable_lldp_400(self):
368
        """Test 400 response for enable_lldp and disable_lldp methods."""
369
        data = {"interfaces": ['00:00:00:00:00:00:00:01:1',
370
                               '00:00:00:00:00:00:00:01:2',
371
                               '00:00:00:00:00:00:00:02:1',
372
                               '00:00:00:00:00:00:00:02:2',
373
                               '00:00:00:00:00:00:00:03:1',
374
                               '00:00:00:00:00:00:00:03:2',
375
                               '00:00:00:00:00:00:00:04:1']}
376
377
        api = get_test_client(self.napp.controller, self.napp)
378
        self.napp.publish_liveness_status = MagicMock()
379
380
        url = f'{self.server_name_url}/v1/interfaces/disable'
381
        disable_response = api.open(url, method='POST', json=data)
382
        assert self.napp.publish_liveness_status.call_count == 1
383
384
        url = f'{self.server_name_url}/v1/interfaces/enable'
385
        enable_response = api.open(url, method='POST', json=data)
386
387
        self.assertEqual(disable_response.status_code, 400)
388
        self.assertEqual(enable_response.status_code, 400)
389
390
    def test_get_time(self):
391
        """Test get polling time."""
392
        api = get_test_client(self.napp.controller, self.napp)
393
394
        url = f'{self.server_name_url}/v1/polling_time'
395
        response = api.open(url, method='GET')
396
397
        self.assertEqual(response.status_code, 200)
398
399
    def test_set_time(self):
400
        """Test update polling time."""
401
        data = {"polling_time": 5}
402
403
        api = get_test_client(self.napp.controller, self.napp)
404
405
        url = f'{self.server_name_url}/v1/polling_time'
406
        response = api.open(url, method='POST', json=data)
407
408
        self.assertEqual(response.status_code, 200)
409
        self.assertEqual(self.napp.polling_time, data['polling_time'])
410
411
    def test_set_time_400(self):
412
        """Test fail case the update polling time."""
413
        api = get_test_client(self.napp.controller, self.napp)
414
415
        url = f'{self.server_name_url}/v1/polling_time'
416
417
        data = {'polling_time': 'A'}
418
        response = api.open(url, method='POST', json=data)
419
        self.assertEqual(response.status_code, 400)
420
421
    def test_endpoint_enable_liveness(self):
422
        """Test POST v1/liveness/enable."""
423
        self.napp.liveness_manager.enable = MagicMock()
424
        self.napp.publish_liveness_status = MagicMock()
425
        api = get_test_client(self.napp.controller, self.napp)
426
        url = f"{self.server_name_url}/v1/liveness/enable"
427
        data = {"interfaces": ["00:00:00:00:00:00:00:01:1"]}
428
        response = api.open(url, method="POST", json=data)
429
        assert self.napp.liveness_controller.enable_interfaces.call_count == 1
430
        assert self.napp.liveness_manager.enable.call_count == 1
431
        assert self.napp.publish_liveness_status.call_count == 1
432
        assert response.json == {}
433
        assert response.status_code == 200
434
435
    def test_endpoint_disable_liveness(self):
436
        """Test POST v1/liveness/disable."""
437
        self.napp.liveness_manager.disable = MagicMock()
438
        self.napp.publish_liveness_status = MagicMock()
439
        api = get_test_client(self.napp.controller, self.napp)
440
        url = f"{self.server_name_url}/v1/liveness/disable"
441
        data = {"interfaces": ["00:00:00:00:00:00:00:01:1"]}
442
        response = api.open(url, method='POST', json=data)
443
        assert self.napp.liveness_controller.disable_interfaces.call_count == 1
444
        assert self.napp.liveness_manager.disable.call_count == 1
445
        assert self.napp.publish_liveness_status.call_count == 1
446
        assert response.json == {}
447
        assert response.status_code == 200
448
449
    def test_endpoint_get_liveness(self):
450
        """Test GET v1/liveness/."""
451
        self.napp.liveness_manager.enable = MagicMock()
452
        self.napp.publish_liveness_status = MagicMock()
453
        api = get_test_client(self.napp.controller, self.napp)
454
        url = f"{self.server_name_url}/v1/liveness/"
455
        response = api.open(url, method="GET")
456
        assert response.json == {"interfaces": []}
457
        assert response.status_code == 200
458
459
    def test_endpoint_get_pair_liveness(self):
460
        """Test GET v1/liveness//pair."""
461
        self.napp.liveness_manager.enable = MagicMock()
462
        self.napp.publish_liveness_status = MagicMock()
463
        api = get_test_client(self.napp.controller, self.napp)
464
        url = f"{self.server_name_url}/v1/liveness/pair"
465
        response = api.open(url, method="GET")
466
        assert response.json == {"pairs": []}
467
        assert response.status_code == 200
468