blob: 08be9377cebaf012eb059b28e091b75f1edcf5aa [file] [log] [blame]
Simon Glass0d24de92012-01-14 15:12:45 +00001# Copyright (c) 2011 The Chromium OS Authors.
2#
Wolfgang Denk1a459662013-07-08 09:37:19 +02003# SPDX-License-Identifier: GPL-2.0+
Simon Glass0d24de92012-01-14 15:12:45 +00004#
5
6import command
7import re
8import os
9import series
Simon Glass0d24de92012-01-14 15:12:45 +000010import subprocess
11import sys
12import terminal
13
Simon Glass757f64a2014-04-20 10:50:13 -060014import checkpatch
Simon Glass5f6a1c42012-12-15 10:42:07 +000015import settings
16
Simon Glasse49f14a2014-08-09 15:33:11 -060017# True to use --no-decorate - we check this in Setup()
18use_no_decorate = True
19
Simon Glasscda2a612014-08-09 15:33:10 -060020def LogCmd(commit_range, git_dir=None, oneline=False, reverse=False,
21 count=None):
22 """Create a command to perform a 'git log'
23
24 Args:
25 commit_range: Range expression to use for log, None for none
26 git_dir: Path to git repositiory (None to use default)
27 oneline: True to use --oneline, else False
28 reverse: True to reverse the log (--reverse)
29 count: Number of commits to list, or None for no limit
30 Return:
31 List containing command and arguments to run
32 """
33 cmd = ['git']
34 if git_dir:
35 cmd += ['--git-dir', git_dir]
Simon Glass9447a6b2014-08-28 09:43:37 -060036 cmd += ['--no-pager', 'log', '--no-color']
Simon Glasscda2a612014-08-09 15:33:10 -060037 if oneline:
38 cmd.append('--oneline')
Simon Glasse49f14a2014-08-09 15:33:11 -060039 if use_no_decorate:
40 cmd.append('--no-decorate')
Simon Glass042a7322014-08-14 21:59:11 -060041 if reverse:
42 cmd.append('--reverse')
Simon Glasscda2a612014-08-09 15:33:10 -060043 if count is not None:
44 cmd.append('-n%d' % count)
45 if commit_range:
46 cmd.append(commit_range)
Simon Glassd4c85722016-03-12 18:50:31 -070047
48 # Add this in case we have a branch with the same name as a directory.
49 # This avoids messages like this, for example:
50 # fatal: ambiguous argument 'test': both revision and filename
51 cmd.append('--')
Simon Glasscda2a612014-08-09 15:33:10 -060052 return cmd
Simon Glass0d24de92012-01-14 15:12:45 +000053
54def CountCommitsToBranch():
55 """Returns number of commits between HEAD and the tracking branch.
56
57 This looks back to the tracking branch and works out the number of commits
58 since then.
59
60 Return:
61 Number of patches that exist on top of the branch
62 """
Simon Glasscda2a612014-08-09 15:33:10 -060063 pipe = [LogCmd('@{upstream}..', oneline=True),
Simon Glass0d24de92012-01-14 15:12:45 +000064 ['wc', '-l']]
Simon Glassa10fd932012-12-15 10:42:04 +000065 stdout = command.RunPipe(pipe, capture=True, oneline=True).stdout
Simon Glass0d24de92012-01-14 15:12:45 +000066 patch_count = int(stdout)
67 return patch_count
68
Simon Glass2a9e2c62014-12-01 17:33:54 -070069def NameRevision(commit_hash):
70 """Gets the revision name for a commit
71
72 Args:
73 commit_hash: Commit hash to look up
74
75 Return:
76 Name of revision, if any, else None
77 """
78 pipe = ['git', 'name-rev', commit_hash]
79 stdout = command.RunPipe([pipe], capture=True, oneline=True).stdout
80
81 # We expect a commit, a space, then a revision name
82 name = stdout.split(' ')[1].strip()
83 return name
84
85def GuessUpstream(git_dir, branch):
86 """Tries to guess the upstream for a branch
87
88 This lists out top commits on a branch and tries to find a suitable
89 upstream. It does this by looking for the first commit where
90 'git name-rev' returns a plain branch name, with no ! or ^ modifiers.
91
92 Args:
93 git_dir: Git directory containing repo
94 branch: Name of branch
95
96 Returns:
97 Tuple:
98 Name of upstream branch (e.g. 'upstream/master') or None if none
99 Warning/error message, or None if none
100 """
101 pipe = [LogCmd(branch, git_dir=git_dir, oneline=True, count=100)]
102 result = command.RunPipe(pipe, capture=True, capture_stderr=True,
103 raise_on_error=False)
104 if result.return_code:
105 return None, "Branch '%s' not found" % branch
106 for line in result.stdout.splitlines()[1:]:
107 commit_hash = line.split(' ')[0]
108 name = NameRevision(commit_hash)
109 if '~' not in name and '^' not in name:
110 if name.startswith('remotes/'):
111 name = name[8:]
112 return name, "Guessing upstream as '%s'" % name
113 return None, "Cannot find a suitable upstream for branch '%s'" % branch
114
Simon Glass5f6a1c42012-12-15 10:42:07 +0000115def GetUpstream(git_dir, branch):
116 """Returns the name of the upstream for a branch
117
118 Args:
119 git_dir: Git directory containing repo
120 branch: Name of branch
121
122 Returns:
Simon Glass2a9e2c62014-12-01 17:33:54 -0700123 Tuple:
124 Name of upstream branch (e.g. 'upstream/master') or None if none
125 Warning/error message, or None if none
Simon Glass5f6a1c42012-12-15 10:42:07 +0000126 """
Simon Glasscce717a2013-05-08 08:06:08 +0000127 try:
128 remote = command.OutputOneLine('git', '--git-dir', git_dir, 'config',
129 'branch.%s.remote' % branch)
130 merge = command.OutputOneLine('git', '--git-dir', git_dir, 'config',
131 'branch.%s.merge' % branch)
132 except:
Simon Glass2a9e2c62014-12-01 17:33:54 -0700133 upstream, msg = GuessUpstream(git_dir, branch)
134 return upstream, msg
Simon Glasscce717a2013-05-08 08:06:08 +0000135
Simon Glass5f6a1c42012-12-15 10:42:07 +0000136 if remote == '.':
Simon Glass71edbe52015-01-29 11:35:16 -0700137 return merge, None
Simon Glass5f6a1c42012-12-15 10:42:07 +0000138 elif remote and merge:
139 leaf = merge.split('/')[-1]
Simon Glass2a9e2c62014-12-01 17:33:54 -0700140 return '%s/%s' % (remote, leaf), None
Simon Glass5f6a1c42012-12-15 10:42:07 +0000141 else:
Paul Burtonac3fde92016-09-27 16:03:51 +0100142 raise ValueError("Cannot determine upstream branch for branch "
Simon Glass5f6a1c42012-12-15 10:42:07 +0000143 "'%s' remote='%s', merge='%s'" % (branch, remote, merge))
144
145
146def GetRangeInBranch(git_dir, branch, include_upstream=False):
147 """Returns an expression for the commits in the given branch.
148
149 Args:
150 git_dir: Directory containing git repo
151 branch: Name of branch
152 Return:
153 Expression in the form 'upstream..branch' which can be used to
Simon Glasscce717a2013-05-08 08:06:08 +0000154 access the commits. If the branch does not exist, returns None.
Simon Glass5f6a1c42012-12-15 10:42:07 +0000155 """
Simon Glass2a9e2c62014-12-01 17:33:54 -0700156 upstream, msg = GetUpstream(git_dir, branch)
Simon Glasscce717a2013-05-08 08:06:08 +0000157 if not upstream:
Simon Glass2a9e2c62014-12-01 17:33:54 -0700158 return None, msg
159 rstr = '%s%s..%s' % (upstream, '~' if include_upstream else '', branch)
160 return rstr, msg
Simon Glass5f6a1c42012-12-15 10:42:07 +0000161
Simon Glass5abab202014-12-01 17:33:57 -0700162def CountCommitsInRange(git_dir, range_expr):
163 """Returns the number of commits in the given range.
164
165 Args:
166 git_dir: Directory containing git repo
167 range_expr: Range to check
168 Return:
169 Number of patches that exist in the supplied rangem or None if none
170 were found
171 """
172 pipe = [LogCmd(range_expr, git_dir=git_dir, oneline=True)]
173 result = command.RunPipe(pipe, capture=True, capture_stderr=True,
174 raise_on_error=False)
175 if result.return_code:
176 return None, "Range '%s' not found or is invalid" % range_expr
177 patch_count = len(result.stdout.splitlines())
178 return patch_count, None
179
Simon Glass5f6a1c42012-12-15 10:42:07 +0000180def CountCommitsInBranch(git_dir, branch, include_upstream=False):
181 """Returns the number of commits in the given branch.
182
183 Args:
184 git_dir: Directory containing git repo
185 branch: Name of branch
186 Return:
Simon Glasscce717a2013-05-08 08:06:08 +0000187 Number of patches that exist on top of the branch, or None if the
188 branch does not exist.
Simon Glass5f6a1c42012-12-15 10:42:07 +0000189 """
Simon Glass2a9e2c62014-12-01 17:33:54 -0700190 range_expr, msg = GetRangeInBranch(git_dir, branch, include_upstream)
Simon Glasscce717a2013-05-08 08:06:08 +0000191 if not range_expr:
Simon Glass2a9e2c62014-12-01 17:33:54 -0700192 return None, msg
Simon Glass5abab202014-12-01 17:33:57 -0700193 return CountCommitsInRange(git_dir, range_expr)
Simon Glass5f6a1c42012-12-15 10:42:07 +0000194
195def CountCommits(commit_range):
196 """Returns the number of commits in the given range.
197
198 Args:
199 commit_range: Range of commits to count (e.g. 'HEAD..base')
200 Return:
201 Number of patches that exist on top of the branch
202 """
Simon Glasscda2a612014-08-09 15:33:10 -0600203 pipe = [LogCmd(commit_range, oneline=True),
Simon Glass5f6a1c42012-12-15 10:42:07 +0000204 ['wc', '-l']]
205 stdout = command.RunPipe(pipe, capture=True, oneline=True).stdout
206 patch_count = int(stdout)
207 return patch_count
208
209def Checkout(commit_hash, git_dir=None, work_tree=None, force=False):
210 """Checkout the selected commit for this build
211
212 Args:
213 commit_hash: Commit hash to check out
214 """
215 pipe = ['git']
216 if git_dir:
217 pipe.extend(['--git-dir', git_dir])
218 if work_tree:
219 pipe.extend(['--work-tree', work_tree])
220 pipe.append('checkout')
221 if force:
222 pipe.append('-f')
223 pipe.append(commit_hash)
Simon Glassddaf5c82014-09-05 19:00:09 -0600224 result = command.RunPipe([pipe], capture=True, raise_on_error=False,
225 capture_stderr=True)
Simon Glass5f6a1c42012-12-15 10:42:07 +0000226 if result.return_code != 0:
Paul Burtonac3fde92016-09-27 16:03:51 +0100227 raise OSError('git checkout (%s): %s' % (pipe, result.stderr))
Simon Glass5f6a1c42012-12-15 10:42:07 +0000228
229def Clone(git_dir, output_dir):
230 """Checkout the selected commit for this build
231
232 Args:
233 commit_hash: Commit hash to check out
234 """
235 pipe = ['git', 'clone', git_dir, '.']
Simon Glassddaf5c82014-09-05 19:00:09 -0600236 result = command.RunPipe([pipe], capture=True, cwd=output_dir,
237 capture_stderr=True)
Simon Glass5f6a1c42012-12-15 10:42:07 +0000238 if result.return_code != 0:
Paul Burtonac3fde92016-09-27 16:03:51 +0100239 raise OSError('git clone: %s' % result.stderr)
Simon Glass5f6a1c42012-12-15 10:42:07 +0000240
241def Fetch(git_dir=None, work_tree=None):
242 """Fetch from the origin repo
243
244 Args:
245 commit_hash: Commit hash to check out
246 """
247 pipe = ['git']
248 if git_dir:
249 pipe.extend(['--git-dir', git_dir])
250 if work_tree:
251 pipe.extend(['--work-tree', work_tree])
252 pipe.append('fetch')
Simon Glassddaf5c82014-09-05 19:00:09 -0600253 result = command.RunPipe([pipe], capture=True, capture_stderr=True)
Simon Glass5f6a1c42012-12-15 10:42:07 +0000254 if result.return_code != 0:
Paul Burtonac3fde92016-09-27 16:03:51 +0100255 raise OSError('git fetch: %s' % result.stderr)
Simon Glass5f6a1c42012-12-15 10:42:07 +0000256
Simon Glass0d24de92012-01-14 15:12:45 +0000257def CreatePatches(start, count, series):
258 """Create a series of patches from the top of the current branch.
259
260 The patch files are written to the current directory using
261 git format-patch.
262
263 Args:
264 start: Commit to start from: 0=HEAD, 1=next one, etc.
265 count: number of commits to include
266 Return:
267 Filename of cover letter
268 List of filenames of patch files
269 """
270 if series.get('version'):
271 version = '%s ' % series['version']
Masahiro Yamada8d3595a2015-08-31 01:23:32 +0900272 cmd = ['git', 'format-patch', '-M', '--signoff']
Simon Glass0d24de92012-01-14 15:12:45 +0000273 if series.get('cover'):
274 cmd.append('--cover-letter')
275 prefix = series.GetPatchPrefix()
276 if prefix:
277 cmd += ['--subject-prefix=%s' % prefix]
278 cmd += ['HEAD~%d..HEAD~%d' % (start + count, start)]
279
280 stdout = command.RunList(cmd)
281 files = stdout.splitlines()
282
283 # We have an extra file if there is a cover letter
284 if series.get('cover'):
285 return files[0], files[1:]
286 else:
287 return None, files
288
Simon Glassa1318f72013-03-26 13:09:42 +0000289def BuildEmailList(in_list, tag=None, alias=None, raise_on_error=True):
Simon Glass0d24de92012-01-14 15:12:45 +0000290 """Build a list of email addresses based on an input list.
291
292 Takes a list of email addresses and aliases, and turns this into a list
293 of only email address, by resolving any aliases that are present.
294
295 If the tag is given, then each email address is prepended with this
296 tag and a space. If the tag starts with a minus sign (indicating a
297 command line parameter) then the email address is quoted.
298
299 Args:
300 in_list: List of aliases/email addresses
301 tag: Text to put before each address
Simon Glassa1318f72013-03-26 13:09:42 +0000302 alias: Alias dictionary
303 raise_on_error: True to raise an error when an alias fails to match,
304 False to just print a message.
Simon Glass0d24de92012-01-14 15:12:45 +0000305
306 Returns:
307 List of email addresses
308
309 >>> alias = {}
310 >>> alias['fred'] = ['f.bloggs@napier.co.nz']
311 >>> alias['john'] = ['j.bloggs@napier.co.nz']
312 >>> alias['mary'] = ['Mary Poppins <m.poppins@cloud.net>']
313 >>> alias['boys'] = ['fred', ' john']
314 >>> alias['all'] = ['fred ', 'john', ' mary ']
315 >>> BuildEmailList(['john', 'mary'], None, alias)
316 ['j.bloggs@napier.co.nz', 'Mary Poppins <m.poppins@cloud.net>']
317 >>> BuildEmailList(['john', 'mary'], '--to', alias)
318 ['--to "j.bloggs@napier.co.nz"', \
319'--to "Mary Poppins <m.poppins@cloud.net>"']
320 >>> BuildEmailList(['john', 'mary'], 'Cc', alias)
321 ['Cc j.bloggs@napier.co.nz', 'Cc Mary Poppins <m.poppins@cloud.net>']
322 """
323 quote = '"' if tag and tag[0] == '-' else ''
324 raw = []
325 for item in in_list:
Simon Glassa1318f72013-03-26 13:09:42 +0000326 raw += LookupEmail(item, alias, raise_on_error=raise_on_error)
Simon Glass0d24de92012-01-14 15:12:45 +0000327 result = []
328 for item in raw:
329 if not item in result:
330 result.append(item)
331 if tag:
332 return ['%s %s%s%s' % (tag, quote, email, quote) for email in result]
333 return result
334
Simon Glassa1318f72013-03-26 13:09:42 +0000335def EmailPatches(series, cover_fname, args, dry_run, raise_on_error, cc_fname,
Mateusz Kulikowski27067a42016-01-14 20:37:41 +0100336 self_only=False, alias=None, in_reply_to=None, thread=False):
Simon Glass0d24de92012-01-14 15:12:45 +0000337 """Email a patch series.
338
339 Args:
340 series: Series object containing destination info
341 cover_fname: filename of cover letter
342 args: list of filenames of patch files
343 dry_run: Just return the command that would be run
Simon Glassa1318f72013-03-26 13:09:42 +0000344 raise_on_error: True to raise an error when an alias fails to match,
345 False to just print a message.
Simon Glass0d24de92012-01-14 15:12:45 +0000346 cc_fname: Filename of Cc file for per-commit Cc
347 self_only: True to just email to yourself as a test
Doug Anderson6d819922013-03-17 10:31:04 +0000348 in_reply_to: If set we'll pass this to git as --in-reply-to.
349 Should be a message ID that this is in reply to.
Mateusz Kulikowski27067a42016-01-14 20:37:41 +0100350 thread: True to add --thread to git send-email (make
351 all patches reply to cover-letter or first patch in series)
Simon Glass0d24de92012-01-14 15:12:45 +0000352
353 Returns:
354 Git command that was/would be run
355
Doug Andersona9700482012-11-26 15:21:40 +0000356 # For the duration of this doctest pretend that we ran patman with ./patman
357 >>> _old_argv0 = sys.argv[0]
358 >>> sys.argv[0] = './patman'
359
Simon Glass0d24de92012-01-14 15:12:45 +0000360 >>> alias = {}
361 >>> alias['fred'] = ['f.bloggs@napier.co.nz']
362 >>> alias['john'] = ['j.bloggs@napier.co.nz']
363 >>> alias['mary'] = ['m.poppins@cloud.net']
364 >>> alias['boys'] = ['fred', ' john']
365 >>> alias['all'] = ['fred ', 'john', ' mary ']
366 >>> alias[os.getenv('USER')] = ['this-is-me@me.com']
367 >>> series = series.Series()
368 >>> series.to = ['fred']
369 >>> series.cc = ['mary']
Simon Glassa1318f72013-03-26 13:09:42 +0000370 >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
371 False, alias)
Simon Glass0d24de92012-01-14 15:12:45 +0000372 'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
373"m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" cover p1 p2'
Simon Glassa1318f72013-03-26 13:09:42 +0000374 >>> EmailPatches(series, None, ['p1'], True, True, 'cc-fname', False, \
375 alias)
Simon Glass0d24de92012-01-14 15:12:45 +0000376 'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
377"m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" p1'
378 >>> series.cc = ['all']
Simon Glassa1318f72013-03-26 13:09:42 +0000379 >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
380 True, alias)
Simon Glass0d24de92012-01-14 15:12:45 +0000381 'git send-email --annotate --to "this-is-me@me.com" --cc-cmd "./patman \
382--cc-cmd cc-fname" cover p1 p2'
Simon Glassa1318f72013-03-26 13:09:42 +0000383 >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
384 False, alias)
Simon Glass0d24de92012-01-14 15:12:45 +0000385 'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
386"f.bloggs@napier.co.nz" --cc "j.bloggs@napier.co.nz" --cc \
387"m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" cover p1 p2'
Doug Andersona9700482012-11-26 15:21:40 +0000388
389 # Restore argv[0] since we clobbered it.
390 >>> sys.argv[0] = _old_argv0
Simon Glass0d24de92012-01-14 15:12:45 +0000391 """
Simon Glassa1318f72013-03-26 13:09:42 +0000392 to = BuildEmailList(series.get('to'), '--to', alias, raise_on_error)
Simon Glass0d24de92012-01-14 15:12:45 +0000393 if not to:
Simon Glass785f1542016-07-25 18:59:00 -0600394 git_config_to = command.Output('git', 'config', 'sendemail.to',
395 raise_on_error=False)
Masahiro Yamadaee860c62014-07-18 14:23:20 +0900396 if not git_config_to:
397 print ("No recipient.\n"
398 "Please add something like this to a commit\n"
399 "Series-to: Fred Bloggs <f.blogs@napier.co.nz>\n"
400 "Or do something like this\n"
401 "git config sendemail.to u-boot@lists.denx.de")
402 return
Peter Tyser21818302015-01-26 11:42:21 -0600403 cc = BuildEmailList(list(set(series.get('cc')) - set(series.get('to'))),
404 '--cc', alias, raise_on_error)
Simon Glass0d24de92012-01-14 15:12:45 +0000405 if self_only:
Simon Glassa1318f72013-03-26 13:09:42 +0000406 to = BuildEmailList([os.getenv('USER')], '--to', alias, raise_on_error)
Simon Glass0d24de92012-01-14 15:12:45 +0000407 cc = []
408 cmd = ['git', 'send-email', '--annotate']
Doug Anderson6d819922013-03-17 10:31:04 +0000409 if in_reply_to:
Simon Glass6f8abf72017-05-29 15:31:23 -0600410 if type(in_reply_to) != str:
411 in_reply_to = in_reply_to.encode('utf-8')
Doug Anderson6d819922013-03-17 10:31:04 +0000412 cmd.append('--in-reply-to="%s"' % in_reply_to)
Mateusz Kulikowski27067a42016-01-14 20:37:41 +0100413 if thread:
414 cmd.append('--thread')
Doug Anderson6d819922013-03-17 10:31:04 +0000415
Simon Glass0d24de92012-01-14 15:12:45 +0000416 cmd += to
417 cmd += cc
418 cmd += ['--cc-cmd', '"%s --cc-cmd %s"' % (sys.argv[0], cc_fname)]
419 if cover_fname:
420 cmd.append(cover_fname)
421 cmd += args
Simon Glass2df3a012017-05-29 15:31:25 -0600422 cmdstr = ' '.join(cmd)
Simon Glass0d24de92012-01-14 15:12:45 +0000423 if not dry_run:
Simon Glass2df3a012017-05-29 15:31:25 -0600424 os.system(cmdstr)
425 return cmdstr
Simon Glass0d24de92012-01-14 15:12:45 +0000426
427
Simon Glassa1318f72013-03-26 13:09:42 +0000428def LookupEmail(lookup_name, alias=None, raise_on_error=True, level=0):
Simon Glass0d24de92012-01-14 15:12:45 +0000429 """If an email address is an alias, look it up and return the full name
430
431 TODO: Why not just use git's own alias feature?
432
433 Args:
434 lookup_name: Alias or email address to look up
Simon Glassa1318f72013-03-26 13:09:42 +0000435 alias: Dictionary containing aliases (None to use settings default)
436 raise_on_error: True to raise an error when an alias fails to match,
437 False to just print a message.
Simon Glass0d24de92012-01-14 15:12:45 +0000438
439 Returns:
440 tuple:
441 list containing a list of email addresses
442
443 Raises:
444 OSError if a recursive alias reference was found
445 ValueError if an alias was not found
446
447 >>> alias = {}
448 >>> alias['fred'] = ['f.bloggs@napier.co.nz']
449 >>> alias['john'] = ['j.bloggs@napier.co.nz']
450 >>> alias['mary'] = ['m.poppins@cloud.net']
451 >>> alias['boys'] = ['fred', ' john', 'f.bloggs@napier.co.nz']
452 >>> alias['all'] = ['fred ', 'john', ' mary ']
453 >>> alias['loop'] = ['other', 'john', ' mary ']
454 >>> alias['other'] = ['loop', 'john', ' mary ']
455 >>> LookupEmail('mary', alias)
456 ['m.poppins@cloud.net']
457 >>> LookupEmail('arthur.wellesley@howe.ro.uk', alias)
458 ['arthur.wellesley@howe.ro.uk']
459 >>> LookupEmail('boys', alias)
460 ['f.bloggs@napier.co.nz', 'j.bloggs@napier.co.nz']
461 >>> LookupEmail('all', alias)
462 ['f.bloggs@napier.co.nz', 'j.bloggs@napier.co.nz', 'm.poppins@cloud.net']
463 >>> LookupEmail('odd', alias)
464 Traceback (most recent call last):
465 ...
466 ValueError: Alias 'odd' not found
467 >>> LookupEmail('loop', alias)
468 Traceback (most recent call last):
469 ...
470 OSError: Recursive email alias at 'other'
Simon Glassa1318f72013-03-26 13:09:42 +0000471 >>> LookupEmail('odd', alias, raise_on_error=False)
Simon Glasse752edc2014-08-28 09:43:35 -0600472 Alias 'odd' not found
Simon Glassa1318f72013-03-26 13:09:42 +0000473 []
474 >>> # In this case the loop part will effectively be ignored.
475 >>> LookupEmail('loop', alias, raise_on_error=False)
Simon Glasse752edc2014-08-28 09:43:35 -0600476 Recursive email alias at 'other'
477 Recursive email alias at 'john'
478 Recursive email alias at 'mary'
Simon Glassa1318f72013-03-26 13:09:42 +0000479 ['j.bloggs@napier.co.nz', 'm.poppins@cloud.net']
Simon Glass0d24de92012-01-14 15:12:45 +0000480 """
481 if not alias:
482 alias = settings.alias
483 lookup_name = lookup_name.strip()
484 if '@' in lookup_name: # Perhaps a real email address
485 return [lookup_name]
486
487 lookup_name = lookup_name.lower()
Simon Glassa1318f72013-03-26 13:09:42 +0000488 col = terminal.Color()
Simon Glass0d24de92012-01-14 15:12:45 +0000489
490 out_list = []
Simon Glassa1318f72013-03-26 13:09:42 +0000491 if level > 10:
492 msg = "Recursive email alias at '%s'" % lookup_name
493 if raise_on_error:
Paul Burtonac3fde92016-09-27 16:03:51 +0100494 raise OSError(msg)
Simon Glassa1318f72013-03-26 13:09:42 +0000495 else:
Paul Burtona920a172016-09-27 16:03:50 +0100496 print(col.Color(col.RED, msg))
Simon Glassa1318f72013-03-26 13:09:42 +0000497 return out_list
498
Simon Glass0d24de92012-01-14 15:12:45 +0000499 if lookup_name:
500 if not lookup_name in alias:
Simon Glassa1318f72013-03-26 13:09:42 +0000501 msg = "Alias '%s' not found" % lookup_name
502 if raise_on_error:
Paul Burtonac3fde92016-09-27 16:03:51 +0100503 raise ValueError(msg)
Simon Glassa1318f72013-03-26 13:09:42 +0000504 else:
Paul Burtona920a172016-09-27 16:03:50 +0100505 print(col.Color(col.RED, msg))
Simon Glassa1318f72013-03-26 13:09:42 +0000506 return out_list
Simon Glass0d24de92012-01-14 15:12:45 +0000507 for item in alias[lookup_name]:
Simon Glassa1318f72013-03-26 13:09:42 +0000508 todo = LookupEmail(item, alias, raise_on_error, level + 1)
Simon Glass0d24de92012-01-14 15:12:45 +0000509 for new_item in todo:
510 if not new_item in out_list:
511 out_list.append(new_item)
512
Paul Burtona920a172016-09-27 16:03:50 +0100513 #print("No match for alias '%s'" % lookup_name)
Simon Glass0d24de92012-01-14 15:12:45 +0000514 return out_list
515
516def GetTopLevel():
517 """Return name of top-level directory for this git repo.
518
519 Returns:
520 Full path to git top-level directory
521
522 This test makes sure that we are running tests in the right subdir
523
Doug Andersona9700482012-11-26 15:21:40 +0000524 >>> os.path.realpath(os.path.dirname(__file__)) == \
525 os.path.join(GetTopLevel(), 'tools', 'patman')
Simon Glass0d24de92012-01-14 15:12:45 +0000526 True
527 """
528 return command.OutputOneLine('git', 'rev-parse', '--show-toplevel')
529
530def GetAliasFile():
531 """Gets the name of the git alias file.
532
533 Returns:
534 Filename of git alias file, or None if none
535 """
Simon Glassdc191502012-12-15 10:42:05 +0000536 fname = command.OutputOneLine('git', 'config', 'sendemail.aliasesfile',
537 raise_on_error=False)
Simon Glass0d24de92012-01-14 15:12:45 +0000538 if fname:
539 fname = os.path.join(GetTopLevel(), fname.strip())
540 return fname
541
Vikram Narayanan87d65552012-05-23 09:01:06 +0000542def GetDefaultUserName():
543 """Gets the user.name from .gitconfig file.
544
545 Returns:
546 User name found in .gitconfig file, or None if none
547 """
548 uname = command.OutputOneLine('git', 'config', '--global', 'user.name')
549 return uname
550
551def GetDefaultUserEmail():
552 """Gets the user.email from the global .gitconfig file.
553
554 Returns:
555 User's email found in .gitconfig file, or None if none
556 """
557 uemail = command.OutputOneLine('git', 'config', '--global', 'user.email')
558 return uemail
559
Wu, Josh3871cd82015-04-15 10:25:18 +0800560def GetDefaultSubjectPrefix():
561 """Gets the format.subjectprefix from local .git/config file.
562
563 Returns:
564 Subject prefix found in local .git/config file, or None if none
565 """
566 sub_prefix = command.OutputOneLine('git', 'config', 'format.subjectprefix',
567 raise_on_error=False)
568
569 return sub_prefix
570
Simon Glass0d24de92012-01-14 15:12:45 +0000571def Setup():
572 """Set up git utils, by reading the alias files."""
Simon Glass0d24de92012-01-14 15:12:45 +0000573 # Check for a git alias file also
Simon Glass0b703db2014-08-28 09:43:45 -0600574 global use_no_decorate
575
Simon Glass0d24de92012-01-14 15:12:45 +0000576 alias_fname = GetAliasFile()
577 if alias_fname:
578 settings.ReadGitAliases(alias_fname)
Simon Glasse49f14a2014-08-09 15:33:11 -0600579 cmd = LogCmd(None, count=0)
580 use_no_decorate = (command.RunPipe([cmd], raise_on_error=False)
581 .return_code == 0)
Simon Glass0d24de92012-01-14 15:12:45 +0000582
Simon Glass5f6a1c42012-12-15 10:42:07 +0000583def GetHead():
584 """Get the hash of the current HEAD
585
586 Returns:
587 Hash of HEAD
588 """
589 return command.OutputOneLine('git', 'show', '-s', '--pretty=format:%H')
590
Simon Glass0d24de92012-01-14 15:12:45 +0000591if __name__ == "__main__":
592 import doctest
593
594 doctest.testmod()