1 # Copyright (c) 2011 The Chromium OS Authors.
3 # SPDX-License-Identifier: GPL-2.0+
18 def CountCommitsToBranch():
19 """Returns number of commits between HEAD and the tracking branch.
21 This looks back to the tracking branch and works out the number of commits
25 Number of patches that exist on top of the branch
27 pipe = [['git', 'log', '--no-color', '--oneline', '--no-decorate',
30 stdout = command.RunPipe(pipe, capture=True, oneline=True).stdout
31 patch_count = int(stdout)
34 def GetUpstream(git_dir, branch):
35 """Returns the name of the upstream for a branch
38 git_dir: Git directory containing repo
39 branch: Name of branch
42 Name of upstream branch (e.g. 'upstream/master') or None if none
45 remote = command.OutputOneLine('git', '--git-dir', git_dir, 'config',
46 'branch.%s.remote' % branch)
47 merge = command.OutputOneLine('git', '--git-dir', git_dir, 'config',
48 'branch.%s.merge' % branch)
54 elif remote and merge:
55 leaf = merge.split('/')[-1]
56 return '%s/%s' % (remote, leaf)
58 raise ValueError, ("Cannot determine upstream branch for branch "
59 "'%s' remote='%s', merge='%s'" % (branch, remote, merge))
62 def GetRangeInBranch(git_dir, branch, include_upstream=False):
63 """Returns an expression for the commits in the given branch.
66 git_dir: Directory containing git repo
67 branch: Name of branch
69 Expression in the form 'upstream..branch' which can be used to
70 access the commits. If the branch does not exist, returns None.
72 upstream = GetUpstream(git_dir, branch)
75 return '%s%s..%s' % (upstream, '~' if include_upstream else '', branch)
77 def CountCommitsInBranch(git_dir, branch, include_upstream=False):
78 """Returns the number of commits in the given branch.
81 git_dir: Directory containing git repo
82 branch: Name of branch
84 Number of patches that exist on top of the branch, or None if the
85 branch does not exist.
87 range_expr = GetRangeInBranch(git_dir, branch, include_upstream)
90 pipe = [['git', '--git-dir', git_dir, 'log', '--oneline', '--no-decorate',
93 result = command.RunPipe(pipe, capture=True, oneline=True)
94 patch_count = int(result.stdout)
97 def CountCommits(commit_range):
98 """Returns the number of commits in the given range.
101 commit_range: Range of commits to count (e.g. 'HEAD..base')
103 Number of patches that exist on top of the branch
105 pipe = [['git', 'log', '--oneline', '--no-decorate', commit_range],
107 stdout = command.RunPipe(pipe, capture=True, oneline=True).stdout
108 patch_count = int(stdout)
111 def Checkout(commit_hash, git_dir=None, work_tree=None, force=False):
112 """Checkout the selected commit for this build
115 commit_hash: Commit hash to check out
119 pipe.extend(['--git-dir', git_dir])
121 pipe.extend(['--work-tree', work_tree])
122 pipe.append('checkout')
125 pipe.append(commit_hash)
126 result = command.RunPipe([pipe], capture=True, raise_on_error=False)
127 if result.return_code != 0:
128 raise OSError, 'git checkout (%s): %s' % (pipe, result.stderr)
130 def Clone(git_dir, output_dir):
131 """Checkout the selected commit for this build
134 commit_hash: Commit hash to check out
136 pipe = ['git', 'clone', git_dir, '.']
137 result = command.RunPipe([pipe], capture=True, cwd=output_dir)
138 if result.return_code != 0:
139 raise OSError, 'git clone: %s' % result.stderr
141 def Fetch(git_dir=None, work_tree=None):
142 """Fetch from the origin repo
145 commit_hash: Commit hash to check out
149 pipe.extend(['--git-dir', git_dir])
151 pipe.extend(['--work-tree', work_tree])
153 result = command.RunPipe([pipe], capture=True)
154 if result.return_code != 0:
155 raise OSError, 'git fetch: %s' % result.stderr
157 def CreatePatches(start, count, series):
158 """Create a series of patches from the top of the current branch.
160 The patch files are written to the current directory using
164 start: Commit to start from: 0=HEAD, 1=next one, etc.
165 count: number of commits to include
167 Filename of cover letter
168 List of filenames of patch files
170 if series.get('version'):
171 version = '%s ' % series['version']
172 cmd = ['git', 'format-patch', '-M', '--signoff']
173 if series.get('cover'):
174 cmd.append('--cover-letter')
175 prefix = series.GetPatchPrefix()
177 cmd += ['--subject-prefix=%s' % prefix]
178 cmd += ['HEAD~%d..HEAD~%d' % (start + count, start)]
180 stdout = command.RunList(cmd)
181 files = stdout.splitlines()
183 # We have an extra file if there is a cover letter
184 if series.get('cover'):
185 return files[0], files[1:]
189 def ApplyPatch(verbose, fname):
190 """Apply a patch with git am to test it
192 TODO: Convert these to use command, with stderr option
195 fname: filename of patch file to apply
197 col = terminal.Color()
198 cmd = ['git', 'am', fname]
199 pipe = subprocess.Popen(cmd, stdout=subprocess.PIPE,
200 stderr=subprocess.PIPE)
201 stdout, stderr = pipe.communicate()
202 re_error = re.compile('^error: patch failed: (.+):(\d+)')
203 for line in stderr.splitlines():
206 match = re_error.match(line)
208 print checkpatch.GetWarningMsg(col, 'warning', match.group(1),
209 int(match.group(2)), 'Patch failed')
210 return pipe.returncode == 0, stdout
212 def ApplyPatches(verbose, args, start_point):
213 """Apply the patches with git am to make sure all is well
216 verbose: Print out 'git am' output verbatim
217 args: List of patch files to apply
218 start_point: Number of commits back from HEAD to start applying.
219 Normally this is len(args), but it can be larger if a start
223 col = terminal.Color()
225 # Figure out our current position
226 cmd = ['git', 'name-rev', 'HEAD', '--name-only']
227 pipe = subprocess.Popen(cmd, stdout=subprocess.PIPE)
228 stdout, stderr = pipe.communicate()
230 str = 'Could not find current commit name'
231 print col.Color(col.RED, str)
234 old_head = stdout.splitlines()[0]
235 if old_head == 'undefined':
236 str = "Invalid HEAD '%s'" % stdout.strip()
237 print col.Color(col.RED, str)
240 # Checkout the required start point
241 cmd = ['git', 'checkout', 'HEAD~%d' % start_point]
242 pipe = subprocess.Popen(cmd, stdout=subprocess.PIPE,
243 stderr=subprocess.PIPE)
244 stdout, stderr = pipe.communicate()
246 str = 'Could not move to commit before patch series'
247 print col.Color(col.RED, str)
251 # Apply all the patches
253 ok, stdout = ApplyPatch(verbose, fname)
255 print col.Color(col.RED, 'git am returned errors for %s: will '
256 'skip this patch' % fname)
260 cmd = ['git', 'am', '--skip']
261 pipe = subprocess.Popen(cmd, stdout=subprocess.PIPE)
262 stdout, stderr = pipe.communicate()
263 if pipe.returncode != 0:
264 print col.Color(col.RED, 'Unable to skip patch! Aborting...')
268 # Return to our previous position
269 cmd = ['git', 'checkout', old_head]
270 pipe = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
271 stdout, stderr = pipe.communicate()
273 print col.Color(col.RED, 'Could not move back to head commit')
275 return error_count == 0
277 def BuildEmailList(in_list, tag=None, alias=None, raise_on_error=True):
278 """Build a list of email addresses based on an input list.
280 Takes a list of email addresses and aliases, and turns this into a list
281 of only email address, by resolving any aliases that are present.
283 If the tag is given, then each email address is prepended with this
284 tag and a space. If the tag starts with a minus sign (indicating a
285 command line parameter) then the email address is quoted.
288 in_list: List of aliases/email addresses
289 tag: Text to put before each address
290 alias: Alias dictionary
291 raise_on_error: True to raise an error when an alias fails to match,
292 False to just print a message.
295 List of email addresses
298 >>> alias['fred'] = ['f.bloggs@napier.co.nz']
299 >>> alias['john'] = ['j.bloggs@napier.co.nz']
300 >>> alias['mary'] = ['Mary Poppins <m.poppins@cloud.net>']
301 >>> alias['boys'] = ['fred', ' john']
302 >>> alias['all'] = ['fred ', 'john', ' mary ']
303 >>> BuildEmailList(['john', 'mary'], None, alias)
304 ['j.bloggs@napier.co.nz', 'Mary Poppins <m.poppins@cloud.net>']
305 >>> BuildEmailList(['john', 'mary'], '--to', alias)
306 ['--to "j.bloggs@napier.co.nz"', \
307 '--to "Mary Poppins <m.poppins@cloud.net>"']
308 >>> BuildEmailList(['john', 'mary'], 'Cc', alias)
309 ['Cc j.bloggs@napier.co.nz', 'Cc Mary Poppins <m.poppins@cloud.net>']
311 quote = '"' if tag and tag[0] == '-' else ''
314 raw += LookupEmail(item, alias, raise_on_error=raise_on_error)
317 if not item in result:
320 return ['%s %s%s%s' % (tag, quote, email, quote) for email in result]
323 def EmailPatches(series, cover_fname, args, dry_run, raise_on_error, cc_fname,
324 self_only=False, alias=None, in_reply_to=None):
325 """Email a patch series.
328 series: Series object containing destination info
329 cover_fname: filename of cover letter
330 args: list of filenames of patch files
331 dry_run: Just return the command that would be run
332 raise_on_error: True to raise an error when an alias fails to match,
333 False to just print a message.
334 cc_fname: Filename of Cc file for per-commit Cc
335 self_only: True to just email to yourself as a test
336 in_reply_to: If set we'll pass this to git as --in-reply-to.
337 Should be a message ID that this is in reply to.
340 Git command that was/would be run
342 # For the duration of this doctest pretend that we ran patman with ./patman
343 >>> _old_argv0 = sys.argv[0]
344 >>> sys.argv[0] = './patman'
347 >>> alias['fred'] = ['f.bloggs@napier.co.nz']
348 >>> alias['john'] = ['j.bloggs@napier.co.nz']
349 >>> alias['mary'] = ['m.poppins@cloud.net']
350 >>> alias['boys'] = ['fred', ' john']
351 >>> alias['all'] = ['fred ', 'john', ' mary ']
352 >>> alias[os.getenv('USER')] = ['this-is-me@me.com']
353 >>> series = series.Series()
354 >>> series.to = ['fred']
355 >>> series.cc = ['mary']
356 >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
358 'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
359 "m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" cover p1 p2'
360 >>> EmailPatches(series, None, ['p1'], True, True, 'cc-fname', False, \
362 'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
363 "m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" p1'
364 >>> series.cc = ['all']
365 >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
367 'git send-email --annotate --to "this-is-me@me.com" --cc-cmd "./patman \
368 --cc-cmd cc-fname" cover p1 p2'
369 >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
371 'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
372 "f.bloggs@napier.co.nz" --cc "j.bloggs@napier.co.nz" --cc \
373 "m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" cover p1 p2'
375 # Restore argv[0] since we clobbered it.
376 >>> sys.argv[0] = _old_argv0
378 to = BuildEmailList(series.get('to'), '--to', alias, raise_on_error)
380 git_config_to = command.Output('git', 'config', 'sendemail.to')
381 if not git_config_to:
382 print ("No recipient.\n"
383 "Please add something like this to a commit\n"
384 "Series-to: Fred Bloggs <f.blogs@napier.co.nz>\n"
385 "Or do something like this\n"
386 "git config sendemail.to u-boot@lists.denx.de")
388 cc = BuildEmailList(series.get('cc'), '--cc', alias, raise_on_error)
390 to = BuildEmailList([os.getenv('USER')], '--to', alias, raise_on_error)
392 cmd = ['git', 'send-email', '--annotate']
394 cmd.append('--in-reply-to="%s"' % in_reply_to)
398 cmd += ['--cc-cmd', '"%s --cc-cmd %s"' % (sys.argv[0], cc_fname)]
400 cmd.append(cover_fname)
408 def LookupEmail(lookup_name, alias=None, raise_on_error=True, level=0):
409 """If an email address is an alias, look it up and return the full name
411 TODO: Why not just use git's own alias feature?
414 lookup_name: Alias or email address to look up
415 alias: Dictionary containing aliases (None to use settings default)
416 raise_on_error: True to raise an error when an alias fails to match,
417 False to just print a message.
421 list containing a list of email addresses
424 OSError if a recursive alias reference was found
425 ValueError if an alias was not found
428 >>> alias['fred'] = ['f.bloggs@napier.co.nz']
429 >>> alias['john'] = ['j.bloggs@napier.co.nz']
430 >>> alias['mary'] = ['m.poppins@cloud.net']
431 >>> alias['boys'] = ['fred', ' john', 'f.bloggs@napier.co.nz']
432 >>> alias['all'] = ['fred ', 'john', ' mary ']
433 >>> alias['loop'] = ['other', 'john', ' mary ']
434 >>> alias['other'] = ['loop', 'john', ' mary ']
435 >>> LookupEmail('mary', alias)
436 ['m.poppins@cloud.net']
437 >>> LookupEmail('arthur.wellesley@howe.ro.uk', alias)
438 ['arthur.wellesley@howe.ro.uk']
439 >>> LookupEmail('boys', alias)
440 ['f.bloggs@napier.co.nz', 'j.bloggs@napier.co.nz']
441 >>> LookupEmail('all', alias)
442 ['f.bloggs@napier.co.nz', 'j.bloggs@napier.co.nz', 'm.poppins@cloud.net']
443 >>> LookupEmail('odd', alias)
444 Traceback (most recent call last):
446 ValueError: Alias 'odd' not found
447 >>> LookupEmail('loop', alias)
448 Traceback (most recent call last):
450 OSError: Recursive email alias at 'other'
451 >>> LookupEmail('odd', alias, raise_on_error=False)
452 \033[1;31mAlias 'odd' not found\033[0m
454 >>> # In this case the loop part will effectively be ignored.
455 >>> LookupEmail('loop', alias, raise_on_error=False)
456 \033[1;31mRecursive email alias at 'other'\033[0m
457 \033[1;31mRecursive email alias at 'john'\033[0m
458 \033[1;31mRecursive email alias at 'mary'\033[0m
459 ['j.bloggs@napier.co.nz', 'm.poppins@cloud.net']
462 alias = settings.alias
463 lookup_name = lookup_name.strip()
464 if '@' in lookup_name: # Perhaps a real email address
467 lookup_name = lookup_name.lower()
468 col = terminal.Color()
472 msg = "Recursive email alias at '%s'" % lookup_name
476 print col.Color(col.RED, msg)
480 if not lookup_name in alias:
481 msg = "Alias '%s' not found" % lookup_name
483 raise ValueError, msg
485 print col.Color(col.RED, msg)
487 for item in alias[lookup_name]:
488 todo = LookupEmail(item, alias, raise_on_error, level + 1)
489 for new_item in todo:
490 if not new_item in out_list:
491 out_list.append(new_item)
493 #print "No match for alias '%s'" % lookup_name
497 """Return name of top-level directory for this git repo.
500 Full path to git top-level directory
502 This test makes sure that we are running tests in the right subdir
504 >>> os.path.realpath(os.path.dirname(__file__)) == \
505 os.path.join(GetTopLevel(), 'tools', 'patman')
508 return command.OutputOneLine('git', 'rev-parse', '--show-toplevel')
511 """Gets the name of the git alias file.
514 Filename of git alias file, or None if none
516 fname = command.OutputOneLine('git', 'config', 'sendemail.aliasesfile',
517 raise_on_error=False)
519 fname = os.path.join(GetTopLevel(), fname.strip())
522 def GetDefaultUserName():
523 """Gets the user.name from .gitconfig file.
526 User name found in .gitconfig file, or None if none
528 uname = command.OutputOneLine('git', 'config', '--global', 'user.name')
531 def GetDefaultUserEmail():
532 """Gets the user.email from the global .gitconfig file.
535 User's email found in .gitconfig file, or None if none
537 uemail = command.OutputOneLine('git', 'config', '--global', 'user.email')
541 """Set up git utils, by reading the alias files."""
542 # Check for a git alias file also
543 alias_fname = GetAliasFile()
545 settings.ReadGitAliases(alias_fname)
548 """Get the hash of the current HEAD
553 return command.OutputOneLine('git', 'show', '-s', '--pretty=format:%H')
555 if __name__ == "__main__":