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