tests/unit/network_services/vnf_generic/vnf/test_tg_rfc2544_trex.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 from __future__ import absolute_import
  19 import unittest
  20 import mock
  21 import os
  22 import multiprocessing
  23 from multiprocessing import Queue
  24
  25 STL_MOCKS = {
  26     'stl': mock.MagicMock(),
  27     'stl.trex_stl_lib': mock.MagicMock(),
  28     'stl.trex_stl_lib.base64': mock.MagicMock(),
  29     'stl.trex_stl_lib.binascii': mock.MagicMock(),
  30     'stl.trex_stl_lib.collections': mock.MagicMock(),
  31     'stl.trex_stl_lib.copy': mock.MagicMock(),
  32     'stl.trex_stl_lib.datetime': mock.MagicMock(),
  33     'stl.trex_stl_lib.functools': mock.MagicMock(),
  34     'stl.trex_stl_lib.imp': mock.MagicMock(),
  35     'stl.trex_stl_lib.inspect': mock.MagicMock(),
  36     'stl.trex_stl_lib.json': mock.MagicMock(),
  37     'stl.trex_stl_lib.linecache': mock.MagicMock(),
  38     'stl.trex_stl_lib.math': mock.MagicMock(),
  39     'stl.trex_stl_lib.os': mock.MagicMock(),
  40     'stl.trex_stl_lib.platform': mock.MagicMock(),
  41     'stl.trex_stl_lib.pprint': mock.MagicMock(),
  42     'stl.trex_stl_lib.random': mock.MagicMock(),
  43     'stl.trex_stl_lib.re': mock.MagicMock(),
  44     'stl.trex_stl_lib.scapy': mock.MagicMock(),
  45     'stl.trex_stl_lib.socket': mock.MagicMock(),
  46     'stl.trex_stl_lib.string': mock.MagicMock(),
  47     'stl.trex_stl_lib.struct': mock.MagicMock(),
  48     'stl.trex_stl_lib.sys': mock.MagicMock(),
  49     'stl.trex_stl_lib.threading': mock.MagicMock(),
  50     'stl.trex_stl_lib.time': mock.MagicMock(),
  51     'stl.trex_stl_lib.traceback': mock.MagicMock(),
  52     'stl.trex_stl_lib.trex_stl_async_client': mock.MagicMock(),
  53     'stl.trex_stl_lib.trex_stl_client': mock.MagicMock(),
  54     'stl.trex_stl_lib.trex_stl_exceptions': mock.MagicMock(),
  55     'stl.trex_stl_lib.trex_stl_ext': mock.MagicMock(),
  56     'stl.trex_stl_lib.trex_stl_jsonrpc_client': mock.MagicMock(),
  57     'stl.trex_stl_lib.trex_stl_packet_builder_interface': mock.MagicMock(),
  58     'stl.trex_stl_lib.trex_stl_packet_builder_scapy': mock.MagicMock(),
  59     'stl.trex_stl_lib.trex_stl_port': mock.MagicMock(),
  60     'stl.trex_stl_lib.trex_stl_stats': mock.MagicMock(),
  61     'stl.trex_stl_lib.trex_stl_streams': mock.MagicMock(),
  62     'stl.trex_stl_lib.trex_stl_types': mock.MagicMock(),
  63     'stl.trex_stl_lib.types': mock.MagicMock(),
  64     'stl.trex_stl_lib.utils': mock.MagicMock(),
  65     'stl.trex_stl_lib.utils.argparse': mock.MagicMock(),
  66     'stl.trex_stl_lib.utils.collections': mock.MagicMock(),
  67     'stl.trex_stl_lib.utils.common': mock.MagicMock(),
  68     'stl.trex_stl_lib.utils.json': mock.MagicMock(),
  69     'stl.trex_stl_lib.utils.os': mock.MagicMock(),
  70     'stl.trex_stl_lib.utils.parsing_opts': mock.MagicMock(),
  71     'stl.trex_stl_lib.utils.pwd': mock.MagicMock(),
  72     'stl.trex_stl_lib.utils.random': mock.MagicMock(),
  73     'stl.trex_stl_lib.utils.re': mock.MagicMock(),
  74     'stl.trex_stl_lib.utils.string': mock.MagicMock(),
  75     'stl.trex_stl_lib.utils.sys': mock.MagicMock(),
  76     'stl.trex_stl_lib.utils.text_opts': mock.MagicMock(),
  77     'stl.trex_stl_lib.utils.text_tables': mock.MagicMock(),
  78     'stl.trex_stl_lib.utils.texttable': mock.MagicMock(),
  79     'stl.trex_stl_lib.warnings': mock.MagicMock(),
  80     'stl.trex_stl_lib.yaml': mock.MagicMock(),
  81     'stl.trex_stl_lib.zlib': mock.MagicMock(),
  82     'stl.trex_stl_lib.zmq': mock.MagicMock(),
  83 }
  84
  85 STLClient = mock.MagicMock()
  86 stl_patch = mock.patch.dict("sys.modules", STL_MOCKS)
  87 stl_patch.start()
  88
  89 if stl_patch:
  90     from yardstick.network_services.vnf_generic.vnf.tg_rfc2544_trex import \
  91         TrexTrafficGenRFC
  92     from yardstick.network_services.vnf_generic.vnf import tg_rfc2544_trex
  93     from yardstick.network_services.traffic_profile.base import TrafficProfile
  94
  95
  96 class TestTrexTrafficGenRFC(unittest.TestCase):
  97     VNFD = {'vnfd:vnfd-catalog':
  98             {'vnfd':
  99              [{'short-name': 'VpeVnf',
 100                'vdu':
 101                [{'routing_table':
 102                  [{'network': '152.16.100.20',
 103                    'netmask': '255.255.255.0',
 104                    'gateway': '152.16.100.20',
 105                    'if': 'xe0'},
 106                   {'network': '152.16.40.20',
 107                    'netmask': '255.255.255.0',
 108                    'gateway': '152.16.40.20',
 109                    'if': 'xe1'}],
 110                  'description': 'VPE approximation using DPDK',
 111                  'name': 'vpevnf-baremetal',
 112                  'nd_route_tbl':
 113                  [{'network': '0064:ff9b:0:0:0:0:9810:6414',
 114                    'netmask': '112',
 115                    'gateway': '0064:ff9b:0:0:0:0:9810:6414',
 116                    'if': 'xe0'},
 117                   {'network': '0064:ff9b:0:0:0:0:9810:2814',
 118                    'netmask': '112',
 119                    'gateway': '0064:ff9b:0:0:0:0:9810:2814',
 120                    'if': 'xe1'}],
 121                  'id': 'vpevnf-baremetal',
 122                  'external-interface':
 123                  [{'virtual-interface':
 124                    {'dst_mac': '00:00:00:00:00:04',
 125                     'vpci': '0000:05:00.0',
 126                     'local_ip': '152.16.100.19',
 127                     'type': 'PCI-PASSTHROUGH',
 128                     'netmask': '255.255.255.0',
 129                     'dpdk_port_num': '0',
 130                     'bandwidth': '10 Gbps',
 131                     'driver': "i40e",
 132                     'dst_ip': '152.16.100.20',
 133                     'local_iface_name': 'xe0',
 134                     'local_mac': '00:00:00:00:00:01'},
 135                    'vnfd-connection-point-ref': 'xe0',
 136                    'name': 'xe0'},
 137                   {'virtual-interface':
 138                    {'dst_mac': '00:00:00:00:00:03',
 139                     'vpci': '0000:05:00.1',
 140                     'local_ip': '152.16.40.19',
 141                     'type': 'PCI-PASSTHROUGH',
 142                     'driver': "i40e",
 143                     'netmask': '255.255.255.0',
 144                     'dpdk_port_num': '1',
 145                     'bandwidth': '10 Gbps',
 146                     'dst_ip': '152.16.40.20',
 147                     'local_iface_name': 'xe1',
 148                     'local_mac': '00:00:00:00:00:02'},
 149                    'vnfd-connection-point-ref': 'xe1',
 150                    'name': 'xe1'}]}],
 151                'description': 'Vpe approximation using DPDK',
 152                'mgmt-interface':
 153                    {'vdu-id': 'vpevnf-baremetal',
 154                     'host': '1.1.1.1',
 155                     'password': 'r00t',
 156                     'user': 'root',
 157                     'ip': '1.1.1.1'},
 158                'benchmark':
 159                    {'kpi': ['packets_in', 'packets_fwd', 'packets_dropped']},
 160                'connection-point': [{'type': 'VPORT', 'name': 'xe0'},
 161                                     {'type': 'VPORT', 'name': 'xe1'}],
 162                'id': 'VpeApproxVnf', 'name': 'VPEVnfSsh'}]}}
 163
 164     TRAFFIC_PROFILE = {
 165         "schema": "isb:traffic_profile:0.1",
 166         "name": "fixed",
 167         "description": "Fixed traffic profile to run UDP traffic",
 168         "traffic_profile": {
 169             "traffic_type": "FixedTraffic",
 170             "frame_rate": 100,  # pps
 171             "flow_number": 10,
 172             "frame_size": 64}}
 173
 174     TC_YAML = {'scenarios': [{'tc_options':
 175                               {'rfc2544': {'allowed_drop_rate': '0.8 - 1'}},
 176                               'runner': {'duration': 400,
 177                                          'interval': 35, 'type': 'Duration'},
 178                               'traffic_options':
 179                               {'flow': 'ipv4_1flow_Packets_vpe.yaml',
 180                                'imix': 'imix_voice.yaml'},
 181                               'vnf_options': {'vpe': {'cfg': 'vpe_config'}},
 182                               'traffic_profile': 'ipv4_throughput_vpe.yaml',
 183                               'type': 'NSPerf',
 184                               'nodes': {'tg__1': 'trafficgen_1.yardstick',
 185                                         'vnf__1': 'vnf.yardstick'},
 186                               'topology': 'vpe_vnf_topology.yaml'}],
 187                'context': {'nfvi_type': 'baremetal', 'type': 'Node',
 188                            'name': 'yardstick',
 189                            'file': '/etc/yardstick/nodes/pod.yaml'},
 190                'schema': 'yardstick:task:0.1'}
 191
 192     def test___init__(self):
 193         with mock.patch("yardstick.ssh.SSH") as ssh:
 194             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 195             ssh_mock = mock.Mock(autospec=ssh.SSH)
 196             ssh_mock.execute = \
 197                 mock.Mock(return_value=(0, "", ""))
 198             ssh.from_node.return_value = ssh_mock
 199             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 200             trex_traffic_gen = TrexTrafficGenRFC(vnfd)
 201             self.assertIsNotNone(trex_traffic_gen._terminated)
 202
 203     def test_collect_kpi(self):
 204         with mock.patch("yardstick.ssh.SSH") as ssh:
 205             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 206             ssh_mock = mock.Mock(autospec=ssh.SSH)
 207             ssh_mock.execute = \
 208                 mock.Mock(return_value=(0, "", ""))
 209             ssh.from_node.return_value = ssh_mock
 210             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 211             trex_traffic_gen = TrexTrafficGenRFC(vnfd)
 212             restult = trex_traffic_gen.collect_kpi()
 213             self.assertEqual({}, restult)
 214
 215     def test_listen_traffic(self):
 216         with mock.patch("yardstick.ssh.SSH") as ssh:
 217             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 218             ssh_mock = mock.Mock(autospec=ssh.SSH)
 219             ssh_mock.execute = \
 220                 mock.Mock(return_value=(0, "", ""))
 221             ssh.from_node.return_value = ssh_mock
 222             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 223             trex_traffic_gen = TrexTrafficGenRFC(vnfd)
 224             self.assertEqual(None, trex_traffic_gen.listen_traffic({}))
 225
 226     def test_instantiate(self):
 227         mock_traffic_profile = mock.Mock(autospec=TrafficProfile)
 228         mock_traffic_profile.get_traffic_definition.return_value = "64"
 229         mock_traffic_profile.params = self.TRAFFIC_PROFILE
 230         with mock.patch("yardstick.ssh.SSH") as ssh:
 231             ssh_mock = mock.Mock(autospec=ssh.SSH)
 232             ssh_mock.execute = \
 233                 mock.Mock(return_value=(0, "", ""))
 234             ssh_mock.run = \
 235                 mock.Mock(return_value=(0, "", ""))
 236             ssh.from_node.return_value = ssh_mock
 237             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 238             trex_traffic_gen = TrexTrafficGenRFC(vnfd)
 239             trex_traffic_gen._start_server = mock.Mock(return_value=0)
 240             scenario_cfg = {"tc": "tc_baremetal_rfc2544_ipv4_1flow_64B"}
 241             tg_rfc2544_trex.WAIT_TIME = 0
 242             self.assertIn(trex_traffic_gen.instantiate(scenario_cfg, {}), {0, None})
 243
 244     def test_instantiate_error(self):
 245         mock_traffic_profile = mock.Mock(autospec=TrafficProfile)
 246         mock_traffic_profile.get_traffic_definition.return_value = "64"
 247         mock_traffic_profile.params = self.TRAFFIC_PROFILE
 248         with mock.patch("yardstick.ssh.SSH") as ssh:
 249             ssh_mock = mock.Mock(autospec=ssh.SSH)
 250             ssh_mock.execute = \
 251                 mock.Mock(return_value=(1, "", ""))
 252             ssh_mock.run = \
 253                 mock.Mock(return_value=(0, "", ""))
 254             ssh.from_node.return_value = ssh_mock
 255             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 256             trex_traffic_gen = TrexTrafficGenRFC(vnfd)
 257             scenario_cfg = {"tc": "tc_baremetal_rfc2544_ipv4_1flow_64B"}
 258             tg_rfc2544_trex.WAIT_TIME = 0
 259             self.assertRaises(RuntimeError,
 260                               trex_traffic_gen.instantiate, scenario_cfg, {})
 261
 262     def test__get_rfc_tolerance(self):
 263         with mock.patch("yardstick.ssh.SSH") as ssh:
 264             ssh_mock = mock.Mock(autospec=ssh.SSH)
 265             ssh_mock.execute = \
 266                 mock.Mock(return_value=(0, "", ""))
 267             ssh_mock.run = \
 268                 mock.Mock(return_value=(0, "", ""))
 269             ssh.from_node.return_value = ssh_mock
 270             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 271             trex_traffic_gen = TrexTrafficGenRFC(vnfd)
 272             self.assertEqual([0.8, 1.0],
 273                              trex_traffic_gen._get_rfc_tolerance(self.TC_YAML))
 274             self.TC_YAML["scenarios"][0]["tc_options"]['rfc2544'][
 275                 'allowed_drop_rate'] = '0.8'
 276             self.assertEqual([0.8, 0.8],
 277                              trex_traffic_gen._get_rfc_tolerance(self.TC_YAML))
 278
 279     def test__start_server(self):
 280         with mock.patch("yardstick.ssh.SSH") as ssh:
 281             ssh_mock = mock.Mock(autospec=ssh.SSH)
 282             ssh_mock.execute = \
 283                 mock.Mock(return_value=(0, "", ""))
 284             ssh_mock.run = \
 285                 mock.Mock(return_value=(0, "", ""))
 286             ssh.from_node.return_value = ssh_mock
 287             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 288             trex_traffic_gen = TrexTrafficGenRFC(vnfd)
 289             self.assertEqual(None, trex_traffic_gen._start_server())
 290
 291     def _get_file_abspath(self, filename):
 292         curr_path = os.path.dirname(os.path.abspath(__file__))
 293         file_path = os.path.join(curr_path, filename)
 294         return file_path
 295
 296     @mock.patch("yardstick.network_services.vnf_generic.vnf.tg_rfc2544_trex.time")
 297     def test__traffic_runner(self, mock_time):
 298         mock_traffic_profile = mock.Mock(autospec=TrafficProfile)
 299         mock_traffic_profile.get_traffic_definition.return_value = "64"
 300         mock_traffic_profile.execute.return_value = "64"
 301         mock_traffic_profile.get_drop_percentage.return_value = "64"
 302         mock_traffic_profile.params = self.TRAFFIC_PROFILE
 303         with mock.patch("yardstick.ssh.SSH") as ssh:
 304             ssh_mock = mock.Mock(autospec=ssh.SSH)
 305             ssh_mock.execute = \
 306                 mock.Mock(return_value=(0, "", ""))
 307             ssh_mock.run = \
 308                 mock.Mock(return_value=(0, "", ""))
 309             ssh.from_node.return_value = ssh_mock
 310             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 311             self.sut = TrexTrafficGenRFC(vnfd)
 312             self.sut.connection = mock.Mock()
 313             self.sut.connection.run = mock.Mock()
 314             q = Queue()
 315             client_started = multiprocessing.Value('i', 1)
 316             self.sut._vpci_ascending = ["0000:05:00.0", "0000:05:00.1"]
 317             self.sut._connect_client = mock.Mock(autospec=STLClient)
 318             self.sut._connect_client.get_stats = mock.Mock(return_value="0")
 319             self.sut.tc_file_name = \
 320                 self._get_file_abspath(
 321                     "tc_baremetal_rfc2544_ipv4_1flow_64B.yaml")
 322             tg_rfc2544_trex.DURATION = 1
 323             tg_rfc2544_trex.WAIT_TIME = 0
 324             self.sut._traffic_runner(mock_traffic_profile, q, client_started,
 325                                      self.sut._terminated)
 326
 327     def test__split_mac_address_into_list(self):
 328         with mock.patch("yardstick.ssh.SSH") as ssh:
 329             ssh_mock = mock.Mock(autospec=ssh.SSH)
 330             ssh_mock.execute = \
 331                 mock.Mock(return_value=(0, "", ""))
 332             ssh.from_node.return_value = ssh_mock
 333             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 334             trex_traffic_gen = TrexTrafficGenRFC(vnfd)
 335             result = ['0x00', '0x00', '0x00', '0x00', '0x00', '0x01']
 336             self.assertEqual(result,
 337                              trex_traffic_gen._split_mac_address_into_list(
 338                                  "00:00:00:00:00:01"))
 339
 340     def test__generate_trex_cfg(self):
 341         with mock.patch("yardstick.ssh.SSH") as ssh:
 342             ssh_mock = mock.Mock(autospec=ssh.SSH)
 343             ssh_mock.execute = \
 344                 mock.Mock(return_value=(0, "", ""))
 345             ssh_mock.run = \
 346                 mock.Mock(return_value=(0, "", ""))
 347             ssh.from_node.return_value = ssh_mock
 348             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 349             trex_traffic_gen = TrexTrafficGenRFC(vnfd)
 350             tg_rfc2544_trex.WAIT_TIME = 0
 351             self.assertEqual(None, trex_traffic_gen._generate_trex_cfg(vnfd))
 352
 353     def test_run_traffic(self):
 354         mock_traffic_profile = mock.Mock(autospec=TrafficProfile)
 355         mock_traffic_profile.get_traffic_definition.return_value = "64"
 356         mock_traffic_profile.params = self.TRAFFIC_PROFILE
 357         with mock.patch("yardstick.ssh.SSH") as ssh:
 358             ssh_mock = mock.Mock(autospec=ssh.SSH)
 359             ssh_mock.execute = \
 360                 mock.Mock(return_value=(0, "", ""))
 361             ssh_mock.run = \
 362                 mock.Mock(return_value=(0, "", ""))
 363             ssh.from_node.return_value = ssh_mock
 364             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 365             self.sut = TrexTrafficGenRFC(vnfd)
 366             self.sut.connection = mock.Mock()
 367             self.sut.connection.run = mock.Mock()
 368             self.sut._traffic_runner = mock.Mock(return_value=0)
 369             client_started = multiprocessing.Value('i', 1)
 370             result = self.sut.run_traffic(mock_traffic_profile, client_started)
 371             self.sut._traffic_process.terminate()
 372             self.assertIsNotNone(result)
 373
 374     def test_scale(self):
 375         with mock.patch("yardstick.ssh.SSH") as ssh:
 376             ssh_mock = mock.Mock(autospec=ssh.SSH)
 377             ssh_mock.execute = \
 378                 mock.Mock(return_value=(0, "", ""))
 379             ssh_mock.run = \
 380                 mock.Mock(return_value=(0, "", ""))
 381             ssh.from_node.return_value = ssh_mock
 382             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 383             flavor = ""
 384             trex_traffic_gen = TrexTrafficGenRFC(vnfd)
 385             self.assertRaises(NotImplementedError,
 386                               trex_traffic_gen.scale, flavor)
 387
 388     def test_terminate(self):
 389         with mock.patch("yardstick.ssh.SSH") as ssh:
 390             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 391             ssh_mock = mock.Mock(autospec=ssh.SSH)
 392             ssh_mock.execute = \
 393                 mock.Mock(return_value=(0, "", ""))
 394             ssh.from_node.return_value = ssh_mock
 395             trex_traffic_gen = TrexTrafficGenRFC(vnfd)
 396             self.assertEqual(None, trex_traffic_gen.terminate())
 397
 398     def test__connect_client(self):
 399         with mock.patch("yardstick.ssh.SSH") as ssh:
 400             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 401             ssh_mock = mock.Mock(autospec=ssh.SSH)
 402             ssh_mock.execute = \
 403                 mock.Mock(return_value=(0, "", ""))
 404             ssh.from_node.return_value = ssh_mock
 405             trex_traffic_gen = TrexTrafficGenRFC(vnfd)
 406             client = mock.Mock(autospec=STLClient)
 407             client.connect = mock.Mock(return_value=0)
 408             self.assertIsNotNone(trex_traffic_gen._connect_client(client))