tests/unit/network_services/vnf_generic/vnf/test_cgnapt_vnf.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
  20 import os
  21 import unittest
  22 import mock
  23
  24 from copy import deepcopy
  25
  26 from tests.unit import STL_MOCKS
  27 from tests.unit.network_services.vnf_generic.vnf.test_base import mock_ssh
  28
  29
  30 STLClient = mock.MagicMock()
  31 stl_patch = mock.patch.dict("sys.modules", STL_MOCKS)
  32 stl_patch.start()
  33
  34 if stl_patch:
  35     from yardstick.network_services.vnf_generic.vnf.cgnapt_vnf import CgnaptApproxVnf, \
  36         CgnaptApproxSetupEnvHelper
  37     from yardstick.network_services.vnf_generic.vnf import cgnapt_vnf
  38     from yardstick.network_services.nfvi.resource import ResourceProfile
  39
  40 TEST_FILE_YAML = 'nsb_test_case.yaml'
  41 SSH_HELPER = 'yardstick.network_services.vnf_generic.vnf.sample_vnf.VnfSshHelper'
  42
  43
  44 name = 'vnf__0'
  45
  46
  47 class TestCgnaptApproxSetupEnvHelper(unittest.TestCase):
  48
  49     def test__generate_ip_from_pool(self):
  50
  51         ip = CgnaptApproxSetupEnvHelper._generate_ip_from_pool("1.2.3.4")
  52         self.assertEqual(next(ip), '1.2.3.4')
  53         self.assertEqual(next(ip), '1.2.4.4')
  54         self.assertEqual(next(ip), '1.2.5.4')
  55
  56     def test__update_cgnat_script_file(self):
  57
  58         sample = """\
  59 # See the License for the specific language governing permissions and
  60 # limitations under the License.
  61
  62 link 0 down
  63 link 0 config {port0_local_ip} {port0_prefixlen}
  64 link 0 up
  65 link 1 down
  66 link 1 config {port1_local_ip} {port1_prefixlen}
  67 link 1 up
  68 """
  69         header = "This is a header"
  70
  71         out = CgnaptApproxSetupEnvHelper._update_cgnat_script_file(header, sample.splitlines())
  72         self.assertNotIn("This is a header", out)
  73
  74     def test__get_cgnapt_config(self):
  75         vnfd_helper = mock.MagicMock()
  76         vnfd_helper.port_pairs.uplink_ports = [{"name": 'a'}, {"name": "b"}, {"name": "c"}]
  77
  78         helper = CgnaptApproxSetupEnvHelper(vnfd_helper, mock.Mock(), mock.Mock())
  79         result = helper._get_cgnapt_config()
  80         self.assertIsNotNone(result)
  81
  82     def test_scale(self):
  83         helper = CgnaptApproxSetupEnvHelper(mock.Mock(), mock.Mock(), mock.Mock())
  84         with self.assertRaises(NotImplementedError):
  85             helper.scale()
  86
  87
  88 @mock.patch("yardstick.network_services.vnf_generic.vnf.sample_vnf.Process")
  89 class TestCgnaptApproxVnf(unittest.TestCase):
  90     VNFD = {'vnfd:vnfd-catalog':
  91             {'vnfd':
  92              [{'short-name': 'VpeVnf',
  93                'vdu':
  94                [{'routing_table':
  95                  [{'network': '152.16.100.20',
  96                    'netmask': '255.255.255.0',
  97                    'gateway': '152.16.100.20',
  98                    'if': 'xe0'},
  99                   {'network': '152.16.40.20',
 100                    'netmask': '255.255.255.0',
 101                    'gateway': '152.16.40.20',
 102                    'if': 'xe1'}],
 103                  'description': 'VPE approximation using DPDK',
 104                  'name': 'vpevnf-baremetal',
 105                  'nd_route_tbl':
 106                  [{'network': '0064:ff9b:0:0:0:0:9810:6414',
 107                    'netmask': '112',
 108                    'gateway': '0064:ff9b:0:0:0:0:9810:6414',
 109                    'if': 'xe0'},
 110                   {'network': '0064:ff9b:0:0:0:0:9810:2814',
 111                    'netmask': '112',
 112                    'gateway': '0064:ff9b:0:0:0:0:9810:2814',
 113                    'if': 'xe1'}],
 114                  'id': 'vpevnf-baremetal',
 115                  'external-interface':
 116                  [{'virtual-interface':
 117                    {'dst_mac': '00:00:00:00:00:04',
 118                     'vpci': '0000:05:00.0',
 119                     'local_ip': '152.16.100.19',
 120                     'type': 'PCI-PASSTHROUGH',
 121                     'netmask': '255.255.255.0',
 122                     'dpdk_port_num': 0,
 123                     'bandwidth': '10 Gbps',
 124                     'driver': "i40e",
 125                     'dst_ip': '152.16.100.20',
 126                     'local_iface_name': 'xe0',
 127                     'local_mac': '00:00:00:00:00:02'},
 128                    'vnfd-connection-point-ref': 'xe0',
 129                    'name': 'xe0'},
 130                   {'virtual-interface':
 131                    {'dst_mac': '00:00:00:00:00:03',
 132                     'vpci': '0000:05:00.1',
 133                     'local_ip': '152.16.40.19',
 134                     'type': 'PCI-PASSTHROUGH',
 135                     'driver': "i40e",
 136                     'netmask': '255.255.255.0',
 137                     'dpdk_port_num': 1,
 138                     'bandwidth': '10 Gbps',
 139                     'dst_ip': '152.16.40.20',
 140                     'local_iface_name': 'xe1',
 141                     'local_mac': '00:00:00:00:00:01'},
 142                    'vnfd-connection-point-ref': 'xe1',
 143                    'name': 'xe1'}]}],
 144                'description': 'Vpe approximation using DPDK',
 145                'mgmt-interface':
 146                    {'vdu-id': 'vpevnf-baremetal',
 147                     'host': '1.2.1.1',
 148                     'password': 'r00t',
 149                     'user': 'root',
 150                     'ip': '1.2.1.1'},
 151                'benchmark':
 152                    {'kpi': ['packets_in', 'packets_fwd', 'packets_dropped']},
 153                'connection-point': [{'type': 'VPORT', 'name': 'xe0'},
 154                                     {'type': 'VPORT', 'name': 'xe1'}],
 155                'id': 'CgnaptApproxVnf', 'name': 'VPEVnfSsh'}]}}
 156
 157     SCENARIO_CFG = {
 158         'options': {
 159             'packetsize': 64,
 160             'traffic_type': 4,
 161             'rfc2544': {
 162                 'allowed_drop_rate': '0.8 - 1',
 163             },
 164             'vnf__0': {
 165                 'napt': 'dynamic',
 166                 'vnf_config': {
 167                     'lb_config': 'SW',
 168                     'lb_count': 1,
 169                     'worker_config':
 170                     '1C/1T',
 171                     'worker_threads': 1,
 172                 },
 173             },
 174             'flow': {'count': 1,
 175                      'dst_ip': [{'tg__1': 'xe0'}],
 176                      'public_ip': [''],
 177                      'src_ip': [{'tg__0': 'xe0'}]},
 178         },
 179         'task_id': 'a70bdf4a-8e67-47a3-9dc1-273c14506eb7',
 180         'task_path': '/tmp',
 181         'tc': 'tc_ipv4_1Mflow_64B_packetsize',
 182         'runner': {
 183             'object': 'NetworkServiceTestCase',
 184             'interval': 35,
 185             'output_filename': '/tmp/yardstick.out',
 186             'runner_id': 74476,
 187             'duration': 400,
 188             'type': 'Duration',
 189         },
 190         'traffic_profile': 'ipv4_throughput_acl.yaml',
 191         'type': 'NSPerf',
 192         'nodes': {
 193             'tg__1': 'trafficgen_1.yardstick',
 194             'tg__0': 'trafficgen_0.yardstick',
 195             'vnf__0': 'vnf.yardstick',
 196         },
 197         'topology': 'vpe-tg-topology-baremetal.yaml',
 198     }
 199
 200     context_cfg = {'nodes': {'tg__2':
 201                              {'member-vnf-index': '3',
 202                               'role': 'TrafficGen',
 203                               'name': 'trafficgen_2.yardstick',
 204                               'vnfd-id-ref': 'tg__2',
 205                               'ip': '1.2.1.1',
 206                               'interfaces':
 207                               {'xe0': {'local_iface_name': 'ens513f0',
 208                                        'vld_id': CgnaptApproxVnf.DOWNLINK,
 209                                        'netmask': '255.255.255.0',
 210                                        'local_ip': '152.16.40.20',
 211                                        'dst_mac': '00:00:00:00:00:01',
 212                                        'local_mac': '00:00:00:00:00:03',
 213                                        'dst_ip': '152.16.40.19',
 214                                        'driver': 'ixgbe',
 215                                        'vpci': '0000:02:00.0',
 216                                        'dpdk_port_num': 0},
 217                                'xe1': {'local_iface_name': 'ens513f1',
 218                                        'netmask': '255.255.255.0',
 219                                        'network': '202.16.100.0',
 220                                        'local_ip': '202.16.100.20',
 221                                        'local_mac': '00:1e:67:d0:60:5d',
 222                                        'driver': 'ixgbe',
 223                                        'vpci': '0000:02:00.1',
 224                                        'dpdk_port_num': 1}},
 225                               'password': 'r00t',
 226                               'VNF model': 'l3fwd_vnf.yaml',
 227                               'user': 'root'},
 228                              'tg__1':
 229                              {'member-vnf-index': '1',
 230                               'role': 'TrafficGen',
 231                               'name': 'trafficgen_1.yardstick',
 232                               'vnfd-id-ref': 'tg__1',
 233                               'ip': '1.2.1.1',
 234                               'interfaces':
 235                               {'xe0': {'local_iface_name': 'ens785f0',
 236                                        'vld_id': CgnaptApproxVnf.UPLINK,
 237                                        'netmask': '255.255.255.0',
 238                                        'local_ip': '152.16.100.20',
 239                                        'dst_mac': '00:00:00:00:00:02',
 240                                        'local_mac': '00:00:00:00:00:04',
 241                                        'dst_ip': '152.16.100.19',
 242                                        'driver': 'i40e',
 243                                        'vpci': '0000:05:00.0',
 244                                        'dpdk_port_num': 0},
 245                                'xe1': {'local_iface_name': 'ens785f1',
 246                                        'netmask': '255.255.255.0',
 247                                        'local_ip': '152.16.100.21',
 248                                        'local_mac': '00:00:00:00:00:01',
 249                                        'driver': 'i40e',
 250                                        'vpci': '0000:05:00.1',
 251                                        'dpdk_port_num': 1}},
 252                               'password': 'r00t',
 253                               'VNF model': 'tg_rfc2544_tpl.yaml',
 254                               'user': 'root'},
 255                              'vnf__0':
 256                              {'name': 'vnf.yardstick',
 257                               'vnfd-id-ref': 'vnf__0',
 258                               'ip': '1.2.1.1',
 259                               'interfaces':
 260                               {'xe0': {'local_iface_name': 'ens786f0',
 261                                        'vld_id': CgnaptApproxVnf.UPLINK,
 262                                        'netmask': '255.255.255.0',
 263                                        'local_ip': '152.16.100.19',
 264                                        'dst_mac': '00:00:00:00:00:04',
 265                                        'local_mac': '00:00:00:00:00:02',
 266                                        'dst_ip': '152.16.100.20',
 267                                        'driver': 'i40e',
 268                                        'vpci': '0000:05:00.0',
 269                                        'dpdk_port_num': 0},
 270                                'xe1': {'local_iface_name': 'ens786f1',
 271                                        'vld_id': CgnaptApproxVnf.DOWNLINK,
 272                                        'netmask': '255.255.255.0',
 273                                        'local_ip': '152.16.40.19',
 274                                        'dst_mac': '00:00:00:00:00:03',
 275                                        'local_mac': '00:00:00:00:00:01',
 276                                        'dst_ip': '152.16.40.20',
 277                                        'driver': 'i40e',
 278                                        'vpci': '0000:05:00.1',
 279                                        'dpdk_port_num': 1}},
 280                               'routing_table':
 281                               [{'netmask': '255.255.255.0',
 282                                 'gateway': '152.16.100.20',
 283                                 'network': '152.16.100.20',
 284                                 'if': 'xe0'},
 285                                {'netmask': '255.255.255.0',
 286                                 'gateway': '152.16.40.20',
 287                                 'network': '152.16.40.20',
 288                                 'if': 'xe1'}],
 289                               'member-vnf-index': '2',
 290                               'host': '1.2.1.1',
 291                               'role': 'vnf',
 292                               'user': 'root',
 293                               'nd_route_tbl':
 294                               [{'netmask': '112',
 295                                 'gateway': '0064:ff9b:0:0:0:0:9810:6414',
 296                                 'network': '0064:ff9b:0:0:0:0:9810:6414',
 297                                 'if': 'xe0'},
 298                                {'netmask': '112',
 299                                 'gateway': '0064:ff9b:0:0:0:0:9810:2814',
 300                                 'network': '0064:ff9b:0:0:0:0:9810:2814',
 301                                 'if': 'xe1'}],
 302                               'password': 'r00t',
 303                               'VNF model': 'cgnapt_vnf.yaml'}}}
 304
 305     def setUp(self):
 306         self.scenario_cfg = deepcopy(self.SCENARIO_CFG)
 307
 308     def test___init__(self, mock_process):
 309         vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 310         cgnapt_approx_vnf = CgnaptApproxVnf(name, vnfd)
 311         self.assertIsNone(cgnapt_approx_vnf._vnf_process)
 312
 313     @mock.patch('yardstick.network_services.vnf_generic.vnf.sample_vnf.time')
 314     @mock.patch(SSH_HELPER)
 315     def test_collect_kpi(self, ssh, mock_time, mock_process):
 316         mock_ssh(ssh)
 317
 318         vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 319         cgnapt_approx_vnf = CgnaptApproxVnf(name, vnfd)
 320         cgnapt_approx_vnf._vnf_process = mock.MagicMock(
 321             **{"is_alive.return_value": True, "exitcode": None})
 322         cgnapt_approx_vnf.q_in = mock.MagicMock()
 323         cgnapt_approx_vnf.q_out = mock.MagicMock()
 324         cgnapt_approx_vnf.q_out.qsize = mock.Mock(return_value=0)
 325         cgnapt_approx_vnf.resource = mock.Mock(autospec=ResourceProfile)
 326         result = {'packets_dropped': 0, 'packets_fwd': 0, 'packets_in': 0}
 327         self.assertEqual(result, cgnapt_approx_vnf.collect_kpi())
 328
 329     @mock.patch('yardstick.network_services.vnf_generic.vnf.sample_vnf.time')
 330     @mock.patch(SSH_HELPER)
 331     def test_vnf_execute_command(self, ssh, mock_time, mock_process):
 332         mock_ssh(ssh)
 333
 334         vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 335         cgnapt_approx_vnf = CgnaptApproxVnf(name, vnfd)
 336         cgnapt_approx_vnf.q_in = mock.MagicMock()
 337         cgnapt_approx_vnf.q_out = mock.MagicMock()
 338         cgnapt_approx_vnf.q_out.qsize = mock.Mock(return_value=0)
 339         cmd = "quit"
 340         self.assertEqual("", cgnapt_approx_vnf.vnf_execute(cmd))
 341
 342     @mock.patch(SSH_HELPER)
 343     def test_get_stats(self, ssh, mock_process):
 344         mock_ssh(ssh)
 345
 346         vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 347         cgnapt_approx_vnf = CgnaptApproxVnf(name, vnfd)
 348         cgnapt_approx_vnf.q_in = mock.MagicMock()
 349         cgnapt_approx_vnf.q_out = mock.MagicMock()
 350         cgnapt_approx_vnf.q_out.qsize = mock.Mock(return_value=0)
 351         result = \
 352             "CG-NAPT(.*\n)*Received 100, Missed 0, Dropped 0,Translated 100,ingress"
 353         cgnapt_approx_vnf.vnf_execute = mock.Mock(return_value=result)
 354         self.assertListEqual(list(result), list(cgnapt_approx_vnf.get_stats()))
 355
 356     def _get_file_abspath(self, filename):
 357         curr_path = os.path.dirname(os.path.abspath(__file__))
 358         file_path = os.path.join(curr_path, filename)
 359         return file_path
 360
 361     @mock.patch("yardstick.network_services.vnf_generic.vnf.cgnapt_vnf.hex")
 362     @mock.patch("yardstick.network_services.vnf_generic.vnf.cgnapt_vnf.eval")
 363     @mock.patch('yardstick.network_services.vnf_generic.vnf.cgnapt_vnf.open')
 364     @mock.patch(SSH_HELPER)
 365     def test_run_vcgnapt(self, ssh, mock_hex, mock_eval, mock_open, mock_process):
 366         mock_ssh(ssh)
 367
 368         vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 369         cgnapt_approx_vnf = CgnaptApproxVnf(name, vnfd)
 370         cgnapt_approx_vnf._build_config = mock.MagicMock()
 371         cgnapt_approx_vnf.queue_wrapper = mock.MagicMock()
 372         cgnapt_approx_vnf.ssh_helper = mock.MagicMock()
 373         cgnapt_approx_vnf.ssh_helper.run = mock.MagicMock()
 374         cgnapt_approx_vnf.scenario_helper.scenario_cfg = self.scenario_cfg
 375         cgnapt_approx_vnf._run()
 376         cgnapt_approx_vnf.ssh_helper.run.assert_called_once()
 377
 378     @mock.patch("yardstick.network_services.vnf_generic.vnf.sample_vnf.Context")
 379     @mock.patch(SSH_HELPER)
 380     def test_instantiate(self, ssh, mock_context, mock_process):
 381         mock_ssh(ssh)
 382
 383         vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 384         cgnapt_approx_vnf = CgnaptApproxVnf(name, vnfd)
 385         cgnapt_approx_vnf.deploy_helper = mock.MagicMock()
 386         cgnapt_approx_vnf.resource_helper = mock.MagicMock()
 387         cgnapt_approx_vnf._build_config = mock.MagicMock()
 388         self.scenario_cfg['vnf_options'] = {'acl': {'cfg': "",
 389                                                     'rules': ""}}
 390         cgnapt_approx_vnf.q_out.put("pipeline>")
 391         cgnapt_vnf.WAIT_TIME = 3
 392         self.scenario_cfg.update({"nodes": {"vnf__0": ""}})
 393         self.assertIsNone(cgnapt_approx_vnf.instantiate(self.scenario_cfg,
 394                                                         self.context_cfg))
 395
 396     def test_scale(self, mock_process):
 397         vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 398         cgnapt_approx_vnf = CgnaptApproxVnf(name, vnfd)
 399         flavor = ""
 400         self.assertRaises(NotImplementedError, cgnapt_approx_vnf.scale, flavor)
 401
 402     @mock.patch("yardstick.network_services.vnf_generic.vnf.sample_vnf.time")
 403     @mock.patch(SSH_HELPER)
 404     def test_terminate(self, ssh, mock_time, mock_process):
 405         mock_ssh(ssh)
 406
 407         vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 408         cgnapt_approx_vnf = CgnaptApproxVnf(name, vnfd)
 409         cgnapt_approx_vnf._vnf_process = mock.MagicMock()
 410         cgnapt_approx_vnf._vnf_process.terminate = mock.Mock()
 411         cgnapt_approx_vnf.used_drivers = {"01:01.0": "i40e",
 412                                           "01:01.1": "i40e"}
 413         cgnapt_approx_vnf.vnf_execute = mock.MagicMock()
 414         cgnapt_approx_vnf.dpdk_nic_bind = "dpdk_nic_bind.py"
 415         cgnapt_approx_vnf._resource_collect_stop = mock.Mock()
 416         self.assertEqual(None, cgnapt_approx_vnf.terminate())
 417
 418     @mock.patch("yardstick.network_services.vnf_generic.vnf.sample_vnf.time")
 419     @mock.patch(SSH_HELPER)
 420     def test__vnf_up_post(self, ssh, mock_time, mock_process):
 421         mock_ssh(ssh)
 422
 423         vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 424         self.scenario_cfg['options'][name]['napt'] = 'static'
 425
 426         cgnapt_approx_vnf = CgnaptApproxVnf(name, vnfd)
 427         cgnapt_approx_vnf._vnf_process = mock.MagicMock()
 428         cgnapt_approx_vnf._vnf_process.terminate = mock.Mock()
 429         cgnapt_approx_vnf.vnf_execute = mock.MagicMock()
 430         cgnapt_approx_vnf.scenario_helper.scenario_cfg = self.scenario_cfg
 431         cgnapt_approx_vnf._resource_collect_stop = mock.Mock()
 432         cgnapt_approx_vnf._vnf_up_post()
 433
 434     @mock.patch("yardstick.network_services.vnf_generic.vnf.sample_vnf.time")
 435     @mock.patch(SSH_HELPER)
 436     def test__vnf_up_post_short(self, ssh, mock_time, mock_process):
 437         mock_ssh(ssh)
 438
 439         vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
 440         cgnapt_approx_vnf = CgnaptApproxVnf(name, vnfd)
 441         cgnapt_approx_vnf._vnf_process = mock.MagicMock()
 442         cgnapt_approx_vnf._vnf_process.terminate = mock.Mock()
 443         cgnapt_approx_vnf.vnf_execute = mock.MagicMock()
 444         cgnapt_approx_vnf.scenario_helper.scenario_cfg = self.scenario_cfg
 445         cgnapt_approx_vnf._resource_collect_stop = mock.Mock()
 446         cgnapt_approx_vnf._vnf_up_post()
 447
 448
 449 if __name__ == '__main__':
 450     unittest.main()