Mercurial > hg
annotate contrib/check-commit @ 40783:e207f0d6c243
perf: update perfindex to be more realistic
The previous code was creating a revlog manually, we now use the actual
`localrepo` method to create it.
We have to jump though extra hops to work around the impact of filecache.
author | Boris Feld <boris.feld@octobus.net> |
---|---|
date | Fri, 23 Nov 2018 06:03:38 +0100 |
parents | 47084b5ffd80 |
children | 811f772b44aa |
rev | line source |
---|---|
22043
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1 #!/usr/bin/env python |
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
2 # |
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
3 # Copyright 2014 Matt Mackall <mpm@selenic.com> |
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
4 # |
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
5 # A tool/hook to run basic sanity checks on commits/patches for |
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
6 # submission to Mercurial. Install by adding the following to your |
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
7 # .hg/hgrc: |
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
8 # |
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
9 # [hooks] |
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
10 # pretxncommit = contrib/check-commit |
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
11 # |
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
12 # The hook can be temporarily bypassed with: |
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
13 # |
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
14 # $ BYPASS= hg commit |
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
15 # |
26421
4b0fc75f9403
urls: bulk-change primary website URLs
Matt Mackall <mpm@selenic.com>
parents:
25643
diff
changeset
|
16 # See also: https://mercurial-scm.org/wiki/ContributingChanges |
22043
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
17 |
29164
91f35b1a34cf
py3: make contrib/check-commit use print_function
Pulkit Goyal <7895pulkit@gmail.com>
parents:
29163
diff
changeset
|
18 from __future__ import absolute_import, print_function |
29163
bf7fd815b083
py3: make contrib/check-commit use absolute_import
Pulkit Goyal <7895pulkit@gmail.com>
parents:
28043
diff
changeset
|
19 |
bf7fd815b083
py3: make contrib/check-commit use absolute_import
Pulkit Goyal <7895pulkit@gmail.com>
parents:
28043
diff
changeset
|
20 import os |
bf7fd815b083
py3: make contrib/check-commit use absolute_import
Pulkit Goyal <7895pulkit@gmail.com>
parents:
28043
diff
changeset
|
21 import re |
bf7fd815b083
py3: make contrib/check-commit use absolute_import
Pulkit Goyal <7895pulkit@gmail.com>
parents:
28043
diff
changeset
|
22 import sys |
22043
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
23 |
27782
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
24 commitheader = r"^(?:# [^\n]*\n)*" |
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
25 afterheader = commitheader + r"(?!#)" |
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
26 beforepatch = afterheader + r"(?!\n(?!@@))" |
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
27 |
22043
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
28 errors = [ |
27782
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
29 (beforepatch + r".*[(]bc[)]", "(BC) needs to be uppercase"), |
28042
08e0c4082903
check-commit: wrap too long line
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
28013
diff
changeset
|
30 (beforepatch + r".*[(]issue \d\d\d", |
08e0c4082903
check-commit: wrap too long line
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
28013
diff
changeset
|
31 "no space allowed between issue and number"), |
27782
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
32 (beforepatch + r".*[(]bug(\d|\s)", "use (issueDDDD) instead of bug"), |
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
33 (commitheader + r"# User [^@\n]+\n", "username is not an email address"), |
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
34 (commitheader + r"(?!merge with )[^#]\S+[^:] ", |
22043
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
35 "summary line doesn't start with 'topic: '"), |
27782
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
36 (afterheader + r"[A-Z][a-z]\S+", "don't capitalize summary lines"), |
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
37 (afterheader + r"[^\n]*: *[A-Z][a-z]\S+", "don't capitalize summary lines"), |
30061
8e805cf27caa
check-commit: allow underscore as commit topic
Mathias De Maré <mathias.de_mare@nokia.com>
parents:
29716
diff
changeset
|
38 (afterheader + r"\S*[^A-Za-z0-9-_]\S*: ", |
27692
e0465035def9
check-commit: try to curb bad commit summary keywords
Matt Mackall <mpm@selenic.com>
parents:
27199
diff
changeset
|
39 "summary keyword should be most user-relevant one-word command or topic"), |
27782
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
40 (afterheader + r".*\.\s*\n", "don't add trailing period on summary line"), |
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
41 (afterheader + r".{79,}", "summary line too long (limit is 78)"), |
29716
37b6f0ec6241
check-commit: allow underbars in cffi_-prefix function names
Augie Fackler <augie@google.com>
parents:
29164
diff
changeset
|
42 # Forbid "_" in function name. |
37b6f0ec6241
check-commit: allow underbars in cffi_-prefix function names
Augie Fackler <augie@google.com>
parents:
29164
diff
changeset
|
43 # |
37b6f0ec6241
check-commit: allow underbars in cffi_-prefix function names
Augie Fackler <augie@google.com>
parents:
29164
diff
changeset
|
44 # We skip the check for cffi related functions. They use names mapping the |
37b6f0ec6241
check-commit: allow underbars in cffi_-prefix function names
Augie Fackler <augie@google.com>
parents:
29164
diff
changeset
|
45 # name of the C function. C function names may contain "_". |
37b6f0ec6241
check-commit: allow underbars in cffi_-prefix function names
Augie Fackler <augie@google.com>
parents:
29164
diff
changeset
|
46 (r"\n\+[ \t]+def (?!cffi)[a-z]+_[a-z]", |
37b6f0ec6241
check-commit: allow underbars in cffi_-prefix function names
Augie Fackler <augie@google.com>
parents:
29164
diff
changeset
|
47 "adds a function with foo_bar naming"), |
22043
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
48 ] |
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
49 |
27782
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
50 word = re.compile('\S') |
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
51 def nonempty(first, second): |
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
52 if word.search(first): |
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
53 return first |
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
54 return second |
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
55 |
28043
ac4684c21f73
check-commit: omit whitespace
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
28042
diff
changeset
|
56 def checkcommit(commit, node=None): |
27780 | 57 exitcode = 0 |
27781
2af351bd289c
check-commit: support REVs as commandline arguments
timeless <timeless@mozdev.org>
parents:
27780
diff
changeset
|
58 printed = node is None |
27783
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
59 hits = [] |
30843
2fb3ae89e4e1
contrib: fix check-commit to not reject commits from `hg sign` and `hg tag`
Augie Fackler <augie@google.com>
parents:
30061
diff
changeset
|
60 signtag = (afterheader + |
2fb3ae89e4e1
contrib: fix check-commit to not reject commits from `hg sign` and `hg tag`
Augie Fackler <augie@google.com>
parents:
30061
diff
changeset
|
61 r'Added (tag [^ ]+|signature) for changeset [a-f0-9]{12}') |
2fb3ae89e4e1
contrib: fix check-commit to not reject commits from `hg sign` and `hg tag`
Augie Fackler <augie@google.com>
parents:
30061
diff
changeset
|
62 if re.search(signtag, commit): |
2fb3ae89e4e1
contrib: fix check-commit to not reject commits from `hg sign` and `hg tag`
Augie Fackler <augie@google.com>
parents:
30061
diff
changeset
|
63 return 0 |
27780 | 64 for exp, msg in errors: |
28012
897b2fcf079f
check-commit: scan for multiple instances of error patterns
Matt Mackall <mpm@selenic.com>
parents:
27783
diff
changeset
|
65 for m in re.finditer(exp, commit): |
27782
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
66 end = m.end() |
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
67 trailing = re.search(r'(\\n)+$', exp) |
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
68 if trailing: |
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
69 end -= len(trailing.group()) / 2 |
27783
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
70 hits.append((end, exp, msg)) |
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
71 if hits: |
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
72 hits.sort() |
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
73 pos = 0 |
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
74 last = '' |
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
75 for n, l in enumerate(commit.splitlines(True)): |
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
76 pos += len(l) |
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
77 while len(hits): |
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
78 end, exp, msg = hits[0] |
27782
7291c8165e33
check-commit: try to fix multiline handling
timeless <timeless@mozdev.org>
parents:
27781
diff
changeset
|
79 if pos < end: |
27780 | 80 break |
27783
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
81 if not printed: |
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
82 printed = True |
29164
91f35b1a34cf
py3: make contrib/check-commit use print_function
Pulkit Goyal <7895pulkit@gmail.com>
parents:
29163
diff
changeset
|
83 print("node: %s" % node) |
91f35b1a34cf
py3: make contrib/check-commit use print_function
Pulkit Goyal <7895pulkit@gmail.com>
parents:
29163
diff
changeset
|
84 print("%d: %s" % (n, msg)) |
91f35b1a34cf
py3: make contrib/check-commit use print_function
Pulkit Goyal <7895pulkit@gmail.com>
parents:
29163
diff
changeset
|
85 print(" %s" % nonempty(l, last)[:-1]) |
27783
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
86 if "BYPASS" not in os.environ: |
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
87 exitcode = 1 |
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
88 del hits[0] |
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
89 last = nonempty(l, last) |
1d095371de47
check-commit: sort errors by line number
timeless <timeless@mozdev.org>
parents:
27782
diff
changeset
|
90 |
27780 | 91 return exitcode |
22043
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
92 |
27780 | 93 def readcommit(node): |
94 return os.popen("hg export %s" % node).read() | |
95 | |
96 if __name__ == "__main__": | |
27781
2af351bd289c
check-commit: support REVs as commandline arguments
timeless <timeless@mozdev.org>
parents:
27780
diff
changeset
|
97 exitcode = 0 |
27780 | 98 node = os.environ.get("HG_NODE") |
22043
1274ff3f20a8
contrib: add check-commit hook script to sanity-check commits
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
99 |
27780 | 100 if node: |
101 commit = readcommit(node) | |
27781
2af351bd289c
check-commit: support REVs as commandline arguments
timeless <timeless@mozdev.org>
parents:
27780
diff
changeset
|
102 exitcode = checkcommit(commit) |
2af351bd289c
check-commit: support REVs as commandline arguments
timeless <timeless@mozdev.org>
parents:
27780
diff
changeset
|
103 elif sys.argv[1:]: |
2af351bd289c
check-commit: support REVs as commandline arguments
timeless <timeless@mozdev.org>
parents:
27780
diff
changeset
|
104 for node in sys.argv[1:]: |
2af351bd289c
check-commit: support REVs as commandline arguments
timeless <timeless@mozdev.org>
parents:
27780
diff
changeset
|
105 exitcode |= checkcommit(readcommit(node), node) |
27780 | 106 else: |
107 commit = sys.stdin.read() | |
27781
2af351bd289c
check-commit: support REVs as commandline arguments
timeless <timeless@mozdev.org>
parents:
27780
diff
changeset
|
108 exitcode = checkcommit(commit) |
27780 | 109 sys.exit(exitcode) |