tools/patman/gitutil.py

   1 # SPDX-License-Identifier: GPL-2.0+
   2 # Copyright (c) 2011 The Chromium OS Authors.
   3 #
   4
   5 import re
   6 import os
   7 import subprocess
   8 import sys
   9
  10 from patman import command
  11 from patman import settings
  12 from patman import terminal
  13 from patman import tools
  14
  15 # True to use --no-decorate - we check this in Setup()
  16 use_no_decorate = True
  17
  18 def LogCmd(commit_range, git_dir=None, oneline=False, reverse=False,
  19            count=None):
  20     """Create a command to perform a 'git log'
  21
  22     Args:
  23         commit_range: Range expression to use for log, None for none
  24         git_dir: Path to git repository (None to use default)
  25         oneline: True to use --oneline, else False
  26         reverse: True to reverse the log (--reverse)
  27         count: Number of commits to list, or None for no limit
  28     Return:
  29         List containing command and arguments to run
  30     """
  31     cmd = ['git']
  32     if git_dir:
  33         cmd += ['--git-dir', git_dir]
  34     cmd += ['--no-pager', 'log', '--no-color']
  35     if oneline:
  36         cmd.append('--oneline')
  37     if use_no_decorate:
  38         cmd.append('--no-decorate')
  39     if reverse:
  40         cmd.append('--reverse')
  41     if count is not None:
  42         cmd.append('-n%d' % count)
  43     if commit_range:
  44         cmd.append(commit_range)
  45
  46     # Add this in case we have a branch with the same name as a directory.
  47     # This avoids messages like this, for example:
  48     #   fatal: ambiguous argument 'test': both revision and filename
  49     cmd.append('--')
  50     return cmd
  51
  52 def CountCommitsToBranch():
  53     """Returns number of commits between HEAD and the tracking branch.
  54
  55     This looks back to the tracking branch and works out the number of commits
  56     since then.
  57
  58     Return:
  59         Number of patches that exist on top of the branch
  60     """
  61     pipe = [LogCmd('@{upstream}..', oneline=True),
  62             ['wc', '-l']]
  63     stdout = command.RunPipe(pipe, capture=True, oneline=True).stdout
  64     patch_count = int(stdout)
  65     return patch_count
  66
  67 def NameRevision(commit_hash):
  68     """Gets the revision name for a commit
  69
  70     Args:
  71         commit_hash: Commit hash to look up
  72
  73     Return:
  74         Name of revision, if any, else None
  75     """
  76     pipe = ['git', 'name-rev', commit_hash]
  77     stdout = command.RunPipe([pipe], capture=True, oneline=True).stdout
  78
  79     # We expect a commit, a space, then a revision name
  80     name = stdout.split(' ')[1].strip()
  81     return name
  82
  83 def GuessUpstream(git_dir, branch):
  84     """Tries to guess the upstream for a branch
  85
  86     This lists out top commits on a branch and tries to find a suitable
  87     upstream. It does this by looking for the first commit where
  88     'git name-rev' returns a plain branch name, with no ! or ^ modifiers.
  89
  90     Args:
  91         git_dir: Git directory containing repo
  92         branch: Name of branch
  93
  94     Returns:
  95         Tuple:
  96             Name of upstream branch (e.g. 'upstream/master') or None if none
  97             Warning/error message, or None if none
  98     """
  99     pipe = [LogCmd(branch, git_dir=git_dir, oneline=True, count=100)]
 100     result = command.RunPipe(pipe, capture=True, capture_stderr=True,
 101                              raise_on_error=False)
 102     if result.return_code:
 103         return None, "Branch '%s' not found" % branch
 104     for line in result.stdout.splitlines()[1:]:
 105         commit_hash = line.split(' ')[0]
 106         name = NameRevision(commit_hash)
 107         if '~' not in name and '^' not in name:
 108             if name.startswith('remotes/'):
 109                 name = name[8:]
 110             return name, "Guessing upstream as '%s'" % name
 111     return None, "Cannot find a suitable upstream for branch '%s'" % branch
 112
 113 def GetUpstream(git_dir, branch):
 114     """Returns the name of the upstream for a branch
 115
 116     Args:
 117         git_dir: Git directory containing repo
 118         branch: Name of branch
 119
 120     Returns:
 121         Tuple:
 122             Name of upstream branch (e.g. 'upstream/master') or None if none
 123             Warning/error message, or None if none
 124     """
 125     try:
 126         remote = command.OutputOneLine('git', '--git-dir', git_dir, 'config',
 127                                        'branch.%s.remote' % branch)
 128         merge = command.OutputOneLine('git', '--git-dir', git_dir, 'config',
 129                                       'branch.%s.merge' % branch)
 130     except:
 131         upstream, msg = GuessUpstream(git_dir, branch)
 132         return upstream, msg
 133
 134     if remote == '.':
 135         return merge, None
 136     elif remote and merge:
 137         leaf = merge.split('/')[-1]
 138         return '%s/%s' % (remote, leaf), None
 139     else:
 140         raise ValueError("Cannot determine upstream branch for branch "
 141                 "'%s' remote='%s', merge='%s'" % (branch, remote, merge))
 142
 143
 144 def GetRangeInBranch(git_dir, branch, include_upstream=False):
 145     """Returns an expression for the commits in the given branch.
 146
 147     Args:
 148         git_dir: Directory containing git repo
 149         branch: Name of branch
 150     Return:
 151         Expression in the form 'upstream..branch' which can be used to
 152         access the commits. If the branch does not exist, returns None.
 153     """
 154     upstream, msg = GetUpstream(git_dir, branch)
 155     if not upstream:
 156         return None, msg
 157     rstr = '%s%s..%s' % (upstream, '~' if include_upstream else '', branch)
 158     return rstr, msg
 159
 160 def CountCommitsInRange(git_dir, range_expr):
 161     """Returns the number of commits in the given range.
 162
 163     Args:
 164         git_dir: Directory containing git repo
 165         range_expr: Range to check
 166     Return:
 167         Number of patches that exist in the supplied range or None if none
 168         were found
 169     """
 170     pipe = [LogCmd(range_expr, git_dir=git_dir, oneline=True)]
 171     result = command.RunPipe(pipe, capture=True, capture_stderr=True,
 172                              raise_on_error=False)
 173     if result.return_code:
 174         return None, "Range '%s' not found or is invalid" % range_expr
 175     patch_count = len(result.stdout.splitlines())
 176     return patch_count, None
 177
 178 def CountCommitsInBranch(git_dir, branch, include_upstream=False):
 179     """Returns the number of commits in the given branch.
 180
 181     Args:
 182         git_dir: Directory containing git repo
 183         branch: Name of branch
 184     Return:
 185         Number of patches that exist on top of the branch, or None if the
 186         branch does not exist.
 187     """
 188     range_expr, msg = GetRangeInBranch(git_dir, branch, include_upstream)
 189     if not range_expr:
 190         return None, msg
 191     return CountCommitsInRange(git_dir, range_expr)
 192
 193 def CountCommits(commit_range):
 194     """Returns the number of commits in the given range.
 195
 196     Args:
 197         commit_range: Range of commits to count (e.g. 'HEAD..base')
 198     Return:
 199         Number of patches that exist on top of the branch
 200     """
 201     pipe = [LogCmd(commit_range, oneline=True),
 202             ['wc', '-l']]
 203     stdout = command.RunPipe(pipe, capture=True, oneline=True).stdout
 204     patch_count = int(stdout)
 205     return patch_count
 206
 207 def Checkout(commit_hash, git_dir=None, work_tree=None, force=False):
 208     """Checkout the selected commit for this build
 209
 210     Args:
 211         commit_hash: Commit hash to check out
 212     """
 213     pipe = ['git']
 214     if git_dir:
 215         pipe.extend(['--git-dir', git_dir])
 216     if work_tree:
 217         pipe.extend(['--work-tree', work_tree])
 218     pipe.append('checkout')
 219     if force:
 220         pipe.append('-f')
 221     pipe.append(commit_hash)
 222     result = command.RunPipe([pipe], capture=True, raise_on_error=False,
 223                              capture_stderr=True)
 224     if result.return_code != 0:
 225         raise OSError('git checkout (%s): %s' % (pipe, result.stderr))
 226
 227 def Clone(git_dir, output_dir):
 228     """Checkout the selected commit for this build
 229
 230     Args:
 231         commit_hash: Commit hash to check out
 232     """
 233     pipe = ['git', 'clone', git_dir, '.']
 234     result = command.RunPipe([pipe], capture=True, cwd=output_dir,
 235                              capture_stderr=True)
 236     if result.return_code != 0:
 237         raise OSError('git clone: %s' % result.stderr)
 238
 239 def Fetch(git_dir=None, work_tree=None):
 240     """Fetch from the origin repo
 241
 242     Args:
 243         commit_hash: Commit hash to check out
 244     """
 245     pipe = ['git']
 246     if git_dir:
 247         pipe.extend(['--git-dir', git_dir])
 248     if work_tree:
 249         pipe.extend(['--work-tree', work_tree])
 250     pipe.append('fetch')
 251     result = command.RunPipe([pipe], capture=True, capture_stderr=True)
 252     if result.return_code != 0:
 253         raise OSError('git fetch: %s' % result.stderr)
 254
 255 def CreatePatches(start, count, ignore_binary, series):
 256     """Create a series of patches from the top of the current branch.
 257
 258     The patch files are written to the current directory using
 259     git format-patch.
 260
 261     Args:
 262         start: Commit to start from: 0=HEAD, 1=next one, etc.
 263         count: number of commits to include
 264     Return:
 265         Filename of cover letter
 266         List of filenames of patch files
 267     """
 268     if series.get('version'):
 269         version = '%s ' % series['version']
 270     cmd = ['git', 'format-patch', '-M', '--signoff']
 271     if ignore_binary:
 272         cmd.append('--no-binary')
 273     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
 289 def BuildEmailList(in_list, tag=None, alias=None, raise_on_error=True):
 290     """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
 302         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.
 305
 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:
 326         raw += LookupEmail(item, alias, raise_on_error=raise_on_error)
 327     result = []
 328     for item in raw:
 329         item = tools.FromUnicode(item)
 330         if not item in result:
 331             result.append(item)
 332     if tag:
 333         return ['%s %s%s%s' % (tag, quote, email, quote) for email in result]
 334     return result
 335
 336 def EmailPatches(series, cover_fname, args, dry_run, raise_on_error, cc_fname,
 337         self_only=False, alias=None, in_reply_to=None, thread=False,
 338         smtp_server=None):
 339     """Email a patch series.
 340
 341     Args:
 342         series: Series object containing destination info
 343         cover_fname: filename of cover letter
 344         args: list of filenames of patch files
 345         dry_run: Just return the command that would be run
 346         raise_on_error: True to raise an error when an alias fails to match,
 347                 False to just print a message.
 348         cc_fname: Filename of Cc file for per-commit Cc
 349         self_only: True to just email to yourself as a test
 350         in_reply_to: If set we'll pass this to git as --in-reply-to.
 351             Should be a message ID that this is in reply to.
 352         thread: True to add --thread to git send-email (make
 353             all patches reply to cover-letter or first patch in series)
 354         smtp_server: SMTP server to use to send patches
 355
 356     Returns:
 357         Git command that was/would be run
 358
 359     # For the duration of this doctest pretend that we ran patman with ./patman
 360     >>> _old_argv0 = sys.argv[0]
 361     >>> sys.argv[0] = './patman'
 362
 363     >>> alias = {}
 364     >>> alias['fred'] = ['f.bloggs@napier.co.nz']
 365     >>> alias['john'] = ['j.bloggs@napier.co.nz']
 366     >>> alias['mary'] = ['m.poppins@cloud.net']
 367     >>> alias['boys'] = ['fred', ' john']
 368     >>> alias['all'] = ['fred ', 'john', '   mary   ']
 369     >>> alias[os.getenv('USER')] = ['this-is-me@me.com']
 370     >>> series = {}
 371     >>> series['to'] = ['fred']
 372     >>> series['cc'] = ['mary']
 373     >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
 374             False, alias)
 375     'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
 376 "m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" cover p1 p2'
 377     >>> EmailPatches(series, None, ['p1'], True, True, 'cc-fname', False, \
 378             alias)
 379     'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
 380 "m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" p1'
 381     >>> series['cc'] = ['all']
 382     >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
 383             True, alias)
 384     'git send-email --annotate --to "this-is-me@me.com" --cc-cmd "./patman \
 385 --cc-cmd cc-fname" cover p1 p2'
 386     >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
 387             False, alias)
 388     'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
 389 "f.bloggs@napier.co.nz" --cc "j.bloggs@napier.co.nz" --cc \
 390 "m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" cover p1 p2'
 391
 392     # Restore argv[0] since we clobbered it.
 393     >>> sys.argv[0] = _old_argv0
 394     """
 395     to = BuildEmailList(series.get('to'), '--to', alias, raise_on_error)
 396     if not to:
 397         git_config_to = command.Output('git', 'config', 'sendemail.to',
 398                                        raise_on_error=False)
 399         if not git_config_to:
 400             print("No recipient.\n"
 401                   "Please add something like this to a commit\n"
 402                   "Series-to: Fred Bloggs <f.blogs@napier.co.nz>\n"
 403                   "Or do something like this\n"
 404                   "git config sendemail.to u-boot@lists.denx.de")
 405             return
 406     cc = BuildEmailList(list(set(series.get('cc')) - set(series.get('to'))),
 407                         '--cc', alias, raise_on_error)
 408     if self_only:
 409         to = BuildEmailList([os.getenv('USER')], '--to', alias, raise_on_error)
 410         cc = []
 411     cmd = ['git', 'send-email', '--annotate']
 412     if smtp_server:
 413         cmd.append('--smtp-server=%s' % smtp_server)
 414     if in_reply_to:
 415         cmd.append('--in-reply-to="%s"' % tools.FromUnicode(in_reply_to))
 416     if thread:
 417         cmd.append('--thread')
 418
 419     cmd += to
 420     cmd += cc
 421     cmd += ['--cc-cmd', '"%s --cc-cmd %s"' % (sys.argv[0], cc_fname)]
 422     if cover_fname:
 423         cmd.append(cover_fname)
 424     cmd += args
 425     cmdstr = ' '.join(cmd)
 426     if not dry_run:
 427         os.system(cmdstr)
 428     return cmdstr
 429
 430
 431 def LookupEmail(lookup_name, alias=None, raise_on_error=True, level=0):
 432     """If an email address is an alias, look it up and return the full name
 433
 434     TODO: Why not just use git's own alias feature?
 435
 436     Args:
 437         lookup_name: Alias or email address to look up
 438         alias: Dictionary containing aliases (None to use settings default)
 439         raise_on_error: True to raise an error when an alias fails to match,
 440                 False to just print a message.
 441
 442     Returns:
 443         tuple:
 444             list containing a list of email addresses
 445
 446     Raises:
 447         OSError if a recursive alias reference was found
 448         ValueError if an alias was not found
 449
 450     >>> alias = {}
 451     >>> alias['fred'] = ['f.bloggs@napier.co.nz']
 452     >>> alias['john'] = ['j.bloggs@napier.co.nz']
 453     >>> alias['mary'] = ['m.poppins@cloud.net']
 454     >>> alias['boys'] = ['fred', ' john', 'f.bloggs@napier.co.nz']
 455     >>> alias['all'] = ['fred ', 'john', '   mary   ']
 456     >>> alias['loop'] = ['other', 'john', '   mary   ']
 457     >>> alias['other'] = ['loop', 'john', '   mary   ']
 458     >>> LookupEmail('mary', alias)
 459     ['m.poppins@cloud.net']
 460     >>> LookupEmail('arthur.wellesley@howe.ro.uk', alias)
 461     ['arthur.wellesley@howe.ro.uk']
 462     >>> LookupEmail('boys', alias)
 463     ['f.bloggs@napier.co.nz', 'j.bloggs@napier.co.nz']
 464     >>> LookupEmail('all', alias)
 465     ['f.bloggs@napier.co.nz', 'j.bloggs@napier.co.nz', 'm.poppins@cloud.net']
 466     >>> LookupEmail('odd', alias)
 467     Traceback (most recent call last):
 468     ...
 469     ValueError: Alias 'odd' not found
 470     >>> LookupEmail('loop', alias)
 471     Traceback (most recent call last):
 472     ...
 473     OSError: Recursive email alias at 'other'
 474     >>> LookupEmail('odd', alias, raise_on_error=False)
 475     Alias 'odd' not found
 476     []
 477     >>> # In this case the loop part will effectively be ignored.
 478     >>> LookupEmail('loop', alias, raise_on_error=False)
 479     Recursive email alias at 'other'
 480     Recursive email alias at 'john'
 481     Recursive email alias at 'mary'
 482     ['j.bloggs@napier.co.nz', 'm.poppins@cloud.net']
 483     """
 484     if not alias:
 485         alias = settings.alias
 486     lookup_name = lookup_name.strip()
 487     if '@' in lookup_name: # Perhaps a real email address
 488         return [lookup_name]
 489
 490     lookup_name = lookup_name.lower()
 491     col = terminal.Color()
 492
 493     out_list = []
 494     if level > 10:
 495         msg = "Recursive email alias at '%s'" % lookup_name
 496         if raise_on_error:
 497             raise OSError(msg)
 498         else:
 499             print(col.Color(col.RED, msg))
 500             return out_list
 501
 502     if lookup_name:
 503         if not lookup_name in alias:
 504             msg = "Alias '%s' not found" % lookup_name
 505             if raise_on_error:
 506                 raise ValueError(msg)
 507             else:
 508                 print(col.Color(col.RED, msg))
 509                 return out_list
 510         for item in alias[lookup_name]:
 511             todo = LookupEmail(item, alias, raise_on_error, level + 1)
 512             for new_item in todo:
 513                 if not new_item in out_list:
 514                     out_list.append(new_item)
 515
 516     #print("No match for alias '%s'" % lookup_name)
 517     return out_list
 518
 519 def GetTopLevel():
 520     """Return name of top-level directory for this git repo.
 521
 522     Returns:
 523         Full path to git top-level directory
 524
 525     This test makes sure that we are running tests in the right subdir
 526
 527     >>> os.path.realpath(os.path.dirname(__file__)) == \
 528             os.path.join(GetTopLevel(), 'tools', 'patman')
 529     True
 530     """
 531     return command.OutputOneLine('git', 'rev-parse', '--show-toplevel')
 532
 533 def GetAliasFile():
 534     """Gets the name of the git alias file.
 535
 536     Returns:
 537         Filename of git alias file, or None if none
 538     """
 539     fname = command.OutputOneLine('git', 'config', 'sendemail.aliasesfile',
 540             raise_on_error=False)
 541     if fname:
 542         fname = os.path.join(GetTopLevel(), fname.strip())
 543     return fname
 544
 545 def GetDefaultUserName():
 546     """Gets the user.name from .gitconfig file.
 547
 548     Returns:
 549         User name found in .gitconfig file, or None if none
 550     """
 551     uname = command.OutputOneLine('git', 'config', '--global', 'user.name')
 552     return uname
 553
 554 def GetDefaultUserEmail():
 555     """Gets the user.email from the global .gitconfig file.
 556
 557     Returns:
 558         User's email found in .gitconfig file, or None if none
 559     """
 560     uemail = command.OutputOneLine('git', 'config', '--global', 'user.email')
 561     return uemail
 562
 563 def GetDefaultSubjectPrefix():
 564     """Gets the format.subjectprefix from local .git/config file.
 565
 566     Returns:
 567         Subject prefix found in local .git/config file, or None if none
 568     """
 569     sub_prefix = command.OutputOneLine('git', 'config', 'format.subjectprefix',
 570                  raise_on_error=False)
 571
 572     return sub_prefix
 573
 574 def Setup():
 575     """Set up git utils, by reading the alias files."""
 576     # Check for a git alias file also
 577     global use_no_decorate
 578
 579     alias_fname = GetAliasFile()
 580     if alias_fname:
 581         settings.ReadGitAliases(alias_fname)
 582     cmd = LogCmd(None, count=0)
 583     use_no_decorate = (command.RunPipe([cmd], raise_on_error=False)
 584                        .return_code == 0)
 585
 586 def GetHead():
 587     """Get the hash of the current HEAD
 588
 589     Returns:
 590         Hash of HEAD
 591     """
 592     return command.OutputOneLine('git', 'show', '-s', '--pretty=format:%H')
 593
 594 if __name__ == "__main__":
 595     import doctest
 596
 597     doctest.testmod()