From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mx.groups.io; dkim=pass header.i=@linaro.org header.s=google header.b=t2bG42K1; spf=pass (domain: linaro.org, ip: 209.85.128.52, mailfrom: leif.lindholm@linaro.org) Received: from mail-wm1-f52.google.com (mail-wm1-f52.google.com [209.85.128.52]) by groups.io with SMTP; Fri, 12 Jul 2019 10:01:38 -0700 Received: by mail-wm1-f52.google.com with SMTP id x15so9568616wmj.3 for ; Fri, 12 Jul 2019 10:01:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=X8lvO2Tziszog0VKWMeit4Y9xXay+hEd+bVLTXA5rlc=; b=t2bG42K1kFT3oyiSjguBUzZw97hnmy0JsbZz78ywp5bmEproRl7yAUxfAbi5+WjqA4 iYYY298GjLLKTHr9WT185mSrcDqMgrd/K/U5hAKfoAlN8Lk5jANsyHRh/uihUozdYe+b SbenPjKHhL+hHH/DgOb0nrDAZefpV9vC5djXRMZocoIDtdERR5GtS8PBTG6g0S6yDSfj 3yzgCGU/JTA+5ahAyD6Duz402Ob0ohtS/qCEonMNY44aIp6ZZr8LGVMTLY6joQ2t3Yi6 BBBC70Sxb1oTUUfxAoihqqJV7Sl6+KTiTuYmcrAgEZkEAPBkclLeoDOwLwsxDf1zkEqr Hpsw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=X8lvO2Tziszog0VKWMeit4Y9xXay+hEd+bVLTXA5rlc=; b=rmh9NMkObyQoZpdQ2Je6U0kuup/7IXZEqUyHCQTLCNziWyRlC1kdImCkkD9n96l3Oa 2Elp9Z1bIVTiP6ebmgmZnCiiLZODNEylZdxRdb3CAD8hioefZr3oRE+GKVwvS/3BADj8 5qLlDNFqIG+3qt646vm+2rG+QVIokn74AFB8MUqCJilKcmHAQF0f5Y4Ft3oaR3S5s6Fx EueGFpoZdAn8c0h7WmA3ToQwGuAzDLGevDAWnIl/my1zWN9rBJdKH4M4deD/k3k0prDh qLh1bspYKfPMrIIvdJISFqH1W/L6TOAke3MUCqQD+ZzJJ0fRyrEzpmLBUAHBZieToGcS xQtw== X-Gm-Message-State: APjAAAXjk+9Eb+R3N8bMpGIrmCiXw62+0W2NvWgOSIcslen0QEGOzzxV /vdOBkSnxFc/RmqrVDGEmYeI+B9JbUA= X-Google-Smtp-Source: APXvYqyronUVZ/qKF1REopyeBEMCVJZxwd0RubhhzkwU0swPRE1ZwtsdAGF25YSXJVLCFROyd+XB6w== X-Received: by 2002:a1c:6454:: with SMTP id y81mr10515263wmb.105.1562950895917; Fri, 12 Jul 2019 10:01:35 -0700 (PDT) Return-Path: Received: from vanye.hemma.eciton.net (cpc92302-cmbg19-2-0-cust304.5-4.cable.virginm.net. [82.1.209.49]) by smtp.gmail.com with ESMTPSA id g11sm9044816wru.24.2019.07.12.10.01.34 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Fri, 12 Jul 2019 10:01:35 -0700 (PDT) From: "Leif Lindholm" To: devel@edk2.groups.io Cc: Andrew Fish , Laszlo Ersek , Michael D Kinney , Philippe Mathieu-Daude , Bob Feng , Liming Gao Subject: [PATCH 3/3] BaseTools: add GetMaintainer.py script Date: Fri, 12 Jul 2019 18:01:28 +0100 Message-Id: <20190712170128.6495-4-leif.lindholm@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190712170128.6495-1-leif.lindholm@linaro.org> References: <20190712170128.6495-1-leif.lindholm@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Add a new script GetMaintainer.py that uses the new Maintainer.txt format to determine which addresses to cc on patch submission. Signed-off-by: Leif Lindholm Reviewed-by: Philippe Mathieu-Daude Tested-by: Philippe Mathieu-Daude --- BaseTools/Scripts/GetMaintainer.py | 190 +++++++++++++++++++++++++++++ 1 file changed, 190 insertions(+) create mode 100644 BaseTools/Scripts/GetMaintainer.py diff --git a/BaseTools/Scripts/GetMaintainer.py b/BaseTools/Scripts/GetMaintainer.py new file mode 100644 index 000000000000..fbc63522db77 --- /dev/null +++ b/BaseTools/Scripts/GetMaintainer.py @@ -0,0 +1,190 @@ +## @file +# Retrieves the people to request review from on submission of a commit. +# +# Copyright (c) 2019, Linaro Ltd. All rights reserved.
+# +# SPDX-License-Identifier: BSD-2-Clause-Patent +# + +from __future__ import print_function +from collections import defaultdict +from collections import OrderedDict +import argparse +import os +import re +import SetupGit + +EXPRESSIONS = { + 'exclude': re.compile(r'^X:\s*(?P.*?)\r*$'), + 'file': re.compile(r'^F:\s*(?P.*?)\r*$'), + 'list': re.compile(r'^L:\s*(?P.*?)\r*$'), + 'maintainer': re.compile(r'^M:\s*(?P.*<.*?>)\r*$'), + 'reviewer': re.compile(r'^R:\s*(?P.*?)\r*$'), + 'status': re.compile(r'^S:\s*(?P.*?)\r*$'), + 'tree': re.compile(r'^T:\s*(?P.*?)\r*$'), + 'webpage': re.compile(r'^W:\s*(?P.*?)\r*$') +} + +def printsection(section): + """Prints out the dictionary describing a Maintainers.txt section.""" + print('===') + for key in section.keys(): + print("Key: %s" % key) + for item in section[key]: + print(' %s' % item) + +def pattern_to_regex(pattern): + """Takes a string containing regular UNIX path wildcards + and returns a string suitable for matching with regex.""" + + pattern = pattern.replace('.', r'\.') + pattern = pattern.replace('?', r'.') + pattern = pattern.replace('*', r'.*') + + if pattern.endswith('/'): + pattern += r'.*' + elif pattern.endswith('.*'): + pattern = pattern[:-2] + pattern += r'(?!.*?/.*?)' + + return pattern + +def path_in_section(path, section): + """Returns True of False indicating whether the path is covered by + the current section.""" + if not 'file' in section: + return False + + for pattern in section['file']: + regex = pattern_to_regex(pattern) + + match = re.match(regex, path) + if match: + # Check if there is an exclude pattern that applies + for pattern in section['exclude']: + regex = pattern_to_regex(pattern) + + match = re.match(regex, path) + if match: + return False + + return True + + return False + +def get_section_maintainers(path, section): + """Returns a list with email addresses to any M: and R: entries + matching the provided path in the provided section.""" + maintainers = [] + lists = [] + + if path_in_section(path, section): + for address in section['maintainer'], section['reviewer']: + # Convert to list if necessary + if isinstance(address, list): + maintainers += address + else: + lists += [address] + for address in section['list']: + # Convert to list if necessary + if isinstance(address, list): + lists += address + else: + lists += [address] + + return maintainers, lists + +def get_maintainers(path, sections, level=0): + """For 'path', iterates over all sections, returning maintainers + for matching ones.""" + maintainers = [] + lists = [] + for section in sections: + tmp_maint, tmp_lists = get_section_maintainers(path, section) + if tmp_maint: + maintainers += tmp_maint + if tmp_lists: + lists += tmp_lists + + if not maintainers: + # If no match found, look for match for (nonexistent) file + # REPO.working_dir/ + print('"%s": no maintainers found, looking for default' % path) + if level == 0: + maintainers = get_maintainers('', sections, level=level + 1) + else: + print("No maintainers set for project.") + if not maintainers: + return None + + return maintainers + lists + +def parse_maintainers_line(line): + """Parse one line of Maintainers.txt, returning any match group and its key.""" + for key, expression in EXPRESSIONS.items(): + match = expression.match(line) + if match: + return key, match.group(key) + return None, None + +def parse_maintainers_file(filename): + """Parse the Maintainers.txt from top-level of repo and + return a list containing dictionaries of all sections.""" + with open(filename, 'r') as text: + line = text.readline() + sectionlist = [] + section = defaultdict(list) + while line: + key, value = parse_maintainers_line(line) + if key and value: + section[key].append(value) + + line = text.readline() + # If end of section (end of file, or non-tag line encountered)... + if not key or not value or not line: + # ...if non-empty, append section to list. + if section: + sectionlist.append(section.copy()) + section.clear() + + return sectionlist + +def get_modified_files(repo, args): + """Returns a list of the files modified by the commit specified in 'args'.""" + commit = repo.commit(args.commit) + return commit.stats.files + +if __name__ == '__main__': + PARSER = argparse.ArgumentParser( + description='Retrieves information on who to cc for review on a given commit') + PARSER.add_argument('commit', + action="store", + help='git revision to examine (default: HEAD)', + nargs='?', + default='HEAD') + PARSER.add_argument('-l', '--lookup', + help='Find section matches for path LOOKUP', + required=False) + ARGS = PARSER.parse_args() + + REPO = SetupGit.locate_repo() + + CONFIG_FILE = os.path.join(REPO.working_dir, 'Maintainers.txt') + + SECTIONS = parse_maintainers_file(CONFIG_FILE) + + if ARGS.lookup: + FILES = [ARGS.lookup] + else: + FILES = get_modified_files(REPO, ARGS) + + ADDRESSES = [] + + for file in FILES: + print(file) + addresslist = get_maintainers(file, SECTIONS) + if addresslist: + ADDRESSES += addresslist + + for address in list(OrderedDict.fromkeys(ADDRESSES)): + print(' %s' % address) -- 2.20.1