| |
| # Copyright 2017-present Open Networking Foundation |
| # |
| # Licensed under the Apache License, Version 2.0 (the "License"); |
| # you may not use this file except in compliance with the License. |
| # You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| |
| |
| import plyxproto.parser as plyxproto |
| import jinja2 |
| import os |
| from xos2jinja import XOS2Jinja |
| from proto2xproto import Proto2XProto |
| import jinja2_extensions |
| import yaml |
| from colorama import Fore |
| |
| loader = jinja2.PackageLoader(__name__, 'templates') |
| env = jinja2.Environment(loader=loader) |
| |
| class XOSProcessorArgs: |
| """ Helper class for use cases that want to call XOSProcessor directly, rather than executing xosgenx from the |
| command line. |
| """ |
| |
| default_rev = False |
| default_output = None |
| default_attic = None |
| default_kvpairs = None |
| default_write_to_file = None |
| default_dest_file = None |
| default_dest_extension = None |
| default_target = None |
| default_checkers = None |
| default_verbosity = 0 # Higher numbers = more verbosity, lower numbers = less verbosity |
| default_include_models = [] # If neither include_models nor include_apps is specified, then all models will |
| default_include_apps = [] # be included. |
| |
| def __init__(self, **kwargs): |
| # set defaults |
| self.rev = XOSProcessorArgs.default_rev |
| self.output = XOSProcessorArgs.default_output |
| self.attic = XOSProcessorArgs.default_attic |
| self.kvpairs = XOSProcessorArgs.default_kvpairs |
| self.verbosity = XOSProcessorArgs.default_verbosity |
| self.write_to_file = XOSProcessorArgs.default_write_to_file |
| self.default_dest_file = XOSProcessorArgs.default_dest_file |
| self.default_dest_extension = XOSProcessorArgs.default_dest_extension |
| self.default_target = XOSProcessorArgs.default_target |
| self.default_checkers = XOSProcessorArgs.default_target |
| self.include_models = XOSProcessorArgs.default_include_models |
| self.include_apps = XOSProcessorArgs.default_include_apps |
| |
| # override defaults with kwargs |
| for (k,v) in kwargs.items(): |
| setattr(self, k, v) |
| |
| class XOSProcessor: |
| |
| @staticmethod |
| def _read_input_from_files(files): |
| input = '' |
| for fname in files: |
| with open(fname) as infile: |
| input += infile.read() |
| return input |
| |
| @staticmethod |
| def _attach_parser(ast, args): |
| if hasattr(args, 'rev') and args.rev: |
| v = Proto2XProto() |
| ast.accept(v) |
| |
| v = XOS2Jinja(args) |
| ast.accept(v) |
| return v |
| |
| @staticmethod |
| def _get_template(target): |
| if not os.path.isabs(target): |
| return os.path.abspath(os.path.dirname(os.path.realpath(__file__)) + '/targets/' + target) |
| return target |
| |
| @staticmethod |
| def _file_exists(attic): |
| # NOTE this method can be used in the jinja template |
| def file_exists2(name): |
| if attic is not None: |
| path = attic + '/' + name |
| else: |
| path = name |
| return (os.path.exists(path)) |
| |
| return file_exists2 |
| |
| @staticmethod |
| def _include_file(attic): |
| # NOTE this method can be used in the jinja template |
| def include_file2(name): |
| if attic is not None: |
| path = attic + '/' + name |
| else: |
| path = name |
| return open(path).read() |
| return include_file2 |
| |
| @staticmethod |
| def _load_jinja2_extensions(os_template_env, attic): |
| |
| os_template_env.globals['include_file'] = XOSProcessor._include_file(attic) # Generates a function |
| os_template_env.globals['file_exists'] = XOSProcessor._file_exists(attic) # Generates a function |
| |
| os_template_env.filters['yaml'] = yaml.dump |
| for f in dir(jinja2_extensions): |
| if f.startswith('xproto'): |
| os_template_env.globals[f] = getattr(jinja2_extensions, f) |
| return os_template_env |
| |
| @staticmethod |
| def _add_context(args): |
| if not hasattr(args, 'kv') or not args.kv: |
| return |
| try: |
| context = {} |
| for s in args.kv.split(','): |
| k, val = s.split(':') |
| context[k] = val |
| return context |
| except Exception, e: |
| print e.message |
| |
| @staticmethod |
| def _write_single_file(rendered, dir, dest_file, quiet): |
| |
| file_name = "%s/%s" % (dir, dest_file) |
| file = open(file_name, 'w') |
| file.write(rendered) |
| file.close() |
| if quiet == False: |
| print "Saved: %s" % file_name |
| |
| @staticmethod |
| def _write_file_per_model(rendered, dir, suffix, quiet): |
| for m in rendered: |
| file_name = "%s/%s%s" % (dir, m.lower(), suffix) |
| if not rendered[m]: |
| if quiet == False: |
| print "Not saving %s as it is empty" % file_name |
| else: |
| file = open(file_name, 'w') |
| file.write(rendered[m]) |
| file.close() |
| if quiet == False: |
| print "Saved: %s" % file_name |
| |
| @staticmethod |
| def _write_split_target(rendered, dir, quiet): |
| |
| lines = rendered.splitlines() |
| current_buffer = [] |
| for l in lines: |
| if (l.startswith('+++')): |
| |
| if dir: |
| path = dir + '/' + l[4:].lower() |
| |
| fil = open(path, 'w') |
| buf = '\n'.join(current_buffer) |
| |
| obuf = buf |
| |
| fil.write(obuf) |
| fil.close() |
| |
| if quiet == False: |
| print "Save file to: %s" % path |
| |
| current_buffer = [] |
| else: |
| current_buffer.append(l) |
| |
| @staticmethod |
| def _find_message_by_model_name(messages, model): |
| return next((x for x in messages if x['name'] == model), None) |
| |
| @staticmethod |
| def _find_last_nonempty_line(text, pointer): |
| ne_pointer = pointer |
| found = False |
| while ne_pointer!=0 and not found: |
| ne_pointer = text[:(ne_pointer-1)].rfind('\n') |
| if ne_pointer<0: ne_pointer = 0 |
| if text[ne_pointer-1]!='\n': |
| found = True |
| |
| return ne_pointer |
| |
| @staticmethod |
| def process(args, operator = None): |
| # Setting defaults |
| if not hasattr(args, 'attic'): |
| args.attic = None |
| if not hasattr(args, 'write_to_file'): |
| args.write_to_file = None |
| if not hasattr(args, 'dest_file'): |
| args.dest_file = None |
| if not hasattr(args, 'dest_extension'): |
| args.dest_extension = None |
| if not hasattr(args, 'output'): |
| args.output = None |
| if not hasattr(args, 'quiet'): |
| args.quiet = True |
| |
| # Validating |
| if args.write_to_file == 'single' and args.dest_file is None: |
| raise Exception("[XosGenX] write_to_file option is specified as 'single' but no dest_file is provided") |
| if args.write_to_file == 'model' and (args.dest_extension is None): |
| raise Exception("[XosGenX] write_to_file option is specified as 'model' but no dest_extension is provided") |
| |
| if args.output is not None and not os.path.isabs(args.output): |
| raise Exception("[XosGenX] The output dir must be an absolute path!") |
| if args.output is not None and not os.path.isdir(args.output): |
| raise Exception("[XosGenX] The output dir must be a directory!") |
| |
| if hasattr(args, 'files'): |
| inputs = XOSProcessor._read_input_from_files(args.files) |
| elif hasattr(args, 'inputs'): |
| inputs = args.inputs |
| else: |
| raise Exception("[XosGenX] No inputs provided!") |
| |
| if not operator: |
| operator = args.target |
| template_path = XOSProcessor._get_template(operator) |
| else: |
| template_path = operator |
| |
| |
| [template_folder, template_name] = os.path.split(template_path) |
| os_template_loader = jinja2.FileSystemLoader(searchpath=[template_folder]) |
| os_template_env = jinja2.Environment(loader=os_template_loader) |
| os_template_env = XOSProcessor._load_jinja2_extensions(os_template_env, args.attic) |
| template = os_template_env.get_template(template_name) |
| context = XOSProcessor._add_context(args) |
| |
| parser = plyxproto.ProtobufAnalyzer() |
| try: |
| ast = parser.parse_string(inputs, debug=0) |
| except plyxproto.ParsingError, e: |
| line, start, end = e.error_range |
| |
| ptr = XOSProcessor._find_last_nonempty_line(inputs, start) |
| |
| if start == 0: |
| beginning = '' |
| else: |
| beginning = inputs[ptr:start-1] |
| |
| line_end_char = inputs[start+end:].find('\n') |
| line_end = inputs[line_end_char] |
| |
| if e.message: |
| error = e.message |
| else: |
| error = "xproto parsing error" |
| |
| print error + "\n" + Fore.YELLOW + "Line %d:"%line + Fore.WHITE |
| print beginning + Fore.YELLOW + inputs[start-1:start+end] + Fore.WHITE + line_end |
| exit(1) |
| |
| |
| v = XOSProcessor._attach_parser(ast, args) |
| |
| if args.include_models or args.include_apps: |
| for message in v.messages: |
| message["is_included"] = False |
| if message["name"] in args.include_models: |
| message["is_included"] = True |
| else: |
| app_label = message.get("options", {}).get("app_label").strip('"') |
| if app_label in args.include_apps: |
| message["is_included"] = True |
| else: |
| for message in v.messages: |
| message["is_included"] = True |
| |
| if args.output is not None and args.write_to_file == "model": |
| rendered = {} |
| for i, model in enumerate(v.models): |
| models = {} |
| models[model] = v.models[model] |
| messages = [XOSProcessor._find_message_by_model_name(v.messages, model)] |
| |
| rendered[model] = template.render( |
| {"proto": |
| { |
| 'message_table': models, |
| 'messages': messages, |
| 'policies': v.policies, |
| 'message_names': [m['name'] for m in v.messages] |
| }, |
| "context": context, |
| "options": v.options |
| } |
| ) |
| if (str(v.options.get("legacy", "false")).strip('"').lower() == "true"): |
| suffix = "_decl." + args.dest_extension |
| else: |
| suffix = "." + args.dest_extension |
| XOSProcessor._write_file_per_model(rendered, args.output, suffix, args.quiet) |
| else: |
| rendered = template.render( |
| {"proto": |
| { |
| 'message_table': v.models, |
| 'messages': v.messages, |
| 'policies': v.policies, |
| 'message_names': [m['name'] for m in v.messages] |
| }, |
| "context": context, |
| "options": v.options |
| } |
| ) |
| if args.output is not None and args.write_to_file == "target": |
| XOSProcessor._write_split_target(rendered, args.output, args.quiet) |
| elif args.output is not None and args.write_to_file == "single": |
| XOSProcessor._write_single_file(rendered, args.output, args.dest_file, args.quiet) |
| |
| return rendered |