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_match = re_cover.match(line)
154 cover_cc_match = re_cover_cc.match(line)
155 signoff_match = re_signoff.match(line)
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
180 elif self.in_section == 'commit-notes':
182 self.commit.notes += self.section
184 self.warn.append("Unknown section '%s'" % self.in_section)
185 self.in_section = None
186 self.skip_blank = True
189 self.section.append(line)
191 # Detect the commit subject
192 elif not is_blank and self.state == STATE_PATCH_SUBJECT:
193 self.commit.subject = line
195 # Detect the tags we want to remove, and skip blank lines
196 elif re_remove.match(line) and not commit_tag_match:
197 self.skip_blank = True
199 # TEST= should be the last thing in the commit, so remove
200 # everything after it
201 if line.startswith('TEST='):
202 self.found_test = True
203 elif self.skip_blank and is_blank:
204 self.skip_blank = False
206 # Detect the start of a cover letter section
208 self.in_section = 'cover'
209 self.skip_blank = False
212 value = cover_cc_match.group(1)
213 self.AddToSeries(line, 'cover-cc', value)
215 # If we are in a change list, key collected lines until a blank one
218 # Blank line ends this change list
222 out = self.ProcessLine(line)
225 self.series.AddChange(self.in_change, self.commit, line)
226 self.skip_blank = False
228 # Detect Series-xxx tags
229 elif series_tag_match:
230 name = series_tag_match.group(1)
231 value = series_tag_match.group(2)
232 if name == 'changes':
233 # value is the version number: e.g. 1, or 2
236 except ValueError as str:
237 raise ValueError("%s: Cannot decode version info '%s'" %
238 (self.commit.hash, line))
239 self.in_change = int(value)
241 self.AddToSeries(line, name, value)
242 self.skip_blank = True
244 # Detect Commit-xxx tags
245 elif commit_tag_match:
246 name = commit_tag_match.group(1)
247 value = commit_tag_match.group(2)
249 self.AddToCommit(line, name, value)
250 self.skip_blank = True
252 # Detect the start of a new commit
255 self.commit = commit.Commit(commit_match.group(1))
257 # Detect tags in the commit message
259 # Remove Tested-by self, since few will take much notice
260 if (tag_match.group(1) == 'Tested-by' and
261 tag_match.group(2).find(os.getenv('USER') + '@') != -1):
262 self.warn.append("Ignoring %s" % line)
263 elif tag_match.group(1) == 'Patch-cc':
264 self.commit.AddCc(tag_match.group(2).split(','))
268 # Suppress duplicate signoffs
270 if (self.is_log or not self.commit or
271 self.commit.CheckDuplicateSignoff(signoff_match.group(1))):
274 # Well that means this is an ordinary line
277 # Look for ugly ASCII characters
279 # TODO: Would be nicer to report source filename and line
281 self.warn.append("Line %d/%d ('%s') has funny ascii char" %
282 (self.linenum, pos, line))
285 # Look for space before tab
286 m = re_space_before_tab.match(line)
288 self.warn.append('Line %d/%d has space before tab' %
289 (self.linenum, m.start()))
291 # OK, we have a valid non-blank line
294 self.skip_blank = False
295 if self.state == STATE_DIFFS:
298 # If this is the start of the diffs section, emit our tags and
301 self.state = STATE_DIFFS
303 # Output the tags (signeoff first), then change list
305 log = self.series.MakeChangeLog(self.commit)
308 out += self.commit.notes
310 elif self.found_test:
311 if not re_allowed_after_test.match(line):
312 self.lines_after_test += 1
317 """Close out processing of this patch stream"""
319 if self.lines_after_test:
320 self.warn.append('Found %d lines after TEST=' %
321 self.lines_after_test)
323 def ProcessStream(self, infd, outfd):
324 """Copy a stream from infd to outfd, filtering out unwanting things.
326 This is used to process patch files one at a time.
329 infd: Input stream file object
330 outfd: Output stream file object
332 # Extract the filename from each diff, for nice warnings
335 re_fname = re.compile('diff --git a/(.*) b/.*')
337 line = infd.readline()
340 out = self.ProcessLine(line)
342 # Try to detect blank lines at EOF
344 match = re_fname.match(line)
347 fname = match.group(1)
349 self.blank_count += 1
351 if self.blank_count and (line == '-- ' or match):
352 self.warn.append("Found possible blank line(s) at "
353 "end of file '%s'" % last_fname)
354 outfd.write('+\n' * self.blank_count)
355 outfd.write(line + '\n')
360 def GetMetaDataForList(commit_range, git_dir=None, count=None,
361 series = None, allow_overwrite=False):
362 """Reads out patch series metadata from the commits
364 This does a 'git log' on the relevant commits and pulls out the tags we
368 commit_range: Range of commits to count (e.g. 'HEAD..base')
369 git_dir: Path to git repositiory (None to use default)
370 count: Number of commits to list, or None for no limit
371 series: Series object to add information into. By default a new series
373 allow_overwrite: Allow tags to overwrite an existing tag
375 A Series object containing information about the commits.
379 series.allow_overwrite = allow_overwrite
380 params = gitutil.LogCmd(commit_range, reverse=True, count=count,
382 stdout = command.RunPipe([params], 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 # if more than 10 or 100 patches, it should say 00/xx, 000/xxx, etc
474 zero_repeat = int(math.log10(count)) + 1
475 zero = '0' * zero_repeat
476 line = 'Subject: [%s %s/%d] %s\n' % (prefix, zero, count, text[0])
478 # Insert our cover letter
479 elif line.startswith('*** BLURB HERE ***'):
480 # First the blurb test
481 line = '\n'.join(text[1:]) + '\n'
482 if series.get('notes'):
483 line += '\n'.join(series.notes) + '\n'
485 # Now the change list
486 out = series.MakeChangeLog(None)
487 line += '\n' + '\n'.join(out)