1 # Copyright (c) 2011 The Chromium OS Authors.
3 # SPDX-License-Identifier: GPL-2.0+
14 from series import Series
16 # Tags that we detect and remove
17 re_remove = re.compile('^BUG=|^TEST=|^BRANCH=|^Change-Id:|^Review URL:'
18 '|Reviewed-on:|Commit-\w*:')
20 # Lines which are allowed after a TEST= line
21 re_allowed_after_test = re.compile('^Signed-off-by:')
24 re_signoff = re.compile('^Signed-off-by:')
26 # The start of the cover letter
27 re_cover = re.compile('^Cover-letter:')
30 re_cover_cc = re.compile('^Cover-letter-cc: *(.*)')
33 re_series_tag = re.compile('^Series-([a-z-]*): *(.*)')
36 re_commit_tag = re.compile('^Commit-([a-z-]*): *(.*)')
38 # Commit tags that we want to collect and keep
39 re_tag = re.compile('^(Tested-by|Acked-by|Reviewed-by|Patch-cc): (.*)')
41 # The start of a new commit in the git log
42 re_commit = re.compile('^commit ([0-9a-f]*)$')
44 # We detect these since checkpatch doesn't always do it
45 re_space_before_tab = re.compile('^[+].* \t')
47 # States we can be in - can we use range() and still have comments?
48 STATE_MSG_HEADER = 0 # Still in the message header
49 STATE_PATCH_SUBJECT = 1 # In patch subject (first line of log for a commit)
50 STATE_PATCH_HEADER = 2 # In patch header (after the subject)
51 STATE_DIFFS = 3 # In the diff part (past --- line)
54 """Class for detecting/injecting tags in a patch or series of patches
56 We support processing the output of 'git log' to read out the tags we
57 are interested in. We can also process a patch file in order to remove
58 unwanted tags or inject additional ones. These correspond to the two
61 def __init__(self, series, name=None, is_log=False):
62 self.skip_blank = False # True to skip a single blank line
63 self.found_test = False # Found a TEST= line
64 self.lines_after_test = 0 # MNumber of lines found after TEST=
65 self.warn = [] # List of warnings we have collected
66 self.linenum = 1 # Output line number we are up to
67 self.in_section = None # Name of start...END section we are in
68 self.notes = [] # Series notes
69 self.section = [] # The current section...END section
70 self.series = series # Info about the patch series
71 self.is_log = is_log # True if indent like git log
72 self.in_change = 0 # Non-zero if we are in a change list
73 self.blank_count = 0 # Number of blank lines stored up
74 self.state = STATE_MSG_HEADER # What state are we in?
75 self.tags = [] # Tags collected, like Tested-by...
76 self.signoff = [] # Contents of signoff line
77 self.commit = None # Current commit
79 def AddToSeries(self, line, name, value):
80 """Add a new Series-xxx tag.
82 When a Series-xxx tag is detected, we come here to record it, if we
83 are scanning a 'git log'.
86 line: Source line containing tag (useful for debug/error messages)
87 name: Tag name (part after 'Series-')
88 value: Tag value (part after 'Series-xxx: ')
91 self.in_section = name
92 self.skip_blank = False
94 self.series.AddTag(self.commit, line, name, value)
96 def AddToCommit(self, line, name, value):
97 """Add a new Commit-xxx tag.
99 When a Commit-xxx tag is detected, we come here to record it.
102 line: Source line containing tag (useful for debug/error messages)
103 name: Tag name (part after 'Commit-')
104 value: Tag value (part after 'Commit-xxx: ')
107 self.in_section = 'commit-' + name
108 self.skip_blank = False
110 def CloseCommit(self):
111 """Save the current commit into our commit list, and reset our state"""
112 if self.commit and self.is_log:
113 self.series.AddCommit(self.commit)
116 def FormatTags(self, tags):
118 for tag in sorted(tags):
119 if tag.startswith('Cc:'):
120 tag_list = tag[4:].split(',')
121 out_list += gitutil.BuildEmailList(tag_list, 'Cc:')
126 def ProcessLine(self, line):
127 """Process a single line of a patch file or commit log
129 This process a line and returns a list of lines to output. The list
130 may be empty or may contain multiple output lines.
132 This is where all the complicated logic is located. The class's
133 state is used to move between different states and detect things
136 We can be in one of two modes:
137 self.is_log == True: This is 'git log' mode, where most output is
138 indented by 4 characters and we are scanning for tags
140 self.is_log == False: This is 'patch' mode, where we already have
141 all the tags, and are processing patches to remove junk we
142 don't want, and add things we think are required.
145 line: text line to process
148 list of output lines, or [] if nothing should be output
150 # Initially we have no output. Prepare the input line string
152 line = line.rstrip('\n')
157 # Handle state transition and skipping blank lines
158 series_tag_match = re_series_tag.match(line)
159 commit_tag_match = re_commit_tag.match(line)
160 commit_match = re_commit.match(line) if self.is_log else None
161 cover_cc_match = re_cover_cc.match(line)
163 if self.state == STATE_PATCH_HEADER:
164 tag_match = re_tag.match(line)
165 is_blank = not line.strip()
167 if (self.state == STATE_MSG_HEADER
168 or self.state == STATE_PATCH_SUBJECT):
171 # We don't have a subject in the text stream of patch files
172 # It has its own line with a Subject: tag
173 if not self.is_log and self.state == STATE_PATCH_SUBJECT:
176 self.state = STATE_MSG_HEADER
178 # If we are in a section, keep collecting lines until we see END
181 if self.in_section == 'cover':
182 self.series.cover = self.section
183 elif self.in_section == 'notes':
185 self.series.notes += self.section
186 elif self.in_section == 'commit-notes':
188 self.commit.notes += self.section
190 self.warn.append("Unknown section '%s'" % self.in_section)
191 self.in_section = None
192 self.skip_blank = True
195 self.section.append(line)
197 # Detect the commit subject
198 elif not is_blank and self.state == STATE_PATCH_SUBJECT:
199 self.commit.subject = line
201 # Detect the tags we want to remove, and skip blank lines
202 elif re_remove.match(line) and not commit_tag_match:
203 self.skip_blank = True
205 # TEST= should be the last thing in the commit, so remove
206 # everything after it
207 if line.startswith('TEST='):
208 self.found_test = True
209 elif self.skip_blank and is_blank:
210 self.skip_blank = False
212 # Detect the start of a cover letter section
213 elif re_cover.match(line):
214 self.in_section = 'cover'
215 self.skip_blank = False
218 value = cover_cc_match.group(1)
219 self.AddToSeries(line, 'cover-cc', value)
221 # If we are in a change list, key collected lines until a blank one
224 # Blank line ends this change list
226 elif line == '---' or re_signoff.match(line):
228 out = self.ProcessLine(line)
231 self.series.AddChange(self.in_change, self.commit, line)
232 self.skip_blank = False
234 # Detect Series-xxx tags
235 elif series_tag_match:
236 name = series_tag_match.group(1)
237 value = series_tag_match.group(2)
238 if name == 'changes':
239 # value is the version number: e.g. 1, or 2
242 except ValueError as str:
243 raise ValueError("%s: Cannot decode version info '%s'" %
244 (self.commit.hash, line))
245 self.in_change = int(value)
247 self.AddToSeries(line, name, value)
248 self.skip_blank = True
250 # Detect Commit-xxx tags
251 elif commit_tag_match:
252 name = commit_tag_match.group(1)
253 value = commit_tag_match.group(2)
255 self.AddToCommit(line, name, value)
256 self.skip_blank = True
258 # Detect the start of a new commit
261 # TODO: We should store the whole hash, and just display a subset
262 self.commit = commit.Commit(commit_match.group(1)[:8])
264 # Detect tags in the commit message
266 # Remove Tested-by self, since few will take much notice
267 if (tag_match.group(1) == 'Tested-by' and
268 tag_match.group(2).find(os.getenv('USER') + '@') != -1):
269 self.warn.append("Ignoring %s" % line)
270 elif tag_match.group(1) == 'Patch-cc':
271 self.commit.AddCc(tag_match.group(2).split(','))
273 self.tags.append(line);
275 # Well that means this is an ordinary line
278 # Look for ugly ASCII characters
280 # TODO: Would be nicer to report source filename and line
282 self.warn.append("Line %d/%d ('%s') has funny ascii char" %
283 (self.linenum, pos, line))
286 # Look for space before tab
287 m = re_space_before_tab.match(line)
289 self.warn.append('Line %d/%d has space before tab' %
290 (self.linenum, m.start()))
292 # OK, we have a valid non-blank line
295 self.skip_blank = False
296 if self.state == STATE_DIFFS:
299 # If this is the start of the diffs section, emit our tags and
302 self.state = STATE_DIFFS
304 # Output the tags (signeoff first), then change list
306 log = self.series.MakeChangeLog(self.commit)
307 out += self.FormatTags(self.tags)
308 out += [line] + self.commit.notes + [''] + log
309 elif self.found_test:
310 if not re_allowed_after_test.match(line):
311 self.lines_after_test += 1
316 """Close out processing of this patch stream"""
318 if self.lines_after_test:
319 self.warn.append('Found %d lines after TEST=' %
320 self.lines_after_test)
322 def ProcessStream(self, infd, outfd):
323 """Copy a stream from infd to outfd, filtering out unwanting things.
325 This is used to process patch files one at a time.
328 infd: Input stream file object
329 outfd: Output stream file object
331 # Extract the filename from each diff, for nice warnings
334 re_fname = re.compile('diff --git a/(.*) b/.*')
336 line = infd.readline()
339 out = self.ProcessLine(line)
341 # Try to detect blank lines at EOF
343 match = re_fname.match(line)
346 fname = match.group(1)
348 self.blank_count += 1
350 if self.blank_count and (line == '-- ' or match):
351 self.warn.append("Found possible blank line(s) at "
352 "end of file '%s'" % last_fname)
353 outfd.write('+\n' * self.blank_count)
354 outfd.write(line + '\n')
359 def GetMetaDataForList(commit_range, git_dir=None, count=None,
361 """Reads out patch series metadata from the commits
363 This does a 'git log' on the relevant commits and pulls out the tags we
367 commit_range: Range of commits to count (e.g. 'HEAD..base')
368 git_dir: Path to git repositiory (None to use default)
369 count: Number of commits to list, or None for no limit
370 series: Series object to add information into. By default a new series
373 A Series object containing information about the commits.
375 params = ['git', 'log', '--no-color', '--reverse', '--no-decorate',
377 if count is not None:
378 params[2:2] = ['-n%d' % count]
380 params[1:1] = ['--git-dir', git_dir]
382 stdout = command.RunPipe(pipe, capture=True).stdout
383 ps = PatchStream(series, is_log=True)
384 for line in stdout.splitlines():
389 def GetMetaData(start, count):
390 """Reads out patch series metadata from the commits
392 This does a 'git log' on the relevant commits and pulls out the tags we
396 start: Commit to start from: 0=HEAD, 1=next one, etc.
397 count: Number of commits to list
399 return GetMetaDataForList('HEAD~%d' % start, None, count)
401 def FixPatch(backup_dir, fname, series, commit):
402 """Fix up a patch file, by adding/removing as required.
404 We remove our tags from the patch file, insert changes lists, etc.
405 The patch file is processed in place, and overwritten.
407 A backup file is put into backup_dir (if not None).
410 fname: Filename to patch file to process
411 series: Series information about this patch set
412 commit: Commit object for this patch file
414 A list of errors, or [] if all ok.
416 handle, tmpname = tempfile.mkstemp()
417 outfd = os.fdopen(handle, 'w')
418 infd = open(fname, 'r')
419 ps = PatchStream(series)
421 ps.ProcessStream(infd, outfd)
425 # Create a backup file if required
427 shutil.copy(fname, os.path.join(backup_dir, os.path.basename(fname)))
428 shutil.move(tmpname, fname)
431 def FixPatches(series, fnames):
432 """Fix up a list of patches identified by filenames
434 The patch files are processed in place, and overwritten.
437 series: The series object
438 fnames: List of patch files to process
440 # Current workflow creates patches, so we shouldn't need a backup
441 backup_dir = None #tempfile.mkdtemp('clean-patch')
444 commit = series.commits[count]
446 result = FixPatch(backup_dir, fname, series, commit)
448 print '%d warnings for %s:' % (len(result), fname)
453 print 'Cleaned %d patches' % count
456 def InsertCoverLetter(fname, series, count):
457 """Inserts a cover letter with the required info into patch 0
460 fname: Input / output filename of the cover letter file
461 series: Series object
462 count: Number of patches in the series
464 fd = open(fname, 'r')
465 lines = fd.readlines()
468 fd = open(fname, 'w')
470 prefix = series.GetPatchPrefix()
472 if line.startswith('Subject:'):
473 # TODO: if more than 10 patches this should save 00/xx, not 0/xx
474 line = 'Subject: [%s 0/%d] %s\n' % (prefix, count, text[0])
476 # Insert our cover letter
477 elif line.startswith('*** BLURB HERE ***'):
478 # First the blurb test
479 line = '\n'.join(text[1:]) + '\n'
480 if series.get('notes'):
481 line += '\n'.join(series.notes) + '\n'
483 # Now the change list
484 out = series.MakeChangeLog(None)
485 line += '\n' + '\n'.join(out)