git.sur5r.net Git - u-boot/blob - tools/patman/patman.py

   1 #!/usr/bin/env python2
   2 # SPDX-License-Identifier: GPL-2.0+
   3 #
   4 # Copyright (c) 2011 The Chromium OS Authors.
   5 #
   6
   7 """See README for more information"""
   8
   9 from optparse import OptionParser
  10 import os
  11 import re
  12 import sys
  13 import unittest
  14
  15 # Our modules
  16 try:
  17     from patman import checkpatch, command, gitutil, patchstream, \
  18         project, settings, terminal, test
  19 except ImportError:
  20     import checkpatch
  21     import command
  22     import gitutil
  23     import patchstream
  24     import project
  25     import settings
  26     import terminal
  27     import test
  28
  29
  30 parser = OptionParser()
  31 parser.add_option('-H', '--full-help', action='store_true', dest='full_help',
  32        default=False, help='Display the README file')
  33 parser.add_option('-c', '--count', dest='count', type='int',
  34        default=-1, help='Automatically create patches from top n commits')
  35 parser.add_option('-i', '--ignore-errors', action='store_true',
  36        dest='ignore_errors', default=False,
  37        help='Send patches email even if patch errors are found')
  38 parser.add_option('-m', '--no-maintainers', action='store_false',
  39        dest='add_maintainers', default=True,
  40        help="Don't cc the file maintainers automatically")
  41 parser.add_option('-l', '--limit-cc', dest='limit', type='int',
  42        default=None, help='Limit the cc list to LIMIT entries [default: %default]')
  43 parser.add_option('-n', '--dry-run', action='store_true', dest='dry_run',
  44        default=False, help="Do a dry run (create but don't email patches)")
  45 parser.add_option('-p', '--project', default=project.DetectProject(),
  46                   help="Project name; affects default option values and "
  47                   "aliases [default: %default]")
  48 parser.add_option('-r', '--in-reply-to', type='string', action='store',
  49                   help="Message ID that this series is in reply to")
  50 parser.add_option('-s', '--start', dest='start', type='int',
  51        default=0, help='Commit to start creating patches from (0 = HEAD)')
  52 parser.add_option('-t', '--ignore-bad-tags', action='store_true',
  53                   default=False, help='Ignore bad tags / aliases')
  54 parser.add_option('--test', action='store_true', dest='test',
  55                   default=False, help='run tests')
  56 parser.add_option('-v', '--verbose', action='store_true', dest='verbose',
  57        default=False, help='Verbose output of errors and warnings')
  58 parser.add_option('--cc-cmd', dest='cc_cmd', type='string', action='store',
  59        default=None, help='Output cc list for patch file (used by git)')
  60 parser.add_option('--no-check', action='store_false', dest='check_patch',
  61                   default=True,
  62                   help="Don't check for patch compliance")
  63 parser.add_option('--no-tags', action='store_false', dest='process_tags',
  64                   default=True, help="Don't process subject tags as aliaes")
  65 parser.add_option('-T', '--thread', action='store_true', dest='thread',
  66                   default=False, help='Create patches as a single thread')
  67
  68 parser.usage += """
  69
  70 Create patches from commits in a branch, check them and email them as
  71 specified by tags you place in the commits. Use -n to do a dry run first."""
  72
  73
  74 # Parse options twice: first to get the project and second to handle
  75 # defaults properly (which depends on project).
  76 (options, args) = parser.parse_args()
  77 settings.Setup(parser, options.project, '')
  78 (options, args) = parser.parse_args()
  79
  80 if __name__ != "__main__":
  81     pass
  82
  83 # Run our meagre tests
  84 elif options.test:
  85     import doctest
  86     import func_test
  87
  88     sys.argv = [sys.argv[0]]
  89     result = unittest.TestResult()
  90     for module in (test.TestPatch, func_test.TestFunctional):
  91         suite = unittest.TestLoader().loadTestsFromTestCase(module)
  92         suite.run(result)
  93
  94     for module in ['gitutil', 'settings']:
  95         suite = doctest.DocTestSuite(module)
  96         suite.run(result)
  97
  98     # TODO: Surely we can just 'print' result?
  99     print(result)
 100     for test, err in result.errors:
 101         print(err)
 102     for test, err in result.failures:
 103         print(err)
 104
 105 # Called from git with a patch filename as argument
 106 # Printout a list of additional CC recipients for this patch
 107 elif options.cc_cmd:
 108     fd = open(options.cc_cmd, 'r')
 109     re_line = re.compile('(\S*) (.*)')
 110     for line in fd.readlines():
 111         match = re_line.match(line)
 112         if match and match.group(1) == args[0]:
 113             for cc in match.group(2).split(', '):
 114                 cc = cc.strip()
 115                 if cc:
 116                     print(cc)
 117     fd.close()
 118
 119 elif options.full_help:
 120     pager = os.getenv('PAGER')
 121     if not pager:
 122         pager = 'more'
 123     fname = os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])),
 124                          'README')
 125     command.Run(pager, fname)
 126
 127 # Process commits, produce patches files, check them, email them
 128 else:
 129     gitutil.Setup()
 130
 131     if options.count == -1:
 132         # Work out how many patches to send if we can
 133         options.count = gitutil.CountCommitsToBranch() - options.start
 134
 135     col = terminal.Color()
 136     if not options.count:
 137         str = 'No commits found to process - please use -c flag'
 138         sys.exit(col.Color(col.RED, str))
 139
 140     # Read the metadata from the commits
 141     if options.count:
 142         series = patchstream.GetMetaData(options.start, options.count)
 143         cover_fname, args = gitutil.CreatePatches(options.start, options.count,
 144                 series)
 145
 146     # Fix up the patch files to our liking, and insert the cover letter
 147     patchstream.FixPatches(series, args)
 148     if cover_fname and series.get('cover'):
 149         patchstream.InsertCoverLetter(cover_fname, series, options.count)
 150
 151     # Do a few checks on the series
 152     series.DoChecks()
 153
 154     # Check the patches, and run them through 'git am' just to be sure
 155     if options.check_patch:
 156         ok = checkpatch.CheckPatches(options.verbose, args)
 157     else:
 158         ok = True
 159
 160     cc_file = series.MakeCcFile(options.process_tags, cover_fname,
 161                                 not options.ignore_bad_tags,
 162                                 options.add_maintainers, options.limit)
 163
 164     # Email the patches out (giving the user time to check / cancel)
 165     cmd = ''
 166     its_a_go = ok or options.ignore_errors
 167     if its_a_go:
 168         cmd = gitutil.EmailPatches(series, cover_fname, args,
 169                 options.dry_run, not options.ignore_bad_tags, cc_file,
 170                 in_reply_to=options.in_reply_to, thread=options.thread)
 171     else:
 172         print(col.Color(col.RED, "Not sending emails due to errors/warnings"))
 173
 174     # For a dry run, just show our actions as a sanity check
 175     if options.dry_run:
 176         series.ShowActions(args, cmd, options.process_tags)
 177         if not its_a_go:
 178             print(col.Color(col.RED, "Email would not be sent"))
 179
 180     os.remove(cc_file)