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
25 from six.moves import filter
27 from yardstick.benchmark.contexts.base import Context
28 from yardstick.benchmark.runners import base as base_runner
29 from yardstick.dispatcher.base import Base as DispatcherBase
30 from yardstick.common.task_template import TaskTemplate
31 from yardstick.common.utils import source_env
32 from yardstick.common import utils
33 from yardstick.common import constants
35 output_file_default = "/tmp/yardstick.out"
36 config_file = '/etc/yardstick/yardstick.conf'
37 test_cases_dir_default = "tests/opnfv/test_cases/"
38 LOG = logging.getLogger(__name__)
41 class Task(object): # pragma: no cover
44 Set of commands to manage benchmark tasks.
51 def start(self, args, **kwargs):
52 """Start a benchmark scenario."""
54 atexit.register(self.atexit_handler)
56 task_id = getattr(args, 'task_id')
57 self.task_id = task_id if task_id else str(uuid.uuid4())
61 output_config = utils.parse_ini_file(config_file)
62 self._init_output_config(output_config)
63 self._set_output_config(output_config, args.output_file)
64 LOG.debug('Output configuration is: %s', output_config)
66 if output_config['DEFAULT'].get('dispatcher') == 'file':
67 result = {'status': 0, 'result': {}}
68 utils.write_json_to_file(args.output_file, result)
70 total_start_time = time.time()
71 parser = TaskParser(args.inputfile[0])
74 # 1.parse suite, return suite_params info
75 task_files, task_args, task_args_fnames = \
78 task_files = [parser.path]
79 task_args = [args.task_args]
80 task_args_fnames = [args.task_args_file]
82 LOG.info("\ntask_files:%s, \ntask_args:%s, \ntask_args_fnames:%s",
83 task_files, task_args, task_args_fnames)
90 for i in range(0, len(task_files)):
91 one_task_start_time = time.time()
92 parser.path = task_files[i]
93 scenarios, run_in_parallel, meet_precondition, contexts = \
94 parser.parse_task(self.task_id, task_args[i],
97 self.contexts.extend(contexts)
99 if not meet_precondition:
100 LOG.info("meet_precondition is %s, please check envrionment",
104 case_name = os.path.splitext(os.path.basename(task_files[i]))[0]
106 data = self._run(scenarios, run_in_parallel, args.output_file)
107 except KeyboardInterrupt:
110 testcases[case_name] = {'criteria': 'FAIL', 'tc_data': []}
112 testcases[case_name] = {'criteria': 'PASS', 'tc_data': data}
115 # keep deployment, forget about stack
116 # (hide it for exit handler)
119 for context in self.contexts[::-1]:
122 one_task_end_time = time.time()
123 LOG.info("task %s finished in %d secs", task_files[i],
124 one_task_end_time - one_task_start_time)
126 result = self._get_format_result(testcases)
128 self._do_output(output_config, result)
130 total_end_time = time.time()
131 LOG.info("total finished in %d secs",
132 total_end_time - total_start_time)
134 scenario = scenarios[0]
135 print("To generate report execute => yardstick report generate ",
136 scenario['task_id'], scenario['tc'])
138 print("Done, exiting")
141 def _init_output_config(self, output_config):
142 output_config.setdefault('DEFAULT', {})
143 output_config.setdefault('dispatcher_http', {})
144 output_config.setdefault('dispatcher_file', {})
145 output_config.setdefault('dispatcher_influxdb', {})
146 output_config.setdefault('nsb', {})
148 def _set_output_config(self, output_config, file_path):
150 out_type = os.environ['DISPATCHER']
152 output_config['DEFAULT'].setdefault('dispatcher', 'file')
154 output_config['DEFAULT']['dispatcher'] = out_type
156 output_config['dispatcher_file']['file_path'] = file_path
159 target = os.environ['TARGET']
163 k = 'dispatcher_{}'.format(output_config['DEFAULT']['dispatcher'])
164 output_config[k]['target'] = target
166 def _get_format_result(self, testcases):
167 criteria = self._get_task_criteria(testcases)
170 'deploy_scenario': os.environ.get('DEPLOY_SCENARIO', 'unknown'),
171 'installer': os.environ.get('INSTALLER_TYPE', 'unknown'),
172 'pod_name': os.environ.get('NODE_NAME', 'unknown'),
173 'version': os.environ.get('YARDSTICK_BRANCH', 'unknown')
179 'criteria': criteria,
180 'task_id': self.task_id,
182 'testcases': testcases
188 def _get_task_criteria(self, testcases):
189 criteria = any(t.get('criteria') != 'PASS' for t in testcases.values())
195 def _do_output(self, output_config, result):
197 dispatcher = DispatcherBase.get(output_config)
198 dispatcher.flush_result_data(result)
200 def _run(self, scenarios, run_in_parallel, output_file):
201 """Deploys context and calls runners"""
202 for context in self.contexts:
205 background_runners = []
208 # Start all background scenarios
209 for scenario in filter(_is_background_scenario, scenarios):
210 scenario["runner"] = dict(type="Duration", duration=1000000000)
211 runner = self.run_one_scenario(scenario, output_file)
212 background_runners.append(runner)
216 for scenario in scenarios:
217 if not _is_background_scenario(scenario):
218 runner = self.run_one_scenario(scenario, output_file)
219 runners.append(runner)
221 # Wait for runners to finish
222 for runner in runners:
223 status = runner_join(runner)
226 self.outputs.update(runner.get_output())
227 result.extend(runner.get_result())
228 print("Runner ended, output in", output_file)
231 for scenario in scenarios:
232 if not _is_background_scenario(scenario):
233 runner = self.run_one_scenario(scenario, output_file)
234 status = runner_join(runner)
236 LOG.error('Scenario: %s ERROR', scenario.get('type'))
238 self.outputs.update(runner.get_output())
239 result.extend(runner.get_result())
240 print("Runner ended, output in", output_file)
242 # Abort background runners
243 for runner in background_runners:
246 # Wait for background runners to finish
247 for runner in background_runners:
248 status = runner.join(timeout=60)
250 # Nuke if it did not stop nicely
251 base_runner.Runner.terminate(runner)
252 status = runner_join(runner)
253 self.outputs.update(runner.get_output())
254 result.extend(runner.get_result())
256 base_runner.Runner.release(runner)
259 print("Background task ended")
263 def atexit_handler(self):
264 """handler for process termination"""
265 base_runner.Runner.terminate_all()
268 print("Undeploying all contexts")
269 for context in self.contexts[::-1]:
272 def _parse_options(self, op):
273 if isinstance(op, dict):
274 return {k: self._parse_options(v) for k, v in op.items()}
275 elif isinstance(op, list):
276 return [self._parse_options(v) for v in op]
277 elif isinstance(op, str):
278 return self.outputs.get(op[1:]) if op.startswith('$') else op
282 def run_one_scenario(self, scenario_cfg, output_file):
283 """run one scenario using context"""
284 runner_cfg = scenario_cfg["runner"]
285 runner_cfg['output_filename'] = output_file
287 options = scenario_cfg.get('options', {})
288 scenario_cfg['options'] = self._parse_options(options)
290 # TODO support get multi hosts/vms info
292 if "host" in scenario_cfg:
293 context_cfg['host'] = Context.get_server(scenario_cfg["host"])
295 if "target" in scenario_cfg:
296 if is_ip_addr(scenario_cfg["target"]):
297 context_cfg['target'] = {}
298 context_cfg['target']["ipaddr"] = scenario_cfg["target"]
300 context_cfg['target'] = Context.get_server(
301 scenario_cfg["target"])
302 if self._is_same_heat_context(scenario_cfg["host"],
303 scenario_cfg["target"]):
304 context_cfg["target"]["ipaddr"] = \
305 context_cfg["target"]["private_ip"]
307 context_cfg["target"]["ipaddr"] = \
308 context_cfg["target"]["ip"]
310 if "targets" in scenario_cfg:
312 for target in scenario_cfg["targets"]:
313 if is_ip_addr(target):
314 ip_list.append(target)
315 context_cfg['target'] = {}
317 context_cfg['target'] = Context.get_server(target)
318 if self._is_same_heat_context(scenario_cfg["host"],
320 ip_list.append(context_cfg["target"]["private_ip"])
322 ip_list.append(context_cfg["target"]["ip"])
323 context_cfg['target']['ipaddr'] = ','.join(ip_list)
325 if "nodes" in scenario_cfg:
326 context_cfg["nodes"] = parse_nodes_with_context(scenario_cfg)
327 runner = base_runner.Runner.get(runner_cfg)
329 print("Starting runner of type '%s'" % runner_cfg["type"])
330 runner.run(scenario_cfg, context_cfg)
334 def _is_same_heat_context(self, host_attr, target_attr):
335 """check if two servers are in the same heat context
336 host_attr: either a name for a server created by yardstick or a dict
337 with attribute name mapping when using external heat templates
338 target_attr: either a name for a server created by yardstick or a dict
339 with attribute name mapping when using external heat templates
343 for context in self.contexts:
344 if context.__context_type__ != "Heat":
347 host = context._get_server(host_attr)
351 target = context._get_server(target_attr)
355 # Both host and target is not None, then they are in the
362 class TaskParser(object): # pragma: no cover
363 """Parser for task config files in yaml format"""
365 def __init__(self, path):
368 def _meet_constraint(self, task, cur_pod, cur_installer):
369 if "constraint" in task:
370 constraint = task.get('constraint', None)
371 if constraint is not None:
372 tc_fit_pod = constraint.get('pod', None)
373 tc_fit_installer = constraint.get('installer', None)
374 LOG.info("cur_pod:%s, cur_installer:%s,tc_constraints:%s",
375 cur_pod, cur_installer, constraint)
376 if cur_pod and tc_fit_pod and cur_pod not in tc_fit_pod:
378 if cur_installer and tc_fit_installer and \
379 cur_installer not in tc_fit_installer:
383 def _get_task_para(self, task, cur_pod):
384 task_args = task.get('task_args', None)
385 if task_args is not None:
386 task_args = task_args.get(cur_pod, None)
387 task_args_fnames = task.get('task_args_fnames', None)
388 if task_args_fnames is not None:
389 task_args_fnames = task_args_fnames.get(cur_pod, None)
390 return task_args, task_args_fnames
392 def parse_suite(self):
393 """parse the suite file and return a list of task config file paths
394 and lists of optional parameters if present"""
395 LOG.info("\nParsing suite file:%s", self.path)
398 with open(self.path) as stream:
399 cfg = yaml.load(stream)
400 except IOError as ioerror:
403 self._check_schema(cfg["schema"], "suite")
404 LOG.info("\nStarting scenario:%s", cfg["name"])
406 test_cases_dir = cfg.get("test_cases_dir", test_cases_dir_default)
407 test_cases_dir = os.path.join(constants.YARDSTICK_ROOT_PATH,
409 if test_cases_dir[-1] != os.sep:
410 test_cases_dir += os.sep
412 cur_pod = os.environ.get('NODE_NAME', None)
413 cur_installer = os.environ.get('INSTALLER_TYPE', None)
415 valid_task_files = []
417 valid_task_args_fnames = []
419 for task in cfg["test_cases"]:
421 if "file_name" in task:
422 task_fname = task.get('file_name', None)
423 if task_fname is None:
428 if self._meet_constraint(task, cur_pod, cur_installer):
429 valid_task_files.append(test_cases_dir + task_fname)
432 # 3.fetch task parameters
433 task_args, task_args_fnames = self._get_task_para(task, cur_pod)
434 valid_task_args.append(task_args)
435 valid_task_args_fnames.append(task_args_fnames)
437 return valid_task_files, valid_task_args, valid_task_args_fnames
439 def parse_task(self, task_id, task_args=None, task_args_file=None):
440 """parses the task file and return an context and scenario instances"""
441 print("Parsing task config:", self.path)
446 with open(task_args_file) as f:
447 kw.update(parse_task_args("task_args_file", f.read()))
448 kw.update(parse_task_args("task_args", task_args))
453 with open(self.path) as f:
455 input_task = f.read()
456 rendered_task = TaskTemplate.render(input_task, **kw)
457 except Exception as e:
458 print("Failed to render template:\n%(task)s\n%(err)s\n"
459 % {"task": input_task, "err": e})
461 print("Input task is:\n%s\n" % rendered_task)
463 cfg = yaml.load(rendered_task)
464 except IOError as ioerror:
467 self._check_schema(cfg["schema"], "task")
468 meet_precondition = self._check_precondition(cfg)
470 # TODO: support one or many contexts? Many would simpler and precise
471 # TODO: support hybrid context type
473 context_cfgs = [cfg["context"]]
474 elif "contexts" in cfg:
475 context_cfgs = cfg["contexts"]
477 context_cfgs = [{"type": "Dummy"}]
480 name_suffix = '-{}'.format(task_id[:8])
481 for cfg_attrs in context_cfgs:
483 cfg_attrs['name'] = '{}{}'.format(cfg_attrs['name'],
487 # default to Heat context because we are testing OpenStack
488 context_type = cfg_attrs.get("type", "Heat")
489 context = Context.get(context_type)
490 context.init(cfg_attrs)
491 contexts.append(context)
493 run_in_parallel = cfg.get("run_in_parallel", False)
495 # add tc and task id for influxdb extended tags
496 for scenario in cfg["scenarios"]:
497 task_name = os.path.splitext(os.path.basename(self.path))[0]
498 scenario["tc"] = task_name
499 scenario["task_id"] = task_id
500 # embed task path into scenario so we can load other files
501 # relative to task path
502 scenario["task_path"] = os.path.dirname(self.path)
504 change_server_name(scenario, name_suffix)
507 for node in scenario['nodes']:
508 scenario['nodes'][node] += name_suffix
512 # TODO we need something better here, a class that represent the file
513 return cfg["scenarios"], run_in_parallel, meet_precondition, contexts
515 def _check_schema(self, cfg_schema, schema_type):
516 """Check if config file is using the correct schema type"""
518 if cfg_schema != "yardstick:" + schema_type + ":0.1":
519 sys.exit("error: file %s has unknown schema %s" % (self.path,
522 def _check_precondition(self, cfg):
523 """Check if the envrionment meet the preconditon"""
525 if "precondition" in cfg:
526 precondition = cfg["precondition"]
527 installer_type = precondition.get("installer_type", None)
528 deploy_scenarios = precondition.get("deploy_scenarios", None)
529 tc_fit_pods = precondition.get("pod_name", None)
530 installer_type_env = os.environ.get('INSTALL_TYPE', None)
531 deploy_scenario_env = os.environ.get('DEPLOY_SCENARIO', None)
532 pod_name_env = os.environ.get('NODE_NAME', None)
534 LOG.info("installer_type: %s, installer_type_env: %s",
535 installer_type, installer_type_env)
536 LOG.info("deploy_scenarios: %s, deploy_scenario_env: %s",
537 deploy_scenarios, deploy_scenario_env)
538 LOG.info("tc_fit_pods: %s, pod_name_env: %s",
539 tc_fit_pods, pod_name_env)
540 if installer_type and installer_type_env:
541 if installer_type_env not in installer_type:
543 if deploy_scenarios and deploy_scenario_env:
544 deploy_scenarios_list = deploy_scenarios.split(',')
545 for deploy_scenario in deploy_scenarios_list:
546 if deploy_scenario_env.startswith(deploy_scenario):
549 if tc_fit_pods and pod_name_env:
550 if pod_name_env not in tc_fit_pods:
555 def is_ip_addr(addr):
556 """check if string addr is an IP address"""
558 addr = addr.get('public_ip_attr', addr.get('private_ip_attr'))
559 except AttributeError:
563 ipaddress.ip_address(addr.encode('utf-8'))
570 def _is_background_scenario(scenario):
571 if "run_in_background" in scenario:
572 return scenario["run_in_background"]
577 def parse_nodes_with_context(scenario_cfg):
578 """paras the 'nodes' fields in scenario """
579 nodes = scenario_cfg["nodes"]
582 for nodename in nodes:
583 nodes_cfg[nodename] = Context.get_server(nodes[nodename])
588 def runner_join(runner):
589 """join (wait for) a runner, exit process at runner failure"""
590 status = runner.join()
591 base_runner.Runner.release(runner)
595 def print_invalid_header(source_name, args):
596 print("Invalid %(source)s passed:\n\n %(args)s\n"
597 % {"source": source_name, "args": args})
600 def parse_task_args(src_name, args):
601 if isinstance(args, collections.Mapping):
605 kw = args and yaml.safe_load(args)
606 kw = {} if kw is None else kw
607 except yaml.parser.ParserError as e:
608 print_invalid_header(src_name, args)
609 print("%(source)s has to be YAML. Details:\n\n%(err)s\n"
610 % {"source": src_name, "err": e})
613 if not isinstance(kw, dict):
614 print_invalid_header(src_name, args)
615 print("%(src)s had to be dict, actually %(src_type)s\n"
616 % {"src": src_name, "src_type": type(kw)})
621 def check_environment():
622 auth_url = os.environ.get('OS_AUTH_URL', None)
625 source_env(constants.OPENRC)
627 if e.errno != errno.EEXIST:
629 LOG.debug('OPENRC file not found')
632 def change_server_name(scenario, suffix):
634 host = scenario['host']
639 host['name'] += suffix
641 scenario['host'] += suffix
644 target = scenario['target']
649 target['name'] += suffix
651 scenario['target'] += suffix
655 scenario[key] = ['{}{}'.format(a, suffix) for a in scenario[key]]