Merge "Update virtualenv installation step in userguide"
[yardstick.git] / tests / unit / benchmark / scenarios / networking / test_vnf_generic.py
1 #!/usr/bin/env python
2
3 # Copyright (c) 2016-2017 Intel Corporation
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 #      http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16 #
17
18 # Unittest for yardstick.benchmark.scenarios.networking.test_vnf_generic
19
20 from __future__ import absolute_import
21
22 import os
23 import unittest
24
25 import mock
26
27 from yardstick.benchmark.scenarios.networking.vnf_generic import \
28     SshManager, NetworkServiceTestCase, IncorrectConfig, IncorrectSetup
29 from yardstick.network_services.collector.subscriber import Collector
30 from yardstick.network_services.vnf_generic.vnf.base import \
31     GenericTrafficGen, GenericVNF
32
33 STL_MOCKS = {
34     'stl': mock.MagicMock(),
35     'stl.trex_stl_lib': mock.MagicMock(),
36     'stl.trex_stl_lib.base64': mock.MagicMock(),
37     'stl.trex_stl_lib.binascii': mock.MagicMock(),
38     'stl.trex_stl_lib.collections': mock.MagicMock(),
39     'stl.trex_stl_lib.copy': mock.MagicMock(),
40     'stl.trex_stl_lib.datetime': mock.MagicMock(),
41     'stl.trex_stl_lib.functools': mock.MagicMock(),
42     'stl.trex_stl_lib.imp': mock.MagicMock(),
43     'stl.trex_stl_lib.inspect': mock.MagicMock(),
44     'stl.trex_stl_lib.json': mock.MagicMock(),
45     'stl.trex_stl_lib.linecache': mock.MagicMock(),
46     'stl.trex_stl_lib.math': mock.MagicMock(),
47     'stl.trex_stl_lib.os': mock.MagicMock(),
48     'stl.trex_stl_lib.platform': mock.MagicMock(),
49     'stl.trex_stl_lib.pprint': mock.MagicMock(),
50     'stl.trex_stl_lib.random': mock.MagicMock(),
51     'stl.trex_stl_lib.re': mock.MagicMock(),
52     'stl.trex_stl_lib.scapy': mock.MagicMock(),
53     'stl.trex_stl_lib.socket': mock.MagicMock(),
54     'stl.trex_stl_lib.string': mock.MagicMock(),
55     'stl.trex_stl_lib.struct': mock.MagicMock(),
56     'stl.trex_stl_lib.sys': mock.MagicMock(),
57     'stl.trex_stl_lib.threading': mock.MagicMock(),
58     'stl.trex_stl_lib.time': mock.MagicMock(),
59     'stl.trex_stl_lib.traceback': mock.MagicMock(),
60     'stl.trex_stl_lib.trex_stl_async_client': mock.MagicMock(),
61     'stl.trex_stl_lib.trex_stl_client': mock.MagicMock(),
62     'stl.trex_stl_lib.trex_stl_exceptions': mock.MagicMock(),
63     'stl.trex_stl_lib.trex_stl_ext': mock.MagicMock(),
64     'stl.trex_stl_lib.trex_stl_jsonrpc_client': mock.MagicMock(),
65     'stl.trex_stl_lib.trex_stl_packet_builder_interface': mock.MagicMock(),
66     'stl.trex_stl_lib.trex_stl_packet_builder_scapy': mock.MagicMock(),
67     'stl.trex_stl_lib.trex_stl_port': mock.MagicMock(),
68     'stl.trex_stl_lib.trex_stl_stats': mock.MagicMock(),
69     'stl.trex_stl_lib.trex_stl_streams': mock.MagicMock(),
70     'stl.trex_stl_lib.trex_stl_types': mock.MagicMock(),
71     'stl.trex_stl_lib.types': mock.MagicMock(),
72     'stl.trex_stl_lib.utils': mock.MagicMock(),
73     'stl.trex_stl_lib.utils.argparse': mock.MagicMock(),
74     'stl.trex_stl_lib.utils.collections': mock.MagicMock(),
75     'stl.trex_stl_lib.utils.common': mock.MagicMock(),
76     'stl.trex_stl_lib.utils.json': mock.MagicMock(),
77     'stl.trex_stl_lib.utils.os': mock.MagicMock(),
78     'stl.trex_stl_lib.utils.parsing_opts': mock.MagicMock(),
79     'stl.trex_stl_lib.utils.pwd': mock.MagicMock(),
80     'stl.trex_stl_lib.utils.random': mock.MagicMock(),
81     'stl.trex_stl_lib.utils.re': mock.MagicMock(),
82     'stl.trex_stl_lib.utils.string': mock.MagicMock(),
83     'stl.trex_stl_lib.utils.sys': mock.MagicMock(),
84     'stl.trex_stl_lib.utils.text_opts': mock.MagicMock(),
85     'stl.trex_stl_lib.utils.text_tables': mock.MagicMock(),
86     'stl.trex_stl_lib.utils.texttable': mock.MagicMock(),
87     'stl.trex_stl_lib.warnings': mock.MagicMock(),
88     'stl.trex_stl_lib.yaml': mock.MagicMock(),
89     'stl.trex_stl_lib.zlib': mock.MagicMock(),
90     'stl.trex_stl_lib.zmq': mock.MagicMock(),
91 }
92
93 COMPLETE_TREX_VNFD = \
94     {'vnfd:vnfd-catalog':
95      {'vnfd':
96       [{'benchmark':
97         {'kpi':
98          ['rx_throughput_fps',
99           'tx_throughput_fps',
100           'tx_throughput_mbps',
101           'rx_throughput_mbps',
102           'tx_throughput_pc_linerate',
103           'rx_throughput_pc_linerate',
104           'min_latency',
105           'max_latency',
106           'avg_latency']},
107         'connection-point': [{'name': 'xe0',
108                               'type': 'VPORT'},
109                              {'name': 'xe1',
110                               'type': 'VPORT'}],
111         'description': 'TRex stateless traffic generator for RFC2544',
112         'id': 'TrexTrafficGen',
113         'mgmt-interface': {'ip': '1.1.1.1',
114                            'password': 'berta',
115                            'user': 'berta',
116                            'vdu-id': 'trexgen-baremetal'},
117         'name': 'trexgen',
118         'short-name': 'trexgen',
119         'vdu': [{'description': 'TRex stateless traffic generator for RFC2544',
120                  'external-interface':
121                  [{'name': 'xe0',
122                    'virtual-interface': {'bandwidth': '10 Gbps',
123                                          'dst_ip': '1.1.1.1',
124                                          'dst_mac': '00:01:02:03:04:05',
125                                          'local_ip': '1.1.1.2',
126                                          'local_mac': '00:01:02:03:05:05',
127                                          'type': 'PCI-PASSTHROUGH',
128                                          'netmask': "255.255.255.0",
129                                          'driver': 'i40',
130                                          'vpci': '0000:00:10.2'},
131                    'vnfd-connection-point-ref': 'xe0'},
132                   {'name': 'xe1',
133                    'virtual-interface': {'bandwidth': '10 Gbps',
134                                          'dst_ip': '2.1.1.1',
135                                          'dst_mac': '00:01:02:03:04:06',
136                                          'local_ip': '2.1.1.2',
137                                          'local_mac': '00:01:02:03:05:06',
138                                          'type': 'PCI-PASSTHROUGH',
139                                          'netmask': "255.255.255.0",
140                                          'driver': 'i40',
141                                          'vpci': '0000:00:10.1'},
142                    'vnfd-connection-point-ref': 'xe1'}],
143                  'id': 'trexgen-baremetal',
144                  'name': 'trexgen-baremetal'}]}]}}
145
146 IP_ADDR_SHOW = """
147 28: eth1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq state UP """
148 """group default qlen 1000
149     link/ether 90:e2:ba:a7:6a:c8 brd ff:ff:ff:ff:ff:ff
150     inet 1.1.1.1/8 brd 1.255.255.255 scope global eth1
151     inet6 fe80::92e2:baff:fea7:6ac8/64 scope link
152        valid_lft forever preferred_lft forever
153 29: eth5: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq state UP """
154 """group default qlen 1000
155     link/ether 90:e2:ba:a7:6a:c9 brd ff:ff:ff:ff:ff:ff
156     inet 2.1.1.1/8 brd 2.255.255.255 scope global eth5
157     inet6 fe80::92e2:baff:fea7:6ac9/64 scope link tentative
158        valid_lft forever preferred_lft forever
159 """
160
161 SYS_CLASS_NET = """
162 lrwxrwxrwx 1 root root 0 sie 10 14:16 eth1 -> """
163 """../../devices/pci0000:80/0000:80:02.2/0000:84:00.1/net/eth1
164 lrwxrwxrwx 1 root root 0 sie  3 10:37 eth2 -> """
165 """../../devices/pci0000:00/0000:00:01.1/0000:84:00.2/net/eth5
166 """
167
168 TRAFFIC_PROFILE = {
169     "schema": "isb:traffic_profile:0.1",
170     "name": "fixed",
171     "description": "Fixed traffic profile to run UDP traffic",
172     "traffic_profile": {
173         "traffic_type": "FixedTraffic",
174         "frame_rate": 100,  # pps
175         "flow_number": 10,
176         "frame_size": 64}}
177
178
179 class TestNetworkServiceTestCase(unittest.TestCase):
180     def setUp(self):
181         self.context_cfg = \
182             {'nodes':
183              {'trexgen__1': {'role': 'TrafficGen',
184                              'name': 'trafficgen_1.yardstick',
185                              'ip': '10.10.10.11',
186                              'interfaces':
187                              {'xe0':
188                               {'netmask': '255.255.255.0',
189                                'local_ip': '152.16.100.20',
190                                'local_mac': '00:00:00:00:00:01',
191                                'driver': 'i40e',
192                                'vpci': '0000:07:00.0',
193                                'dpdk_port_num': 0},
194                               'xe1':
195                               {'netmask': '255.255.255.0',
196                                'local_ip': '152.16.40.20',
197                                'local_mac': '00:00:00:00:00:02',
198                                'driver': 'i40e',
199                                'vpci': '0000:07:00.1',
200                                'dpdk_port_num': 1}},
201                              'password': 'r00t',
202                              'user': 'root'},
203               'trexvnf__1': {'name': 'vnf.yardstick',
204                              'ip': '10.10.10.12',
205                              'interfaces':
206                              {'xe0':
207                               {'netmask': '255.255.255.0',
208                                'local_ip': '152.16.100.19',
209                                'local_mac': '00:00:00:00:00:03',
210                                'driver': 'i40e',
211                                'vpci': '0000:07:00.0',
212                                'dpdk_port_num': 0},
213                               'xe1': {'netmask': '255.255.255.0',
214                                       'local_ip': '152.16.40.19',
215                                       'local_mac': '00:00:00:00:00:04',
216                                       'driver': 'i40e',
217                                       'vpci': '0000:07:00.1',
218                                       'dpdk_port_num': 1}},
219                              'routing_table': [{'netmask': '255.255.255.0',
220                                                 'gateway': '152.16.100.20',
221                                                 'network': '152.16.100.20',
222                                                 'if': 'xe0'},
223                                                {'netmask': '255.255.255.0',
224                                                 'gateway': '152.16.40.20',
225                                                 'network': '152.16.40.20',
226                                                 'if': 'xe1'}],
227                              'host': '10.223.197.164',
228                              'role': 'vnf',
229                              'user': 'root',
230                              'nd_route_tbl':
231                              [{'netmask': '112',
232                                'gateway': '0064:ff9b:0:0:0:0:9810:6414',
233                                'network': '0064:ff9b:0:0:0:0:9810:6414',
234                                'if': 'xe0'},
235                               {'netmask': '112',
236                                'gateway': '0064:ff9b:0:0:0:0:9810:2814',
237                                'network': '0064:ff9b:0:0:0:0:9810:2814',
238                                'if': 'xe1'}],
239                              'password': 'r00t'}}}
240
241         self.topology = {
242             'short-name': 'trex-tg-topology',
243             'constituent-vnfd':
244                 [{'member-vnf-index': '1',
245                   'VNF model': 'tg_trex_tpl.yaml',
246                   'vnfd-id-ref': 'trexgen__1'},
247                  {'member-vnf-index': '2',
248                   'VNF model': 'tg_trex_tpl.yaml',
249                   'vnfd-id-ref': 'trexvnf__1'}],
250             'description': 'trex-tg-topology',
251             'name': 'trex-tg-topology',
252             'vld': [
253                 {
254                     'vnfd-connection-point-ref': [
255                         {
256                             'vnfd-connection-point-ref': 'xe0',
257                             'member-vnf-index-ref': '1',
258                             'vnfd-id-ref': 'trexgen'
259                         },
260                         {
261                             'vnfd-connection-point-ref': 'xe0',
262                             'member-vnf-index-ref': '2',
263                             'vnfd-id-ref': 'trexgen'
264                         }
265                     ],
266                     'type': 'ELAN',
267                     'id': 'private',
268                     'name': 'trexgen__1 to trexvnf__1 link 1'
269                 },
270                 {
271                     'vnfd-connection-point-ref': [
272                         {
273                             'vnfd-connection-point-ref': 'xe1',
274                             'member-vnf-index-ref': '1',
275                             'vnfd-id-ref': 'trexgen'
276                         },
277                         {
278                             'vnfd-connection-point-ref': 'xe1',
279                             'member-vnf-index-ref': '2',
280                             'vnfd-id-ref': 'trexgen'
281                         }
282                     ],
283                     'type': 'ELAN',
284                     'id': 'public',
285                     'name': 'trexvnf__1 to trexgen__1 link 2'
286                 }],
287             'id': 'trex-tg-topology',
288         }
289
290         self.scenario_cfg = {
291             'tc_options': {'rfc2544': {'allowed_drop_rate': '0.8 - 1'}},
292             'task_id': 'a70bdf4a-8e67-47a3-9dc1-273c14506eb7',
293             'tc': 'tc_ipv4_1Mflow_64B_packetsize',
294             'runner': {'object': 'NetworkServiceTestCase',
295                        'interval': 35,
296                        'output_filename': 'yardstick.out',
297                        'runner_id': 74476,
298                        'duration': 400, 'type': 'Duration'},
299             'traffic_profile': 'ipv4_throughput_vpe.yaml',
300             'traffic_options': {'flow': 'ipv4_1flow_Packets_vpe.yaml',
301                                 'imix': 'imix_voice.yaml'}, 'type': 'ISB',
302             'nodes': {'tg__2': 'trafficgen_2.yardstick',
303                       'tg__1': 'trafficgen_1.yardstick',
304                       'vnf__1': 'vnf.yardstick'},
305             "topology": self._get_file_abspath("vpe_vnf_topology.yaml")}
306
307         self.s = NetworkServiceTestCase(self.scenario_cfg, self.context_cfg)
308
309     def _get_file_abspath(self, filename):
310         curr_path = os.path.dirname(os.path.abspath(__file__))
311         file_path = os.path.join(curr_path, filename)
312         return file_path
313
314     def test_ssh_manager(self):
315         with mock.patch("yardstick.ssh.SSH") as ssh:
316             ssh_mock = mock.Mock(autospec=ssh.SSH)
317             ssh_mock.execute = \
318                 mock.Mock(return_value=(0, SYS_CLASS_NET + IP_ADDR_SHOW, ""))
319             ssh.from_node.return_value = ssh_mock
320             for node, node_dict in self.context_cfg["nodes"].items():
321                 with SshManager(node_dict) as conn:
322                     self.assertIsNotNone(conn)
323
324     def test___init__(self):
325         assert self.topology
326
327     def test___get_traffic_flow(self):
328         self.scenario_cfg["traffic_options"]["flow"] = \
329             self._get_file_abspath("ipv4_1flow_Packets_vpe.yaml")
330         result = {'flow': {'dstip4_range': '152.40.0.20',
331                            'srcip4_range': '152.16.0.20', 'count': 1}}
332         self.assertEqual(result, self.s._get_traffic_flow(self.scenario_cfg))
333
334     def test___get_traffic_flow_error(self):
335         self.scenario_cfg["traffic_options"]["flow"] = \
336             "ipv4_1flow_Packets_vpe.yaml1"
337         self.assertEqual({}, self.s._get_traffic_flow(self.scenario_cfg))
338
339     def test_get_vnf_imp(self):
340         vnfd = COMPLETE_TREX_VNFD['vnfd:vnfd-catalog']['vnfd'][0]
341         with mock.patch.dict("sys.modules", STL_MOCKS):
342             self.assertIsNotNone(self.s.get_vnf_impl(vnfd))
343
344     def test_load_vnf_models_invalid(self):
345         self.context_cfg["nodes"]['trexgen__1']['VNF model'] = \
346             self._get_file_abspath("tg_trex_tpl.yaml")
347         self.context_cfg["nodes"]['trexvnf__1']['VNF model'] = \
348             self._get_file_abspath("tg_trex_tpl.yaml")
349
350         vnf = mock.Mock(autospec=GenericVNF)
351         self.s.get_vnf_impl = mock.Mock(return_value=vnf)
352
353         self.assertIsNotNone(self.s.load_vnf_models(self.context_cfg))
354
355     def test_map_topology_to_infrastructure(self):
356         with mock.patch("yardstick.ssh.SSH") as ssh:
357             ssh_mock = mock.Mock(autospec=ssh.SSH)
358             ssh_mock.execute = \
359                 mock.Mock(return_value=(0, SYS_CLASS_NET + IP_ADDR_SHOW, ""))
360             ssh.from_node.return_value = ssh_mock
361             self.s.map_topology_to_infrastructure(self.context_cfg,
362                                                   self.topology)
363         self.assertEqual("tg_trex_tpl.yaml",
364                          self.context_cfg["nodes"]['trexgen__1']['VNF model'])
365         self.assertEqual("tg_trex_tpl.yaml",
366                          self.context_cfg["nodes"]['trexvnf__1']['VNF model'])
367
368     def test_map_topology_to_infrastructure_insufficient_nodes(self):
369         del self.context_cfg['nodes']['trexvnf__1']
370         with mock.patch("yardstick.ssh.SSH") as ssh:
371             ssh_mock = mock.Mock(autospec=ssh.SSH)
372             ssh_mock.execute = \
373                 mock.Mock(return_value=(1, SYS_CLASS_NET + IP_ADDR_SHOW, ""))
374             ssh.from_node.return_value = ssh_mock
375
376             self.assertRaises(IncorrectSetup,
377                               self.s.map_topology_to_infrastructure,
378                               self.context_cfg, self.topology)
379
380     def test_map_topology_to_infrastructure_config_invalid(self):
381         cfg = dict(self.context_cfg)
382         del cfg['nodes']['trexvnf__1']['interfaces']['xe0']['local_mac']
383         with mock.patch("yardstick.ssh.SSH") as ssh:
384             ssh_mock = mock.Mock(autospec=ssh.SSH)
385             ssh_mock.execute = \
386                 mock.Mock(return_value=(0, SYS_CLASS_NET + IP_ADDR_SHOW, ""))
387             ssh.from_node.return_value = ssh_mock
388
389             self.assertRaises(IncorrectConfig,
390                               self.s.map_topology_to_infrastructure,
391                               self.context_cfg, self.topology)
392
393     def test__resolve_topology_invalid_config(self):
394         with mock.patch("yardstick.ssh.SSH") as ssh:
395             ssh_mock = mock.Mock(autospec=ssh.SSH)
396             ssh_mock.execute = \
397                 mock.Mock(return_value=(0, SYS_CLASS_NET + IP_ADDR_SHOW, ""))
398             ssh.from_node.return_value = ssh_mock
399
400             del self.context_cfg['nodes']
401             self.assertRaises(IncorrectConfig, self.s._resolve_topology,
402                               self.context_cfg, self.topology)
403
404             self.topology['vld'][0]['vnfd-connection-point-ref'].append(
405                 self.topology['vld'][0]['vnfd-connection-point-ref'])
406             self.assertRaises(IncorrectConfig, self.s._resolve_topology,
407                               self.context_cfg, self.topology)
408
409     def test_run(self):
410         tgen = mock.Mock(autospec=GenericTrafficGen)
411         tgen.traffic_finished = True
412         verified_dict = {"verified": True}
413         tgen.verify_traffic = lambda x: verified_dict
414         tgen.name = "tgen__1"
415         vnf = mock.Mock(autospec=GenericVNF)
416         vnf.runs_traffic = False
417         self.s.vnfs = [tgen, vnf]
418         self.s.traffic_profile = mock.Mock()
419         self.s.collector = mock.Mock(autospec=Collector)
420         self.s.collector.get_kpi = \
421             mock.Mock(return_value={tgen.name: verified_dict})
422         result = {}
423         self.s.run(result)
424         self.assertDictEqual(result, {tgen.name: verified_dict})
425
426     def test_setup(self):
427         with mock.patch("yardstick.ssh.SSH") as ssh:
428             ssh_mock = mock.Mock(autospec=ssh.SSH)
429             ssh_mock.execute = \
430                 mock.Mock(return_value=(0, SYS_CLASS_NET + IP_ADDR_SHOW, ""))
431             ssh.from_node.return_value = ssh_mock
432
433             tgen = mock.Mock(autospec=GenericTrafficGen)
434             tgen.traffic_finished = True
435             verified_dict = {"verified": True}
436             tgen.verify_traffic = lambda x: verified_dict
437             tgen.terminate = mock.Mock(return_value=True)
438             tgen.name = "tgen__1"
439             vnf = mock.Mock(autospec=GenericVNF)
440             vnf.runs_traffic = False
441             vnf.terminate = mock.Mock(return_value=True)
442             self.s.vnfs = [tgen, vnf]
443             self.s.traffic_profile = mock.Mock()
444             self.s.collector = mock.Mock(autospec=Collector)
445             self.s.collector.get_kpi = \
446                 mock.Mock(return_value={tgen.name: verified_dict})
447             self.s.map_topology_to_infrastructure = mock.Mock(return_value=0)
448             self.s.load_vnf_models = mock.Mock(return_value=self.s.vnfs)
449             self.s._fill_traffic_profile = \
450                 mock.Mock(return_value=TRAFFIC_PROFILE)
451             self.assertEqual(None, self.s.setup())
452
453     def test__get_traffic_profile(self):
454         self.scenario_cfg["traffic_profile"] = \
455             self._get_file_abspath("ipv4_throughput_vpe.yaml")
456         self.assertIsNotNone(self.s._get_traffic_profile(self.scenario_cfg,
457                                                          self.context_cfg))
458
459     def test__get_traffic_profile_exception(self):
460         cfg = dict(self.scenario_cfg)
461         cfg["traffic_profile"] = ""
462         self.assertRaises(IOError, self.s._get_traffic_profile, cfg,
463                           self.context_cfg)
464
465     def test___get_traffic_imix_exception(self):
466         cfg = dict(self.scenario_cfg)
467         cfg["traffic_options"]["imix"] = ""
468         self.assertEqual({}, self.s._get_traffic_imix(cfg))
469
470     def test__fill_traffic_profile(self):
471         with mock.patch.dict("sys.modules", STL_MOCKS):
472             self.scenario_cfg["traffic_profile"] = \
473                 self._get_file_abspath("ipv4_throughput_vpe.yaml")
474             self.scenario_cfg["traffic_options"]["flow"] = \
475                 self._get_file_abspath("ipv4_1flow_Packets_vpe.yaml")
476             self.scenario_cfg["traffic_options"]["imix"] = \
477                 self._get_file_abspath("imix_voice.yaml")
478             self.assertIsNotNone(self.s._fill_traffic_profile(self.scenario_cfg,
479                                                               self.context_cfg))
480
481     def test_teardown(self):
482         vnf = mock.Mock(autospec=GenericVNF)
483         vnf.terminate = \
484             mock.Mock(return_value=True)
485         self.s.vnfs = [vnf]
486         self.s.traffic_profile = mock.Mock()
487         self.s.collector = mock.Mock(autospec=Collector)
488         self.s.collector.stop = \
489             mock.Mock(return_value=True)
490         self.assertIsNone(self.s.teardown())