1 # Copyright (c) 2011 The Chromium OS Authors.
3 # SPDX-License-Identifier: GPL-2.0+
15 from series import Series
17 # Tags that we detect and remove
18 re_remove = re.compile('^BUG=|^TEST=|^BRANCH=|^Change-Id:|^Review URL:'
19 '|Reviewed-on:|Commit-\w*:')
21 # Lines which are allowed after a TEST= line
22 re_allowed_after_test = re.compile('^Signed-off-by:')
25 re_signoff = re.compile('^Signed-off-by: *(.*)')
27 # The start of the cover letter
28 re_cover = re.compile('^Cover-letter:')
31 re_cover_cc = re.compile('^Cover-letter-cc: *(.*)')
34 re_series_tag = re.compile('^Series-([a-z-]*): *(.*)')
37 re_commit_tag = re.compile('^Commit-([a-z-]*): *(.*)')
39 # Commit tags that we want to collect and keep
40 re_tag = re.compile('^(Tested-by|Acked-by|Reviewed-by|Patch-cc): (.*)')
42 # The start of a new commit in the git log
43 re_commit = re.compile('^commit ([0-9a-f]*)$')
45 # We detect these since checkpatch doesn't always do it
46 re_space_before_tab = re.compile('^[+].* \t')
48 # States we can be in - can we use range() and still have comments?
49 STATE_MSG_HEADER = 0 # Still in the message header
50 STATE_PATCH_SUBJECT = 1 # In patch subject (first line of log for a commit)
51 STATE_PATCH_HEADER = 2 # In patch header (after the subject)
52 STATE_DIFFS = 3 # In the diff part (past --- line)
55 """Class for detecting/injecting tags in a patch or series of patches
57 We support processing the output of 'git log' to read out the tags we
58 are interested in. We can also process a patch file in order to remove
59 unwanted tags or inject additional ones. These correspond to the two
62 def __init__(self, series, name=None, is_log=False):
63 self.skip_blank = False # True to skip a single blank line
64 self.found_test = False # Found a TEST= line
65 self.lines_after_test = 0 # MNumber of lines found after TEST=
66 self.warn = [] # List of warnings we have collected
67 self.linenum = 1 # Output line number we are up to
68 self.in_section = None # Name of start...END section we are in
69 self.notes = [] # Series notes
70 self.section = [] # The current section...END section
71 self.series = series # Info about the patch series
72 self.is_log = is_log # True if indent like git log
73 self.in_change = 0 # Non-zero if we are in a change list
74 self.blank_count = 0 # Number of blank lines stored up
75 self.state = STATE_MSG_HEADER # What state are we in?
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 ProcessLine(self, line):
117 """Process a single line of a patch file or commit log
119 This process a line and returns a list of lines to output. The list
120 may be empty or may contain multiple output lines.
122 This is where all the complicated logic is located. The class's
123 state is used to move between different states and detect things
126 We can be in one of two modes:
127 self.is_log == True: This is 'git log' mode, where most output is
128 indented by 4 characters and we are scanning for tags
130 self.is_log == False: This is 'patch' mode, where we already have
131 all the tags, and are processing patches to remove junk we
132 don't want, and add things we think are required.
135 line: text line to process
138 list of output lines, or [] if nothing should be output
140 # Initially we have no output. Prepare the input line string
142 line = line.rstrip('\n')
144 commit_match = re_commit.match(line) if self.is_log else None
150 # Handle state transition and skipping blank lines
151 series_tag_match = re_series_tag.match(line)
152 commit_tag_match = re_commit_tag.match(line)
153 cover_cc_match = re_cover_cc.match(line)
154 signoff_match = re_signoff.match(line)
156 if self.state == STATE_PATCH_HEADER:
157 tag_match = re_tag.match(line)
158 is_blank = not line.strip()
160 if (self.state == STATE_MSG_HEADER
161 or self.state == STATE_PATCH_SUBJECT):
164 # We don't have a subject in the text stream of patch files
165 # It has its own line with a Subject: tag
166 if not self.is_log and self.state == STATE_PATCH_SUBJECT:
169 self.state = STATE_MSG_HEADER
171 # If we are in a section, keep collecting lines until we see END
174 if self.in_section == 'cover':
175 self.series.cover = self.section
176 elif self.in_section == 'notes':
178 self.series.notes += self.section
179 elif self.in_section == 'commit-notes':
181 self.commit.notes += self.section
183 self.warn.append("Unknown section '%s'" % self.in_section)
184 self.in_section = None
185 self.skip_blank = True
188 self.section.append(line)
190 # Detect the commit subject
191 elif not is_blank and self.state == STATE_PATCH_SUBJECT:
192 self.commit.subject = line
194 # Detect the tags we want to remove, and skip blank lines
195 elif re_remove.match(line) and not commit_tag_match:
196 self.skip_blank = True
198 # TEST= should be the last thing in the commit, so remove
199 # everything after it
200 if line.startswith('TEST='):
201 self.found_test = True
202 elif self.skip_blank and is_blank:
203 self.skip_blank = False
205 # Detect the start of a cover letter section
206 elif re_cover.match(line):
207 self.in_section = 'cover'
208 self.skip_blank = False
211 value = cover_cc_match.group(1)
212 self.AddToSeries(line, 'cover-cc', value)
214 # If we are in a change list, key collected lines until a blank one
217 # Blank line ends this change list
221 out = self.ProcessLine(line)
224 self.series.AddChange(self.in_change, self.commit, line)
225 self.skip_blank = False
227 # Detect Series-xxx tags
228 elif series_tag_match:
229 name = series_tag_match.group(1)
230 value = series_tag_match.group(2)
231 if name == 'changes':
232 # value is the version number: e.g. 1, or 2
235 except ValueError as str:
236 raise ValueError("%s: Cannot decode version info '%s'" %
237 (self.commit.hash, line))
238 self.in_change = int(value)
240 self.AddToSeries(line, name, value)
241 self.skip_blank = True
243 # Detect Commit-xxx tags
244 elif commit_tag_match:
245 name = commit_tag_match.group(1)
246 value = commit_tag_match.group(2)
248 self.AddToCommit(line, name, value)
249 self.skip_blank = True
251 # Detect the start of a new commit
254 self.commit = commit.Commit(commit_match.group(1))
256 # Detect tags in the commit message
258 # Remove Tested-by self, since few will take much notice
259 if (tag_match.group(1) == 'Tested-by' and
260 tag_match.group(2).find(os.getenv('USER') + '@') != -1):
261 self.warn.append("Ignoring %s" % line)
262 elif tag_match.group(1) == 'Patch-cc':
263 self.commit.AddCc(tag_match.group(2).split(','))
267 # Suppress duplicate signoffs
269 if (self.is_log or not self.commit or
270 self.commit.CheckDuplicateSignoff(signoff_match.group(1))):
273 # Well that means this is an ordinary line
276 # Look for ugly ASCII characters
278 # TODO: Would be nicer to report source filename and line
280 self.warn.append("Line %d/%d ('%s') has funny ascii char" %
281 (self.linenum, pos, line))
284 # Look for space before tab
285 m = re_space_before_tab.match(line)
287 self.warn.append('Line %d/%d has space before tab' %
288 (self.linenum, m.start()))
290 # OK, we have a valid non-blank line
293 self.skip_blank = False
294 if self.state == STATE_DIFFS:
297 # If this is the start of the diffs section, emit our tags and
300 self.state = STATE_DIFFS
302 # Output the tags (signeoff first), then change list
304 log = self.series.MakeChangeLog(self.commit)
307 out += self.commit.notes
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,
360 series = None, allow_overwrite=False):
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
372 allow_overwrite: Allow tags to overwrite an existing tag
374 A Series object containing information about the commits.
378 series.allow_overwrite = allow_overwrite
379 params = gitutil.LogCmd(commit_range,reverse=True, count=count,
381 stdout = command.RunPipe([params], capture=True).stdout
382 ps = PatchStream(series, is_log=True)
383 for line in stdout.splitlines():
388 def GetMetaData(start, count):
389 """Reads out patch series metadata from the commits
391 This does a 'git log' on the relevant commits and pulls out the tags we
395 start: Commit to start from: 0=HEAD, 1=next one, etc.
396 count: Number of commits to list
398 return GetMetaDataForList('HEAD~%d' % start, None, count)
400 def FixPatch(backup_dir, fname, series, commit):
401 """Fix up a patch file, by adding/removing as required.
403 We remove our tags from the patch file, insert changes lists, etc.
404 The patch file is processed in place, and overwritten.
406 A backup file is put into backup_dir (if not None).
409 fname: Filename to patch file to process
410 series: Series information about this patch set
411 commit: Commit object for this patch file
413 A list of errors, or [] if all ok.
415 handle, tmpname = tempfile.mkstemp()
416 outfd = os.fdopen(handle, 'w')
417 infd = open(fname, 'r')
418 ps = PatchStream(series)
420 ps.ProcessStream(infd, outfd)
424 # Create a backup file if required
426 shutil.copy(fname, os.path.join(backup_dir, os.path.basename(fname)))
427 shutil.move(tmpname, fname)
430 def FixPatches(series, fnames):
431 """Fix up a list of patches identified by filenames
433 The patch files are processed in place, and overwritten.
436 series: The series object
437 fnames: List of patch files to process
439 # Current workflow creates patches, so we shouldn't need a backup
440 backup_dir = None #tempfile.mkdtemp('clean-patch')
443 commit = series.commits[count]
445 result = FixPatch(backup_dir, fname, series, commit)
447 print '%d warnings for %s:' % (len(result), fname)
452 print 'Cleaned %d patches' % count
455 def InsertCoverLetter(fname, series, count):
456 """Inserts a cover letter with the required info into patch 0
459 fname: Input / output filename of the cover letter file
460 series: Series object
461 count: Number of patches in the series
463 fd = open(fname, 'r')
464 lines = fd.readlines()
467 fd = open(fname, 'w')
469 prefix = series.GetPatchPrefix()
471 if line.startswith('Subject:'):
472 # if more than 10 or 100 patches, it should say 00/xx, 000/xxx, etc
473 zero_repeat = int(math.log10(count)) + 1
474 zero = '0' * zero_repeat
475 line = 'Subject: [%s %s/%d] %s\n' % (prefix, zero, count, text[0])
477 # Insert our cover letter
478 elif line.startswith('*** BLURB HERE ***'):
479 # First the blurb test
480 line = '\n'.join(text[1:]) + '\n'
481 if series.get('notes'):
482 line += '\n'.join(series.notes) + '\n'
484 # Now the change list
485 out = series.MakeChangeLog(None)
486 line += '\n' + '\n'.join(out)