Passed
Push — master ( 0cda6c...7959d3 )
by
unknown
02:07 queued 13s
created

TestMain.test_traces_same_switch()   B

Complexity

Conditions 1

Size

Total Lines 57
Code Lines 37

Duplication

Lines 57
Ratio 100 %

Importance

Changes 0
Metric Value
cc 1
eloc 37
nop 2
dl 57
loc 57
rs 8.9919
c 0
b 0
f 0

How to fix   Long Method   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
"""Module to test the main napp file."""
2
import json
3
from unittest import TestCase
4
from unittest.mock import patch, MagicMock
5
6
from kytos.core.interface import Interface
7
from kytos.lib.helpers import (
8
    get_interface_mock,
9
    get_switch_mock,
10
    get_controller_mock,
11
    get_link_mock,
12
    get_test_client,
13
)
14
15
16
# pylint: disable=too-many-public-methods, too-many-lines
17
class TestMain(TestCase):
18
    """Test the Main class."""
19
20
    def setUp(self):
21
        """Execute steps before each tests.
22
23
        Set the server_name_url_url from amlight/sdntrace_cp
24
        """
25
        self.server_name_url = "http://localhost:8181/api/amlight/sdntrace_cp"
26
27
        # The decorator run_on_thread is patched, so methods that listen
28
        # for events do not run on threads while tested.
29
        # Decorators have to be patched before the methods that are
30
        # decorated with them are imported.
31
        patch("kytos.core.helpers.run_on_thread", lambda x: x).start()
32
        # pylint: disable=import-outside-toplevel
33
        from napps.amlight.sdntrace_cp.main import Main
34
35
        self.napp = Main(get_controller_mock())
36
37
    @staticmethod
38
    def get_napp_urls(napp):
39
        """Return the amlight/sdntrace_cp urls.
40
41
        The urls will be like:
42
43
        urls = [
44
            (options, methods, url)
45
        ]
46
47
        """
48
        controller = napp.controller
49
        controller.api_server.register_napp_endpoints(napp)
50
51
        urls = []
52
        for rule in controller.api_server.app.url_map.iter_rules():
53
            options = {}
54
            for arg in rule.arguments:
55
                options[arg] = f"[{0}]".format(arg)
56
57
            if f"{napp.username}/{napp.name}" in str(rule):
58
                urls.append((options, rule.methods, f"{str(rule)}"))
59
60
        return urls
61
62
    def test_verify_api_urls(self):
63
        """Verify all APIs registered."""
64
65
        expected_urls = [
66
            (
67
                {},
68
                {"OPTIONS", "HEAD", "PUT"},
69
                "/api/amlight/sdntrace_cp/trace/ ",
70
            ),
71
            (
72
                {},
73
                {"OPTIONS", "HEAD", "PUT"},
74
                "/api/amlight/sdntrace_cp/traces/ ",
75
            ),
76
        ]
77
        urls = self.get_napp_urls(self.napp)
78
        self.assertEqual(len(expected_urls), len(urls))
79
80
    @patch("napps.amlight.sdntrace_cp.main.Main.match_and_apply")
81
    def test_trace_step(self, mock_flow_match):
82
        """Test trace_step success result."""
83
        mock_flow_match.return_value = ["1"], ["entries"], 1
84
        switch = get_switch_mock("00:00:00:00:00:00:00:01", 0x04)
85
86
        mock_interface = Interface("interface A", 1, MagicMock())
87
        mock_interface.address = "00:00:00:00:00:00:00:01"
88
89
        iface1 = get_interface_mock(
90
            "", 1, get_switch_mock("00:00:00:00:00:00:00:01")
91
        )
92
        iface2 = get_interface_mock(
93
            "", 2, get_switch_mock("00:00:00:00:00:00:00:02")
94
        )
95
        mock_interface.link = get_link_mock(iface1, iface2)
96
        mock_interface.link.endpoint_a.port_number = 1
97
        mock_interface.link.endpoint_a.port_number = 2
98
99
        # Patch for utils.find_endpoint
100
        switch.get_interface_by_port_no.return_value = mock_interface
101
102
        entries = MagicMock()
103
104
        stored_flows = {
105
            "flow": {
106
                "table_id": 0,
107
                "cookie": 84114964,
108
                "hard_timeout": 0,
109
                "idle_timeout": 0,
110
                "priority": 10,
111
            },
112
            "flow_id": 1,
113
            "state": "installed",
114
            "switch": "00:00:00:00:00:00:00:01",
115
        }
116
117
        stored_flows_arg = {
118
            "00:00:00:00:00:00:00:01": [stored_flows]
119
        }
120
121
        result = self.napp.trace_step(switch, entries, stored_flows_arg)
122
123
        mock_flow_match.assert_called_once()
124
        self.assertEqual(
125
            result,
126
            {
127
                "dpid": "00:00:00:00:00:00:00:01",
128
                "in_port": 2,
129
                "out_port": 1,
130
                "entries": ["entries"],
131
            },
132
        )
133
134
    @patch("napps.amlight.sdntrace_cp.main.Main.match_and_apply")
135
    def test_trace_step__no_endpoint(self, mock_flow_match):
136
        """Test trace_step without endpoints available for switch/port."""
137
        mock_flow_match.return_value = ["1"], ["entries"], 1
138
        switch = get_switch_mock("00:00:00:00:00:00:00:01", 0x04)
139
140
        mock_interface = Interface("interface A", 1, MagicMock())
141
        mock_interface.address = "00:00:00:00:00:00:00:01"
142
        mock_interface.link = None
143
144
        # Patch for utils.find_endpoint
145
        switch.get_interface_by_port_no.return_value = mock_interface
146
147
        entries = MagicMock()
148
149
        stored_flows = {
150
            "flow": {
151
                "table_id": 0,
152
                "cookie": 84114964,
153
                "hard_timeout": 0,
154
                "idle_timeout": 0,
155
                "priority": 10,
156
            },
157
            "flow_id": 1,
158
            "state": "installed",
159
            "switch": "00:00:00:00:00:00:00:01",
160
        }
161
162
        stored_flows_arg = {
163
            "00:00:00:00:00:00:00:01": [stored_flows]
164
        }
165
166
        result = self.napp.trace_step(switch, entries, stored_flows_arg)
167
168
        mock_flow_match.assert_called_once()
169
        self.assertEqual(result, {"entries": ["entries"], "out_port": 1})
170
171
    def test_trace_step__no_flow(self):
172
        """Test trace_step without flows for the switch."""
173
        switch = get_switch_mock("00:00:00:00:00:00:00:01")
174
        entries = MagicMock()
175
176
        stored_flows = {
177
            "flow": {
178
                "table_id": 0,
179
                "cookie": 84114964,
180
                "hard_timeout": 0,
181
                "idle_timeout": 0,
182
                "priority": 10,
183
            },
184
            "flow_id": 1,
185
            "state": "installed",
186
            "switch": "00:00:00:00:00:00:00:01",
187
        }
188
189
        stored_flows_arg = {
190
            "00:00:00:00:00:00:00:01": [stored_flows]
191
        }
192
193
        result = self.napp.trace_step(switch, entries, stored_flows_arg)
194
        assert result is None
195
196
    @patch("napps.amlight.sdntrace_cp.main.Main.trace_step")
197
    def test_tracepath(self, mock_trace_step):
198
        """Test tracepath with success result."""
199
        eth = {"dl_vlan": 100}
200
        dpid = {"dpid": "00:00:00:00:00:00:00:01", "in_port": 1}
201
        switch = {"switch": dpid, "eth": eth}
202
        entries = {"trace": switch}
203
        mock_trace_step.return_value = {
204
            "dpid": "00:00:00:00:00:00:00:02",
205
            "in_port": 2,
206
            "out_port": 3,
207
            "entries": entries,
208
        }
209
        stored_flows = {
210
            "flow": {
211
                "table_id": 0,
212
                "cookie": 84114964,
213
                "hard_timeout": 0,
214
                "idle_timeout": 0,
215
                "priority": 10,
216
            },
217
            "flow_id": 1,
218
            "state": "installed",
219
            "switch": "00:00:00:00:00:00:00:01",
220
        }
221
222
        stored_flows_arg = {
223
            "00:00:00:00:00:00:00:01": [stored_flows]
224
        }
225
226
        result = self.napp.tracepath(
227
                                        entries["trace"]["switch"],
228
                                        stored_flows_arg
229
                                    )
230
231
        assert result[0]["in"]["dpid"] == "00:00:00:00:00:00:00:01"
232
        assert result[0]["in"]["port"] == 1
233
        assert result[0]["in"]["type"] == "starting"
234
        assert result[0]["out"]["port"] == 3
235
236
        assert result[1]["in"]["dpid"] == "00:00:00:00:00:00:00:02"
237
        assert result[1]["in"]["port"] == 2
238
        assert result[1]["in"]["type"] == "trace"
239
        assert result[1]["out"]["port"] == 3
240
241
    def test_has_loop(self):
242
        """Test has_loop to detect a tracepath with loop."""
243
        trace_result = [
244
            {
245
                "in": {
246
                    "dpid": "00:00:00:00:00:00:00:01",
247
                    "port": 2,
248
                },
249
                "out": {
250
                    "port": 1,
251
                },
252
            },
253
            {
254
                "in": {
255
                    "dpid": "00:00:00:00:00:00:00:03",
256
                    "port": 2,
257
                },
258
                "out": {
259
                    "port": 1,
260
                },
261
            },
262
            {
263
                "in": {
264
                    "dpid": "00:00:00:00:00:00:00:03",
265
                    "port": 3,
266
                },
267
                "out": {
268
                    "port": 1,
269
                },
270
            },
271
            {
272
                "in": {
273
                    "dpid": "00:00:00:00:00:00:00:03",
274
                    "port": 3,
275
                },
276
                "out": {
277
                    "port": 1,
278
                },
279
            },
280
        ]
281
        trace_step = {
282
            "dpid": "00:00:00:00:00:00:00:03",
283
            "port": 3,
284
        }
285
286
        result = self.napp.has_loop(trace_step, trace_result)
287
288
        self.assertTrue(result)
289
290
    def test_has_loop__fail(self):
291
        """Test has_loop to detect a tracepath with loop."""
292
        trace_result = [
293
            {
294
                "in": {
295
                    "dpid": "00:00:00:00:00:00:00:01",
296
                    "port": 2,
297
                },
298
                "out": {
299
                    "port": 1,
300
                },
301
            },
302
            {
303
                "in": {
304
                    "dpid": "00:00:00:00:00:00:00:02",
305
                    "port": 2,
306
                },
307
                "out": {
308
                    "port": 1,
309
                },
310
            },
311
        ]
312
        trace_step = {
313
            "dpid": "00:00:00:00:00:00:00:03",
314
            "port": 2,
315
        }
316
317
        result = self.napp.has_loop(trace_step, trace_result)
318
319
        self.assertFalse(result)
320
321
    @patch("napps.amlight.sdntrace_cp.main.settings")
322
    def test_update_circuits(self, mock_settings):
323
        """Test update_circuits event listener with success."""
324
        mock_settings.FIND_CIRCUITS_IN_FLOWS = True
325
326
        self.napp.automate = MagicMock()
327
        self.napp.automate.find_circuits = MagicMock()
328
329
        event = MagicMock()
330
        self.napp.update_circuits(event)
331
332
        self.napp.automate.find_circuits.assert_called_once()
333
334
    @patch("napps.amlight.sdntrace_cp.main.settings")
335
    def test_update_circuits__no_settings(self, mock_settings):
336
        """Test update_circuits event listener without
337
        settings option enabled."""
338
        mock_settings.FIND_CIRCUITS_IN_FLOWS = False
339
340
        self.napp.automate = MagicMock()
341
        self.napp.automate.find_circuits = MagicMock()
342
343
        event = MagicMock()
344
        self.napp.update_circuits(event)
345
346
        self.napp.automate.find_circuits.assert_not_called()
347
348
    @patch("napps.amlight.sdntrace_cp.main.Main.get_stored_flows")
349
    def test_trace(self, mock_stored_flows):
350
        """Test trace rest call."""
351
        api = get_test_client(get_controller_mock(), self.napp)
352
        url = f"{self.server_name_url}/trace/"
353
354
        payload = {
355
            "trace": {
356
                "switch": {
357
                    "dpid": "00:00:00:00:00:00:00:01",
358
                    "in_port": 1
359
                    },
360
                "eth": {"dl_vlan": 100},
361
            }
362
        }
363
        stored_flows = {
364
            "00:00:00:00:00:00:00:01": {
365
                "flow": {
366
                    "table_id": 0,
367
                    "cookie": 84114964,
368
                    "hard_timeout": 0,
369
                    "idle_timeout": 0,
370
                    "priority": 10,
371
                },
372
                "flow_id": 1,
373
                "state": "installed",
374
                "switch": "00:00:00:00:00:00:00:01",
375
            }
376
        }
377
        mock_stored_flows.return_value = {
378
            "00:00:00:00:00:00:00:01": [stored_flows]
379
        }
380
381
        response = api.put(
382
            url, data=json.dumps(payload), content_type="application/json"
383
        )
384
        current_data = json.loads(response.data)
385
        result = current_data["result"]
386
387
        assert result[0]["dpid"] == "00:00:00:00:00:00:00:01"
388
        assert result[0]["port"] == 1
389
        assert result[0]["type"] == "starting"
390
        assert result[0]["vlan"] == 100
391
392 View Code Duplication
    @patch("napps.amlight.sdntrace_cp.main.Main.get_stored_flows")
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated in your project.
Loading history...
393
    def test_traces(self, mock_stored_flows):
394
        """Test traces rest call for two traces with different switches."""
395
        api = get_test_client(get_controller_mock(), self.napp)
396
        url = f"{self.server_name_url}/traces/"
397
398
        payload = [
399
            {
400
                "trace": {
401
                    "switch": {
402
                        "dpid": "00:00:00:00:00:00:00:01",
403
                        "in_port": 1
404
                        },
405
                    "eth": {"dl_vlan": 100},
406
                }
407
            },
408
            {
409
                "trace": {
410
                    "switch": {
411
                        "dpid": "00:00:00:00:00:00:00:02",
412
                        "in_port": 1},
413
                    "eth": {"dl_vlan": 100},
414
                }
415
            }
416
        ]
417
418
        stored_flow = {
419
                "id": 1,
420
                "table_id": 0,
421
                "cookie": 84114964,
422
                "hard_timeout": 0,
423
                "idle_timeout": 0,
424
                "priority": 10,
425
        }
426
427
        mock_stored_flows.return_value = {
428
            "00:00:00:00:00:00:00:01": [stored_flow]
429
        }
430
431
        response = api.put(
432
            url, data=json.dumps(payload), content_type="application/json"
433
        )
434
        current_data = json.loads(response.data)
435
        result1 = current_data["00:00:00:00:00:00:00:01"]
436
        result2 = current_data["00:00:00:00:00:00:00:02"]
437
438
        assert result1[0][0]["dpid"] == "00:00:00:00:00:00:00:01"
439
        assert result1[0][0]["port"] == 1
440
        assert result1[0][0]["type"] == "starting"
441
        assert result1[0][0]["vlan"] == 100
442
443
        assert result2[0][0]["dpid"] == "00:00:00:00:00:00:00:02"
444
        assert result2[0][0]["port"] == 1
445
        assert result2[0][0]["type"] == "starting"
446
        assert result2[0][0]["vlan"] == 100
447
448 View Code Duplication
    @patch("napps.amlight.sdntrace_cp.main.Main.get_stored_flows")
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated in your project.
Loading history...
449
    def test_traces_same_switch(self, mock_stored_flows):
450
        """Test traces rest call for two traces with samw switches."""
451
        api = get_test_client(get_controller_mock(), self.napp)
452
        url = f"{self.server_name_url}/traces/"
453
454
        payload = [
455
            {
456
                "trace": {
457
                    "switch": {
458
                        "dpid": "00:00:00:00:00:00:00:01",
459
                        "in_port": 1
460
                    },
461
                    "eth": {"dl_vlan": 100},
462
                }
463
            },
464
            {
465
                "trace": {
466
                    "switch": {
467
                        "dpid": "00:00:00:00:00:00:00:01",
468
                        "in_port": 2
469
                    },
470
                    "eth": {"dl_vlan": 100},
471
                }
472
            }
473
        ]
474
475
        stored_flow = {
476
                "id": 1,
477
                "table_id": 0,
478
                "cookie": 84114964,
479
                "hard_timeout": 0,
480
                "idle_timeout": 0,
481
                "priority": 10,
482
        }
483
484
        mock_stored_flows.return_value = {
485
            "00:00:00:00:00:00:00:01": [stored_flow]
486
        }
487
488
        response = api.put(
489
            url, data=json.dumps(payload), content_type="application/json"
490
        )
491
        current_data = json.loads(response.data)
492
        result = current_data["00:00:00:00:00:00:00:01"]
493
494
        assert len(current_data) == 1
495
496
        assert result[0][0]["dpid"] == "00:00:00:00:00:00:00:01"
497
        assert result[0][0]["port"] == 1
498
        assert result[0][0]["type"] == "starting"
499
        assert result[0][0]["vlan"] == 100
500
501
        assert result[1][0]["dpid"] == "00:00:00:00:00:00:00:01"
502
        assert result[1][0]["port"] == 2
503
        assert result[1][0]["type"] == "starting"
504
        assert result[1][0]["vlan"] == 100
505
506
    @patch("napps.amlight.sdntrace_cp.main.Main.get_stored_flows")
507
    def test_traces_twice(self, mock_stored_flows):
508
        """Test traces rest call for two equal traces."""
509
        api = get_test_client(get_controller_mock(), self.napp)
510
        url = f"{self.server_name_url}/traces/"
511
512
        payload = [
513
            {
514
                "trace": {
515
                    "switch": {
516
                        "dpid": "00:00:00:00:00:00:00:01",
517
                        "in_port": 1
518
                        },
519
                    "eth": {"dl_vlan": 100},
520
                }
521
            },
522
            {
523
                "trace": {
524
                    "switch": {
525
                        "dpid": "00:00:00:00:00:00:00:01",
526
                        "in_port": 1
527
                        },
528
                    "eth": {"dl_vlan": 100},
529
                }
530
            }
531
        ]
532
        stored_flow = {
533
                "id": 1,
534
                "table_id": 0,
535
                "cookie": 84114964,
536
                "hard_timeout": 0,
537
                "idle_timeout": 0,
538
                "priority": 10,
539
        }
540
541
        mock_stored_flows.return_value = {
542
            "00:00:00:00:00:00:00:01": [stored_flow]
543
        }
544
545
        response = api.put(
546
            url, data=json.dumps(payload), content_type="application/json"
547
        )
548
        current_data = json.loads(response.data)
549
        result = current_data["00:00:00:00:00:00:00:01"]
550
551
        assert len(current_data) == 1
552
        assert len(result) == 1
553
554
        assert result[0][0]["dpid"] == "00:00:00:00:00:00:00:01"
555
        assert result[0][0]["port"] == 1
556
        assert result[0][0]["type"] == "starting"
557
        assert result[0][0]["vlan"] == 100
558