1 ##############################################################################
2 # Copyright (c) 2015 Ericsson AB and others.
4 # All rights reserved. This program and the accompanying materials
5 # are made available under the terms of the Apache License, Version 2.0
6 # which accompanies this distribution, and is available at
7 # http://www.apache.org/licenses/LICENSE-2.0
8 ##############################################################################
10 """ Handler for yardstick command 'task' """
12 from __future__ import absolute_import
13 from __future__ import print_function
16 from collections import OrderedDict
27 from six.moves import filter
29 from yardstick.benchmark.contexts.base import Context
30 from yardstick.benchmark.runners import base as base_runner
31 from yardstick.dispatcher.base import Base as DispatcherBase
32 from yardstick.common.task_template import TaskTemplate
33 from yardstick.common.utils import source_env
34 from yardstick.common import utils
35 from yardstick.common import constants
37 output_file_default = "/tmp/yardstick.out"
38 config_file = '/etc/yardstick/yardstick.conf'
39 test_cases_dir_default = "tests/opnfv/test_cases/"
40 LOG = logging.getLogger(__name__)
43 class Task(object): # pragma: no cover
46 Set of commands to manage benchmark tasks.
53 def _set_dispatchers(self, output_config):
54 dispatchers = output_config.get('DEFAULT', {}).get('dispatcher',
56 out_types = [s.strip() for s in dispatchers.split(',')]
57 output_config['DEFAULT']['dispatcher'] = out_types
59 def start(self, args, **kwargs):
60 """Start a benchmark scenario."""
62 atexit.register(self.atexit_handler)
64 task_id = getattr(args, 'task_id')
65 self.task_id = task_id if task_id else str(uuid.uuid4())
70 output_config = utils.parse_ini_file(config_file)
72 # all error will be ignore, the default value is {}
75 self._init_output_config(output_config)
76 self._set_output_config(output_config, args.output_file)
77 LOG.debug('Output configuration is: %s', output_config)
79 self._set_dispatchers(output_config)
81 # update dispatcher list
82 if 'file' in output_config['DEFAULT']['dispatcher']:
83 result = {'status': 0, 'result': {}}
84 utils.write_json_to_file(args.output_file, result)
86 total_start_time = time.time()
87 parser = TaskParser(args.inputfile[0])
90 # 1.parse suite, return suite_params info
91 task_files, task_args, task_args_fnames = \
94 task_files = [parser.path]
95 task_args = [args.task_args]
96 task_args_fnames = [args.task_args_file]
98 LOG.info("\ntask_files:%s, \ntask_args:%s, \ntask_args_fnames:%s",
99 task_files, task_args, task_args_fnames)
106 for i in range(0, len(task_files)):
107 one_task_start_time = time.time()
108 parser.path = task_files[i]
109 scenarios, run_in_parallel, meet_precondition, contexts = \
110 parser.parse_task(self.task_id, task_args[i],
113 self.contexts.extend(contexts)
115 if not meet_precondition:
116 LOG.info("meet_precondition is %s, please check envrionment",
120 case_name = os.path.splitext(os.path.basename(task_files[i]))[0]
122 data = self._run(scenarios, run_in_parallel, args.output_file)
123 except KeyboardInterrupt:
126 LOG.exception("Running test case %s failed!", case_name)
127 testcases[case_name] = {'criteria': 'FAIL', 'tc_data': []}
129 testcases[case_name] = {'criteria': 'PASS', 'tc_data': data}
132 # keep deployment, forget about stack
133 # (hide it for exit handler)
136 for context in self.contexts[::-1]:
139 one_task_end_time = time.time()
140 LOG.info("task %s finished in %d secs", task_files[i],
141 one_task_end_time - one_task_start_time)
143 result = self._get_format_result(testcases)
145 self._do_output(output_config, result)
147 total_end_time = time.time()
148 LOG.info("total finished in %d secs",
149 total_end_time - total_start_time)
151 scenario = scenarios[0]
152 print("To generate report execute => yardstick report generate ",
153 scenario['task_id'], scenario['tc'])
155 print("Done, exiting")
158 def _init_output_config(self, output_config):
159 output_config.setdefault('DEFAULT', {})
160 output_config.setdefault('dispatcher_http', {})
161 output_config.setdefault('dispatcher_file', {})
162 output_config.setdefault('dispatcher_influxdb', {})
163 output_config.setdefault('nsb', {})
165 def _set_output_config(self, output_config, file_path):
167 out_type = os.environ['DISPATCHER']
169 output_config['DEFAULT'].setdefault('dispatcher', 'file')
171 output_config['DEFAULT']['dispatcher'] = out_type
173 output_config['dispatcher_file']['file_path'] = file_path
176 target = os.environ['TARGET']
180 k = 'dispatcher_{}'.format(output_config['DEFAULT']['dispatcher'])
181 output_config[k]['target'] = target
183 def _get_format_result(self, testcases):
184 criteria = self._get_task_criteria(testcases)
187 'deploy_scenario': os.environ.get('DEPLOY_SCENARIO', 'unknown'),
188 'installer': os.environ.get('INSTALLER_TYPE', 'unknown'),
189 'pod_name': os.environ.get('NODE_NAME', 'unknown'),
190 'version': os.environ.get('YARDSTICK_BRANCH', 'unknown')
196 'criteria': criteria,
197 'task_id': self.task_id,
199 'testcases': testcases
205 def _get_task_criteria(self, testcases):
206 criteria = any(t.get('criteria') != 'PASS' for t in testcases.values())
212 def _do_output(self, output_config, result):
213 dispatchers = DispatcherBase.get(output_config)
215 for dispatcher in dispatchers:
216 dispatcher.flush_result_data(result)
218 def _run(self, scenarios, run_in_parallel, output_file):
219 """Deploys context and calls runners"""
220 for context in self.contexts:
223 background_runners = []
226 # Start all background scenarios
227 for scenario in filter(_is_background_scenario, scenarios):
228 scenario["runner"] = dict(type="Duration", duration=1000000000)
229 runner = self.run_one_scenario(scenario, output_file)
230 background_runners.append(runner)
234 for scenario in scenarios:
235 if not _is_background_scenario(scenario):
236 runner = self.run_one_scenario(scenario, output_file)
237 runners.append(runner)
239 # Wait for runners to finish
240 for runner in runners:
241 status = runner_join(runner)
244 self.outputs.update(runner.get_output())
245 result.extend(runner.get_result())
246 print("Runner ended, output in", output_file)
249 for scenario in scenarios:
250 if not _is_background_scenario(scenario):
251 runner = self.run_one_scenario(scenario, output_file)
252 status = runner_join(runner)
254 LOG.error('Scenario: %s ERROR', scenario.get('type'))
256 self.outputs.update(runner.get_output())
257 result.extend(runner.get_result())
258 print("Runner ended, output in", output_file)
260 # Abort background runners
261 for runner in background_runners:
264 # Wait for background runners to finish
265 for runner in background_runners:
266 status = runner.join(timeout=60)
268 # Nuke if it did not stop nicely
269 base_runner.Runner.terminate(runner)
270 status = runner_join(runner)
272 base_runner.Runner.release(runner)
274 self.outputs.update(runner.get_output())
275 result.extend(runner.get_result())
276 print("Background task ended")
279 def atexit_handler(self):
280 """handler for process termination"""
281 base_runner.Runner.terminate_all()
284 print("Undeploying all contexts")
285 for context in self.contexts[::-1]:
288 def _parse_options(self, op):
289 if isinstance(op, dict):
290 return {k: self._parse_options(v) for k, v in op.items()}
291 elif isinstance(op, list):
292 return [self._parse_options(v) for v in op]
293 elif isinstance(op, str):
294 return self.outputs.get(op[1:]) if op.startswith('$') else op
298 def run_one_scenario(self, scenario_cfg, output_file):
299 """run one scenario using context"""
300 runner_cfg = scenario_cfg["runner"]
301 runner_cfg['output_filename'] = output_file
303 options = scenario_cfg.get('options', {})
304 scenario_cfg['options'] = self._parse_options(options)
306 # TODO support get multi hosts/vms info
308 if "host" in scenario_cfg:
309 context_cfg['host'] = Context.get_server(scenario_cfg["host"])
311 if "target" in scenario_cfg:
312 if is_ip_addr(scenario_cfg["target"]):
313 context_cfg['target'] = {}
314 context_cfg['target']["ipaddr"] = scenario_cfg["target"]
316 context_cfg['target'] = Context.get_server(
317 scenario_cfg["target"])
318 if self._is_same_heat_context(scenario_cfg["host"],
319 scenario_cfg["target"]):
320 context_cfg["target"]["ipaddr"] = \
321 context_cfg["target"]["private_ip"]
323 context_cfg["target"]["ipaddr"] = \
324 context_cfg["target"]["ip"]
326 if "targets" in scenario_cfg:
328 for target in scenario_cfg["targets"]:
329 if is_ip_addr(target):
330 ip_list.append(target)
331 context_cfg['target'] = {}
333 context_cfg['target'] = Context.get_server(target)
334 if self._is_same_heat_context(scenario_cfg["host"],
336 ip_list.append(context_cfg["target"]["private_ip"])
338 ip_list.append(context_cfg["target"]["ip"])
339 context_cfg['target']['ipaddr'] = ','.join(ip_list)
341 if "nodes" in scenario_cfg:
342 context_cfg["nodes"] = parse_nodes_with_context(scenario_cfg)
343 context_cfg["networks"] = get_networks_from_nodes(
344 context_cfg["nodes"])
345 runner = base_runner.Runner.get(runner_cfg)
347 print("Starting runner of type '%s'" % runner_cfg["type"])
348 runner.run(scenario_cfg, context_cfg)
352 def _is_same_heat_context(self, host_attr, target_attr):
353 """check if two servers are in the same heat context
354 host_attr: either a name for a server created by yardstick or a dict
355 with attribute name mapping when using external heat templates
356 target_attr: either a name for a server created by yardstick or a dict
357 with attribute name mapping when using external heat templates
361 for context in self.contexts:
362 if context.__context_type__ != "Heat":
365 host = context._get_server(host_attr)
369 target = context._get_server(target_attr)
373 # Both host and target is not None, then they are in the
380 class TaskParser(object): # pragma: no cover
381 """Parser for task config files in yaml format"""
383 def __init__(self, path):
386 def _meet_constraint(self, task, cur_pod, cur_installer):
387 if "constraint" in task:
388 constraint = task.get('constraint', None)
389 if constraint is not None:
390 tc_fit_pod = constraint.get('pod', None)
391 tc_fit_installer = constraint.get('installer', None)
392 LOG.info("cur_pod:%s, cur_installer:%s,tc_constraints:%s",
393 cur_pod, cur_installer, constraint)
394 if (cur_pod is None) or (tc_fit_pod and cur_pod not in tc_fit_pod):
396 if (cur_installer is None) or (tc_fit_installer and cur_installer
397 not in tc_fit_installer):
401 def _get_task_para(self, task, cur_pod):
402 task_args = task.get('task_args', None)
403 if task_args is not None:
404 task_args = task_args.get(cur_pod, task_args.get('default'))
405 task_args_fnames = task.get('task_args_fnames', None)
406 if task_args_fnames is not None:
407 task_args_fnames = task_args_fnames.get(cur_pod, None)
408 return task_args, task_args_fnames
410 def parse_suite(self):
411 """parse the suite file and return a list of task config file paths
412 and lists of optional parameters if present"""
413 LOG.info("\nParsing suite file:%s", self.path)
416 with open(self.path) as stream:
417 cfg = yaml.safe_load(stream)
418 except IOError as ioerror:
421 self._check_schema(cfg["schema"], "suite")
422 LOG.info("\nStarting scenario:%s", cfg["name"])
424 test_cases_dir = cfg.get("test_cases_dir", test_cases_dir_default)
425 test_cases_dir = os.path.join(constants.YARDSTICK_ROOT_PATH,
427 if test_cases_dir[-1] != os.sep:
428 test_cases_dir += os.sep
430 cur_pod = os.environ.get('NODE_NAME', None)
431 cur_installer = os.environ.get('INSTALLER_TYPE', None)
433 valid_task_files = []
435 valid_task_args_fnames = []
437 for task in cfg["test_cases"]:
439 if "file_name" in task:
440 task_fname = task.get('file_name', None)
441 if task_fname is None:
446 if self._meet_constraint(task, cur_pod, cur_installer):
447 valid_task_files.append(test_cases_dir + task_fname)
450 # 3.fetch task parameters
451 task_args, task_args_fnames = self._get_task_para(task, cur_pod)
452 valid_task_args.append(task_args)
453 valid_task_args_fnames.append(task_args_fnames)
455 return valid_task_files, valid_task_args, valid_task_args_fnames
457 def parse_task(self, task_id, task_args=None, task_args_file=None):
458 """parses the task file and return an context and scenario instances"""
459 print("Parsing task config:", self.path)
464 with open(task_args_file) as f:
465 kw.update(parse_task_args("task_args_file", f.read()))
466 kw.update(parse_task_args("task_args", task_args))
471 with open(self.path) as f:
473 input_task = f.read()
474 rendered_task = TaskTemplate.render(input_task, **kw)
475 except Exception as e:
476 print("Failed to render template:\n%(task)s\n%(err)s\n"
477 % {"task": input_task, "err": e})
479 print("Input task is:\n%s\n" % rendered_task)
481 cfg = yaml.safe_load(rendered_task)
482 except IOError as ioerror:
485 self._check_schema(cfg["schema"], "task")
486 meet_precondition = self._check_precondition(cfg)
488 # TODO: support one or many contexts? Many would simpler and precise
489 # TODO: support hybrid context type
491 context_cfgs = [cfg["context"]]
492 elif "contexts" in cfg:
493 context_cfgs = cfg["contexts"]
495 context_cfgs = [{"type": "Dummy"}]
498 name_suffix = '-{}'.format(task_id[:8])
499 for cfg_attrs in context_cfgs:
501 cfg_attrs['name'] = '{}{}'.format(cfg_attrs['name'],
505 # default to Heat context because we are testing OpenStack
506 context_type = cfg_attrs.get("type", "Heat")
507 context = Context.get(context_type)
508 context.init(cfg_attrs)
509 contexts.append(context)
511 run_in_parallel = cfg.get("run_in_parallel", False)
513 # add tc and task id for influxdb extended tags
514 for scenario in cfg["scenarios"]:
515 task_name = os.path.splitext(os.path.basename(self.path))[0]
516 scenario["tc"] = task_name
517 scenario["task_id"] = task_id
518 # embed task path into scenario so we can load other files
519 # relative to task path
520 scenario["task_path"] = os.path.dirname(self.path)
522 change_server_name(scenario, name_suffix)
525 for node in scenario['nodes']:
526 scenario['nodes'][node] += name_suffix
530 # TODO we need something better here, a class that represent the file
531 return cfg["scenarios"], run_in_parallel, meet_precondition, contexts
533 def _check_schema(self, cfg_schema, schema_type):
534 """Check if config file is using the correct schema type"""
536 if cfg_schema != "yardstick:" + schema_type + ":0.1":
537 sys.exit("error: file %s has unknown schema %s" % (self.path,
540 def _check_precondition(self, cfg):
541 """Check if the environment meet the precondition"""
543 if "precondition" in cfg:
544 precondition = cfg["precondition"]
545 installer_type = precondition.get("installer_type", None)
546 deploy_scenarios = precondition.get("deploy_scenarios", None)
547 tc_fit_pods = precondition.get("pod_name", None)
548 installer_type_env = os.environ.get('INSTALL_TYPE', None)
549 deploy_scenario_env = os.environ.get('DEPLOY_SCENARIO', None)
550 pod_name_env = os.environ.get('NODE_NAME', None)
552 LOG.info("installer_type: %s, installer_type_env: %s",
553 installer_type, installer_type_env)
554 LOG.info("deploy_scenarios: %s, deploy_scenario_env: %s",
555 deploy_scenarios, deploy_scenario_env)
556 LOG.info("tc_fit_pods: %s, pod_name_env: %s",
557 tc_fit_pods, pod_name_env)
558 if installer_type and installer_type_env:
559 if installer_type_env not in installer_type:
561 if deploy_scenarios and deploy_scenario_env:
562 deploy_scenarios_list = deploy_scenarios.split(',')
563 for deploy_scenario in deploy_scenarios_list:
564 if deploy_scenario_env.startswith(deploy_scenario):
567 if tc_fit_pods and pod_name_env:
568 if pod_name_env not in tc_fit_pods:
573 def is_ip_addr(addr):
574 """check if string addr is an IP address"""
576 addr = addr.get('public_ip_attr', addr.get('private_ip_attr'))
577 except AttributeError:
581 ipaddress.ip_address(addr.encode('utf-8'))
588 def _is_background_scenario(scenario):
589 if "run_in_background" in scenario:
590 return scenario["run_in_background"]
595 def parse_nodes_with_context(scenario_cfg):
596 """parse the 'nodes' fields in scenario """
597 # ensure consistency in node instantiation order
598 return OrderedDict((nodename, Context.get_server(scenario_cfg["nodes"][nodename]))
599 for nodename in sorted(scenario_cfg["nodes"]))
602 def get_networks_from_nodes(nodes):
603 """parse the 'nodes' fields in scenario """
605 for node in nodes.values():
608 interfaces = node.get('interfaces', {})
609 for interface in interfaces.values():
610 vld_id = interface.get('vld_id')
611 # mgmt network doesn't have vld_id
614 network = Context.get_network({"vld_id": vld_id})
616 networks[network['name']] = network
620 def runner_join(runner):
621 """join (wait for) a runner, exit process at runner failure"""
622 status = runner.join()
623 base_runner.Runner.release(runner)
627 def print_invalid_header(source_name, args):
628 print("Invalid %(source)s passed:\n\n %(args)s\n"
629 % {"source": source_name, "args": args})
632 def parse_task_args(src_name, args):
633 if isinstance(args, collections.Mapping):
637 kw = args and yaml.safe_load(args)
638 kw = {} if kw is None else kw
639 except yaml.parser.ParserError as e:
640 print_invalid_header(src_name, args)
641 print("%(source)s has to be YAML. Details:\n\n%(err)s\n"
642 % {"source": src_name, "err": e})
645 if not isinstance(kw, dict):
646 print_invalid_header(src_name, args)
647 print("%(src)s had to be dict, actually %(src_type)s\n"
648 % {"src": src_name, "src_type": type(kw)})
653 def check_environment():
654 auth_url = os.environ.get('OS_AUTH_URL', None)
657 source_env(constants.OPENRC)
659 if e.errno != errno.EEXIST:
661 LOG.debug('OPENRC file not found')
664 def change_server_name(scenario, suffix):
666 host = scenario['host']
671 host['name'] += suffix
673 scenario['host'] += suffix
676 target = scenario['target']
681 target['name'] += suffix
683 scenario['target'] += suffix
687 scenario[key] = ['{}{}'.format(a, suffix) for a in scenario[key]]