aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/python/search/AbstractSearchAlgorithm.py
diff options
context:
space:
mode:
authorVratko Polak <vrpolak@cisco.com>2018-04-27 15:11:12 +0200
committerPeter Mikus <pmikus@cisco.com>2018-05-04 11:46:26 +0000
commit35175924550d67f98fb1c2c50b0634656d29169e (patch)
treefe1008e80c9c6f09227dff84672bd0eaa831ff23 /resources/libraries/python/search/AbstractSearchAlgorithm.py
parent4bfd1dcd604dac12d1dd00ba63c0d5e4170a1f2b (diff)
CSIT-992: Add libraries for optimized search
+ Place the libraries into resources/libraries/python/search/. + Except OptimizedTrexSearch in TrafficGenerator.py + Change traffic generator to support floats for duration and warmup. + Remove explicit type conversions where not needed. + Add robot keywords to performance_utils.robot + for calling the optimized search. + for reporting the resulting values. + for checking the minimal performance has been reached. + for running five second "Traffic should pass with no loss" after the search. - Add methodology documentation in subsequent Change. - Add simulator for testing algorithm correctness in a subsequent Change. - Add tests using the libraries in subsequent Change. Change-Id: Ia041008382ee4c9a562172099aea794c854d5f2f Signed-off-by: Vratko Polak <vrpolak@cisco.com>
Diffstat (limited to 'resources/libraries/python/search/AbstractSearchAlgorithm.py')
-rw-r--r--resources/libraries/python/search/AbstractSearchAlgorithm.py49
1 files changed, 49 insertions, 0 deletions
diff --git a/resources/libraries/python/search/AbstractSearchAlgorithm.py b/resources/libraries/python/search/AbstractSearchAlgorithm.py
new file mode 100644
index 0000000000..ae326bd4ca
--- /dev/null
+++ b/resources/libraries/python/search/AbstractSearchAlgorithm.py
@@ -0,0 +1,49 @@
+# Copyright (c) 2018 Cisco and/or its affiliates.
+# 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.
+
+"""Module defining AbstractSearchAlgorithm class."""
+
+from abc import ABCMeta, abstractmethod
+
+
+class AbstractSearchAlgorithm(object):
+ """Abstract class defining common API for search algorithms."""
+
+ __metaclass__ = ABCMeta
+
+ def __init__(self, rate_provider):
+ """Store the rate provider.
+
+ :param rate_provider: Object able to perform trial measurements.
+ :type rate_provider: AbstractRateProvider
+ """
+ # TODO: Type check for AbstractRateProvider?
+ self.rate_provider = rate_provider
+
+ @abstractmethod
+ def narrow_down_ndr_and_pdr(
+ self, fail_rate, line_rate, allowed_drop_fraction):
+ """Perform measurements to narrow down intervals, return them.
+
+ :param fail_rate: Minimal target transmit rate [pps].
+ :param line_rate: Maximal target transmit rate [pps].
+ :param allowed_drop_fraction: Fraction of dropped packets for PDR [1].
+ :type fail_rate: float
+ :type line_rate: float
+ :type allowed_drop_fraction: float
+ :returns: Structure containing narrowed down intervals
+ and their measurements.
+ :rtype: NdrPdrResult
+ """
+ # TODO: Do we agree on arguments related to precision or trial duration?
+ pass