Merge "Document for Euphrates test case results"
[yardstick.git] / yardstick / network_services / collector / subscriber.py
1 # Copyright (c) 2016-2017 Intel Corporation
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 #      http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14 """This module implements stub for publishing results in yardstick format."""
15 import logging
16
17 LOG = logging.getLogger(__name__)
18
19
20 class Collector(object):
21     """Class that handles dictionary of results in yardstick-plot format."""
22
23     def __init__(self, vnfs):
24         super(Collector, self).__init__()
25         self.vnfs = vnfs
26
27     def start(self):
28         for vnf in self.vnfs:
29             vnf.start_collect()
30
31     def stop(self):
32         for vnf in self.vnfs:
33             vnf.stop_collect()
34
35     def get_kpi(self):
36         """Returns dictionary of results in yardstick-plot format
37
38         :return: (dict) dictionary of kpis collected from the VNFs;
39                  the keys are the names of the VNFs.
40         """
41         results = {}
42         for vnf in self.vnfs:
43             # Result example:
44             # {"VNF1: { "tput" : [1000, 999] }, "VNF2": { "latency": 100 }}
45             LOG.debug("collect KPI for %s", vnf.name)
46             results[vnf.name] = vnf.collect_kpi()
47
48         return results