Add arguments to the traffic profile render

In order to render configurable traffic profiles in NSB test cases,
a new variable is introduced: "extra_arg". The content of
this variable is added to the VNFD render data, under a key called
"extra_args".

This will allow the user to define Jinja templates for traffic profiles.

E.g.:

  $ cat test_case_definition.yml
  scenarios:
  - type: NSPerf
    traffic_profile: traffic_profile.yml
    extra_args:
      vports: 10

  $ cat traffic_profile.yml
  {% set vports = get(extra_args, 'vports', '0') or 4 %}
  {% for vport in range(vports|int) %}
  uplink_{{vport}}:
    data...
  {% endfor %}

JIRA: YARDSTICK-946

Change-Id: Ib3c1f2d89efa012772edf2156e97d5f4742a6b80
Signed-off-by: Rodolfo Alonso Hernandez <rodolfo.alonso.hernandez@intel.com>

1 files changed, 49 insertions, 28 deletions

diff --git a/yardstick/tests/unit/benchmark/scenarios/networking/test_vnf_generic.py b/yardstick/tests/unit/benchmark/scenarios/networking/test_vnf_generic.py
index 846de13de..022e66ff1 100644
--- a/yardstick/tests/unit/benchmark/scenarios/networking/test_vnf_generic.py
+++ b/yardstick/tests/unit/benchmark/scenarios/networking/test_vnf_generic.py
@@ -15,18 +15,31 @@
 from copy import deepcopy
 import errno
 import os
+import sys
 
 import mock
 import six
 import unittest
 
+from yardstick import tests
 from yardstick.common import utils
-from yardstick.benchmark.scenarios.networking import vnf_generic
 from yardstick.network_services.collector.subscriber import Collector
+from yardstick.network_services.traffic_profile import base
+from yardstick.network_services.vnf_generic import vnfdgen
 from yardstick.network_services.vnf_generic.vnf.base import \
     GenericTrafficGen, GenericVNF
 
 
+stl_patch = mock.patch.dict(sys.modules, tests.STL_MOCKS)
+stl_patch.start()
+
+if stl_patch:
+    from yardstick.benchmark.scenarios.networking import vnf_generic
+
+# pylint: disable=unused-argument
+# disable this for now because I keep forgetting mock patch arg ordering
+
+
 COMPLETE_TREX_VNFD = {
     'vnfd:vnfd-catalog': {
         'vnfd': [
@@ -305,6 +318,7 @@ class TestNetworkServiceTestCase(unittest.TestCase):
             'task_id': 'a70bdf4a-8e67-47a3-9dc1-273c14506eb7',
             'tc': 'tc_ipv4_1Mflow_64B_packetsize',
             'traffic_profile': 'ipv4_throughput_vpe.yaml',
+            'extra_args': {'arg1': 'value1', 'arg2': 'value2'},
             'type': 'ISB',
             'tc_options': {
                 'rfc2544': {
@@ -404,11 +418,10 @@ class TestNetworkServiceTestCase(unittest.TestCase):
                 'public_ip': ['1.1.1.1'],
             },
         }
-
-        # NOTE(ralonsoh): this variable is not used in the test case and maybe
-        # it should.
-        #result = {'flow': {'dst_ip0': '152.16.40.2-152.16.40.254',
-        #                   'src_ip0': '152.16.100.2-152.16.100.254'}}
+        # NOTE(ralonsoh): check the expected output. This test could be
+        # incorrect
+        # result = {'flow': {'dst_ip0': '152.16.40.2-152.16.40.254',
+        #                    'src_ip0': '152.16.100.2-152.16.100.254'}}
         self.assertEqual({'flow': {}}, self.s._get_traffic_flow())
 
     def test___get_traffic_flow_error(self):
@@ -418,7 +431,8 @@ class TestNetworkServiceTestCase(unittest.TestCase):
 
     def test_get_vnf_imp(self):
         vnfd = COMPLETE_TREX_VNFD['vnfd:vnfd-catalog']['vnfd'][0]['class-name']
-        self.assertIsNotNone(self.s.get_vnf_impl(vnfd))
+        with mock.patch.dict(sys.modules, tests.STL_MOCKS):
+            self.assertIsNotNone(self.s.get_vnf_impl(vnfd))
 
         with self.assertRaises(vnf_generic.IncorrectConfig) as raised:
             self.s.get_vnf_impl('NonExistentClass')
@@ -456,9 +470,9 @@ class TestNetworkServiceTestCase(unittest.TestCase):
             self.s.map_topology_to_infrastructure()
 
         nodes = self.context_cfg["nodes"]
-        self.assertEqual(
-            "../../vnf_descriptors/tg_rfc2544_tpl.yaml", nodes['tg__1']['VNF model'])
-        self.assertEqual("../../vnf_descriptors/vpe_vnf.yaml",
+        self.assertEqual('../../vnf_descriptors/tg_rfc2544_tpl.yaml',
+                         nodes['tg__1']['VNF model'])
+        self.assertEqual('../../vnf_descriptors/vpe_vnf.yaml',
                          nodes['vnf__1']['VNF model'])
 
     def test_map_topology_to_infrastructure_insufficient_nodes(self):
@@ -495,10 +509,8 @@ class TestNetworkServiceTestCase(unittest.TestCase):
             for interface in self.tg__1['interfaces'].values():
                 del interface['local_mac']
 
-            with mock.patch(
-                "yardstick.benchmark.scenarios.networking.vnf_generic.LOG"):
-                with self.assertRaises(vnf_generic.IncorrectConfig) as raised:
-                    self.s._resolve_topology()
+            with self.assertRaises(vnf_generic.IncorrectConfig) as raised:
+                self.s._resolve_topology()
 
             self.assertIn('not found', str(raised.exception))
 
@@ -510,9 +522,8 @@ class TestNetworkServiceTestCase(unittest.TestCase):
             self.s.topology["vld"][0]['vnfd-connection-point-ref'].append(
                 self.s.topology["vld"][0]['vnfd-connection-point-ref'][0])
 
-            with mock.patch.object(vnf_generic, 'LOG'):
-                with self.assertRaises(vnf_generic.IncorrectConfig) as raised:
-                    self.s._resolve_topology()
+            with self.assertRaises(vnf_generic.IncorrectConfig) as raised:
+                self.s._resolve_topology()
 
             self.assertIn('wrong endpoint count', str(raised.exception))
 
@@ -520,9 +531,8 @@ class TestNetworkServiceTestCase(unittest.TestCase):
             self.s.topology["vld"][0]['vnfd-connection-point-ref'] = \
                 self.s.topology["vld"][0]['vnfd-connection-point-ref'][:1]
 
-            with mock.patch.object(vnf_generic, 'LOG'):
-                with self.assertRaises(vnf_generic.IncorrectConfig) as raised:
-                    self.s._resolve_topology()
+            with self.assertRaises(vnf_generic.IncorrectConfig) as raised:
+                self.s._resolve_topology()
 
             self.assertIn('wrong endpoint count', str(raised.exception))
 
@@ -615,14 +625,25 @@ class TestNetworkServiceTestCase(unittest.TestCase):
             self.assertEqual({'imix': {'64B': 100}},
                              self.s._get_traffic_imix())
 
-    def test__fill_traffic_profile(self):
-        self.scenario_cfg["traffic_profile"] = \
-            self._get_file_abspath("ipv4_throughput_vpe.yaml")
-        self.scenario_cfg["traffic_options"]["flow"] = \
-            self._get_file_abspath("ipv4_1flow_Packets_vpe.yaml")
-        self.scenario_cfg["traffic_options"]["imix"] = \
-            self._get_file_abspath("imix_voice.yaml")
-        self.assertIsNotNone(self.s._fill_traffic_profile())
+    @mock.patch.object(base.TrafficProfile, 'get')
+    @mock.patch.object(vnfdgen, 'generate_vnfd')
+    def test__fill_traffic_profile(self, mock_generate, mock_tprofile_get):
+        fake_tprofile = mock.Mock()
+        fake_vnfd = mock.Mock()
+        with mock.patch.object(self.s, '_get_traffic_profile',
+                               return_value=fake_tprofile) as mock_get_tp:
+            mock_generate.return_value = fake_vnfd
+            self.s._fill_traffic_profile()
+            mock_get_tp.assert_called_once()
+            mock_generate.assert_called_once_with(
+                fake_tprofile,
+                {'downlink': {},
+                 'extra_args': {'arg1': 'value1', 'arg2': 'value2'},
+                 'flow': {'flow': {}},
+                 'imix': {'imix': {'64B': 100}},
+                 'uplink': {}}
+            )
+            mock_tprofile_get.assert_called_once_with(fake_vnfd)
 
     def test_teardown(self):
         vnf = mock.Mock(autospec=GenericVNF)