tests/unit/network_services/vnf_generic/vnf/test_tg_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 multiprocessing
  22 from multiprocessing import Queue
  23
  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_trex import \
  91         TrexTrafficGen
  92     from yardstick.network_services.traffic_profile.base import TrafficProfile
  93
  94
  95 class TestTrexTrafficGen(unittest.TestCase):
  96     VNFD = {'vnfd:vnfd-catalog':
  97             {'vnfd':
  98              [{'short-name': 'VpeVnf',
  99                'vdu':
 100                [{'routing_table':
 101                  [{'network': '152.16.100.20',
 102                    'netmask': '255.255.255.0',
 103                    'gateway': '152.16.100.20',
 104                    'if': 'xe0'},
 105                   {'network': '152.16.40.20',
 106                    'netmask': '255.255.255.0',
 107                    'gateway': '152.16.40.20',
 108                    'if': 'xe1'}],
 109                  'description': 'VPE approximation using DPDK',
 110                  'name': 'vpevnf-baremetal',
 111                  'nd_route_tbl':
 112                  [{'network': '0064:ff9b:0:0:0:0:9810:6414',
 113                    'netmask': '112',
 114                    'gateway': '0064:ff9b:0:0:0:0:9810:6414',
 115                    'if': 'xe0'},
 116                   {'network': '0064:ff9b:0:0:0:0:9810:2814',
 117                    'netmask': '112',
 118                    'gateway': '0064:ff9b:0:0:0:0:9810:2814',
 119                    'if': 'xe1'}],
 120                  'id': 'vpevnf-baremetal',
 121                  'external-interface':
 122                  [{'virtual-interface':
 123                    {'dst_mac': '00:00:00:00:00:04',
 124                     'vpci': '0000:05:00.0',
 125                     'local_ip': '152.16.100.19',
 126                     'type': 'PCI-PASSTHROUGH',
 127                     'netmask': '255.255.255.0',
 128                     'dpdk_port_num': '0',
 129                     'bandwidth': '10 Gbps',
 130                     'driver': "i40e",
 131                     'dst_ip': '152.16.100.20',
 132                     'local_iface_name': 'xe0',
 133                     'local_mac': '00:00:00:00:00:02'},
 134                    'vnfd-connection-point-ref': 'xe0',
 135                    'name': 'xe0'},
 136                   {'virtual-interface':
 137                    {'dst_mac': '00:00:00:00:00:03',
 138                     'vpci': '0000:05:00.1',
 139                     'local_ip': '152.16.40.19',
 140                     'type': 'PCI-PASSTHROUGH',
 141                     'driver': "i40e",
 142                     'netmask': '255.255.255.0',
 143                     'dpdk_port_num': '1',
 144                     'bandwidth': '10 Gbps',
 145                     'dst_ip': '152.16.40.20',
 146                     'local_iface_name': 'xe1',
 147                     'local_mac': '00:00:00:00:00:01'},
 148                    'vnfd-connection-point-ref': 'xe1',
 149                    'name': 'xe1'}]}],
 150                'description': 'Vpe approximation using DPDK',
 151                'mgmt-interface':
 152                    {'vdu-id': 'vpevnf-baremetal',
 153                     'host': '1.1.1.1',
 154                     'password': 'r00t',
 155                     'user': 'root',
 156                     'ip': '1.1.1.1'},
 157                'benchmark':
 158                    {'kpi': ['packets_in', 'packets_fwd', 'packets_dropped']},
 159                'connection-point': [{'type': 'VPORT', 'name': 'xe0'},
 160                                     {'type': 'VPORT', 'name': 'xe1'}],
 161                'id': 'VpeApproxVnf', 'name': 'VPEVnfSsh'}]}}
 162
 163     TRAFFIC_PROFILE = {
 164         "schema": "isb:traffic_profile:0.1",
 165         "name": "fixed",
 166         "description": "Fixed traffic profile to run UDP traffic",
 167         "traffic_profile": {
 168             "traffic_type": "FixedTraffic",
 169             "frame_rate": 100,  # pps
 170             "flow_number": 10,
 171             "frame_size": 64}}
 172
 173     def test___init__(self):
 174         with mock.patch("yardstick.ssh.SSH") as ssh:
 175             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 176             ssh_mock = mock.Mock(autospec=ssh.SSH)
 177             ssh_mock.execute = \
 178                 mock.Mock(return_value=(0, "", ""))
 179             ssh.from_node.return_value = ssh_mock
 180             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 181             trex_traffic_gen = TrexTrafficGen(vnfd)
 182             self.assertIsNotNone(trex_traffic_gen._terminated)
 183
 184     def test_collect_kpi(self):
 185         with mock.patch("yardstick.ssh.SSH") as ssh:
 186             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 187             ssh_mock = mock.Mock(autospec=ssh.SSH)
 188             ssh_mock.execute = \
 189                 mock.Mock(return_value=(0, "", ""))
 190             ssh.from_node.return_value = ssh_mock
 191             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 192             trex_traffic_gen = TrexTrafficGen(vnfd)
 193             trex_traffic_gen._queue.put({})
 194             restult = trex_traffic_gen.collect_kpi()
 195             self.assertEqual({}, restult)
 196
 197     def test_listen_traffic(self):
 198         with mock.patch("yardstick.ssh.SSH") as ssh:
 199             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 200             ssh_mock = mock.Mock(autospec=ssh.SSH)
 201             ssh_mock.execute = \
 202                 mock.Mock(return_value=(0, "", ""))
 203             ssh.from_node.return_value = ssh_mock
 204             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 205             trex_traffic_gen = TrexTrafficGen(vnfd)
 206             self.assertEqual(None, trex_traffic_gen.listen_traffic({}))
 207
 208     @mock.patch("yardstick.network_services.vnf_generic.vnf.tg_trex.time")
 209     def test_instantiate(self, mock_time):
 210         mock_traffic_profile = mock.Mock(autospec=TrafficProfile)
 211         mock_traffic_profile.get_traffic_definition.return_value = "64"
 212         mock_traffic_profile.params = self.TRAFFIC_PROFILE
 213         with mock.patch("yardstick.ssh.SSH") as ssh:
 214             ssh_mock = mock.Mock(autospec=ssh.SSH)
 215             ssh_mock.execute = \
 216                 mock.Mock(return_value=(0, "", ""))
 217             ssh_mock.run = \
 218                 mock.Mock(return_value=(0, "", ""))
 219             ssh.from_node.return_value = ssh_mock
 220             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 221             trex_traffic_gen = TrexTrafficGen(vnfd)
 222             self.assertIn(trex_traffic_gen.instantiate({}, {}), {0, None})
 223
 224     @mock.patch("yardstick.network_services.vnf_generic.vnf.tg_trex.time")
 225     def test_instantiate_error(self, mock_time):
 226         mock_traffic_profile = mock.Mock(autospec=TrafficProfile)
 227         mock_traffic_profile.get_traffic_definition.return_value = "64"
 228         mock_traffic_profile.params = self.TRAFFIC_PROFILE
 229         with mock.patch("yardstick.ssh.SSH") as ssh:
 230             ssh_mock = mock.Mock(autospec=ssh.SSH)
 231             ssh_mock.execute = \
 232                 mock.Mock(return_value=(1, "", ""))
 233             ssh_mock.run = \
 234                 mock.Mock(return_value=(0, "", ""))
 235             ssh.from_node.return_value = ssh_mock
 236             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 237             trex_traffic_gen = TrexTrafficGen(vnfd)
 238             self.assertRaises(RuntimeError,
 239                               trex_traffic_gen.instantiate, {}, {})
 240
 241     def test__start_server(self):
 242         with mock.patch("yardstick.ssh.SSH") as ssh:
 243             ssh_mock = mock.Mock(autospec=ssh.SSH)
 244             ssh_mock.execute = \
 245                 mock.Mock(return_value=(0, "", ""))
 246             ssh_mock.run = \
 247                 mock.Mock(return_value=(0, "", ""))
 248             ssh.from_node.return_value = ssh_mock
 249             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 250             trex_traffic_gen = TrexTrafficGen(vnfd)
 251             self.assertEqual(None, trex_traffic_gen._start_server())
 252
 253     @mock.patch("yardstick.network_services.vnf_generic.vnf.tg_trex.time")
 254     def test__traffic_runner(self, mock_time):
 255         mock_traffic_profile = mock.Mock(autospec=TrafficProfile)
 256         mock_traffic_profile.get_traffic_definition.return_value = "64"
 257         mock_traffic_profile.execute.return_value = "64"
 258         mock_traffic_profile.params = self.TRAFFIC_PROFILE
 259         with mock.patch("yardstick.ssh.SSH") as ssh:
 260             ssh_mock = mock.Mock(autospec=ssh.SSH)
 261             ssh_mock.execute = \
 262                 mock.Mock(return_value=(0, "", ""))
 263             ssh_mock.run = \
 264                 mock.Mock(return_value=(0, "", ""))
 265             ssh.from_node.return_value = ssh_mock
 266             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 267             self.sut = TrexTrafficGen(vnfd)
 268             self.sut.connection = mock.Mock()
 269             self.sut.connection.run = mock.Mock()
 270             q = Queue()
 271             client_started = multiprocessing.Value('i', 1)
 272             self.sut._vpci_ascending = ["0000:05:00.0", "0000:05:00.1"]
 273             self.sut._connect_client = mock.Mock(autospec=STLClient)
 274             self.sut._connect_client.get_stats = mock.Mock(return_value="0")
 275             self.sut._traffic_runner(mock_traffic_profile, q, client_started,
 276                                      self.sut._terminated)
 277
 278     def test__generate_trex_cfg(self):
 279         with mock.patch("yardstick.ssh.SSH") as ssh:
 280             ssh_mock = mock.Mock(autospec=ssh.SSH)
 281             ssh_mock.execute = \
 282                 mock.Mock(return_value=(0, "", ""))
 283             ssh_mock.run = \
 284                 mock.Mock(return_value=(0, "", ""))
 285             ssh.from_node.return_value = ssh_mock
 286             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 287             trex_traffic_gen = TrexTrafficGen(vnfd)
 288             self.assertEqual(None, trex_traffic_gen._generate_trex_cfg(vnfd))
 289
 290     def test__split_mac_address_into_list(self):
 291         with mock.patch("yardstick.ssh.SSH") as ssh:
 292             ssh_mock = mock.Mock(autospec=ssh.SSH)
 293             ssh_mock.execute = \
 294                 mock.Mock(return_value=(0, "", ""))
 295             ssh_mock.run = \
 296                 mock.Mock(return_value=(0, "", ""))
 297             ssh.from_node.return_value = ssh_mock
 298             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 299             trex_traffic_gen = TrexTrafficGen(vnfd)
 300             result = ['0x00', '0x00', '0x00', '0x00', '0x00', '0x01']
 301             self.assertEqual(
 302                 result, trex_traffic_gen._split_mac_address_into_list(
 303                     "00:00:00:00:00:01"))
 304
 305     def test_run_traffic(self):
 306         mock_traffic_profile = mock.Mock(autospec=TrafficProfile)
 307         mock_traffic_profile.get_traffic_definition.return_value = "64"
 308         mock_traffic_profile.params = self.TRAFFIC_PROFILE
 309         with mock.patch("yardstick.ssh.SSH") as ssh:
 310             ssh_mock = mock.Mock(autospec=ssh.SSH)
 311             ssh_mock.execute = \
 312                 mock.Mock(return_value=(0, "", ""))
 313             ssh_mock.run = \
 314                 mock.Mock(return_value=(0, "", ""))
 315             ssh.from_node.return_value = ssh_mock
 316             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 317             self.sut = TrexTrafficGen(vnfd)
 318             self.sut.connection = mock.Mock()
 319             self.sut.connection.run = mock.Mock()
 320             self.sut._traffic_runner = mock.Mock(return_value=0)
 321             self.sut.client_started.value = 1
 322             result = self.sut.run_traffic(mock_traffic_profile)
 323             self.sut._traffic_process.terminate()
 324             self.assertIsNotNone(result)
 325
 326     def test_scale(self):
 327         with mock.patch("yardstick.ssh.SSH") as ssh:
 328             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 329             ssh_mock = mock.Mock(autospec=ssh.SSH)
 330             ssh_mock.execute = \
 331                 mock.Mock(return_value=(1, "", ""))
 332             ssh.from_node.return_value = ssh_mock
 333             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 334             flavor = ""
 335             trex_traffic_gen = TrexTrafficGen(vnfd)
 336             self.assertRaises(NotImplementedError,
 337                               trex_traffic_gen.scale, flavor)
 338
 339     def test_setup_vnf_environment(self):
 340         with mock.patch("yardstick.ssh.SSH") as ssh:
 341             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 342             ssh_mock = mock.Mock(autospec=ssh.SSH)
 343             ssh_mock.execute = \
 344                 mock.Mock(return_value=(1, "", ""))
 345             ssh.from_node.return_value = ssh_mock
 346             trex_traffic_gen = TrexTrafficGen(vnfd)
 347             self.assertEqual(
 348                 None, trex_traffic_gen.setup_vnf_environment(ssh_mock))
 349
 350     def test_terminate(self):
 351         with mock.patch("yardstick.ssh.SSH") as ssh:
 352             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 353             ssh_mock = mock.Mock(autospec=ssh.SSH)
 354             ssh_mock.execute = \
 355                 mock.Mock(return_value=(0, "", ""))
 356             ssh.from_node.return_value = ssh_mock
 357             trex_traffic_gen = TrexTrafficGen(vnfd)
 358             self.assertEqual(None, trex_traffic_gen.terminate())
 359
 360     def test__connect_client(self):
 361         with mock.patch("yardstick.ssh.SSH") as ssh:
 362             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 363             ssh_mock = mock.Mock(autospec=ssh.SSH)
 364             ssh_mock.execute = \
 365                 mock.Mock(return_value=(0, "", ""))
 366             ssh.from_node.return_value = ssh_mock
 367             vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 368             trex_traffic_gen = TrexTrafficGen(vnfd)
 369             client = mock.Mock(autospec=STLClient)
 370             client.connect = mock.Mock(return_value=0)
 371             self.assertIsNotNone(trex_traffic_gen._connect_client(client))