a49a2cb7172f88c62e14a2d43b4d2540027e8d75
[yardstick.git] / yardstick / benchmark / core / task.py
1 ##############################################################################
2 # Copyright (c) 2015 Ericsson AB and others.
3 #
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 ##############################################################################
9
10 """ Handler for yardstick command 'task' """
11
12 from __future__ import absolute_import
13 from __future__ import print_function
14 import sys
15 import os
16 from collections import OrderedDict
17
18 import yaml
19 import atexit
20 import ipaddress
21 import time
22 import logging
23 import uuid
24 import collections
25
26 from six.moves import filter
27 from jinja2 import Environment
28
29 from yardstick.benchmark.contexts.base import Context
30 from yardstick.benchmark.runners import base as base_runner
31 from yardstick.common.yaml_loader import yaml_load
32 from yardstick.dispatcher.base import Base as DispatcherBase
33 from yardstick.common.task_template import TaskTemplate
34 from yardstick.common import utils
35 from yardstick.common import constants
36 from yardstick.common.html_template import report_template
37
38 output_file_default = "/tmp/yardstick.out"
39 config_file = '/etc/yardstick/yardstick.conf'
40 test_cases_dir_default = "tests/opnfv/test_cases/"
41 LOG = logging.getLogger(__name__)
42 JOIN_TIMEOUT = 60
43
44
45 class Task(object):     # pragma: no cover
46     """Task commands.
47
48        Set of commands to manage benchmark tasks.
49     """
50
51     def __init__(self):
52         self.contexts = []
53         self.outputs = {}
54
55     def _set_dispatchers(self, output_config):
56         dispatchers = output_config.get('DEFAULT', {}).get('dispatcher',
57                                                            'file')
58         out_types = [s.strip() for s in dispatchers.split(',')]
59         output_config['DEFAULT']['dispatcher'] = out_types
60
61     def start(self, args, **kwargs):
62         """Start a benchmark scenario."""
63
64         atexit.register(self.atexit_handler)
65
66         task_id = getattr(args, 'task_id')
67         self.task_id = task_id if task_id else str(uuid.uuid4())
68
69         self._set_log()
70
71         try:
72             output_config = utils.parse_ini_file(config_file)
73         except Exception:
74             # all error will be ignore, the default value is {}
75             output_config = {}
76
77         self._init_output_config(output_config)
78         self._set_output_config(output_config, args.output_file)
79         LOG.debug('Output configuration is: %s', output_config)
80
81         self._set_dispatchers(output_config)
82
83         # update dispatcher list
84         if 'file' in output_config['DEFAULT']['dispatcher']:
85             result = {'status': 0, 'result': {}}
86             utils.write_json_to_file(args.output_file, result)
87
88         total_start_time = time.time()
89         parser = TaskParser(args.inputfile[0])
90
91         if args.suite:
92             # 1.parse suite, return suite_params info
93             task_files, task_args, task_args_fnames = \
94                 parser.parse_suite()
95         else:
96             task_files = [parser.path]
97             task_args = [args.task_args]
98             task_args_fnames = [args.task_args_file]
99
100         LOG.info("\ntask_files:%s, \ntask_args:%s, \ntask_args_fnames:%s",
101                  task_files, task_args, task_args_fnames)
102
103         if args.parse_only:
104             sys.exit(0)
105
106         testcases = {}
107         # parse task_files
108         for i in range(0, len(task_files)):
109             one_task_start_time = time.time()
110             parser.path = task_files[i]
111             scenarios, run_in_parallel, meet_precondition, contexts = \
112                 parser.parse_task(self.task_id, task_args[i],
113                                   task_args_fnames[i])
114
115             self.contexts.extend(contexts)
116
117             if not meet_precondition:
118                 LOG.info("meet_precondition is %s, please check envrionment",
119                          meet_precondition)
120                 continue
121
122             case_name = os.path.splitext(os.path.basename(task_files[i]))[0]
123             try:
124                 data = self._run(scenarios, run_in_parallel, args.output_file)
125             except KeyboardInterrupt:
126                 raise
127             except Exception:
128                 LOG.exception("Running test case %s failed!", case_name)
129                 testcases[case_name] = {'criteria': 'FAIL', 'tc_data': []}
130             else:
131                 testcases[case_name] = {'criteria': 'PASS', 'tc_data': data}
132
133             if args.keep_deploy:
134                 # keep deployment, forget about stack
135                 # (hide it for exit handler)
136                 self.contexts = []
137             else:
138                 for context in self.contexts[::-1]:
139                     context.undeploy()
140                 self.contexts = []
141             one_task_end_time = time.time()
142             LOG.info("task %s finished in %d secs", task_files[i],
143                      one_task_end_time - one_task_start_time)
144
145         result = self._get_format_result(testcases)
146
147         self._do_output(output_config, result)
148         self._generate_reporting(result)
149
150         total_end_time = time.time()
151         LOG.info("total finished in %d secs",
152                  total_end_time - total_start_time)
153
154         scenario = scenarios[0]
155         print("To generate report execute => yardstick report generate ",
156               scenario['task_id'], scenario['tc'])
157
158         print("Done, exiting")
159         return result
160
161     def _generate_reporting(self, result):
162         env = Environment()
163         with open(constants.REPORTING_FILE, 'w') as f:
164             f.write(env.from_string(report_template).render(result))
165
166         LOG.info('yardstick reporting generate in %s', constants.REPORTING_FILE)
167
168     def _set_log(self):
169         log_format = '%(asctime)s %(name)s %(filename)s:%(lineno)d %(levelname)s %(message)s'
170         log_formatter = logging.Formatter(log_format)
171
172         utils.makedirs(constants.TASK_LOG_DIR)
173         log_path = os.path.join(constants.TASK_LOG_DIR, '{}.log'.format(self.task_id))
174         log_handler = logging.FileHandler(log_path)
175         log_handler.setFormatter(log_formatter)
176         log_handler.setLevel(logging.DEBUG)
177
178         logging.root.addHandler(log_handler)
179
180     def _init_output_config(self, output_config):
181         output_config.setdefault('DEFAULT', {})
182         output_config.setdefault('dispatcher_http', {})
183         output_config.setdefault('dispatcher_file', {})
184         output_config.setdefault('dispatcher_influxdb', {})
185         output_config.setdefault('nsb', {})
186
187     def _set_output_config(self, output_config, file_path):
188         try:
189             out_type = os.environ['DISPATCHER']
190         except KeyError:
191             output_config['DEFAULT'].setdefault('dispatcher', 'file')
192         else:
193             output_config['DEFAULT']['dispatcher'] = out_type
194
195         output_config['dispatcher_file']['file_path'] = file_path
196
197         try:
198             target = os.environ['TARGET']
199         except KeyError:
200             pass
201         else:
202             k = 'dispatcher_{}'.format(output_config['DEFAULT']['dispatcher'])
203             output_config[k]['target'] = target
204
205     def _get_format_result(self, testcases):
206         criteria = self._get_task_criteria(testcases)
207
208         info = {
209             'deploy_scenario': os.environ.get('DEPLOY_SCENARIO', 'unknown'),
210             'installer': os.environ.get('INSTALLER_TYPE', 'unknown'),
211             'pod_name': os.environ.get('NODE_NAME', 'unknown'),
212             'version': os.environ.get('YARDSTICK_BRANCH', 'unknown')
213         }
214
215         result = {
216             'status': 1,
217             'result': {
218                 'criteria': criteria,
219                 'task_id': self.task_id,
220                 'info': info,
221                 'testcases': testcases
222             }
223         }
224
225         return result
226
227     def _get_task_criteria(self, testcases):
228         criteria = any(t.get('criteria') != 'PASS' for t in testcases.values())
229         if criteria:
230             return 'FAIL'
231         else:
232             return 'PASS'
233
234     def _do_output(self, output_config, result):
235         dispatchers = DispatcherBase.get(output_config)
236
237         for dispatcher in dispatchers:
238             dispatcher.flush_result_data(result)
239
240     def _run(self, scenarios, run_in_parallel, output_file):
241         """Deploys context and calls runners"""
242         for context in self.contexts:
243             context.deploy()
244
245         background_runners = []
246
247         result = []
248         # Start all background scenarios
249         for scenario in filter(_is_background_scenario, scenarios):
250             scenario["runner"] = dict(type="Duration", duration=1000000000)
251             runner = self.run_one_scenario(scenario, output_file)
252             background_runners.append(runner)
253
254         runners = []
255         if run_in_parallel:
256             for scenario in scenarios:
257                 if not _is_background_scenario(scenario):
258                     runner = self.run_one_scenario(scenario, output_file)
259                     runners.append(runner)
260
261             # Wait for runners to finish
262             for runner in runners:
263                 status = runner_join(runner)
264                 if status != 0:
265                     raise RuntimeError
266                 self.outputs.update(runner.get_output())
267                 result.extend(runner.get_result())
268                 print("Runner ended, output in", output_file)
269         else:
270             # run serially
271             for scenario in scenarios:
272                 if not _is_background_scenario(scenario):
273                     runner = self.run_one_scenario(scenario, output_file)
274                     status = runner_join(runner)
275                     if status != 0:
276                         LOG.error('Scenario: %s ERROR', scenario.get('type'))
277                         raise RuntimeError
278                     self.outputs.update(runner.get_output())
279                     result.extend(runner.get_result())
280                     print("Runner ended, output in", output_file)
281
282         # Abort background runners
283         for runner in background_runners:
284             runner.abort()
285
286         # Wait for background runners to finish
287         for runner in background_runners:
288             status = runner.join(JOIN_TIMEOUT)
289             if status is None:
290                 # Nuke if it did not stop nicely
291                 base_runner.Runner.terminate(runner)
292                 runner.join(JOIN_TIMEOUT)
293             base_runner.Runner.release(runner)
294
295             self.outputs.update(runner.get_output())
296             result.extend(runner.get_result())
297             print("Background task ended")
298         return result
299
300     def atexit_handler(self):
301         """handler for process termination"""
302         base_runner.Runner.terminate_all()
303
304         if self.contexts:
305             print("Undeploying all contexts")
306             for context in self.contexts[::-1]:
307                 context.undeploy()
308
309     def _parse_options(self, op):
310         if isinstance(op, dict):
311             return {k: self._parse_options(v) for k, v in op.items()}
312         elif isinstance(op, list):
313             return [self._parse_options(v) for v in op]
314         elif isinstance(op, str):
315             return self.outputs.get(op[1:]) if op.startswith('$') else op
316         else:
317             return op
318
319     def run_one_scenario(self, scenario_cfg, output_file):
320         """run one scenario using context"""
321         runner_cfg = scenario_cfg["runner"]
322         runner_cfg['output_filename'] = output_file
323
324         options = scenario_cfg.get('options', {})
325         scenario_cfg['options'] = self._parse_options(options)
326
327         # TODO support get multi hosts/vms info
328         context_cfg = {}
329         if "host" in scenario_cfg:
330             context_cfg['host'] = Context.get_server(scenario_cfg["host"])
331
332         if "target" in scenario_cfg:
333             if is_ip_addr(scenario_cfg["target"]):
334                 context_cfg['target'] = {}
335                 context_cfg['target']["ipaddr"] = scenario_cfg["target"]
336             else:
337                 context_cfg['target'] = Context.get_server(
338                     scenario_cfg["target"])
339                 if self._is_same_heat_context(scenario_cfg["host"],
340                                               scenario_cfg["target"]):
341                     context_cfg["target"]["ipaddr"] = \
342                         context_cfg["target"]["private_ip"]
343                 else:
344                     context_cfg["target"]["ipaddr"] = \
345                         context_cfg["target"]["ip"]
346
347         if "targets" in scenario_cfg:
348             ip_list = []
349             for target in scenario_cfg["targets"]:
350                 if is_ip_addr(target):
351                     ip_list.append(target)
352                     context_cfg['target'] = {}
353                 else:
354                     context_cfg['target'] = Context.get_server(target)
355                     if self._is_same_heat_context(scenario_cfg["host"],
356                                                   target):
357                         ip_list.append(context_cfg["target"]["private_ip"])
358                     else:
359                         ip_list.append(context_cfg["target"]["ip"])
360             context_cfg['target']['ipaddr'] = ','.join(ip_list)
361
362         if "nodes" in scenario_cfg:
363             context_cfg["nodes"] = parse_nodes_with_context(scenario_cfg)
364             context_cfg["networks"] = get_networks_from_nodes(
365                 context_cfg["nodes"])
366         runner = base_runner.Runner.get(runner_cfg)
367
368         print("Starting runner of type '%s'" % runner_cfg["type"])
369         runner.run(scenario_cfg, context_cfg)
370
371         return runner
372
373     def _is_same_heat_context(self, host_attr, target_attr):
374         """check if two servers are in the same heat context
375         host_attr: either a name for a server created by yardstick or a dict
376         with attribute name mapping when using external heat templates
377         target_attr: either a name for a server created by yardstick or a dict
378         with attribute name mapping when using external heat templates
379         """
380         host = None
381         target = None
382         for context in self.contexts:
383             if context.__context_type__ != "Heat":
384                 continue
385
386             host = context._get_server(host_attr)
387             if host is None:
388                 continue
389
390             target = context._get_server(target_attr)
391             if target is None:
392                 return False
393
394             # Both host and target is not None, then they are in the
395             # same heat context.
396             return True
397
398         return False
399
400
401 class TaskParser(object):       # pragma: no cover
402     """Parser for task config files in yaml format"""
403
404     def __init__(self, path):
405         self.path = path
406
407     def _meet_constraint(self, task, cur_pod, cur_installer):
408         if "constraint" in task:
409             constraint = task.get('constraint', None)
410             if constraint is not None:
411                 tc_fit_pod = constraint.get('pod', None)
412                 tc_fit_installer = constraint.get('installer', None)
413                 LOG.info("cur_pod:%s, cur_installer:%s,tc_constraints:%s",
414                          cur_pod, cur_installer, constraint)
415                 if (cur_pod is None) or (tc_fit_pod and cur_pod not in tc_fit_pod):
416                     return False
417                 if (cur_installer is None) or (tc_fit_installer and cur_installer
418                                                not in tc_fit_installer):
419                     return False
420         return True
421
422     def _get_task_para(self, task, cur_pod):
423         task_args = task.get('task_args', None)
424         if task_args is not None:
425             task_args = task_args.get(cur_pod, task_args.get('default'))
426         task_args_fnames = task.get('task_args_fnames', None)
427         if task_args_fnames is not None:
428             task_args_fnames = task_args_fnames.get(cur_pod, None)
429         return task_args, task_args_fnames
430
431     def parse_suite(self):
432         """parse the suite file and return a list of task config file paths
433            and lists of optional parameters if present"""
434         LOG.info("\nParsing suite file:%s", self.path)
435
436         try:
437             with open(self.path) as stream:
438                 cfg = yaml_load(stream)
439         except IOError as ioerror:
440             sys.exit(ioerror)
441
442         self._check_schema(cfg["schema"], "suite")
443         LOG.info("\nStarting scenario:%s", cfg["name"])
444
445         test_cases_dir = cfg.get("test_cases_dir", test_cases_dir_default)
446         test_cases_dir = os.path.join(constants.YARDSTICK_ROOT_PATH,
447                                       test_cases_dir)
448         if test_cases_dir[-1] != os.sep:
449             test_cases_dir += os.sep
450
451         cur_pod = os.environ.get('NODE_NAME', None)
452         cur_installer = os.environ.get('INSTALLER_TYPE', None)
453
454         valid_task_files = []
455         valid_task_args = []
456         valid_task_args_fnames = []
457
458         for task in cfg["test_cases"]:
459             # 1.check file_name
460             if "file_name" in task:
461                 task_fname = task.get('file_name', None)
462                 if task_fname is None:
463                     continue
464             else:
465                 continue
466             # 2.check constraint
467             if self._meet_constraint(task, cur_pod, cur_installer):
468                 valid_task_files.append(test_cases_dir + task_fname)
469             else:
470                 continue
471             # 3.fetch task parameters
472             task_args, task_args_fnames = self._get_task_para(task, cur_pod)
473             valid_task_args.append(task_args)
474             valid_task_args_fnames.append(task_args_fnames)
475
476         return valid_task_files, valid_task_args, valid_task_args_fnames
477
478     def parse_task(self, task_id, task_args=None, task_args_file=None):
479         """parses the task file and return an context and scenario instances"""
480         print("Parsing task config:", self.path)
481
482         try:
483             kw = {}
484             if task_args_file:
485                 with open(task_args_file) as f:
486                     kw.update(parse_task_args("task_args_file", f.read()))
487             kw.update(parse_task_args("task_args", task_args))
488         except TypeError:
489             raise TypeError()
490
491         try:
492             with open(self.path) as f:
493                 try:
494                     input_task = f.read()
495                     rendered_task = TaskTemplate.render(input_task, **kw)
496                 except Exception as e:
497                     print("Failed to render template:\n%(task)s\n%(err)s\n"
498                           % {"task": input_task, "err": e})
499                     raise e
500                 print("Input task is:\n%s\n" % rendered_task)
501
502                 cfg = yaml_load(rendered_task)
503         except IOError as ioerror:
504             sys.exit(ioerror)
505
506         self._check_schema(cfg["schema"], "task")
507         meet_precondition = self._check_precondition(cfg)
508
509         # TODO: support one or many contexts? Many would simpler and precise
510         # TODO: support hybrid context type
511         if "context" in cfg:
512             context_cfgs = [cfg["context"]]
513         elif "contexts" in cfg:
514             context_cfgs = cfg["contexts"]
515         else:
516             context_cfgs = [{"type": "Dummy"}]
517
518         contexts = []
519         name_suffix = '-{}'.format(task_id[:8])
520         for cfg_attrs in context_cfgs:
521             try:
522                 cfg_attrs['name'] = '{}{}'.format(cfg_attrs['name'],
523                                                   name_suffix)
524             except KeyError:
525                 pass
526             # default to Heat context because we are testing OpenStack
527             context_type = cfg_attrs.get("type", "Heat")
528             context = Context.get(context_type)
529             context.init(cfg_attrs)
530             contexts.append(context)
531
532         run_in_parallel = cfg.get("run_in_parallel", False)
533
534         # add tc and task id for influxdb extended tags
535         for scenario in cfg["scenarios"]:
536             task_name = os.path.splitext(os.path.basename(self.path))[0]
537             scenario["tc"] = task_name
538             scenario["task_id"] = task_id
539             # embed task path into scenario so we can load other files
540             # relative to task path
541             scenario["task_path"] = os.path.dirname(self.path)
542
543             change_server_name(scenario, name_suffix)
544
545             try:
546                 for node in scenario['nodes']:
547                     scenario['nodes'][node] += name_suffix
548             except KeyError:
549                 pass
550
551         # TODO we need something better here, a class that represent the file
552         return cfg["scenarios"], run_in_parallel, meet_precondition, contexts
553
554     def _check_schema(self, cfg_schema, schema_type):
555         """Check if config file is using the correct schema type"""
556
557         if cfg_schema != "yardstick:" + schema_type + ":0.1":
558             sys.exit("error: file %s has unknown schema %s" % (self.path,
559                                                                cfg_schema))
560
561     def _check_precondition(self, cfg):
562         """Check if the environment meet the precondition"""
563
564         if "precondition" in cfg:
565             precondition = cfg["precondition"]
566             installer_type = precondition.get("installer_type", None)
567             deploy_scenarios = precondition.get("deploy_scenarios", None)
568             tc_fit_pods = precondition.get("pod_name", None)
569             installer_type_env = os.environ.get('INSTALL_TYPE', None)
570             deploy_scenario_env = os.environ.get('DEPLOY_SCENARIO', None)
571             pod_name_env = os.environ.get('NODE_NAME', None)
572
573             LOG.info("installer_type: %s, installer_type_env: %s",
574                      installer_type, installer_type_env)
575             LOG.info("deploy_scenarios: %s, deploy_scenario_env: %s",
576                      deploy_scenarios, deploy_scenario_env)
577             LOG.info("tc_fit_pods: %s, pod_name_env: %s",
578                      tc_fit_pods, pod_name_env)
579             if installer_type and installer_type_env:
580                 if installer_type_env not in installer_type:
581                     return False
582             if deploy_scenarios and deploy_scenario_env:
583                 deploy_scenarios_list = deploy_scenarios.split(',')
584                 for deploy_scenario in deploy_scenarios_list:
585                     if deploy_scenario_env.startswith(deploy_scenario):
586                         return True
587                 return False
588             if tc_fit_pods and pod_name_env:
589                 if pod_name_env not in tc_fit_pods:
590                     return False
591         return True
592
593
594 def is_ip_addr(addr):
595     """check if string addr is an IP address"""
596     try:
597         addr = addr.get('public_ip_attr', addr.get('private_ip_attr'))
598     except AttributeError:
599         pass
600
601     try:
602         ipaddress.ip_address(addr.encode('utf-8'))
603     except ValueError:
604         return False
605     else:
606         return True
607
608
609 def _is_background_scenario(scenario):
610     if "run_in_background" in scenario:
611         return scenario["run_in_background"]
612     else:
613         return False
614
615
616 def parse_nodes_with_context(scenario_cfg):
617     """parse the 'nodes' fields in scenario """
618     # ensure consistency in node instantiation order
619     return OrderedDict((nodename, Context.get_server(scenario_cfg["nodes"][nodename]))
620                        for nodename in sorted(scenario_cfg["nodes"]))
621
622
623 def get_networks_from_nodes(nodes):
624     """parse the 'nodes' fields in scenario """
625     networks = {}
626     for node in nodes.values():
627         if not node:
628             continue
629         interfaces = node.get('interfaces', {})
630         for interface in interfaces.values():
631             vld_id = interface.get('vld_id')
632             # mgmt network doesn't have vld_id
633             if not vld_id:
634                 continue
635             network = Context.get_network({"vld_id": vld_id})
636             if network:
637                 networks[network['name']] = network
638     return networks
639
640
641 def runner_join(runner):
642     """join (wait for) a runner, exit process at runner failure"""
643     status = runner.join()
644     base_runner.Runner.release(runner)
645     return status
646
647
648 def print_invalid_header(source_name, args):
649     print("Invalid %(source)s passed:\n\n %(args)s\n"
650           % {"source": source_name, "args": args})
651
652
653 def parse_task_args(src_name, args):
654     if isinstance(args, collections.Mapping):
655         return args
656
657     try:
658         kw = args and yaml_load(args)
659         kw = {} if kw is None else kw
660     except yaml.parser.ParserError as e:
661         print_invalid_header(src_name, args)
662         print("%(source)s has to be YAML. Details:\n\n%(err)s\n"
663               % {"source": src_name, "err": e})
664         raise TypeError()
665
666     if not isinstance(kw, dict):
667         print_invalid_header(src_name, args)
668         print("%(src)s had to be dict, actually %(src_type)s\n"
669               % {"src": src_name, "src_type": type(kw)})
670         raise TypeError()
671     return kw
672
673
674 def change_server_name(scenario, suffix):
675     try:
676         host = scenario['host']
677     except KeyError:
678         pass
679     else:
680         try:
681             host['name'] += suffix
682         except TypeError:
683             scenario['host'] += suffix
684
685     try:
686         target = scenario['target']
687     except KeyError:
688         pass
689     else:
690         try:
691             target['name'] += suffix
692         except TypeError:
693             scenario['target'] += suffix
694
695     try:
696         key = 'targets'
697         scenario[key] = ['{}{}'.format(a, suffix) for a in scenario[key]]
698     except KeyError:
699         pass