blob: 52138dc180912f22920d019ad2cfe715b9bea78a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
#!/usr/bin/env python3
# Copyright 2023 The ChromiumOS Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Ensure commit messages using LOW_COVERAGE_REASON include a bug."""
import argparse
import logging
import pathlib
import re
import subprocess
import sys
# Look for LOW_COVERAGE_REASON and then an optional b{:|/}number bug reference.
LOW_COV_REGEX = re.compile(
r"\s*(LOW_COVERAGE_REASON=)(?:(?!b[/|:][\d]+).)*(b[/|:]([\d]+))?"
)
EC_BASE = pathlib.Path(__file__).resolve().parent.parent
def main(argv=None):
"""Check for bug in LOW_COVERAGE_REASON."""
parser = argparse.ArgumentParser()
parser.add_argument(
"commit_id",
help="Commit whose message will be checked.",
)
opts = parser.parse_args(argv)
if opts.commit_id == "pre-submit":
# Only run check if verifying an actual commit.
return 0
try:
commit_log = subprocess.check_output(
["git", "log", "--max-count=1", opts.commit_id],
cwd=EC_BASE,
)
except subprocess.CalledProcessError as err:
logging.error("Unable to query git log: %s", err)
return 1
# Search commit message for LOW_COVERAGE_REASON and bug
matches = LOW_COV_REGEX.findall(commit_log.decode())
if matches and not any({m[2] for m in matches}):
# We have LOW_COVERAGE_REASON line(s) but none include a bug
logging.error(
"LOW_COVERAGE_REASON line must include one or more bugs "
"tracking the reason for missing coverage"
)
return 1
return 0
if __name__ == "__main__":
sys.exit(main(sys.argv[1:]))
|
