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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
#!ON_PYTHON
#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
# or http://www.opensolaris.org/os/licensing.
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#
#
# Copyright 2009 Sun Microsystems, Inc. All rights reserved.
# Use is subject to license terms.
#
# Copyright 2007, 2010 Richard Lowe
#
# Check delta comments:
# - Have the correct form.
# - Have a synopsis matching that of the bug
# - Appear only once.
#
import re, sys
from onbld.Checks.DbLookups import BugDB
bugre = re.compile(r'^(\d{2,7}|[A-Z]{1,7}-\d{1,7}) (.*)$')
def isBug(comment):
return bugre.match(comment)
def comchk(comments, check_db=True, output=sys.stderr):
'''Validate checkin comments against ON standards.
Comments must be a list of one-line comments, with no trailing
newline.
If check_db is True (the default), validate bug synopses against the
databases.
Error messages intended for the user are written to output,
which defaults to stderr
'''
bugnospcre = re.compile(r'^(\d{2,7})([^ ].*)')
ignorere = re.compile(r'^(' +
r'Portions contributed by|' +
r'Contributed by|' +
r'Reviewed[ -]by|' +
r'Approved[ -]by|' +
r'back[ -]?out)' +
r'[: ]')
errors = { 'bugnospc': [],
'mutant': [],
'dup': [],
'nomatch': [],
'nonexistent': [] }
bugs = {}
ret = 0
blanks = False
for com in comments:
# Our input must be newline-free, comments are line-wise.
if com.find('\n') != -1:
raise ValueError("newline in comment '%s'" % com)
# Ignore valid comments we can't check
if ignorere.search(com):
continue
if not com or com.isspace():
blanks = True
continue
match = bugre.search(com)
if match:
if match.group(1) not in bugs:
bugs[match.group(1)] = []
bugs[match.group(1)].append(match.group(2))
continue
#
# Bugs missing a space after the ID are still bugs
# for the purposes of the duplicate ID and synopsis
# checks.
#
match = bugnospcre.search(com)
if match:
if match.group(1) not in bugs:
bugs[match.group(1)] = []
bugs[match.group(1)].append(match.group(2))
errors['bugnospc'].append(com)
continue
# Anything else is bogus
errors['mutant'].append(com)
if len(bugs) > 0 and check_db:
bugdb = BugDB()
results = bugdb.lookup(bugs.keys())
for crid, insts in bugs.iteritems():
if len(insts) > 1:
errors['dup'].append(crid)
if not check_db:
continue
if crid not in results:
errors['nonexistent'].append(crid)
continue
#
# For each synopsis, compare the real synopsis with
# that in the comments, allowing for possible '(fix
# stuff)'-like trailing text
#
for entered in insts:
synopsis = results[crid]["synopsis"]
if not re.search(r'^' + re.escape(synopsis) +
r'( \([^)]+\))?$', entered):
errors['nomatch'].append([crid, synopsis,
entered])
if blanks:
output.write("WARNING: Blank line(s) in comments\n")
ret = 1
if errors['dup']:
ret = 1
output.write("These IDs appear more than once in your "
"comments:\n")
for err in errors['dup']:
output.write(" %s\n" % err)
if errors['bugnospc']:
ret = 1
output.write("These bugs are missing a single space following "
"the ID:\n")
for com in errors['bugnospc']:
output.write(" %s\n" % com)
if errors['mutant']:
ret = 1
output.write("These comments are not valid bugs:\n")
for com in errors['mutant']:
output.write(" %s\n" % com)
if errors['nonexistent']:
ret = 1
output.write("These bugs were not found in the databases:\n")
for id in errors['nonexistent']:
output.write(" %s\n" % id)
if errors['nomatch']:
ret = 1
output.write("These bug synopses don't match "
"the database entries:\n")
for err in errors['nomatch']:
output.write("Synopsis of %s is wrong:\n" % err[0])
output.write(" should be: '%s'\n" % err[1])
output.write(" is: '%s'\n" % err[2])
return ret
|
