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 checkpatch
  11 from patman import command
  12 from patman import series
  13 from patman import settings
  14 from patman import terminal
  15 from patman import tools
  16
  17 # True to use --no-decorate - we check this in Setup()
  18 use_no_decorate = True
  19
  20 def 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 repository (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]
  36     cmd += ['--no-pager', 'log', '--no-color']
  37     if oneline:
  38         cmd.append('--oneline')
  39     if use_no_decorate:
  40         cmd.append('--no-decorate')
  41     if reverse:
  42         cmd.append('--reverse')
  43     if count is not None:
  44         cmd.append('-n%d' % count)
  45     if commit_range:
  46         cmd.append(commit_range)
  47
  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('--')
  52     return cmd
  53
  54 def 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     """
  63     pipe = [LogCmd('@{upstream}..', oneline=True),
  64             ['wc', '-l']]
  65     stdout = command.RunPipe(pipe, capture=True, oneline=True).stdout
  66     patch_count = int(stdout)
  67     return patch_count
  68
  69 def 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
  85 def 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
 115 def 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:
 123         Tuple:
 124             Name of upstream branch (e.g. 'upstream/master') or None if none
 125             Warning/error message, or None if none
 126     """
 127     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:
 133         upstream, msg = GuessUpstream(git_dir, branch)
 134         return upstream, msg
 135
 136     if remote == '.':
 137         return merge, None
 138     elif remote and merge:
 139         leaf = merge.split('/')[-1]
 140         return '%s/%s' % (remote, leaf), None
 141     else:
 142         raise ValueError("Cannot determine upstream branch for branch "
 143                 "'%s' remote='%s', merge='%s'" % (branch, remote, merge))
 144
 145
 146 def 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
 154         access the commits. If the branch does not exist, returns None.
 155     """
 156     upstream, msg = GetUpstream(git_dir, branch)
 157     if not upstream:
 158         return None, msg
 159     rstr = '%s%s..%s' % (upstream, '~' if include_upstream else '', branch)
 160     return rstr, msg
 161
 162 def 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 range 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
 180 def 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:
 187         Number of patches that exist on top of the branch, or None if the
 188         branch does not exist.
 189     """
 190     range_expr, msg = GetRangeInBranch(git_dir, branch, include_upstream)
 191     if not range_expr:
 192         return None, msg
 193     return CountCommitsInRange(git_dir, range_expr)
 194
 195 def 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     """
 203     pipe = [LogCmd(commit_range, oneline=True),
 204             ['wc', '-l']]
 205     stdout = command.RunPipe(pipe, capture=True, oneline=True).stdout
 206     patch_count = int(stdout)
 207     return patch_count
 208
 209 def 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)
 224     result = command.RunPipe([pipe], capture=True, raise_on_error=False,
 225                              capture_stderr=True)
 226     if result.return_code != 0:
 227         raise OSError('git checkout (%s): %s' % (pipe, result.stderr))
 228
 229 def 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, '.']
 236     result = command.RunPipe([pipe], capture=True, cwd=output_dir,
 237                              capture_stderr=True)
 238     if result.return_code != 0:
 239         raise OSError('git clone: %s' % result.stderr)
 240
 241 def 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')
 253     result = command.RunPipe([pipe], capture=True, capture_stderr=True)
 254     if result.return_code != 0:
 255         raise OSError('git fetch: %s' % result.stderr)
 256
 257 def CreatePatches(start, count, ignore_binary, 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']
 272     cmd = ['git', 'format-patch', '-M', '--signoff']
 273     if ignore_binary:
 274         cmd.append('--no-binary')
 275     if series.get('cover'):
 276         cmd.append('--cover-letter')
 277     prefix = series.GetPatchPrefix()
 278     if prefix:
 279         cmd += ['--subject-prefix=%s' % prefix]
 280     cmd += ['HEAD~%d..HEAD~%d' % (start + count, start)]
 281
 282     stdout = command.RunList(cmd)
 283     files = stdout.splitlines()
 284
 285     # We have an extra file if there is a cover letter
 286     if series.get('cover'):
 287        return files[0], files[1:]
 288     else:
 289        return None, files
 290
 291 def BuildEmailList(in_list, tag=None, alias=None, raise_on_error=True):
 292     """Build a list of email addresses based on an input list.
 293
 294     Takes a list of email addresses and aliases, and turns this into a list
 295     of only email address, by resolving any aliases that are present.
 296
 297     If the tag is given, then each email address is prepended with this
 298     tag and a space. If the tag starts with a minus sign (indicating a
 299     command line parameter) then the email address is quoted.
 300
 301     Args:
 302         in_list:        List of aliases/email addresses
 303         tag:            Text to put before each address
 304         alias:          Alias dictionary
 305         raise_on_error: True to raise an error when an alias fails to match,
 306                 False to just print a message.
 307
 308     Returns:
 309         List of email addresses
 310
 311     >>> alias = {}
 312     >>> alias['fred'] = ['f.bloggs@napier.co.nz']
 313     >>> alias['john'] = ['j.bloggs@napier.co.nz']
 314     >>> alias['mary'] = ['Mary Poppins <m.poppins@cloud.net>']
 315     >>> alias['boys'] = ['fred', ' john']
 316     >>> alias['all'] = ['fred ', 'john', '   mary   ']
 317     >>> BuildEmailList(['john', 'mary'], None, alias)
 318     ['j.bloggs@napier.co.nz', 'Mary Poppins <m.poppins@cloud.net>']
 319     >>> BuildEmailList(['john', 'mary'], '--to', alias)
 320     ['--to "j.bloggs@napier.co.nz"', \
 321 '--to "Mary Poppins <m.poppins@cloud.net>"']
 322     >>> BuildEmailList(['john', 'mary'], 'Cc', alias)
 323     ['Cc j.bloggs@napier.co.nz', 'Cc Mary Poppins <m.poppins@cloud.net>']
 324     """
 325     quote = '"' if tag and tag[0] == '-' else ''
 326     raw = []
 327     for item in in_list:
 328         raw += LookupEmail(item, alias, raise_on_error=raise_on_error)
 329     result = []
 330     for item in raw:
 331         item = tools.FromUnicode(item)
 332         if not item in result:
 333             result.append(item)
 334     if tag:
 335         return ['%s %s%s%s' % (tag, quote, email, quote) for email in result]
 336     return result
 337
 338 def EmailPatches(series, cover_fname, args, dry_run, raise_on_error, cc_fname,
 339         self_only=False, alias=None, in_reply_to=None, thread=False,
 340         smtp_server=None):
 341     """Email a patch series.
 342
 343     Args:
 344         series: Series object containing destination info
 345         cover_fname: filename of cover letter
 346         args: list of filenames of patch files
 347         dry_run: Just return the command that would be run
 348         raise_on_error: True to raise an error when an alias fails to match,
 349                 False to just print a message.
 350         cc_fname: Filename of Cc file for per-commit Cc
 351         self_only: True to just email to yourself as a test
 352         in_reply_to: If set we'll pass this to git as --in-reply-to.
 353             Should be a message ID that this is in reply to.
 354         thread: True to add --thread to git send-email (make
 355             all patches reply to cover-letter or first patch in series)
 356         smtp_server: SMTP server to use to send patches
 357
 358     Returns:
 359         Git command that was/would be run
 360
 361     # For the duration of this doctest pretend that we ran patman with ./patman
 362     >>> _old_argv0 = sys.argv[0]
 363     >>> sys.argv[0] = './patman'
 364
 365     >>> alias = {}
 366     >>> alias['fred'] = ['f.bloggs@napier.co.nz']
 367     >>> alias['john'] = ['j.bloggs@napier.co.nz']
 368     >>> alias['mary'] = ['m.poppins@cloud.net']
 369     >>> alias['boys'] = ['fred', ' john']
 370     >>> alias['all'] = ['fred ', 'john', '   mary   ']
 371     >>> alias[os.getenv('USER')] = ['this-is-me@me.com']
 372     >>> series = series.Series()
 373     >>> series.to = ['fred']
 374     >>> series.cc = ['mary']
 375     >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
 376             False, alias)
 377     'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
 378 "m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" cover p1 p2'
 379     >>> EmailPatches(series, None, ['p1'], True, True, 'cc-fname', False, \
 380             alias)
 381     'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
 382 "m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" p1'
 383     >>> series.cc = ['all']
 384     >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
 385             True, alias)
 386     'git send-email --annotate --to "this-is-me@me.com" --cc-cmd "./patman \
 387 --cc-cmd cc-fname" cover p1 p2'
 388     >>> EmailPatches(series, 'cover', ['p1', 'p2'], True, True, 'cc-fname', \
 389             False, alias)
 390     'git send-email --annotate --to "f.bloggs@napier.co.nz" --cc \
 391 "f.bloggs@napier.co.nz" --cc "j.bloggs@napier.co.nz" --cc \
 392 "m.poppins@cloud.net" --cc-cmd "./patman --cc-cmd cc-fname" cover p1 p2'
 393
 394     # Restore argv[0] since we clobbered it.
 395     >>> sys.argv[0] = _old_argv0
 396     """
 397     to = BuildEmailList(series.get('to'), '--to', alias, raise_on_error)
 398     if not to:
 399         git_config_to = command.Output('git', 'config', 'sendemail.to',
 400                                        raise_on_error=False)
 401         if not git_config_to:
 402             print("No recipient.\n"
 403                   "Please add something like this to a commit\n"
 404                   "Series-to: Fred Bloggs <f.blogs@napier.co.nz>\n"
 405                   "Or do something like this\n"
 406                   "git config sendemail.to u-boot@lists.denx.de")
 407             return
 408     cc = BuildEmailList(list(set(series.get('cc')) - set(series.get('to'))),
 409                         '--cc', alias, raise_on_error)
 410     if self_only:
 411         to = BuildEmailList([os.getenv('USER')], '--to', alias, raise_on_error)
 412         cc = []
 413     cmd = ['git', 'send-email', '--annotate']
 414     if smtp_server:
 415         cmd.append('--smtp-server=%s' % smtp_server)
 416     if in_reply_to:
 417         cmd.append('--in-reply-to="%s"' % tools.FromUnicode(in_reply_to))
 418     if thread:
 419         cmd.append('--thread')
 420
 421     cmd += to
 422     cmd += cc
 423     cmd += ['--cc-cmd', '"%s --cc-cmd %s"' % (sys.argv[0], cc_fname)]
 424     if cover_fname:
 425         cmd.append(cover_fname)
 426     cmd += args
 427     cmdstr = ' '.join(cmd)
 428     if not dry_run:
 429         os.system(cmdstr)
 430     return cmdstr
 431
 432
 433 def LookupEmail(lookup_name, alias=None, raise_on_error=True, level=0):
 434     """If an email address is an alias, look it up and return the full name
 435
 436     TODO: Why not just use git's own alias feature?
 437
 438     Args:
 439         lookup_name: Alias or email address to look up
 440         alias: Dictionary containing aliases (None to use settings default)
 441         raise_on_error: True to raise an error when an alias fails to match,
 442                 False to just print a message.
 443
 444     Returns:
 445         tuple:
 446             list containing a list of email addresses
 447
 448     Raises:
 449         OSError if a recursive alias reference was found
 450         ValueError if an alias was not found
 451
 452     >>> alias = {}
 453     >>> alias['fred'] = ['f.bloggs@napier.co.nz']
 454     >>> alias['john'] = ['j.bloggs@napier.co.nz']
 455     >>> alias['mary'] = ['m.poppins@cloud.net']
 456     >>> alias['boys'] = ['fred', ' john', 'f.bloggs@napier.co.nz']
 457     >>> alias['all'] = ['fred ', 'john', '   mary   ']
 458     >>> alias['loop'] = ['other', 'john', '   mary   ']
 459     >>> alias['other'] = ['loop', 'john', '   mary   ']
 460     >>> LookupEmail('mary', alias)
 461     ['m.poppins@cloud.net']
 462     >>> LookupEmail('arthur.wellesley@howe.ro.uk', alias)
 463     ['arthur.wellesley@howe.ro.uk']
 464     >>> LookupEmail('boys', alias)
 465     ['f.bloggs@napier.co.nz', 'j.bloggs@napier.co.nz']
 466     >>> LookupEmail('all', alias)
 467     ['f.bloggs@napier.co.nz', 'j.bloggs@napier.co.nz', 'm.poppins@cloud.net']
 468     >>> LookupEmail('odd', alias)
 469     Traceback (most recent call last):
 470     ...
 471     ValueError: Alias 'odd' not found
 472     >>> LookupEmail('loop', alias)
 473     Traceback (most recent call last):
 474     ...
 475     OSError: Recursive email alias at 'other'
 476     >>> LookupEmail('odd', alias, raise_on_error=False)
 477     Alias 'odd' not found
 478     []
 479     >>> # In this case the loop part will effectively be ignored.
 480     >>> LookupEmail('loop', alias, raise_on_error=False)
 481     Recursive email alias at 'other'
 482     Recursive email alias at 'john'
 483     Recursive email alias at 'mary'
 484     ['j.bloggs@napier.co.nz', 'm.poppins@cloud.net']
 485     """
 486     if not alias:
 487         alias = settings.alias
 488     lookup_name = lookup_name.strip()
 489     if '@' in lookup_name: # Perhaps a real email address
 490         return [lookup_name]
 491
 492     lookup_name = lookup_name.lower()
 493     col = terminal.Color()
 494
 495     out_list = []
 496     if level > 10:
 497         msg = "Recursive email alias at '%s'" % lookup_name
 498         if raise_on_error:
 499             raise OSError(msg)
 500         else:
 501             print(col.Color(col.RED, msg))
 502             return out_list
 503
 504     if lookup_name:
 505         if not lookup_name in alias:
 506             msg = "Alias '%s' not found" % lookup_name
 507             if raise_on_error:
 508                 raise ValueError(msg)
 509             else:
 510                 print(col.Color(col.RED, msg))
 511                 return out_list
 512         for item in alias[lookup_name]:
 513             todo = LookupEmail(item, alias, raise_on_error, level + 1)
 514             for new_item in todo:
 515                 if not new_item in out_list:
 516                     out_list.append(new_item)
 517
 518     #print("No match for alias '%s'" % lookup_name)
 519     return out_list
 520
 521 def GetTopLevel():
 522     """Return name of top-level directory for this git repo.
 523
 524     Returns:
 525         Full path to git top-level directory
 526
 527     This test makes sure that we are running tests in the right subdir
 528
 529     >>> os.path.realpath(os.path.dirname(__file__)) == \
 530             os.path.join(GetTopLevel(), 'tools', 'patman')
 531     True
 532     """
 533     return command.OutputOneLine('git', 'rev-parse', '--show-toplevel')
 534
 535 def GetAliasFile():
 536     """Gets the name of the git alias file.
 537
 538     Returns:
 539         Filename of git alias file, or None if none
 540     """
 541     fname = command.OutputOneLine('git', 'config', 'sendemail.aliasesfile',
 542             raise_on_error=False)
 543     if fname:
 544         fname = os.path.join(GetTopLevel(), fname.strip())
 545     return fname
 546
 547 def GetDefaultUserName():
 548     """Gets the user.name from .gitconfig file.
 549
 550     Returns:
 551         User name found in .gitconfig file, or None if none
 552     """
 553     uname = command.OutputOneLine('git', 'config', '--global', 'user.name')
 554     return uname
 555
 556 def GetDefaultUserEmail():
 557     """Gets the user.email from the global .gitconfig file.
 558
 559     Returns:
 560         User's email found in .gitconfig file, or None if none
 561     """
 562     uemail = command.OutputOneLine('git', 'config', '--global', 'user.email')
 563     return uemail
 564
 565 def GetDefaultSubjectPrefix():
 566     """Gets the format.subjectprefix from local .git/config file.
 567
 568     Returns:
 569         Subject prefix found in local .git/config file, or None if none
 570     """
 571     sub_prefix = command.OutputOneLine('git', 'config', 'format.subjectprefix',
 572                  raise_on_error=False)
 573
 574     return sub_prefix
 575
 576 def Setup():
 577     """Set up git utils, by reading the alias files."""
 578     # Check for a git alias file also
 579     global use_no_decorate
 580
 581     alias_fname = GetAliasFile()
 582     if alias_fname:
 583         settings.ReadGitAliases(alias_fname)
 584     cmd = LogCmd(None, count=0)
 585     use_no_decorate = (command.RunPipe([cmd], raise_on_error=False)
 586                        .return_code == 0)
 587
 588 def GetHead():
 589     """Get the hash of the current HEAD
 590
 591     Returns:
 592         Hash of HEAD
 593     """
 594     return command.OutputOneLine('git', 'show', '-s', '--pretty=format:%H')
 595
 596 if __name__ == "__main__":
 597     import doctest
 598
 599     doctest.testmod()