From decad5f7fdb212c4f78fc31f00e591eaba104450 Mon Sep 17 00:00:00 2001 From: Yujun Zhang Date: Tue, 27 Dec 2016 16:57:28 +0800 Subject: Add module skeletons - Remove `suite` and `case` which seems redundant at the moment - Rename `qtip.spec` to `qtip.loader` since the class loads spec - Add driver `sample` which will generate random performance data - Add collector `logfile` which will collect result from log files - Add reporter `console` which will print report to console - Add exception classes See updated class diagram in https://wiki.opnfv.org/display/qtip/Design JIRA: QTIP-148 JIRA: QTIP-193 Change-Id: Idf751d33428176a26224e4443100a142feda6f32 Signed-off-by: Yujun Zhang --- qtip/agent/collector.py | 13 ---- qtip/agent/reporter.py | 13 ---- qtip/base/benchmark.py | 95 --------------------------- qtip/base/constant.py | 50 ++++++++++++++ qtip/base/error.py | 23 +++++++ qtip/collector/__init__.py | 0 qtip/collector/base.py | 12 ++++ qtip/collector/logfile.py | 14 ++++ qtip/driver/__init__.py | 0 qtip/driver/ansible.py | 14 ++++ qtip/driver/base.py | 20 ++++++ qtip/driver/sample.py | 15 +++++ qtip/driver/yardstick.py | 14 ++++ qtip/drivers/__init__.py | 0 qtip/drivers/ansible.py | 14 ---- qtip/drivers/base.py | 12 ---- qtip/drivers/yardstick.py | 14 ---- qtip/loader/__init__.py | 0 qtip/loader/base.py | 62 +++++++++++++++++ qtip/loader/metric.py | 16 +++++ qtip/loader/qpi.py | 18 +++++ qtip/reporter/__init__.py | 0 qtip/reporter/base.py | 14 ++++ qtip/reporter/console.py | 14 ++++ qtip/runner/base.py | 45 +++++++++++++ qtip/runner/case.py | 17 ----- qtip/runner/plan.py | 21 +++--- qtip/runner/suite.py | 22 ------- qtip/spec/__init__.py | 0 qtip/spec/metric.py | 16 ----- qtip/spec/qpi.py | 18 ----- tests/conftest.py | 7 ++ tests/data/benchmarks/QPI/fake-qpi.yaml | 9 +++ tests/data/benchmarks/metric/dhrystone.yaml | 7 ++ tests/data/benchmarks/metric/dpi.yaml | 5 ++ tests/data/benchmarks/metric/fake-metric.yaml | 7 ++ tests/data/benchmarks/metric/ramspeed.yaml | 5 ++ tests/data/benchmarks/metric/ssl.yaml | 5 ++ tests/data/benchmarks/metric/whetstone.yaml | 5 ++ tests/data/benchmarks/metrics/dhrystone.yaml | 7 -- tests/data/benchmarks/metrics/dpi.yaml | 5 -- tests/data/benchmarks/metrics/ramspeed.yaml | 5 -- tests/data/benchmarks/metrics/ssl.yaml | 5 -- tests/data/benchmarks/metrics/whetstone.yaml | 5 -- tests/data/benchmarks/plan/fake-plan.yaml | 10 +++ tests/data/benchmarks/plans/verification.yaml | 21 ------ tests/unit/loader/metric_test.py | 24 +++---- tests/unit/loader/qpi_test.py | 28 ++++---- tests/unit/runner/case_test.py | 15 ----- tests/unit/runner/conftest.py | 30 --------- tests/unit/runner/plan_test.py | 18 ++--- tests/unit/runner/suite_test.py | 27 -------- 52 files changed, 436 insertions(+), 400 deletions(-) delete mode 100644 qtip/agent/collector.py delete mode 100644 qtip/agent/reporter.py delete mode 100644 qtip/base/benchmark.py create mode 100644 qtip/base/constant.py create mode 100644 qtip/base/error.py create mode 100644 qtip/collector/__init__.py create mode 100644 qtip/collector/base.py create mode 100644 qtip/collector/logfile.py create mode 100644 qtip/driver/__init__.py create mode 100644 qtip/driver/ansible.py create mode 100644 qtip/driver/base.py create mode 100644 qtip/driver/sample.py create mode 100644 qtip/driver/yardstick.py delete mode 100644 qtip/drivers/__init__.py delete mode 100644 qtip/drivers/ansible.py delete mode 100644 qtip/drivers/base.py delete mode 100644 qtip/drivers/yardstick.py create mode 100644 qtip/loader/__init__.py create mode 100644 qtip/loader/base.py create mode 100644 qtip/loader/metric.py create mode 100644 qtip/loader/qpi.py create mode 100644 qtip/reporter/__init__.py create mode 100644 qtip/reporter/base.py create mode 100644 qtip/reporter/console.py create mode 100644 qtip/runner/base.py delete mode 100644 qtip/runner/case.py delete mode 100644 qtip/runner/suite.py delete mode 100644 qtip/spec/__init__.py delete mode 100644 qtip/spec/metric.py delete mode 100644 qtip/spec/qpi.py create mode 100644 tests/data/benchmarks/QPI/fake-qpi.yaml create mode 100644 tests/data/benchmarks/metric/dhrystone.yaml create mode 100644 tests/data/benchmarks/metric/dpi.yaml create mode 100644 tests/data/benchmarks/metric/fake-metric.yaml create mode 100644 tests/data/benchmarks/metric/ramspeed.yaml create mode 100644 tests/data/benchmarks/metric/ssl.yaml create mode 100644 tests/data/benchmarks/metric/whetstone.yaml delete mode 100644 tests/data/benchmarks/metrics/dhrystone.yaml delete mode 100644 tests/data/benchmarks/metrics/dpi.yaml delete mode 100644 tests/data/benchmarks/metrics/ramspeed.yaml delete mode 100644 tests/data/benchmarks/metrics/ssl.yaml delete mode 100644 tests/data/benchmarks/metrics/whetstone.yaml create mode 100644 tests/data/benchmarks/plan/fake-plan.yaml delete mode 100644 tests/data/benchmarks/plans/verification.yaml delete mode 100644 tests/unit/runner/case_test.py delete mode 100644 tests/unit/runner/conftest.py delete mode 100644 tests/unit/runner/suite_test.py diff --git a/qtip/agent/collector.py b/qtip/agent/collector.py deleted file mode 100644 index 3df21379..00000000 --- a/qtip/agent/collector.py +++ /dev/null @@ -1,13 +0,0 @@ -############################################################################## -# Copyright (c) 2016 ZTE Corp and others. -# -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - - -class Collector(object): - """collect test result and test condition""" - pass diff --git a/qtip/agent/reporter.py b/qtip/agent/reporter.py deleted file mode 100644 index b5c4acfa..00000000 --- a/qtip/agent/reporter.py +++ /dev/null @@ -1,13 +0,0 @@ -############################################################################## -# Copyright (c) 2016 ZTE Corp and others. -# -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - - -class Reporter(object): - """generate test report and push test data to database""" - pass diff --git a/qtip/base/benchmark.py b/qtip/base/benchmark.py deleted file mode 100644 index b38e6016..00000000 --- a/qtip/base/benchmark.py +++ /dev/null @@ -1,95 +0,0 @@ -############################################################################## -# Copyright (c) 2016 ZTE Corp and others. -# -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - -from itertools import chain -from os import listdir -from os import path -import yaml - - -class Property(object): - # list - NAME = 'name' - CONTENT = 'content' - ABSPATH = 'abspath' - # content - TITLE = 'title' - DESCRIPTION = 'description' - # spec - ALGORITHM = 'algorithm' - SECTIONS = 'sections' - WEIGHT = 'weight' - METRICS = 'metrics' - SPEC = 'spec' - WORKLOADS = 'workloads' - # plan - INFO = 'info' - FACILITY = 'facility' - ENGINEER = 'engineer' - SUITES = 'suites' - # suite - QPI_SPEC = 'QPI_spec' - CONDITION = 'condition' - CASES = 'cases' - # case - METRIC_SPEC = 'metric_spec' - CONFIG = 'config' - - -class QtipError(Exception): - pass - - -class Algorithm(object): - ARITHMETIC_MEAN = 'arithmetic mean' - WEIGHTED_ARITHMETIC_MEAN = 'weighted arithmetic mean' - GEOMETRIC_MEAN = 'geometric mean' - WEIGHTED_GEOMETRIC_MEAN = 'weighted geometric mean' - - -ROOT_DIR = 'benchmarks' - - -class Benchmark(object): - """Abstract class of QTIP benchmarks""" - DEFAULT_DIR = '.' - _paths = [path.join(path.dirname(__file__), path.pardir, path.pardir, - ROOT_DIR)] - - def __init__(self, name, paths=None): - self._file = name - self._abspath = self._find(name, paths) - self.name = path.splitext(name)[0] - - def _find(self, name, paths): - """find a benchmark in searching paths""" - paths = self._paths if paths is None else paths - name = path.join(self.DEFAULT_DIR, name) - for p in paths: - abspath = path.join(p, name) - if path.exists(abspath): - return abspath - raise QtipError("'{}' not found in paths: {}".format(name, paths)) - - @classmethod - def list_all(cls, paths=None): - """list all available benchmarks""" - paths = cls._paths if paths is None else paths - names = chain.from_iterable([listdir(path.join(p, cls.DEFAULT_DIR)) - for p in paths]) - for name in names: - item = cls(name, paths=paths) - yield { - Property.NAME: name, - Property.ABSPATH: item._abspath, - Property.CONTENT: item.content()} - - def content(self): - """description of benchmark""" - return yaml.safe_load(file(self._abspath)) diff --git a/qtip/base/constant.py b/qtip/base/constant.py new file mode 100644 index 00000000..187f0706 --- /dev/null +++ b/qtip/base/constant.py @@ -0,0 +1,50 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + + +class AlgoName(object): + """algorithm names""" + ARITHMETIC_MEAN = 'arithmetic mean' + WEIGHTED_ARITHMETIC_MEAN = 'weighted arithmetic mean' + GEOMETRIC_MEAN = 'geometric mean' + WEIGHTED_GEOMETRIC_MEAN = 'weighted geometric mean' + + +class PkgName(object): + """QTIP package names""" + COLLECTOR = 'collector' + DRIVER = 'driver' + REPORTER = 'reporter' + RUNNER = 'runner' + SPEC = 'spec' + + +class PropName(object): + """property names""" + # list + NAME = 'name' + CONTENT = 'content' + ABSPATH = 'abspath' + # content + name = 'name' + DESCRIPTION = 'description' + # spec + SECTIONS = 'sections' + WEIGHT = 'weight' + ALGORITHM = 'algorithm' + METRICS = 'metrics' + WORKLOADS = 'workloads' + # plan + CONFIG = 'config' + FACILITY = 'facility' + ENGINEER = 'engineer' + DRIVER = 'driver' + COLLECTOR = 'collector' + REPORTER = 'reporter' + QPIS = 'QPIs' diff --git a/qtip/base/error.py b/qtip/base/error.py new file mode 100644 index 00000000..d364c532 --- /dev/null +++ b/qtip/base/error.py @@ -0,0 +1,23 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + + +class QtipError(Exception): + pass + + +class InvalidFormat(QtipError): + def __init__(self, filename): + self.filename = filename + + +class NotFound(QtipError): + def __init__(self, module, package='qtip'): + self.package = package + self.module = module diff --git a/qtip/collector/__init__.py b/qtip/collector/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/qtip/collector/base.py b/qtip/collector/base.py new file mode 100644 index 00000000..cd8fc797 --- /dev/null +++ b/qtip/collector/base.py @@ -0,0 +1,12 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + + +class BaseCollector(object): + """performance metrics collector""" diff --git a/qtip/collector/logfile.py b/qtip/collector/logfile.py new file mode 100644 index 00000000..6528ea9f --- /dev/null +++ b/qtip/collector/logfile.py @@ -0,0 +1,14 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + +from base import BaseCollector + + +class LogfileCollector(BaseCollector): + """collect performance metrics from log files""" diff --git a/qtip/driver/__init__.py b/qtip/driver/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/qtip/driver/ansible.py b/qtip/driver/ansible.py new file mode 100644 index 00000000..04e9f9bd --- /dev/null +++ b/qtip/driver/ansible.py @@ -0,0 +1,14 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + +from base import BaseDriver + + +class AnsibleDriver(BaseDriver): + """driver for running performance tests with Ansible""" diff --git a/qtip/driver/base.py b/qtip/driver/base.py new file mode 100644 index 00000000..6f5cab3c --- /dev/null +++ b/qtip/driver/base.py @@ -0,0 +1,20 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + + +class BaseDriver(object): + """performance testing tool driver""" + def pre_run(self): + pass + + def run(self): + pass + + def post_run(self): + pass diff --git a/qtip/driver/sample.py b/qtip/driver/sample.py new file mode 100644 index 00000000..9b347949 --- /dev/null +++ b/qtip/driver/sample.py @@ -0,0 +1,15 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + + +from base import BaseDriver + + +class SampleDriver(BaseDriver): + """sample driver that generates random data for testing""" diff --git a/qtip/driver/yardstick.py b/qtip/driver/yardstick.py new file mode 100644 index 00000000..83f1b3d8 --- /dev/null +++ b/qtip/driver/yardstick.py @@ -0,0 +1,14 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + +from base import BaseDriver + + +class YardstickDriver(BaseDriver): + """driver for running performance test with yardstick""" diff --git a/qtip/drivers/__init__.py b/qtip/drivers/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/qtip/drivers/ansible.py b/qtip/drivers/ansible.py deleted file mode 100644 index 04e9f9bd..00000000 --- a/qtip/drivers/ansible.py +++ /dev/null @@ -1,14 +0,0 @@ -############################################################################## -# Copyright (c) 2016 ZTE Corp and others. -# -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - -from base import BaseDriver - - -class AnsibleDriver(BaseDriver): - """driver for running performance tests with Ansible""" diff --git a/qtip/drivers/base.py b/qtip/drivers/base.py deleted file mode 100644 index 1aa8d8ad..00000000 --- a/qtip/drivers/base.py +++ /dev/null @@ -1,12 +0,0 @@ -############################################################################## -# Copyright (c) 2016 ZTE Corp and others. -# -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - - -class BaseDriver(object): - """performance testing tool driver""" diff --git a/qtip/drivers/yardstick.py b/qtip/drivers/yardstick.py deleted file mode 100644 index 83f1b3d8..00000000 --- a/qtip/drivers/yardstick.py +++ /dev/null @@ -1,14 +0,0 @@ -############################################################################## -# Copyright (c) 2016 ZTE Corp and others. -# -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - -from base import BaseDriver - - -class YardstickDriver(BaseDriver): - """driver for running performance test with yardstick""" diff --git a/qtip/loader/__init__.py b/qtip/loader/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/qtip/loader/base.py b/qtip/loader/base.py new file mode 100644 index 00000000..f7fcb669 --- /dev/null +++ b/qtip/loader/base.py @@ -0,0 +1,62 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + +from itertools import chain +from os import listdir +from os import path +import yaml + +from qtip.base.error import InvalidFormat, NotFound +from qtip.base.constant import PropName + +ROOT_DIR = 'benchmarks' + + +class BaseLoader(object): + """Abstract class of QTIP benchmark loader""" + DEFAULT_DIR = '.' + _paths = [path.join(path.dirname(__file__), path.pardir, path.pardir, + ROOT_DIR)] + + def __init__(self, name, paths=None): + self._file = name + self._abspath = self._find(name, paths) + + try: + content = yaml.safe_load(file(self._abspath)) + except yaml.YAMLError: + # TODO(yujunz) log yaml error + raise InvalidFormat(self._abspath) + + self.name = content[PropName.NAME] if PropName.NAME in content \ + else path.splitext(name)[0] + self.content = content + + def _find(self, name, paths): + """find a benchmark in searching paths""" + paths = self._paths if paths is None else paths + name = path.join(self.DEFAULT_DIR, name) + for p in paths: + abspath = path.join(p, name) + if path.exists(abspath): + return abspath + raise NotFound(name, paths) + + @classmethod + def list_all(cls, paths=None): + """list all available benchmarks""" + paths = cls._paths if paths is None else paths + names = chain.from_iterable([listdir(path.join(p, cls.DEFAULT_DIR)) + for p in paths]) + for name in names: + item = cls(name, paths=paths) + yield { + PropName.NAME: name, + PropName.ABSPATH: item._abspath, + PropName.CONTENT: item.content} diff --git a/qtip/loader/metric.py b/qtip/loader/metric.py new file mode 100644 index 00000000..d6174e8f --- /dev/null +++ b/qtip/loader/metric.py @@ -0,0 +1,16 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + +from base import BaseLoader + + +class MetricSpec(BaseLoader): + """metrics in QTIP are categorized by performance test tools, such as + dhrystone, whetstone and etc""" + DEFAULT_DIR = 'metric' diff --git a/qtip/loader/qpi.py b/qtip/loader/qpi.py new file mode 100644 index 00000000..2972cbd7 --- /dev/null +++ b/qtip/loader/qpi.py @@ -0,0 +1,18 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + +from base import BaseLoader + + +class QPISpec(BaseLoader): + """ + a QPI specification defines how to calculate a performance index from + collected metrics. + """ + DEFAULT_DIR = 'QPI' diff --git a/qtip/reporter/__init__.py b/qtip/reporter/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/qtip/reporter/base.py b/qtip/reporter/base.py new file mode 100644 index 00000000..b931d14d --- /dev/null +++ b/qtip/reporter/base.py @@ -0,0 +1,14 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + + +class BaseReporter(object): + """benchmark result reporter""" + def __init__(self, collector=None): + self.collector = collector diff --git a/qtip/reporter/console.py b/qtip/reporter/console.py new file mode 100644 index 00000000..136ce358 --- /dev/null +++ b/qtip/reporter/console.py @@ -0,0 +1,14 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + +from base import BaseReporter + + +class ConsoleReporter(BaseReporter): + """report result to console""" diff --git a/qtip/runner/base.py b/qtip/runner/base.py new file mode 100644 index 00000000..07fba104 --- /dev/null +++ b/qtip/runner/base.py @@ -0,0 +1,45 @@ +############################################################################## +# Copyright (c) 2016 ZTE Corp and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + +from qtip.base.constant import PkgName, PropName +from qtip.base.error import NotFound +from qtip.collector.logfile import LogfileCollector +from qtip.driver.sample import SampleDriver +from qtip.loader.base import BaseLoader +from qtip.reporter.console import ConsoleReporter + + +class BaseRunner(BaseLoader): + def __init__(self, name, paths=None, config=None): + super(BaseRunner, self).__init__(name, paths=paths) + if config is None: + config = self.content[PropName.CONFIG] + + driver_name = config[PropName.DRIVER] + collector_name = config[PropName.COLLECTOR] + reporter_name = config[PropName.REPORTER] + + # TODO(yujunz) dynamically load modules by name + + if driver_name == 'sample': + self.driver = SampleDriver() + else: + raise NotFound(driver_name, package=PkgName.DRIVER) + + if collector_name == 'logfile': + self.collector = LogfileCollector() + else: + raise NotFound(collector_name, + package=PkgName.COLLECTOR) + + if reporter_name == 'console': + self.reporter = ConsoleReporter() + else: + raise NotFound(reporter_name, + package=PkgName.REPORTER) diff --git a/qtip/runner/case.py b/qtip/runner/case.py deleted file mode 100644 index eb3febc2..00000000 --- a/qtip/runner/case.py +++ /dev/null @@ -1,17 +0,0 @@ -############################################################################## -# Copyright (c) 2016 ZTE Corp and others. -# -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - -from qtip.base.benchmark import Property -from qtip.spec.metric import MetricSpec - - -class Case(object): - def __init__(self, spec, paths=None): - self.metric_spec = MetricSpec(spec[Property.METRIC_SPEC], paths=paths) - self.config = spec[Property.CONFIG] diff --git a/qtip/runner/plan.py b/qtip/runner/plan.py index 265ad8d7..f6c1c3bb 100644 --- a/qtip/runner/plan.py +++ b/qtip/runner/plan.py @@ -7,20 +7,19 @@ # http://www.apache.org/licenses/LICENSE-2.0 ############################################################################## -from qtip.base.benchmark import Benchmark, Property -from qtip.runner.suite import Suite +from qtip.base.constant import PropName +from qtip.runner.base import BaseRunner +from qtip.loader.qpi import QPISpec -class Plan(Benchmark): +class Plan(BaseRunner): + """ + a benchmark plan is consist of configuration and a QPI list """ - a benchmark plan is consist of basic information and several suites""" - DEFAULT_DIR = 'plans' + DEFAULT_DIR = 'plan' def __init__(self, name, paths=None): - super(Plan, self).__init__(name, paths=paths) - content = self.content() - - self.info = content[Property.INFO] - self.suites = [Suite(suite, paths=paths) - for suite in content[Property.SUITES]] + super(Plan, self).__init__(name, paths) + self.qpis = [QPISpec(qpi, paths=paths) + for qpi in self.content[PropName.QPIS]] diff --git a/qtip/runner/suite.py b/qtip/runner/suite.py deleted file mode 100644 index 55033d2b..00000000 --- a/qtip/runner/suite.py +++ /dev/null @@ -1,22 +0,0 @@ -############################################################################## -# Copyright (c) 2016 ZTE Corp and others. -# -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - -from qtip.base.benchmark import Property -from qtip.spec.qpi import QPISpec -from qtip.runner.case import Case - - -class Suite(object): - """a suite of benchmark cases under specified condition""" - def __init__(self, spec, paths=None): - self._paths = paths - self.qpi_spec = QPISpec(spec[Property.QPI_SPEC], paths=paths) - self.condition = spec.get(Property.CONDITION, {}) - self.cases = [Case(case_spec, paths) - for case_spec in spec.get(Property.CASES, [])] diff --git a/qtip/spec/__init__.py b/qtip/spec/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/qtip/spec/metric.py b/qtip/spec/metric.py deleted file mode 100644 index e9c70547..00000000 --- a/qtip/spec/metric.py +++ /dev/null @@ -1,16 +0,0 @@ -############################################################################## -# Copyright (c) 2016 ZTE Corp and others. -# -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - -from qtip.base.benchmark import Benchmark - - -class MetricSpec(Benchmark): - """metrics in QTIP are categorized by performance test tools, such as - dhrystone, whetstone and etc""" - DEFAULT_DIR = 'metrics' diff --git a/qtip/spec/qpi.py b/qtip/spec/qpi.py deleted file mode 100644 index b7d7aa02..00000000 --- a/qtip/spec/qpi.py +++ /dev/null @@ -1,18 +0,0 @@ -############################################################################## -# Copyright (c) 2016 ZTE Corp and others. -# -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - -from qtip.base.benchmark import Benchmark - - -class QPISpec(Benchmark): - """ - a QPI specification defines how to calculate a performance index from - collected metrics. - """ - DEFAULT_DIR = 'QPI' diff --git a/tests/conftest.py b/tests/conftest.py index 8e2ecf7c..f1ec91fb 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -10,6 +10,8 @@ from os import path import pytest +from qtip.runner.plan import Plan + @pytest.fixture(scope='session') def data_root(): @@ -19,3 +21,8 @@ def data_root(): @pytest.fixture(scope='session') def benchmarks_root(data_root): return path.join(data_root, 'benchmarks') + + +@pytest.fixture(scope='session') +def plan(benchmarks_root): + return Plan('fake-plan.yaml', [benchmarks_root]) diff --git a/tests/data/benchmarks/QPI/fake-qpi.yaml b/tests/data/benchmarks/QPI/fake-qpi.yaml new file mode 100644 index 00000000..d75c6568 --- /dev/null +++ b/tests/data/benchmarks/QPI/fake-qpi.yaml @@ -0,0 +1,9 @@ +name: Fake QPI +description: a fake QPI producing random result +algorithm: weighted arithmetic mean +sections: +- name: Fake Section + weight: 0.5 + algorithm: geometric mean + metrics: + - fake_metric.yaml diff --git a/tests/data/benchmarks/metric/dhrystone.yaml b/tests/data/benchmarks/metric/dhrystone.yaml new file mode 100644 index 00000000..b0d55ed2 --- /dev/null +++ b/tests/data/benchmarks/metric/dhrystone.yaml @@ -0,0 +1,7 @@ +name: dhrystone +description: > + a synthetic computing benchmark program intended to be representative of + system (integer) programming +workloads: + - single_cpu + - multi_cpu diff --git a/tests/data/benchmarks/metric/dpi.yaml b/tests/data/benchmarks/metric/dpi.yaml new file mode 100644 index 00000000..fc24c8d1 --- /dev/null +++ b/tests/data/benchmarks/metric/dpi.yaml @@ -0,0 +1,5 @@ +name: dpi +description: deep packet inspection +workloads: + - bps + - pps diff --git a/tests/data/benchmarks/metric/fake-metric.yaml b/tests/data/benchmarks/metric/fake-metric.yaml new file mode 100644 index 00000000..c5fcc5c2 --- /dev/null +++ b/tests/data/benchmarks/metric/fake-metric.yaml @@ -0,0 +1,7 @@ +name: fake compute +description: > + a fake compute performance index which generate random result +workloads: # all supported workloads + - fake_workload_1 + - fake_workload_2 + - fake_workload_3 diff --git a/tests/data/benchmarks/metric/ramspeed.yaml b/tests/data/benchmarks/metric/ramspeed.yaml new file mode 100644 index 00000000..bb7618b7 --- /dev/null +++ b/tests/data/benchmarks/metric/ramspeed.yaml @@ -0,0 +1,5 @@ +name: ramspeed +description: a memory performance benchmarking +workloads: + - int: [add, average, copy, scale, triad] + - float: [add, average, copy, scale, triad] diff --git a/tests/data/benchmarks/metric/ssl.yaml b/tests/data/benchmarks/metric/ssl.yaml new file mode 100644 index 00000000..21e8add7 --- /dev/null +++ b/tests/data/benchmarks/metric/ssl.yaml @@ -0,0 +1,5 @@ +name: ssl +description: a Secure Sockets Layer performance benchmarking +workloads: + - aes_128_cbc: [512, 1024, 2048, 4096] + - rsa_sig: [16, 64, 256, 1024, 8192] diff --git a/tests/data/benchmarks/metric/whetstone.yaml b/tests/data/benchmarks/metric/whetstone.yaml new file mode 100644 index 00000000..d83680c4 --- /dev/null +++ b/tests/data/benchmarks/metric/whetstone.yaml @@ -0,0 +1,5 @@ +name: dhrystone +description: a synthetic benchmark for evaluating the performance of computers +workloads: + - single_cpu + - multi_cpu diff --git a/tests/data/benchmarks/metrics/dhrystone.yaml b/tests/data/benchmarks/metrics/dhrystone.yaml deleted file mode 100644 index b0d55ed2..00000000 --- a/tests/data/benchmarks/metrics/dhrystone.yaml +++ /dev/null @@ -1,7 +0,0 @@ -name: dhrystone -description: > - a synthetic computing benchmark program intended to be representative of - system (integer) programming -workloads: - - single_cpu - - multi_cpu diff --git a/tests/data/benchmarks/metrics/dpi.yaml b/tests/data/benchmarks/metrics/dpi.yaml deleted file mode 100644 index fc24c8d1..00000000 --- a/tests/data/benchmarks/metrics/dpi.yaml +++ /dev/null @@ -1,5 +0,0 @@ -name: dpi -description: deep packet inspection -workloads: - - bps - - pps diff --git a/tests/data/benchmarks/metrics/ramspeed.yaml b/tests/data/benchmarks/metrics/ramspeed.yaml deleted file mode 100644 index bb7618b7..00000000 --- a/tests/data/benchmarks/metrics/ramspeed.yaml +++ /dev/null @@ -1,5 +0,0 @@ -name: ramspeed -description: a memory performance benchmarking -workloads: - - int: [add, average, copy, scale, triad] - - float: [add, average, copy, scale, triad] diff --git a/tests/data/benchmarks/metrics/ssl.yaml b/tests/data/benchmarks/metrics/ssl.yaml deleted file mode 100644 index 21e8add7..00000000 --- a/tests/data/benchmarks/metrics/ssl.yaml +++ /dev/null @@ -1,5 +0,0 @@ -name: ssl -description: a Secure Sockets Layer performance benchmarking -workloads: - - aes_128_cbc: [512, 1024, 2048, 4096] - - rsa_sig: [16, 64, 256, 1024, 8192] diff --git a/tests/data/benchmarks/metrics/whetstone.yaml b/tests/data/benchmarks/metrics/whetstone.yaml deleted file mode 100644 index d83680c4..00000000 --- a/tests/data/benchmarks/metrics/whetstone.yaml +++ /dev/null @@ -1,5 +0,0 @@ -name: dhrystone -description: a synthetic benchmark for evaluating the performance of computers -workloads: - - single_cpu - - multi_cpu diff --git a/tests/data/benchmarks/plan/fake-plan.yaml b/tests/data/benchmarks/plan/fake-plan.yaml new file mode 100644 index 00000000..8887f66d --- /dev/null +++ b/tests/data/benchmarks/plan/fake-plan.yaml @@ -0,0 +1,10 @@ +name: fake plan +description: fake benchmark plan for demonstration and testing +config: + facility: local + engineer: local + driver: sample + collector: logfile + reporter: console +QPIs: + - fake-qpi.yaml diff --git a/tests/data/benchmarks/plans/verification.yaml b/tests/data/benchmarks/plans/verification.yaml deleted file mode 100644 index b146ee37..00000000 --- a/tests/data/benchmarks/plans/verification.yaml +++ /dev/null @@ -1,21 +0,0 @@ -title: verification -description: benchmark plan for QTIP verification -info: - facility: opnfv-ci - engineer: opnfv-bot -suites: - - QPI_spec: compute.yaml -# Uncomment next line to setup suite running condition -# condition: {} -# Uncomment the following lines setup case running configuration -# cases: -# - metric_spec: dhrystone.yaml -# config: {} -# - metric_spec: whetstone.yaml -# config: {} -# - metric_spec: ramspeed.yaml -# config: {} -# - metric_spec: dpi.yaml -# config: {} -# - metric_spec: ssl.yaml -# config: {} diff --git a/tests/unit/loader/metric_test.py b/tests/unit/loader/metric_test.py index 5eced700..d2be0388 100644 --- a/tests/unit/loader/metric_test.py +++ b/tests/unit/loader/metric_test.py @@ -9,8 +9,8 @@ import pytest -from qtip.base.benchmark import Property -from qtip.spec.metric import MetricSpec +from qtip.base.constant import PropName +from qtip.loader.metric import MetricSpec @pytest.fixture(scope='module') @@ -29,17 +29,17 @@ def init_test(metric_spec): def list_all_test(): metric_list = MetricSpec.list_all() - assert len(list(metric_list)) is 1 + assert len(list(metric_list)) is 6 for desc in metric_list: - assert Property.NAME in desc - assert Property.DESCRIPTION in desc - assert Property.ABSPATH in desc - assert Property.ABSPATH is not None + assert PropName.NAME in desc + assert PropName.DESCRIPTION in desc + assert PropName.ABSPATH in desc + assert PropName.ABSPATH is not None def content_test(metric): - content = metric.content() - assert Property.NAME in content - assert Property.DESCRIPTION in content - assert Property.WORKLOADS in content - assert isinstance(content[Property.WORKLOADS], list) + content = metric.content + assert PropName.NAME in content + assert PropName.DESCRIPTION in content + assert PropName.WORKLOADS in content + assert isinstance(content[PropName.WORKLOADS], list) diff --git a/tests/unit/loader/qpi_test.py b/tests/unit/loader/qpi_test.py index bfa1f580..c0d4b377 100644 --- a/tests/unit/loader/qpi_test.py +++ b/tests/unit/loader/qpi_test.py @@ -9,8 +9,8 @@ import pytest -from qtip.base.benchmark import Algorithm, Property -from qtip.spec.qpi import QPISpec +from qtip.base.constant import AlgoName, PropName +from qtip.loader.qpi import QPISpec QPI_SPEC = 'compute.yaml' @@ -31,22 +31,22 @@ def test_init(qpi_spec): def test_list_all(benchmarks_root): qpi_spec_list = QPISpec.list_all(paths=[benchmarks_root]) - assert len(list(qpi_spec_list)) is 1 + assert len(list(qpi_spec_list)) is 2 for item in qpi_spec_list: - assert Property.NAME in item - assert Property.CONTENT in item - assert Property.ABSPATH in item - assert Property.ABSPATH is not None + assert PropName.NAME in item + assert PropName.CONTENT in item + assert PropName.ABSPATH in item + assert PropName.ABSPATH is not None def test_content(qpi_spec): - content = qpi_spec.content() - assert Property.DESCRIPTION in content - assert Property.ALGORITHM in content - assert Property.SECTIONS in content + content = qpi_spec.content + assert PropName.DESCRIPTION in content + assert PropName.ALGORITHM in content + assert PropName.SECTIONS in content - assert content[Property.ALGORITHM] in Algorithm.__dict__.values() - sections = content[Property.SECTIONS] + assert content[PropName.ALGORITHM] in AlgoName.__dict__.values() + sections = content[PropName.SECTIONS] assert isinstance(sections, list) for section in sections: - assert Property.NAME in section + assert PropName.NAME in section diff --git a/tests/unit/runner/case_test.py b/tests/unit/runner/case_test.py deleted file mode 100644 index 59a54a84..00000000 --- a/tests/unit/runner/case_test.py +++ /dev/null @@ -1,15 +0,0 @@ -############################################################### -# Copyright (c) 2016 ZTE Corp and others. -# -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - -from qtip.spec.metric import MetricSpec - - -def init_test(case): - assert isinstance(case.metric_spec, MetricSpec) - assert isinstance(case.config, dict) diff --git a/tests/unit/runner/conftest.py b/tests/unit/runner/conftest.py deleted file mode 100644 index 6d14f7ae..00000000 --- a/tests/unit/runner/conftest.py +++ /dev/null @@ -1,30 +0,0 @@ -############################################################################## -# Copyright (c) 2016 ZTE Corp and others. -# -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - -import pytest - -from qtip.base.benchmark import Property -from qtip.runner.case import Case -from qtip.runner.plan import Plan -from qtip.runner.suite import Suite - - -@pytest.fixture(scope='module') -def plan(benchmarks_root): - return Plan('verification.yaml', paths=[benchmarks_root]) - - -@pytest.fixture(scope='module') -def suite(plan): - return Suite(plan[Property.SUITES][0]) - - -@pytest.fixture(scope='module') -def case(suite): - return Case(suite[Property.CASES][0]) diff --git a/tests/unit/runner/plan_test.py b/tests/unit/runner/plan_test.py index d783e5e9..7b3611d1 100644 --- a/tests/unit/runner/plan_test.py +++ b/tests/unit/runner/plan_test.py @@ -9,12 +9,12 @@ import pytest -from qtip.base.benchmark import Property +from qtip.base.constant import PropName from qtip.runner.plan import Plan def test_init(plan): - assert plan.name == 'verification' + assert plan.name == 'fake plan' with pytest.raises(TypeError) as excinfo: Plan() @@ -26,13 +26,13 @@ def test_list_all(benchmarks_root): plan_list = Plan.list_all(paths=[benchmarks_root]) assert len(list(plan_list)) is 1 for desc in plan_list: - assert Property.NAME in desc - assert Property.CONTENT in desc - assert Property.ABSPATH in desc - assert Property.ABSPATH is not None + assert PropName.NAME in desc + assert PropName.CONTENT in desc + assert PropName.ABSPATH in desc + assert PropName.ABSPATH is not None def test_content(plan): - content = plan.content() - assert Property.TITLE in content - assert Property.DESCRIPTION in content + content = plan.content + assert PropName.NAME in content + assert PropName.DESCRIPTION in content diff --git a/tests/unit/runner/suite_test.py b/tests/unit/runner/suite_test.py deleted file mode 100644 index 7dad8f62..00000000 --- a/tests/unit/runner/suite_test.py +++ /dev/null @@ -1,27 +0,0 @@ -############################################################################## -# Copyright (c) 2016 ZTE Corp and others. -# -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - -import pytest - -from qtip.runner.suite import Suite -from qtip.runner.case import Case -from qtip.spec.qpi import QPISpec - - -def init_test(suite): - assert isinstance(suite.qpi, QPISpec) - assert isinstance(suite.condition, dict) - assert isinstance(suite.cases, list) - for case in suite.cases: - assert isinstance(case, Case) - - with pytest.raises(TypeError) as excinfo: - Suite() - assert '__init__() takes exactly 2 arguments (1 given)' \ - in str(excinfo.value) -- cgit 1.2.3-korg