Introducing the collector to subscribe/publish the KPIs for yardstick plot

v2: Added unit tests to keep test coverage :)

JIRA: YARDSTICK-482
Change-Id: I9281b00a4b619cc04550cb623c027ee5765c4974
Signed-off-by: Deepak S <deepak.s@linux.intel.com>

8 files changed, 178 insertions, 0 deletions

diff --git a/tests/unit/network_services/__init__.py b/tests/unit/network_services/__init__.py
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/tests/unit/network_services/__init__.py
diff --git a/tests/unit/network_services/collector/__init__.py b/tests/unit/network_services/collector/__init__.py
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/tests/unit/network_services/collector/__init__.py
diff --git a/tests/unit/network_services/collector/test_publisher.py b/tests/unit/network_services/collector/test_publisher.py
new file mode 100644
index 000000000..d1e56e114
--- /dev/null
+++ b/tests/unit/network_services/collector/test_publisher.py
@@ -0,0 +1,41 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2016-2017 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.
+#
+
+# Unittest for yardstick.network_services.collector.publisher
+
+from __future__ import absolute_import
+import unittest
+
+from yardstick.network_services.collector import publisher
+
+
+class PublisherTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.test_publisher = publisher.Publisher()
+
+    def test_successful_init(self):
+        pass
+
+    def test_unsuccessful_init(self):
+        pass
+
+    def test_start(self):
+        self.assertIsNone(self.test_publisher.start())
+
+    def test_stop(self):
+        self.assertIsNone(self.test_publisher.stop())
diff --git a/tests/unit/network_services/collector/test_subscriber.py b/tests/unit/network_services/collector/test_subscriber.py
new file mode 100644
index 000000000..373f5dccf
--- /dev/null
+++ b/tests/unit/network_services/collector/test_subscriber.py
@@ -0,0 +1,69 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2016-2017 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.
+#
+
+# Unittest for yardstick.network_services.collector.subscriber
+
+from __future__ import absolute_import
+import unittest
+
+from yardstick.network_services.collector import subscriber
+
+
+class CollectorTestCase(unittest.TestCase):
+
+    TRAFFIC_PROFILE = {}
+    VNFS = {}
+
+    def setUp(self):
+        self.test_subscriber = subscriber.Collector(self.TRAFFIC_PROFILE,
+                                                    self.VNFS)
+
+    def test_successful_init(self):
+
+        self.assertEqual(self.test_subscriber.traffic_profile, {})
+        self.assertEqual(self.test_subscriber.service, {})
+
+    def test_unsuccessful_init(self):
+        pass
+
+    def test_start(self):
+        self.assertIsNone(self.test_subscriber.start())
+
+    def test_stop(self):
+        self.assertIsNone(self.test_subscriber.stop())
+
+    def test_get_kpi(self):
+
+        class VnfAprrox(object):
+            def __init__(self):
+                self.result = {}
+                self.name = "vnf__1"
+
+            def collect_kpi(self):
+                self.result = {'pkt_in_up_stream': 100,
+                               'pkt_drop_up_stream': 5,
+                               'pkt_in_down_stream': 50,
+                               'pkt_drop_down_stream': 40}
+                return self.result
+
+        vnf = VnfAprrox()
+        result = self.test_subscriber.get_kpi(vnf)
+
+        self.assertEqual(result["vnf__1"]["pkt_in_up_stream"], 100)
+        self.assertEqual(result["vnf__1"]["pkt_drop_up_stream"], 5)
+        self.assertEqual(result["vnf__1"]["pkt_in_down_stream"], 50)
+        self.assertEqual(result["vnf__1"]["pkt_drop_down_stream"], 40)
diff --git a/yardstick/network_services/__init__.py b/yardstick/network_services/__init__.py
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/yardstick/network_services/__init__.py
diff --git a/yardstick/network_services/collector/__init__.py b/yardstick/network_services/collector/__init__.py
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/yardstick/network_services/collector/__init__.py
diff --git a/yardstick/network_services/collector/publisher.py b/yardstick/network_services/collector/publisher.py
new file mode 100644
index 000000000..004d4774b
--- /dev/null
+++ b/yardstick/network_services/collector/publisher.py
@@ -0,0 +1,29 @@
+# Copyright (c) 2016-2017 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.
+"""This module implements stub for publishing results in yardstick format."""
+
+
+class Publisher(object):
+    """Class that handles publishing test results in yardstick format."""
+
+    def __init__(self):
+        super(Publisher, self).__init__()
+
+    def start(self):
+        """Nothing to do, yet"""
+        pass
+
+    def stop(self):
+        """Nothing to do, yet"""
+        pass
diff --git a/yardstick/network_services/collector/subscriber.py b/yardstick/network_services/collector/subscriber.py
new file mode 100644
index 000000000..3bcb20876
--- /dev/null
+++ b/yardstick/network_services/collector/subscriber.py
@@ -0,0 +1,39 @@
+# Copyright (c) 2016-2017 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.
+"""This module implements stub for publishing results in yardstick format."""
+
+
+class Collector(object):
+    """Class that handles dictionary of results in yardstick-plot format."""
+
+    def __init__(self, traffic_profile, vnfs):
+        super(Collector, self).__init__()
+        self.traffic_profile = traffic_profile
+        self.service = vnfs
+
+    def start(self):
+        """Nothing to do, yet"""
+        pass
+
+    def stop(self):
+        """Nothing to do, yet"""
+        pass
+
+    @classmethod
+    def get_kpi(cls, vnf):
+        """Returns dictionary of results in yardstick-plot format
+
+        :return:
+        """
+        return {vnf.name: vnf.collect_kpi()}