1 # Copyright (c) 2011 The Chromium OS Authors.
3 # See file CREDITS for list of people who contributed to this
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License as
8 # published by the Free Software Foundation; either version 2 of
9 # the License, or (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston,
30 from series import Series
32 # Tags that we detect and remove
33 re_remove = re.compile('^BUG=|^TEST=|^Change-Id:|^Review URL:'
34 '|Reviewed-on:|Reviewed-by:')
36 # Lines which are allowed after a TEST= line
37 re_allowed_after_test = re.compile('^Signed-off-by:')
40 re_signoff = re.compile('^Signed-off-by:')
42 # The start of the cover letter
43 re_cover = re.compile('^Cover-letter:')
46 re_series = re.compile('^Series-(\w*): *(.*)')
48 # Commit tags that we want to collect and keep
49 re_tag = re.compile('^(Tested-by|Acked-by|Signed-off-by|Cc): (.*)')
51 # The start of a new commit in the git log
52 re_commit = re.compile('^commit (.*)')
54 # We detect these since checkpatch doesn't always do it
55 re_space_before_tab = re.compile('^[+].* \t')
57 # States we can be in - can we use range() and still have comments?
58 STATE_MSG_HEADER = 0 # Still in the message header
59 STATE_PATCH_SUBJECT = 1 # In patch subject (first line of log for a commit)
60 STATE_PATCH_HEADER = 2 # In patch header (after the subject)
61 STATE_DIFFS = 3 # In the diff part (past --- line)
64 """Class for detecting/injecting tags in a patch or series of patches
66 We support processing the output of 'git log' to read out the tags we
67 are interested in. We can also process a patch file in order to remove
68 unwanted tags or inject additional ones. These correspond to the two
71 def __init__(self, series, name=None, is_log=False):
72 self.skip_blank = False # True to skip a single blank line
73 self.found_test = False # Found a TEST= line
74 self.lines_after_test = 0 # MNumber of lines found after TEST=
75 self.warn = [] # List of warnings we have collected
76 self.linenum = 1 # Output line number we are up to
77 self.in_section = None # Name of start...END section we are in
78 self.notes = [] # Series notes
79 self.section = [] # The current section...END section
80 self.series = series # Info about the patch series
81 self.is_log = is_log # True if indent like git log
82 self.in_change = 0 # Non-zero if we are in a change list
83 self.blank_count = 0 # Number of blank lines stored up
84 self.state = STATE_MSG_HEADER # What state are we in?
85 self.tags = [] # Tags collected, like Tested-by...
86 self.signoff = [] # Contents of signoff line
87 self.commit = None # Current commit
89 def AddToSeries(self, line, name, value):
90 """Add a new Series-xxx tag.
92 When a Series-xxx tag is detected, we come here to record it, if we
93 are scanning a 'git log'.
96 line: Source line containing tag (useful for debug/error messages)
97 name: Tag name (part after 'Series-')
98 value: Tag value (part after 'Series-xxx: ')
101 self.in_section = name
102 self.skip_blank = False
104 self.series.AddTag(self.commit, line, name, value)
106 def CloseCommit(self):
107 """Save the current commit into our commit list, and reset our state"""
108 if self.commit and self.is_log:
109 self.series.AddCommit(self.commit)
112 def FormatTags(self, tags):
114 for tag in sorted(tags):
115 if tag.startswith('Cc:'):
116 tag_list = tag[4:].split(',')
117 out_list += gitutil.BuildEmailList(tag_list, 'Cc:')
122 def ProcessLine(self, line):
123 """Process a single line of a patch file or commit log
125 This process a line and returns a list of lines to output. The list
126 may be empty or may contain multiple output lines.
128 This is where all the complicated logic is located. The class's
129 state is used to move between different states and detect things
132 We can be in one of two modes:
133 self.is_log == True: This is 'git log' mode, where most output is
134 indented by 4 characters and we are scanning for tags
136 self.is_log == False: This is 'patch' mode, where we already have
137 all the tags, and are processing patches to remove junk we
138 don't want, and add things we think are required.
141 line: text line to process
144 list of output lines, or [] if nothing should be output
146 # Initially we have no output. Prepare the input line string
148 line = line.rstrip('\n')
153 # Handle state transition and skipping blank lines
154 series_match = re_series.match(line)
155 commit_match = re_commit.match(line) if self.is_log else None
157 if self.state == STATE_PATCH_HEADER:
158 tag_match = re_tag.match(line)
159 is_blank = not line.strip()
161 if (self.state == STATE_MSG_HEADER
162 or self.state == STATE_PATCH_SUBJECT):
165 # We don't have a subject in the text stream of patch files
166 # It has its own line with a Subject: tag
167 if not self.is_log and self.state == STATE_PATCH_SUBJECT:
170 self.state = STATE_MSG_HEADER
172 # If we are in a section, keep collecting lines until we see END
175 if self.in_section == 'cover':
176 self.series.cover = self.section
177 elif self.in_section == 'notes':
179 self.series.notes += self.section
181 self.warn.append("Unknown section '%s'" % self.in_section)
182 self.in_section = None
183 self.skip_blank = True
186 self.section.append(line)
188 # Detect the commit subject
189 elif not is_blank and self.state == STATE_PATCH_SUBJECT:
190 self.commit.subject = line
192 # Detect the tags we want to remove, and skip blank lines
193 elif re_remove.match(line):
194 self.skip_blank = True
196 # TEST= should be the last thing in the commit, so remove
197 # everything after it
198 if line.startswith('TEST='):
199 self.found_test = True
200 elif self.skip_blank and is_blank:
201 self.skip_blank = False
203 # Detect the start of a cover letter section
204 elif re_cover.match(line):
205 self.in_section = 'cover'
206 self.skip_blank = False
208 # If we are in a change list, key collected lines until a blank one
211 # Blank line ends this change list
213 elif line == '---' or re_signoff.match(line):
215 out = self.ProcessLine(line)
218 self.series.AddChange(self.in_change, self.commit, line)
219 self.skip_blank = False
221 # Detect Series-xxx tags
223 name = series_match.group(1)
224 value = series_match.group(2)
225 if name == 'changes':
226 # value is the version number: e.g. 1, or 2
229 except ValueError as str:
230 raise ValueError("%s: Cannot decode version info '%s'" %
231 (self.commit.hash, line))
232 self.in_change = int(value)
234 self.AddToSeries(line, name, value)
235 self.skip_blank = True
237 # Detect the start of a new commit
240 self.commit = commit.Commit(commit_match.group(1)[:7])
242 # Detect tags in the commit message
244 # Onlly allow a single signoff tag
245 if tag_match.group(1) == 'Signed-off-by':
247 self.warn.append('Patch has more than one Signed-off-by '
249 self.signoff += [line]
251 # Remove Tested-by self, since few will take much notice
252 elif (tag_match.group(1) == 'Tested-by' and
253 tag_match.group(2).find(os.getenv('USER') + '@') != -1):
254 self.warn.append("Ignoring %s" % line)
255 elif tag_match.group(1) == 'Cc':
256 self.commit.AddCc(tag_match.group(2).split(','))
258 self.tags.append(line);
260 # Well that means this is an ordinary line
263 # Look for ugly ASCII characters
265 # TODO: Would be nicer to report source filename and line
267 self.warn.append("Line %d/%d ('%s') has funny ascii char" %
268 (self.linenum, pos, line))
271 # Look for space before tab
272 m = re_space_before_tab.match(line)
274 self.warn.append('Line %d/%d has space before tab' %
275 (self.linenum, m.start()))
277 # OK, we have a valid non-blank line
280 self.skip_blank = False
281 if self.state == STATE_DIFFS:
284 # If this is the start of the diffs section, emit our tags and
287 self.state = STATE_DIFFS
289 # Output the tags (signeoff first), then change list
293 log = self.series.MakeChangeLog(self.commit)
294 out += self.FormatTags(self.tags)
296 elif self.found_test:
297 if not re_allowed_after_test.match(line):
298 self.lines_after_test += 1
303 """Close out processing of this patch stream"""
305 if self.lines_after_test:
306 self.warn.append('Found %d lines after TEST=' %
307 self.lines_after_test)
309 def ProcessStream(self, infd, outfd):
310 """Copy a stream from infd to outfd, filtering out unwanting things.
312 This is used to process patch files one at a time.
315 infd: Input stream file object
316 outfd: Output stream file object
318 # Extract the filename from each diff, for nice warnings
321 re_fname = re.compile('diff --git a/(.*) b/.*')
323 line = infd.readline()
326 out = self.ProcessLine(line)
328 # Try to detect blank lines at EOF
330 match = re_fname.match(line)
333 fname = match.group(1)
335 self.blank_count += 1
337 if self.blank_count and (line == '-- ' or match):
338 self.warn.append("Found possible blank line(s) at "
339 "end of file '%s'" % last_fname)
340 outfd.write('+\n' * self.blank_count)
341 outfd.write(line + '\n')
346 def GetMetaData(start, count):
347 """Reads out patch series metadata from the commits
349 This does a 'git log' on the relevant commits and pulls out the tags we
353 start: Commit to start from: 0=HEAD, 1=next one, etc.
354 count: Number of commits to list
356 pipe = [['git', 'log', '--reverse', 'HEAD~%d' % start, '-n%d' % count]]
357 stdout = command.RunPipe(pipe, capture=True)
359 ps = PatchStream(series, is_log=True)
360 for line in stdout.splitlines():
365 def FixPatch(backup_dir, fname, series, commit):
366 """Fix up a patch file, by adding/removing as required.
368 We remove our tags from the patch file, insert changes lists, etc.
369 The patch file is processed in place, and overwritten.
371 A backup file is put into backup_dir (if not None).
374 fname: Filename to patch file to process
375 series: Series information about this patch set
376 commit: Commit object for this patch file
378 A list of errors, or [] if all ok.
380 handle, tmpname = tempfile.mkstemp()
381 outfd = os.fdopen(handle, 'w')
382 infd = open(fname, 'r')
383 ps = PatchStream(series)
385 ps.ProcessStream(infd, outfd)
389 # Create a backup file if required
391 shutil.copy(fname, os.path.join(backup_dir, os.path.basename(fname)))
392 shutil.move(tmpname, fname)
395 def FixPatches(series, fnames):
396 """Fix up a list of patches identified by filenames
398 The patch files are processed in place, and overwritten.
401 series: The series object
402 fnames: List of patch files to process
404 # Current workflow creates patches, so we shouldn't need a backup
405 backup_dir = None #tempfile.mkdtemp('clean-patch')
408 commit = series.commits[count]
410 result = FixPatch(backup_dir, fname, series, commit)
412 print '%d warnings for %s:' % (len(result), fname)
417 print 'Cleaned %d patches' % count
420 def InsertCoverLetter(fname, series, count):
421 """Inserts a cover letter with the required info into patch 0
424 fname: Input / output filename of the cover letter file
425 series: Series object
426 count: Number of patches in the series
428 fd = open(fname, 'r')
429 lines = fd.readlines()
432 fd = open(fname, 'w')
434 prefix = series.GetPatchPrefix()
436 if line.startswith('Subject:'):
437 # TODO: if more than 10 patches this should save 00/xx, not 0/xx
438 line = 'Subject: [%s 0/%d] %s\n' % (prefix, count, text[0])
440 # Insert our cover letter
441 elif line.startswith('*** BLURB HERE ***'):
442 # First the blurb test
443 line = '\n'.join(text[1:]) + '\n'
444 if series.get('notes'):
445 line += '\n'.join(series.notes) + '\n'
447 # Now the change list
448 out = series.MakeChangeLog(None)
449 line += '\n' + '\n'.join(out)