Add DPDK pktgen traffic generator

Add DPDK pktgen traffic generator. This traffic generator is designed
only to work in with a MQ aware runner. Implements two consumer methods:
  - runner_method_start_iteration
  - runner_method_stop_iteration

"run_traffic" method will only initialize the traffic profile object.
This traffic generator uses a socket port (LUA port, default 22022) to
send the command messages.

Link: http://pktgen-dpdk.readthedocs.io/en/latest/index.html

JIRA: YARDSTICK-1344

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

4 files changed, 187 insertions, 0 deletions

diff --git a/yardstick/common/constants.py b/yardstick/common/constants.py
index 4ed40f8af..3d775d48e 100644
--- a/yardstick/common/constants.py
+++ b/yardstick/common/constants.py
@@ -175,3 +175,4 @@ SCOPE_CLUSTER = 'Cluster'
 
 # VNF definition
 SSH_PORT = 22
+LUA_PORT = 22022
diff --git a/yardstick/common/exceptions.py b/yardstick/common/exceptions.py
index 2e6cbdd7b..56b11b7aa 100644
--- a/yardstick/common/exceptions.py
+++ b/yardstick/common/exceptions.py
@@ -212,6 +212,10 @@ class WaitTimeout(YardstickException):
     message = 'Wait timeout while waiting for condition'
 
 
+class PktgenActionError(YardstickException):
+    message = 'Error in "%(action)s" action'
+
+
 class KubernetesApiException(YardstickException):
     message = ('Kubernetes API errors. Action: %(action)s, '
                'resource: %(resource)s')
diff --git a/yardstick/network_services/vnf_generic/vnf/tg_pktgen.py b/yardstick/network_services/vnf_generic/vnf/tg_pktgen.py
new file mode 100644
index 000000000..9d452213f
--- /dev/null
+++ b/yardstick/network_services/vnf_generic/vnf/tg_pktgen.py
@@ -0,0 +1,103 @@
+# Copyright (c) 2018 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import logging
+import multiprocessing
+import time
+import uuid
+
+from yardstick.common import constants
+from yardstick.common import exceptions
+from yardstick.common import utils
+from yardstick.network_services.vnf_generic.vnf import base as vnf_base
+
+
+LOG = logging.getLogger(__name__)
+
+
+class PktgenTrafficGen(vnf_base.GenericTrafficGen,
+                       vnf_base.GenericVNFEndpoint):
+    """DPDK Pktgen traffic generator
+
+    Website: http://pktgen-dpdk.readthedocs.io/en/latest/index.html
+    """
+
+    TIMEOUT = 30
+
+    def __init__(self, name, vnfd, task_id):
+        vnf_base.GenericTrafficGen.__init__(self, name, vnfd, task_id)
+        self.queue = multiprocessing.Queue()
+        self._id = uuid.uuid1().int
+        self._mq_producer = self._setup_mq_producer(self._id)
+        vnf_base.GenericVNFEndpoint.__init__(self, self._id, [task_id],
+                                             self.queue)
+        self._consumer = vnf_base.GenericVNFConsumer([task_id], self)
+        self._consumer.start_rpc_server()
+        self._traffic_profile = None
+        self._node_ip = vnfd['mgmt-interface'].get('ip')
+        self._lua_node_port = self._get_lua_node_port(
+            vnfd['mgmt-interface'].get('service_ports', []))
+        self._rate = 1
+
+    def instantiate(self, scenario_cfg, context_cfg):  # pragma: no cover
+        pass
+
+    def run_traffic(self, traffic_profile):
+        self._traffic_profile = traffic_profile
+        self._traffic_profile.init(self._node_ip, self._lua_node_port)
+        utils.wait_until_true(self._is_running, timeout=self.TIMEOUT,
+                              sleep=2)
+
+    def terminate(self):  # pragma: no cover
+        pass
+
+    def collect_kpi(self):  # pragma: no cover
+        pass
+
+    def scale(self, flavor=''):  # pragma: no cover
+        pass
+
+    def wait_for_instantiate(self):  # pragma: no cover
+        pass
+
+    def runner_method_start_iteration(self, ctxt, **kwargs):
+        # pragma: no cover
+        LOG.debug('Start method')
+        # NOTE(ralonsoh): 'rate' should be modified between iterations. The
+        # current implementation is just for testing.
+        self._rate += 1
+        self._traffic_profile.start()
+        self._traffic_profile.rate(self._rate)
+        time.sleep(4)
+        self._traffic_profile.stop()
+        self._mq_producer.tg_method_iteration(1, 1, {})
+
+    def runner_method_stop_iteration(self, ctxt, **kwargs):  # pragma: no cover
+        # pragma: no cover
+        LOG.debug('Stop method')
+
+    @staticmethod
+    def _get_lua_node_port(service_ports):
+        for port in (port for port in service_ports if
+                     int(port['port']) == constants.LUA_PORT):
+            return int(port['node_port'])
+        # NOTE(ralonsoh): in case LUA port is not present, an exception should
+        # be raised.
+
+    def _is_running(self):
+        try:
+            self._traffic_profile.help()
+            return True
+        except exceptions.PktgenActionError:
+            return False
diff --git a/yardstick/tests/unit/network_services/vnf_generic/vnf/test_tg_pktgen.py b/yardstick/tests/unit/network_services/vnf_generic/vnf/test_tg_pktgen.py
new file mode 100644
index 000000000..d341b970b
--- /dev/null
+++ b/yardstick/tests/unit/network_services/vnf_generic/vnf/test_tg_pktgen.py
@@ -0,0 +1,79 @@
+# Copyright (c) 2018 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import uuid
+
+import mock
+
+from yardstick.common import constants
+from yardstick.common import exceptions
+from yardstick.network_services.vnf_generic.vnf import base as vnf_base
+from yardstick.network_services.vnf_generic.vnf import tg_pktgen
+from yardstick.tests.unit import base as ut_base
+
+
+class PktgenTrafficGenTestCase(ut_base.BaseUnitTestCase):
+
+    SERVICE_PORTS = [{'port': constants.LUA_PORT,
+                      'node_port': '34501'}]
+    VNFD = {'mgmt-interface': {'ip': '1.2.3.4',
+                               'service_ports': SERVICE_PORTS},
+            'vdu': [{'external-interface': 'interface'}],
+            'benchmark': {'kpi': 'fake_kpi'}
+            }
+
+    def setUp(self):
+        self._id = uuid.uuid1().int
+        self._mock_vnf_consumer = mock.patch.object(vnf_base,
+                                                    'GenericVNFConsumer')
+        self.mock_vnf_consumer = self._mock_vnf_consumer.start()
+        self.addCleanup(self._stop_mock)
+
+    def _stop_mock(self):
+        self._mock_vnf_consumer.stop()
+
+    def test__init(self):
+        tg = tg_pktgen.PktgenTrafficGen('name1', self.VNFD, self._id)
+        self.assertTrue(isinstance(tg, (vnf_base.GenericTrafficGen,
+                                        vnf_base.GenericVNFEndpoint)))
+
+    def test_run_traffic(self):
+        tg = tg_pktgen.PktgenTrafficGen('name1', self.VNFD, self._id)
+        mock_tp = mock.Mock()
+        with mock.patch.object(tg, '_is_running', return_value=True):
+            tg.run_traffic(mock_tp)
+
+        mock_tp.init.assert_called_once_with(tg._node_ip, tg._lua_node_port)
+
+    def test__get_lua_node_port(self):
+        tg = tg_pktgen.PktgenTrafficGen('name1', self.VNFD, self._id)
+        service_ports = [{'port': constants.LUA_PORT,
+                          'node_port': '12345'}]
+        self.assertEqual(12345, tg._get_lua_node_port(service_ports))
+
+    def test__get_lua_node_port_no_lua_port(self):
+        tg = tg_pktgen.PktgenTrafficGen('name1', self.VNFD, self._id)
+        service_ports = [{'port': '333'}]
+        self.assertIsNone(tg._get_lua_node_port(service_ports))
+
+    def test__is_running(self):
+        tg = tg_pktgen.PktgenTrafficGen('name1', self.VNFD, self._id)
+        with mock.patch.object(tg, '_traffic_profile'):
+            self.assertTrue(tg._is_running())
+
+    def test__is_running_exception(self):
+        tg = tg_pktgen.PktgenTrafficGen('name1', self.VNFD, self._id)
+        with mock.patch.object(tg, '_traffic_profile') as mock_tp:
+            mock_tp.help.side_effect = exceptions.PktgenActionError()
+            self.assertFalse(tg._is_running())