+##############################################################################
+# Copyright (c) 2017 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 BaseActor(object):
+ """abstract actor class"""
+
+ def __init__(self, config, parent=None):
+ self._config = config
+ self._parent = parent
+
+ def get_config(self, key, default=None):
+ return self._config.get(key, default)
# content
DESCRIPTION = 'description'
WORKLOADS = 'workloads'
+ TYPE = 'type'
class SpecProp(BaseProp):
pass
-@cli.command('run', help='Run tests to collect Performance Metrics')
+@cli.command('run', help='Run tests to run Performance Metrics')
@click.argument('name')
@pass_context
def cmd_run(ctx, name):
+##############################################################################
+# Copyright (c) 2017 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 BaseProp
+from qtip.collector.parser.grep import GrepParser
+
+
+class CollectorProp(BaseProp):
+ TYPE = 'type'
+ PARSERS = 'parsers'
+ PATHS = 'paths'
+
+
+def load_parser(type_name):
+ if type_name == GrepParser.TYPE:
+ return GrepParser
+ else:
+ raise Exception("Invalid parser type: {}".format(type_name))
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
-from base import BaseCollector
+from itertools import chain
+from six.moves import reduce
+import os
-from qtip.collector.base import CollectorProp as CProp
+from qtip.base import BaseActor
+from qtip.collector import load_parser
+from qtip.collector import CollectorProp as CProp
from qtip.loader.file import FileLoader
-class LogfileCollector(BaseCollector):
- """collect performance metrics from log files"""
+class LogItem(BaseActor):
+ def find(self, filename, paths=None):
+ return self._parent.find(filename, paths)
+
+class LogfileCollector(BaseActor):
+ """run performance metrics from log files"""
TYPE = 'logfile'
+ LOGS = 'logs'
+ PATHS = 'paths'
def __init__(self, config, parent=None):
super(LogfileCollector, self).__init__(config)
- paths = [config[CProp.PATHS]] if CProp.PATHS in config else ['.']
- self.loader = FileLoader('.', paths)
- self._parent = parent
-
- def collect(self):
- captured = {}
- for item in self._config[CProp.LOGS]:
- captured.update(self._parse_log(item))
- return captured
-
- def _parse_log(self, log_item):
- captured = {}
- # TODO(yujunz) select parser by name
- if CProp.GREP in log_item:
- for rule in log_item[CProp.GREP]:
- captured.update(self._grep(log_item[CProp.FILENAME], rule))
- return captured
-
- def _grep(self, filename, rule):
- return {}
+ self._parent = parent # plan
+ # TODO(yujunz) handle exception of invalid parent
+ dirname = os.path.dirname(self._parent.abspath)
+ paths = [os.path.join(dirname, p) for p in config.get(self.PATHS, [])]
+ self._loader = FileLoader('.', paths)
+
+ def run(self):
+ collected = []
+ for log_item_config in self._config[self.LOGS]:
+ log_item = LogItem(log_item_config, self)
+ matches = [load_parser(c[CProp.TYPE])(c, log_item).run()
+ for c in log_item.get_config(CProp.PARSERS)]
+ collected = chain(collected, reduce(chain, matches))
+ return reduce(merge_matchobj_to_dict, collected, {'groups': (), 'groupdict': {}})
+
+ def find(self, filename, paths=None):
+ return self._loader.find(filename, paths)
+
+
+def merge_matchobj_to_dict(d, m):
+ d['groups'] = chain(d['groups'], m.groups())
+ d['groupdict'].update(m.groupdict())
+ return d
##############################################################################
-# Copyright (c) 2016 ZTE Corp and others.
+# Copyright (c) 2017 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
##############################################################################
-from qtip.base.constant import BaseProp
+import re
-class BaseCollector(object):
- """performance metrics collector"""
- def __init__(self, config):
- self._config = config
+from qtip.base.constant import BaseProp
+from qtip.base import BaseActor
-class CollectorProp(BaseProp):
- TYPE = 'type'
- LOGS = 'logs'
+class GrepProp(BaseProp):
FILENAME = 'filename'
- GREP = 'grep'
REGEX = 'regex'
- CAPTURE = 'capture'
- PATHS = 'path'
+
+
+class GrepParser(BaseActor):
+ TYPE = 'grep'
+
+ def run(self):
+ filename = self._parent.get_config(GrepProp.FILENAME)
+ return grep_in_file(self._parent.find(filename), self._config[GrepProp.REGEX])
+
+
+def grep_in_file(filename, regex):
+ with open(filename, 'r') as f:
+ return filter(lambda x: x is not None, [re.search(regex, line) for line in f])
_paths = [ROOT_DIR]
def __init__(self, name, paths=None):
- self._file = name
- self._abspath = self._find(name, paths=paths)
+ self._filename = name
+ self.abspath = self.find(name, paths=paths)
- def _find(self, name, paths=None):
+ def find(self, name, paths=None):
"""find a specification in searching paths"""
- paths = self._paths if paths is None else paths
+ paths = [self.abspath] if paths is None else paths
for p in paths:
abspath = path.join(p, self.RELATIVE_PATH, name)
if path.exists(abspath):
item = cls(name, paths=paths)
yield {
BaseProp.NAME: name,
- BaseProp.ABSPATH: item._abspath}
+ BaseProp.ABSPATH: item.abspath}
from qtip.base.constant import BaseProp
-from qtip.collector.base import CollectorProp as CProp
-from qtip.loader.module import load_collector
+from qtip.collector import CollectorProp as CProp
+from qtip.collector.logfile import LogfileCollector
from qtip.loader.yaml_file import YamlFileLoader
from qtip.loader.qpi import QPISpec
+# TODO(yujunz) more elegant way to load module dynamically
+def load_collector(type_name):
+ if type_name == LogfileCollector.TYPE:
+ return LogfileCollector
+ else:
+ raise Exception("Invalid collector type: {}".format(type_name))
+
+
class Plan(YamlFileLoader):
"""
a benchmark plan is consist of configuration and a QPI list
def __init__(self, name, paths=None):
super(YamlFileLoader, self).__init__(name, paths)
- with open(self._abspath, 'r') as stream:
+ abspath = self.abspath
+
+ with open(abspath, 'r') as stream:
content = yaml.safe_load(stream)
if not isinstance(content, dict):
- raise InvalidContent(self._abspath)
+ raise InvalidContent(abspath)
self.content = content
self.name = content.get(BaseProp.NAME, path.splitext(name)[0])
if driver_name == 'random':
self.driver = RandomDriver()
else:
- raise NotFound(driver_name, package=PkgName.DRIVER)
+ raise NotFound(driver_name, heystack=PkgName.DRIVER)
if collector_name == 'stdout':
self.collector = StdoutCollector()
else:
raise NotFound(collector_name,
- package=PkgName.COLLECTOR)
+ heystack=PkgName.COLLECTOR)
if reporter_name == 'console':
self.reporter = ConsoleReporter()
else:
raise NotFound(reporter_name,
- package=PkgName.REPORTER)
+ heystack=PkgName.REPORTER)
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
+tox
pytest
+pytest-cov
+coverage
pykwalify
mock
pip_check_reqs
-coverage
-pytest-cov
-tox
import pytest
from qtip.loader.plan import Plan
+from qtip.loader.plan import PlanProp
@pytest.fixture(scope='session')
@pytest.fixture(scope='session')
def plan(benchmarks_root):
- return Plan('fake-plan.yaml', [benchmarks_root])
+ return Plan('doctor.yaml', [benchmarks_root])
+
+
+@pytest.fixture(scope='session')
+def plan_config(plan):
+ return plan.content[PlanProp.CONFIG]
+
+
+@pytest.fixture(scope='session')
+def collectors_config(plan_config):
+ return plan_config[PlanProp.COLLECTORS]
+
+
+@pytest.fixture(scope='session')
+def logfile_config(collectors_config):
+ return collectors_config[0]
facility: local
engineer: local
config:
- driver: sample
collectors:
- type: logfile
+ paths:
+ - '../../external/doctor-verify-apex-sample-master'
logs:
- filename: doctor_consumer.log
- # 2016-12-28 03:16:05,630 consumer.py 26 INFO doctor consumer notified at 1482894965.63
- grep:
- - regex: 'doctor consumer notified at \d+(\.\d+)?$'
- capture: notified consumer
+ parsers:
+ - type: grep
+ regex: 'doctor consumer notified at (?P<notified>\d+(?:\.\d+)?)$'
- filename: doctor_inspector.log
- # 2016-12-28 03:16:05,299 inspector.py 76 INFO event posted at 1482894965.3
- # 2016-12-28 03:16:05,299 inspector.py 56 INFO doctor mark vm(<Server: doctor_vm1>) error at 1482894965.3
- # 2016-12-28 03:16:05,506 inspector.py 66 INFO doctor mark host(overcloud-novacompute-1.ool-virtual1) down at 1482894965.51
- grep:
- - regex: 'event posted at \d+(\.\d+)?$'
- capture: posted event
- - regex: 'doctor mark vm\(.*\) error at \d+(\.\d+)?$'
- capture: marked VM error
- - regex: 'doctor mark host\(.*\) down at \d+(\.\d+)?$'
- capture: marked host down
+ parsers:
+ - type: grep
+ regex: 'event posted at (?P<event_posted>\d+(?:\.\d+)?)$'
+ - type: grep
+ regex: 'doctor mark vm\(.*\) error at (?P<vm_error>\d+(?:\.\d+)?)$'
+ - type: grep
+ regex: 'doctor mark host\(.*\) down at (?P<host_down>\d+(?:\.\d+)?)$'
- filename: disable_network.log
- # doctor set host down at 1482894965.164096803
- grep:
- - regex: 'doctor set host down at \d+(\.\d+)?$'
- capture: set host down
- reporter:
- name: console
- # transform collected data into timeline
- transformer: timeline
+ parsers:
+ - type: grep
+ regex: 'doctor set host down at (?P<network_down>\d+(?:\.\d+)?)$'
+ reporters:
+ - type: console
+ # transform collected data into timeline
+ transformer: timeline
QPIs:
- - fake-qpi.yaml
+ - fake_qpi.yaml
+++ /dev/null
-name: fake plan
-description: fake benchmark plan for demonstration and testing
-config:
- facility: local
- engineer: local
- driver: sample
- collectors: []
- reporter: console
-QPIs:
- - fake-qpi.yaml
--- /dev/null
+Lorem ipsum dolor sit amet,
+consectetur adipiscing elit,
+sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+
+Ut enim ad minim veniam,
+quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+
+Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
##############################################################################
-from qtip.collector.logfile import LogfileCollector
+from qtip.loader.plan import load_collector
+from qtip.collector import CollectorProp as CProp
-# TODO(yujunz) more elegant way to load module dynamically
-def load_collector(type_name):
- if type_name == LogfileCollector.TYPE:
- return LogfileCollector
- else:
- raise Exception("Invalid collector type: {}".format(type_name))
+def test_load_collector(collectors_config):
+ for c in collectors_config:
+ collector = load_collector(c[CProp.TYPE])
+ assert collector.TYPE == c[CProp.TYPE]
--- /dev/null
+##############################################################################
+# Copyright (c) 2017 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 os
+import pytest
+
+from qtip.collector.parser.grep import grep_in_file
+
+
+@pytest.fixture
+def logfile(data_root):
+ return os.path.join(data_root, 'fake.log')
+
+
+@pytest.mark.parametrize("regex,expected", [
+ ('not exist', []),
+ ('Lorem (\S+)', [{'groups': ('ipsum',), 'groupdict': {}}]),
+ ('nisi ut (?P<name>\S+)', [{'groups': ('aliquip',), 'groupdict': {'name': 'aliquip'}}])
+])
+def test_grep_in_file(logfile, regex, expected):
+ matches = grep_in_file(logfile, regex)
+ assert len(matches) == len(expected)
+ for i in range(len(matches)):
+ assert matches[i].groups() == expected[i]['groups']
+ assert matches[i].groupdict() == expected[i]['groupdict']
--- /dev/null
+##############################################################################
+# Copyright (c) 2017 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.collector.logfile import LogfileCollector
+
+
+@pytest.fixture
+def logfile_collector(logfile_config, plan):
+ return LogfileCollector(logfile_config, plan)
+
+
+def test_run(logfile_collector):
+ collected = logfile_collector.run()
+ assert collected['groupdict'] == {
+ 'event_posted': '1482894965.3',
+ 'host_down': '1482894965.51',
+ 'network_down': '1482894965.164096803',
+ 'notified': '1482894965.63',
+ 'vm_error': '1482894965.3'
+ }
+ assert list(collected['groups']) == ['1482894965.63',
+ '1482894965.3',
+ '1482894965.3',
+ '1482894965.51',
+ '1482894965.164096803']
import pytest
+from qtip.collector.logfile import LogfileCollector
+from qtip.loader.plan import load_collector
from qtip.loader.plan import Plan
from qtip.loader.plan import PlanProp
from qtip.loader.plan import QPISpec
def test_init(plan):
- assert plan.name == 'fake plan'
+ assert plan.name == 'doctor performance profiling'
assert isinstance(plan.content, dict)
for qpi in plan.qpis:
assert isinstance(qpi, QPISpec)
def test_list_all(benchmarks_root):
plan_list = Plan.list_all(paths=[benchmarks_root])
- assert len(list(plan_list)) is 2
+ assert len(list(plan_list)) is 1
for desc in plan_list:
assert PlanProp.NAME in desc
assert PlanProp.CONTENT in desc
assert PlanProp.DESCRIPTION in content
assert PlanProp.CONFIG in content
assert PlanProp.QPIS in content
+
+
+def test_load_collector():
+ assert load_collector(LogfileCollector.TYPE) is LogfileCollector
Code Review / qtip.git / commitdiff