1 # SPDX-License-Identifier: GPL-2.0+
2 # Copyright (c) 2011 The Chromium OS Authors.
16 # True to use --no-decorate - we check this in Setup()
17 use_no_decorate = True
19 def LogCmd(commit_range, git_dir=None, oneline=False, reverse=False,
21 """Create a command to perform a 'git log'
24 commit_range: Range expression to use for log, None for none
25 git_dir: Path to git repositiory (None to use default)
26 oneline: True to use --oneline, else False
27 reverse: True to reverse the log (--reverse)
28 count: Number of commits to list, or None for no limit
30 List containing command and arguments to run
34 cmd += ['--git-dir', git_dir]
35 cmd += ['--no-pager', 'log', '--no-color']
37 cmd.append('--oneline')
39 cmd.append('--no-decorate')
41 cmd.append('--reverse')
43 cmd.append('-n%d' % count)
45 cmd.append(commit_range)
47 # Add this in case we have a branch with the same name as a directory.
48 # This avoids messages like this, for example:
49 # fatal: ambiguous argument 'test': both revision and filename
53 def CountCommitsToBranch():
54 """Returns number of commits between HEAD and the tracking branch.
56 This looks back to the tracking branch and works out the number of commits
60 Number of patches that exist on top of the branch
62 pipe = [LogCmd('@{upstream}..', oneline=True),
64 stdout = command.RunPipe(pipe, capture=True, oneline=True).stdout
65 patch_count = int(stdout)
68 def NameRevision(commit_hash):
69 """Gets the revision name for a commit
72 commit_hash: Commit hash to look up
75 Name of revision, if any, else None
77 pipe = ['git', 'name-rev', commit_hash]
78 stdout = command.RunPipe([pipe], capture=True, oneline=True).stdout
80 # We expect a commit, a space, then a revision name
81 name = stdout.split(' ')[1].strip()
84 def GuessUpstream(git_dir, branch):
85 """Tries to guess the upstream for a branch
87 This lists out top commits on a branch and tries to find a suitable
88 upstream. It does this by looking for the first commit where
89 'git name-rev' returns a plain branch name, with no ! or ^ modifiers.
92 git_dir: Git directory containing repo
93 branch: Name of branch
97 Name of upstream branch (e.g. 'upstream/master') or None if none
98 Warning/error message, or None if none
100 pipe = [LogCmd(branch, git_dir=git_dir, oneline=True, count=100)]
101 result = command.RunPipe(pipe, capture=True, capture_stderr=True,
102 raise_on_error=False)
103 if result.return_code:
104 return None, "Branch '%s' not found" % branch
105 for line in result.stdout.splitlines()[1:]:
106 commit_hash = line.split(' ')[0]
107 name = NameRevision(commit_hash)
108 if '~' not in name and '^' not in name:
109 if name.startswith('remotes/'):
111 return name, "Guessing upstream as '%s'" % name
112 return None, "Cannot find a suitable upstream for branch '%s'" % branch
114 def GetUpstream(git_dir, branch):
115 """Returns the name of the upstream for a branch
118 git_dir: Git directory containing repo
119 branch: Name of branch
123 Name of upstream branch (e.g. 'upstream/master') or None if none
124 Warning/error message, or None if none
127 remote = command.OutputOneLine('git', '--git-dir', git_dir, 'config',
128 'branch.%s.remote' % branch)
129 merge = command.OutputOneLine('git', '--git-dir', git_dir, 'config',
130 'branch.%s.merge' % branch)
132 upstream, msg = GuessUpstream(git_dir, branch)
137 elif remote and merge:
138 leaf = merge.split('/')[-1]
139 return '%s/%s' % (remote, leaf), None
141 raise ValueError("Cannot determine upstream branch for branch "
142 "'%s' remote='%s', merge='%s'" % (branch, remote, merge))
145 def GetRangeInBranch(git_dir, branch, include_upstream=False):
146 """Returns an expression for the commits in the given branch.
149 git_dir: Directory containing git repo
150 branch: Name of branch
152 Expression in the form 'upstream..branch' which can be used to
153 access the commits. If the branch does not exist, returns None.
155 upstream, msg = GetUpstream(git_dir, branch)
158 rstr = '%s%s..%s' % (upstream, '~' if include_upstream else '', branch)
161 def CountCommitsInRange(git_dir, range_expr):
162 """Returns the number of commits in the given range.
165 git_dir: Directory containing git repo
166 range_expr: Range to check
168 Number of patches that exist in the supplied rangem or None if none
171 pipe = [LogCmd(range_expr, git_dir=git_dir, oneline=True)]
172 result = command.RunPipe(pipe, capture=True, capture_stderr=True,
173 raise_on_error=False)
174 if result.return_code:
175 return None, "Range '%s' not found or is invalid" % range_expr
176 patch_count = len(result.stdout.splitlines())
177 return patch_count, None
179 def CountCommitsInBranch(git_dir, branch, include_upstream=False):
180 """Returns the number of commits in the given branch.
183 git_dir: Directory containing git repo
184 branch: Name of branch
186 Number of patches that exist on top of the branch, or None if the
187 branch does not exist.
189 range_expr, msg = GetRangeInBranch(git_dir, branch, include_upstream)
192 return CountCommitsInRange(git_dir, range_expr)
194 def CountCommits(commit_range):
195 """Returns the number of commits in the given range.
198 commit_range: Range of commits to count (e.g. 'HEAD..base')
200 Number of patches that exist on top of the branch
202 pipe = [LogCmd(commit_range, oneline=True),
204 stdout = command.RunPipe(pipe, capture=True, oneline=True).stdout
205 patch_count = int(stdout)
208 def Checkout(commit_hash, git_dir=None, work_tree=None, force=False):
209 """Checkout the selected commit for this build
212 commit_hash: Commit hash to check out
216 pipe.extend(['--git-dir', git_dir])
218 pipe.extend(['--work-tree', work_tree])
219 pipe.append('checkout')
222 pipe.append(commit_hash)
223 result = command.RunPipe([pipe], capture=True, raise_on_error=False,
225 if result.return_code != 0:
226 raise OSError('git checkout (%s): %s' % (pipe, result.stderr))
228 def Clone(git_dir, output_dir):
229 """Checkout the selected commit for this build
232 commit_hash: Commit hash to check out
234 pipe = ['git', 'clone', git_dir, '.']
235 result = command.RunPipe([pipe], capture=True, cwd=output_dir,
237 if result.return_code != 0:
238 raise OSError('git clone: %s' % result.stderr)
240 def Fetch(git_dir=None, work_tree=None):
241 """Fetch from the origin repo
244 commit_hash: Commit hash to check out
248 pipe.extend(['--git-dir', git_dir])
250 pipe.extend(['--work-tree', work_tree])
252 result = command.RunPipe([pipe], capture=True, capture_stderr=True)
253 if result.return_code != 0:
254 raise OSError('git fetch: %s' % result.stderr)
256 def CreatePatches(start, count, series):
257 """Create a series of patches from the top of the current branch.
259 The patch files are written to the current directory using
263 start: Commit to start from: 0=HEAD, 1=next one, etc.
264 count: number of commits to include
266 Filename of cover letter
267 List of filenames of patch files
269 if series.get('version'):
270 version = '%s ' % series['version']
271 cmd = ['git', 'format-patch', '-M', '--signoff']
272 if series.get('cover'):
273 cmd.append('--cover-letter')
274 prefix = series.GetPatchPrefix()
276 cmd += ['--subject-prefix=%s' % prefix]
277 cmd += ['HEAD~%d..HEAD~%d' % (start + count, start)]
279 stdout = command.RunList(cmd)
280 files = stdout.splitlines()
282 # We have an extra file if there is a cover letter
283 if series.get('cover'):
284 return files[0], files[1:]
288 def BuildEmailList(in_list, tag=None, alias=None, raise_on_error=True):
289 """Build a list of email addresses based on an input list.
291 Takes a list of email addresses and aliases, and turns this into a list
292 of only email address, by resolving any aliases that are present.
294 If the tag is given, then each email address is prepended with this
295 tag and a space. If the tag starts with a minus sign (indicating a
296 command line parameter) then the email address is quoted.
299 in_list: List of aliases/email addresses
300 tag: Text to put before each address
301 alias: Alias dictionary
302 raise_on_error: True to raise an error when an alias fails to match,
303 False to just print a message.
306 List of email addresses
309 >>> alias['fred'] = ['f.bloggs@napier.co.nz']
310 >>> alias['john'] = ['j.bloggs@napier.co.nz']
311 >>> alias['mary'] = ['Mary Poppins <m.poppins@cloud.net>']
312 >>> alias['boys'] = ['fred', ' john']
313 >>> alias['all'] = ['fred ', 'john', ' mary ']
314 >>> BuildEmailList(['john', 'mary'], None, alias)
315 ['j.bloggs@napier.co.nz', 'Mary Poppins <m.poppins@cloud.net>']
316 >>> BuildEmailList(['john', 'mary'], '--to', alias)
317 ['--to "j.bloggs@napier.co.nz"', \
318 '--to "Mary Poppins <m.poppins@cloud.net>"']
319 >>> BuildEmailList(['john', 'mary'], 'Cc', alias)
320 ['Cc j.bloggs@napier.co.nz', 'Cc Mary Poppins <m.poppins@cloud.net>']
322 quote = '"' if tag and tag[0] == '-' else ''
325 raw += LookupEmail(item, alias, raise_on_error=raise_on_error)
328 if not item in result:
331 return ['%s %s%s%s' % (tag, quote, email, quote) for email in result]
334 def EmailPatches(series, cover_fname, args, dry_run, raise_on_error, cc_fname,
335 self_only=False, alias=None, in_reply_to=None, thread=False):
336 """Email a patch series.
339 series: Series object containing destination info
340 cover_fname: filename of cover letter
341 args: list of filenames of patch files
342 dry_run: Just return the command that would be run
343 raise_on_error: True to raise an error when an alias fails to match,
344 False to just print a message.
345 cc_fname: Filename of Cc file for per-commit Cc
346 self_only: True to just email to yourself as a test
347 in_reply_to: If set we'll pass this to git as --in-reply-to.
348 Should be a message ID that this is in reply to.
349 thread: True to add --thread to git send-email (make
350 all patches reply to cover-letter or first patch in series)
353 Git command that was/would be run
355 # For the duration of this doctest pretend that we ran patman with ./patman
356 >>> _old_argv0 = sys.argv[0]
357 >>> sys.argv[0] = './patman'
360 >>> alias['fred'] = ['f.bloggs@napier.co.nz']
361 >>> alias['john'] = ['j.bloggs@napier.co.nz']
362 >>> alias['mary'] = ['m.poppins@cloud.net']
363 >>> alias['boys'] = ['fred', ' john']
364 >>> alias['all'] = ['fred ', 'john', ' mary ']
365 >>> alias[os.getenv('USER')] = ['this-is-me@me.com']
366 >>> series = series.Series()
367 >>> series.to = ['fred']
368 >>> series.cc = ['mary']
369 >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
371 'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
372 "m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" cover p1 p2'
373 >>> EmailPatches(series, None, ['p1'], True, True, 'cc-fname', False, \
375 'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
376 "m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" p1'
377 >>> series.cc = ['all']
378 >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
380 'git send-email --annotate --to "this-is-me@me.com" --cc-cmd "./patman \
381 --cc-cmd cc-fname" cover p1 p2'
382 >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
384 'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
385 "f.bloggs@napier.co.nz" --cc "j.bloggs@napier.co.nz" --cc \
386 "m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" cover p1 p2'
388 # Restore argv[0] since we clobbered it.
389 >>> sys.argv[0] = _old_argv0
391 to = BuildEmailList(series.get('to'), '--to', alias, raise_on_error)
393 git_config_to = command.Output('git', 'config', 'sendemail.to',
394 raise_on_error=False)
395 if not git_config_to:
396 print ("No recipient.\n"
397 "Please add something like this to a commit\n"
398 "Series-to: Fred Bloggs <f.blogs@napier.co.nz>\n"
399 "Or do something like this\n"
400 "git config sendemail.to u-boot@lists.denx.de")
402 cc = BuildEmailList(list(set(series.get('cc')) - set(series.get('to'))),
403 '--cc', alias, raise_on_error)
405 to = BuildEmailList([os.getenv('USER')], '--to', alias, raise_on_error)
407 cmd = ['git', 'send-email', '--annotate']
409 if type(in_reply_to) != str:
410 in_reply_to = in_reply_to.encode('utf-8')
411 cmd.append('--in-reply-to="%s"' % in_reply_to)
413 cmd.append('--thread')
417 cmd += ['--cc-cmd', '"%s --cc-cmd %s"' % (sys.argv[0], cc_fname)]
419 cmd.append(cover_fname)
421 cmdstr = ' '.join(cmd)
427 def LookupEmail(lookup_name, alias=None, raise_on_error=True, level=0):
428 """If an email address is an alias, look it up and return the full name
430 TODO: Why not just use git's own alias feature?
433 lookup_name: Alias or email address to look up
434 alias: Dictionary containing aliases (None to use settings default)
435 raise_on_error: True to raise an error when an alias fails to match,
436 False to just print a message.
440 list containing a list of email addresses
443 OSError if a recursive alias reference was found
444 ValueError if an alias was not found
447 >>> alias['fred'] = ['f.bloggs@napier.co.nz']
448 >>> alias['john'] = ['j.bloggs@napier.co.nz']
449 >>> alias['mary'] = ['m.poppins@cloud.net']
450 >>> alias['boys'] = ['fred', ' john', 'f.bloggs@napier.co.nz']
451 >>> alias['all'] = ['fred ', 'john', ' mary ']
452 >>> alias['loop'] = ['other', 'john', ' mary ']
453 >>> alias['other'] = ['loop', 'john', ' mary ']
454 >>> LookupEmail('mary', alias)
455 ['m.poppins@cloud.net']
456 >>> LookupEmail('arthur.wellesley@howe.ro.uk', alias)
457 ['arthur.wellesley@howe.ro.uk']
458 >>> LookupEmail('boys', alias)
459 ['f.bloggs@napier.co.nz', 'j.bloggs@napier.co.nz']
460 >>> LookupEmail('all', alias)
461 ['f.bloggs@napier.co.nz', 'j.bloggs@napier.co.nz', 'm.poppins@cloud.net']
462 >>> LookupEmail('odd', alias)
463 Traceback (most recent call last):
465 ValueError: Alias 'odd' not found
466 >>> LookupEmail('loop', alias)
467 Traceback (most recent call last):
469 OSError: Recursive email alias at 'other'
470 >>> LookupEmail('odd', alias, raise_on_error=False)
471 Alias 'odd' not found
473 >>> # In this case the loop part will effectively be ignored.
474 >>> LookupEmail('loop', alias, raise_on_error=False)
475 Recursive email alias at 'other'
476 Recursive email alias at 'john'
477 Recursive email alias at 'mary'
478 ['j.bloggs@napier.co.nz', 'm.poppins@cloud.net']
481 alias = settings.alias
482 lookup_name = lookup_name.strip()
483 if '@' in lookup_name: # Perhaps a real email address
486 lookup_name = lookup_name.lower()
487 col = terminal.Color()
491 msg = "Recursive email alias at '%s'" % lookup_name
495 print(col.Color(col.RED, msg))
499 if not lookup_name in alias:
500 msg = "Alias '%s' not found" % lookup_name
502 raise ValueError(msg)
504 print(col.Color(col.RED, msg))
506 for item in alias[lookup_name]:
507 todo = LookupEmail(item, alias, raise_on_error, level + 1)
508 for new_item in todo:
509 if not new_item in out_list:
510 out_list.append(new_item)
512 #print("No match for alias '%s'" % lookup_name)
516 """Return name of top-level directory for this git repo.
519 Full path to git top-level directory
521 This test makes sure that we are running tests in the right subdir
523 >>> os.path.realpath(os.path.dirname(__file__)) == \
524 os.path.join(GetTopLevel(), 'tools', 'patman')
527 return command.OutputOneLine('git', 'rev-parse', '--show-toplevel')
530 """Gets the name of the git alias file.
533 Filename of git alias file, or None if none
535 fname = command.OutputOneLine('git', 'config', 'sendemail.aliasesfile',
536 raise_on_error=False)
538 fname = os.path.join(GetTopLevel(), fname.strip())
541 def GetDefaultUserName():
542 """Gets the user.name from .gitconfig file.
545 User name found in .gitconfig file, or None if none
547 uname = command.OutputOneLine('git', 'config', '--global', 'user.name')
550 def GetDefaultUserEmail():
551 """Gets the user.email from the global .gitconfig file.
554 User's email found in .gitconfig file, or None if none
556 uemail = command.OutputOneLine('git', 'config', '--global', 'user.email')
559 def GetDefaultSubjectPrefix():
560 """Gets the format.subjectprefix from local .git/config file.
563 Subject prefix found in local .git/config file, or None if none
565 sub_prefix = command.OutputOneLine('git', 'config', 'format.subjectprefix',
566 raise_on_error=False)
571 """Set up git utils, by reading the alias files."""
572 # Check for a git alias file also
573 global use_no_decorate
575 alias_fname = GetAliasFile()
577 settings.ReadGitAliases(alias_fname)
578 cmd = LogCmd(None, count=0)
579 use_no_decorate = (command.RunPipe([cmd], raise_on_error=False)
583 """Get the hash of the current HEAD
588 return command.OutputOneLine('git', 'show', '-s', '--pretty=format:%H')
590 if __name__ == "__main__":