Add pktgen traffic profile

This new profile is based on the DPDK pktgen traffic generator. The traffic
generator is controlled using LUA [1]. Those string commands are sent to
the traffic generator using an open socket. Host address and open port are
needed parameters.

The following actions are implemented:
  - start injection
  - stop injection
  - change injection rate
  - clear all stats
  - help message command

[1] http://pktgen-dpdk.readthedocs.io/en/latest/lua.html

JIRA: YARDSTICK-1345

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

3 files changed, 125 insertions, 0 deletions

diff --git a/yardstick/network_services/traffic_profile/__init__.py b/yardstick/network_services/traffic_profile/__init__.py
index 356b36bd9..a1b26a24d 100644
--- a/yardstick/network_services/traffic_profile/__init__.py
+++ b/yardstick/network_services/traffic_profile/__init__.py
@@ -27,6 +27,7 @@ def register_modules():
         'yardstick.network_services.traffic_profile.prox_profile',
         'yardstick.network_services.traffic_profile.prox_ramp',
         'yardstick.network_services.traffic_profile.rfc2544',
+        'yardstick.network_services.traffic_profile.pktgen',
     ]
 
     for module in modules:
diff --git a/yardstick/network_services/traffic_profile/pktgen.py b/yardstick/network_services/traffic_profile/pktgen.py
new file mode 100644
index 000000000..30f81b794
--- /dev/null
+++ b/yardstick/network_services/traffic_profile/pktgen.py
@@ -0,0 +1,61 @@
+# 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.
+
+from yardstick.common import exceptions
+from yardstick.common import utils
+from yardstick.network_services.traffic_profile import base as tp_base
+
+
+class PktgenTrafficProfile(tp_base.TrafficProfile):
+    """This class handles Pktgen Trex Traffic profile execution"""
+
+    def __init__(self, tp_config):  # pragma: no cover
+        super(PktgenTrafficProfile, self).__init__(tp_config)
+        self._host = None
+        self._port = None
+
+    def init(self, host, port):  # pragma: no cover
+        """Initialize control parameters
+
+        :param host: (str) ip or host name
+        :param port: (int) TCP socket port number for Lua commands
+        """
+        self._host = host
+        self._port = port
+
+    def start(self):
+        if utils.send_socket_command(self._host, self._port,
+                                     'pktgen.start("0")') != 0:
+            raise exceptions.PktgenActionError(action='start')
+
+    def stop(self):
+        if utils.send_socket_command(self._host, self._port,
+                                     'pktgen.stop("0")') != 0:
+            raise exceptions.PktgenActionError(action='stop')
+
+    def rate(self, rate):
+        command = 'pktgen.set("0", "rate", ' + str(rate) + ')'
+        if utils.send_socket_command(self._host, self._port, command) != 0:
+            raise exceptions.PktgenActionError(action='rate')
+
+    def clear_all_stats(self):
+        if utils.send_socket_command(self._host, self._port, 'clr') != 0:
+            raise exceptions.PktgenActionError(action='clear all stats')
+
+    def help(self):
+        if utils.send_socket_command(self._host, self._port, 'help') != 0:
+            raise exceptions.PktgenActionError(action='help')
+
+    def execute_traffic(self, *args, **kwargs):  # pragma: no cover
+        pass
diff --git a/yardstick/tests/unit/network_services/traffic_profile/test_pktgen.py b/yardstick/tests/unit/network_services/traffic_profile/test_pktgen.py
new file mode 100644
index 000000000..08542b4f1
--- /dev/null
+++ b/yardstick/tests/unit/network_services/traffic_profile/test_pktgen.py
@@ -0,0 +1,63 @@
+# 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 mock
+
+from yardstick.common import utils
+from yardstick.network_services.traffic_profile import pktgen
+from yardstick.tests.unit import base as ut_base
+
+
+class TestIXIARFC2544Profile(ut_base.BaseUnitTestCase):
+
+    def setUp(self):
+        self._tp_config = {'traffic_profile': {}}
+        self._host = 'localhost'
+        self._port = '12345'
+        self.tp = pktgen.PktgenTrafficProfile(self._tp_config)
+        self.tp.init(self._host, self._port)
+        self._mock_send_socket_command = mock.patch.object(
+            utils, 'send_socket_command', return_value=0)
+        self.mock_send_socket_command = self._mock_send_socket_command.start()
+        self.addCleanup(self._stop_mock)
+
+    def _stop_mock(self):
+        self._mock_send_socket_command.stop()
+
+    def test_start(self):
+        self.tp.start()
+        self.mock_send_socket_command.assert_called_once_with(
+            self._host, self._port, 'pktgen.start("0")')
+
+    def test_stop(self):
+        self.tp.stop()
+        self.mock_send_socket_command.assert_called_once_with(
+            self._host, self._port, 'pktgen.stop("0")')
+
+    def test_rate(self):
+        rate = 75
+        self.tp.rate(rate)
+        command = 'pktgen.set("0", "rate", 75)'
+        self.mock_send_socket_command.assert_called_once_with(
+            self._host, self._port, command)
+
+    def test_clear_all_stats(self):
+        self.tp.clear_all_stats()
+        self.mock_send_socket_command.assert_called_once_with(
+            self._host, self._port, 'clr')
+
+    def test_help(self):
+        self.tp.help()
+        self.mock_send_socket_command.assert_called_once_with(
+            self._host, self._port, 'help')