diff options
author | kubi <jean.gaoliang@huawei.com> | 2015-08-19 06:19:25 -0400 |
---|---|---|
committer | kubi <jean.gaoliang@huawei.com> | 2015-09-01 07:19:11 -0400 |
commit | c2d65daf876dca1c9bade1e7fa91653251c0c01b (patch) | |
tree | bdb876f6d50fe0d0d4e8de8905f49013fc6bbd5d /yardstick | |
parent | 6d202fe4ba773d785959a4112373f2766a9ebe47 (diff) |
add support for Jinja2 in task file
Add support in task file for the template syntax based on Jinja2.
JIRA:YARDSTICK-101
Change-Id: I24be133ba590510612d97a1fce6c024e6edb57e4
Signed-off-by: kubi <jean.gaoliang@huawei.com>
Diffstat (limited to 'yardstick')
-rwxr-xr-x[-rw-r--r--] | yardstick/cmd/commands/task.py | 62 | ||||
-rwxr-xr-x | yardstick/common/task_template.py | 53 |
2 files changed, 109 insertions, 6 deletions
diff --git a/yardstick/cmd/commands/task.py b/yardstick/cmd/commands/task.py index 8b9f269c5..f49a258a1 100644..100755 --- a/yardstick/cmd/commands/task.py +++ b/yardstick/cmd/commands/task.py @@ -18,7 +18,7 @@ import ipaddress from yardstick.benchmark.context.model import Context from yardstick.benchmark.runners import base as base_runner - +from yardstick.common.task_template import TaskTemplate from yardstick.common.utils import cliargs output_file_default = "/tmp/yardstick.out" @@ -31,6 +31,13 @@ class TaskCommands(object): ''' @cliargs("taskfile", type=str, help="path to taskfile", nargs=1) + @cliargs("--task-args", dest="task_args", + help="Input task args (dict in json). These args are used" + "to render input task that is jinja2 template.") + @cliargs("--task-args-file", dest="task_args_file", + help="Path to the file with input task args (dict in " + "json/yaml). These args are used to render input" + "task that is jinja2 template.") @cliargs("--keep-deploy", help="keep context deployed in cloud", action="store_true") @cliargs("--parse-only", help="parse the benchmark config file and exit", @@ -43,7 +50,8 @@ class TaskCommands(object): atexit.register(atexit_handler) parser = TaskParser(args.taskfile[0]) - scenarios, run_in_parallel = parser.parse() + scenarios, run_in_parallel = parser.parse(args.task_args, + args.task_args_file) if args.parse_only: sys.exit(0) @@ -80,20 +88,39 @@ class TaskCommands(object): print "Done, exiting" - # TODO: Move stuff below into TaskCommands class !? + class TaskParser(object): '''Parser for task config files in yaml format''' def __init__(self, path): self.path = path - def parse(self): + def parse(self, task_args=None, task_args_file=None): '''parses the task file and return an context and scenario instances''' print "Parsing task config:", self.path + + try: + kw = {} + if task_args_file: + with open(task_args_file) as f: + kw.update(parse_task_args("task_args_file", f.read())) + kw.update(parse_task_args("task_args", task_args)) + except TypeError: + raise TypeError() + try: - with open(self.path) as stream: - cfg = yaml.load(stream) + with open(self.path) as f: + try: + input_task = f.read() + rendered_task = TaskTemplate.render(input_task, **kw) + except Exception as e: + print(("Failed to render template:\n%(task)s\n%(err)s\n") + % {"task": input_task, "err": e}) + raise e + print(("Input task is:\n%s\n") % rendered_task) + + cfg = yaml.load(rendered_task) except IOError as ioerror: sys.exit(ioerror) @@ -181,3 +208,26 @@ def runner_join(runner): base_runner.Runner.release(runner) if status != 0: sys.exit("Runner failed") + + +def print_invalid_header(source_name, args): + print(("Invalid %(source)s passed:\n\n %(args)s\n") + % {"source": source_name, "args": args}) + + +def parse_task_args(src_name, args): + try: + kw = args and yaml.safe_load(args) + kw = {} if kw is None else kw + except yaml.parser.ParserError as e: + print_invalid_header(src_name, args) + print(("%(source)s has to be YAML. Details:\n\n%(err)s\n") + % {"source": src_name, "err": e}) + raise TypeError() + + if not isinstance(kw, dict): + print_invalid_header(src_name, args) + print(("%(src)s had to be dict, actually %(src_type)s\n") + % {"src": src_name, "src_type": type(kw)}) + raise TypeError() + return kw diff --git a/yardstick/common/task_template.py b/yardstick/common/task_template.py new file mode 100755 index 000000000..2739323bd --- /dev/null +++ b/yardstick/common/task_template.py @@ -0,0 +1,53 @@ +############################################################################## +# Copyright (c) 2015 Huawei Technologies Co.,Ltd 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 +# yardstick: this file is copied from rally and slightly modified +############################################################################## +import re +import jinja2 +import jinja2.meta + + +class TaskTemplate(object): + @classmethod + def render(cls, task_template, **kwargs): + """Render jinja2 task template to Yardstick input task. + + :param task_template: string that contains template + :param kwargs: Dict with template arguments + :returns:rendered template str + """ + + from six.moves import builtins + + ast = jinja2.Environment().parse(task_template) + required_kwargs = jinja2.meta.find_undeclared_variables(ast) + + missing = set(required_kwargs) - set(kwargs) - set(dir(builtins)) + real_missing = [mis for mis in missing + if is_really_missing(mis, task_template)] + + if real_missing: + multi_msg = ("Please specify next template task arguments:%s") + single_msg = ("Please specify template task argument:%s") + raise TypeError((len(real_missing) > 1 and multi_msg or single_msg) + % ", ".join(real_missing)) + return jinja2.Template(task_template).render(**kwargs) + + +def is_really_missing(mis, task_template): + # Removing variables that have default values from + # missing. Construction that won't be properly + # check is {% set x = x or 1} + if re.search(mis.join(["{%\s*set\s+", "\s*=\s*", "[^\w]+"]), + task_template): + return False + # Also check for a default filter which can show up as + # a missing variable + if re.search(mis + "\s*\|\s*default\(", task_template): + return False + return True |