|
| 1 | +#!/usr/bin/env python3 |
| 2 | + |
| 3 | +import re |
| 4 | +import subprocess |
| 5 | +import sys |
| 6 | + |
| 7 | +verbosity = 0 # Show what's going on, 0 1 or 2. |
| 8 | +suggestions = 1 # Set to 0 to not include lengthy suggestions in error messages. |
| 9 | + |
| 10 | +ignore_prefixes = [] |
| 11 | + |
| 12 | + |
| 13 | +def verbose(*args): |
| 14 | + if verbosity: |
| 15 | + print(*args) |
| 16 | + |
| 17 | + |
| 18 | +def very_verbose(*args): |
| 19 | + if verbosity > 1: |
| 20 | + print(*args) |
| 21 | + |
| 22 | + |
| 23 | +class ErrorCollection: |
| 24 | + # Track errors and warnings as the program runs |
| 25 | + def __init__(self): |
| 26 | + self.has_errors = False |
| 27 | + self.has_warnings = False |
| 28 | + self.prefix = "" |
| 29 | + |
| 30 | + def error(self, text): |
| 31 | + print("error: {}{}".format(self.prefix, text)) |
| 32 | + self.has_errors = True |
| 33 | + |
| 34 | + def warning(self, text): |
| 35 | + print("warning: {}{}".format(self.prefix, text)) |
| 36 | + self.has_warnings = True |
| 37 | + |
| 38 | + |
| 39 | +def git_log(pretty_format, *args): |
| 40 | + # Delete pretty argument from user args so it doesn't interfere with what we do. |
| 41 | + args = ["git", "log"] + [arg for arg in args if "--pretty" not in args] |
| 42 | + args.append("--pretty=format:" + pretty_format) |
| 43 | + very_verbose("git_log", *args) |
| 44 | + # Generator yielding each output line. |
| 45 | + for line in subprocess.Popen(args, stdout=subprocess.PIPE).stdout: |
| 46 | + yield line.decode().rstrip("\r\n") |
| 47 | + |
| 48 | + |
| 49 | +def diagnose_subject_line(subject_line, subject_line_format, err): |
| 50 | + err.error("Subject line: " + subject_line) |
| 51 | + if not subject_line.endswith("."): |
| 52 | + err.error('* must end with "."') |
| 53 | + if not re.match(r"^[^!]+: ", subject_line): |
| 54 | + err.error('* must start with "path: "') |
| 55 | + if re.match(r"^[^!]+: *$", subject_line): |
| 56 | + err.error("* must contain a subject after the path.") |
| 57 | + m = re.match(r"^[^!]+: ([a-z][^ ]*)", subject_line) |
| 58 | + if m: |
| 59 | + err.error('* first word of subject ("{}") must be capitalised.'.format(m.group(1))) |
| 60 | + if re.match(r"^[^!]+: [^ ]+$", subject_line): |
| 61 | + err.error("* subject must contain more than one word.") |
| 62 | + err.error("* must match: " + repr(subject_line_format)) |
| 63 | + err.error("* Examples:") |
| 64 | + err.error('* 1: "boards: Support ${board_name}."') |
| 65 | + err.error('* 2: "libs/unit: Add support for ${unit_name}."') |
| 66 | + err.error('* 3: "libs/driver: Fix ${xxxx} bug."') |
| 67 | + err.error('* 4: "docs: Fix typo."') |
| 68 | + |
| 69 | + |
| 70 | +def verify(sha, err): |
| 71 | + verbose("verify", sha) |
| 72 | + err.prefix = "commit " + sha + ": " |
| 73 | + |
| 74 | + # Author and committer email. |
| 75 | + for line in git_log("%ae%n%ce", sha, "-n1"): |
| 76 | + very_verbose("email", line) |
| 77 | + if "noreply" in line: |
| 78 | + err.error("Unwanted email address: " + line) |
| 79 | + |
| 80 | + # Message body. |
| 81 | + raw_body = list(git_log("%B", sha, "-n1")) |
| 82 | + verify_message_body(raw_body, err) |
| 83 | + |
| 84 | + |
| 85 | +def verify_message_body(raw_body, err): |
| 86 | + if not raw_body: |
| 87 | + err.error("Message is empty") |
| 88 | + return |
| 89 | + |
| 90 | + # Subject line. |
| 91 | + subject_line = raw_body[0] |
| 92 | + for prefix in ignore_prefixes: |
| 93 | + if subject_line.startswith(prefix): |
| 94 | + verbose("Skipping ignored commit message") |
| 95 | + return |
| 96 | + very_verbose("subject_line", subject_line) |
| 97 | + subject_line_format = r"^[^!]+: [A-Z]+.+ .+\.$" |
| 98 | + if not re.match(subject_line_format, subject_line): |
| 99 | + diagnose_subject_line(subject_line, subject_line_format, err) |
| 100 | + if len(subject_line) >= 73: |
| 101 | + err.error("Subject line must be 72 or fewer characters: " + subject_line) |
| 102 | + |
| 103 | + # Second one divides subject and body. |
| 104 | + if len(raw_body) > 1 and raw_body[1]: |
| 105 | + err.error("Second message line must be empty: " + raw_body[1]) |
| 106 | + |
| 107 | + # Message body lines. |
| 108 | + for line in raw_body[2:]: |
| 109 | + # Long lines with URLs are exempt from the line length rule. |
| 110 | + if len(line) >= 76 and "://" not in line: |
| 111 | + err.error("Message lines should be 75 or less characters: " + line) |
| 112 | + |
| 113 | + if not raw_body[-1].startswith("Signed-off-by: ") or "@" not in raw_body[-1]: |
| 114 | + err.error('Message must be signed-off. Use "git commit -s".') |
| 115 | + |
| 116 | + |
| 117 | +def run(args): |
| 118 | + verbose("run", *args) |
| 119 | + |
| 120 | + err = ErrorCollection() |
| 121 | + |
| 122 | + if "--check-file" in args: |
| 123 | + filename = args[-1] |
| 124 | + verbose("checking commit message from", filename) |
| 125 | + with open(args[-1]) as f: |
| 126 | + # Remove comment lines as well as any empty lines at the end. |
| 127 | + lines = [line.rstrip("\r\n") for line in f if not line.startswith("#")] |
| 128 | + while not lines[-1]: |
| 129 | + lines.pop() |
| 130 | + verify_message_body(lines, err) |
| 131 | + else: # Normal operation, pass arguments to git log |
| 132 | + for sha in git_log("%h", *args): |
| 133 | + verify(sha, err) |
| 134 | + |
| 135 | + if err.has_errors or err.has_warnings: |
| 136 | + if suggestions: |
| 137 | + print("See https://github.com/micropython/micropython/blob/master/CODECONVENTIONS.md") |
| 138 | + else: |
| 139 | + print("ok") |
| 140 | + if err.has_errors: |
| 141 | + sys.exit(1) |
| 142 | + |
| 143 | + |
| 144 | +def show_help(): |
| 145 | + print("usage: verifygitlog.py [-v -n -h --check-file] ...") |
| 146 | + print("-v : increase verbosity, can be specified multiple times") |
| 147 | + print("-n : do not print multi-line suggestions") |
| 148 | + print("-h : print this help message and exit") |
| 149 | + print( |
| 150 | + "--check-file : Pass a single argument which is a file containing a candidate commit message" |
| 151 | + ) |
| 152 | + print( |
| 153 | + "--ignore-rebase : Skip checking commits with git rebase autosquash prefixes or WIP as a prefix" |
| 154 | + ) |
| 155 | + print("... : arguments passed to git log to retrieve commits to verify") |
| 156 | + print(" see https://www.git-scm.com/docs/git-log") |
| 157 | + print(" passing no arguments at all will verify all commits") |
| 158 | + print("examples:") |
| 159 | + print("verifygitlog.py -n10 # Check last 10 commits") |
| 160 | + print("verifygitlog.py -v master..HEAD # Check commits since master") |
| 161 | + |
| 162 | + |
| 163 | +if __name__ == "__main__": |
| 164 | + args = sys.argv[1:] |
| 165 | + verbosity = args.count("-v") |
| 166 | + suggestions = args.count("-n") == 0 |
| 167 | + if "--ignore-rebase" in args: |
| 168 | + args.remove("--ignore-rebase") |
| 169 | + ignore_prefixes = ["squash!", "fixup!", "amend!", "WIP"] |
| 170 | + |
| 171 | + if "-h" in args: |
| 172 | + show_help() |
| 173 | + else: |
| 174 | + args = [arg for arg in args if arg not in ["-v", "-n", "-h"]] |
| 175 | + run(args) |
0 commit comments