tools/patman/patman.py

   1 #!/usr/bin/python
   2 #
   3 # Copyright (c) 2011 The Chromium OS Authors.
   4 #
   5 # See file CREDITS for list of people who contributed to this
   6 # project.
   7 #
   8 # This program is free software; you can redistribute it and/or
   9 # modify it under the terms of the GNU General Public License as
  10 # published by the Free Software Foundation; either version 2 of
  11 # the License, or (at your option) any later version.
  12 #
  13 # This program is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with this program; if not, write to the Free Software
  20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  21 # MA 02111-1307 USA
  22 #
  23
  24 """See README for more information"""
  25
  26 from optparse import OptionParser
  27 import os
  28 import re
  29 import sys
  30 import unittest
  31
  32 # Our modules
  33 import checkpatch
  34 import command
  35 import gitutil
  36 import patchstream
  37 import terminal
  38 import test
  39
  40
  41 parser = OptionParser()
  42 parser.add_option('-H', '--full-help', action='store_true', dest='full_help',
  43        default=False, help='Display the README file')
  44 parser.add_option('-c', '--count', dest='count', type='int',
  45        default=-1, help='Automatically create patches from top n commits')
  46 parser.add_option('-i', '--ignore-errors', action='store_true',
  47        dest='ignore_errors', default=False,
  48        help='Send patches email even if patch errors are found')
  49 parser.add_option('-n', '--dry-run', action='store_true', dest='dry_run',
  50        default=False, help="Do a try run (create but don't email patches)")
  51 parser.add_option('-s', '--start', dest='start', type='int',
  52        default=0, help='Commit to start creating patches from (0 = HEAD)')
  53 parser.add_option('-t', '--test', action='store_true', dest='test',
  54                   default=False, help='run tests')
  55 parser.add_option('-v', '--verbose', action='store_true', dest='verbose',
  56        default=False, help='Verbose output of errors and warnings')
  57 parser.add_option('--cc-cmd', dest='cc_cmd', type='string', action='store',
  58        default=None, help='Output cc list for patch file (used by git)')
  59 parser.add_option('--no-tags', action='store_false', dest='process_tags',
  60                   default=True, help="Don't process subject tags as aliaes")
  61
  62 parser.usage = """patman [options]
  63
  64 Create patches from commits in a branch, check them and email them as
  65 specified by tags you place in the commits. Use -n to """
  66
  67 (options, args) = parser.parse_args()
  68
  69 # Run our meagre tests
  70 if options.test:
  71     import doctest
  72
  73     sys.argv = [sys.argv[0]]
  74     suite = unittest.TestLoader().loadTestsFromTestCase(test.TestPatch)
  75     result = unittest.TestResult()
  76     suite.run(result)
  77
  78     suite = doctest.DocTestSuite('gitutil')
  79     suite.run(result)
  80
  81     # TODO: Surely we can just 'print' result?
  82     print result
  83     for test, err in result.errors:
  84         print err
  85     for test, err in result.failures:
  86         print err
  87
  88 # Called from git with a patch filename as argument
  89 # Printout a list of additional CC recipients for this patch
  90 elif options.cc_cmd:
  91     fd = open(options.cc_cmd, 'r')
  92     re_line = re.compile('(\S*) (.*)')
  93     for line in fd.readlines():
  94         match = re_line.match(line)
  95         if match and match.group(1) == args[0]:
  96             for cc in match.group(2).split(', '):
  97                 cc = cc.strip()
  98                 if cc:
  99                     print cc
 100     fd.close()
 101
 102 elif options.full_help:
 103     pager = os.getenv('PAGER')
 104     if not pager:
 105         pager = 'more'
 106     fname = os.path.join(os.path.dirname(sys.argv[0]), 'README')
 107     command.Run(pager, fname)
 108
 109 # Process commits, produce patches files, check them, email them
 110 else:
 111     gitutil.Setup()
 112
 113     if options.count == -1:
 114         # Work out how many patches to send if we can
 115         options.count = gitutil.CountCommitsToBranch() - options.start
 116
 117     col = terminal.Color()
 118     if not options.count:
 119         str = 'No commits found to process - please use -c flag'
 120         print col.Color(col.RED, str)
 121         sys.exit(1)
 122
 123     # Read the metadata from the commits
 124     if options.count:
 125         series = patchstream.GetMetaData(options.start, options.count)
 126         cover_fname, args = gitutil.CreatePatches(options.start, options.count,
 127                 series)
 128
 129     # Fix up the patch files to our liking, and insert the cover letter
 130     series = patchstream.FixPatches(series, args)
 131     if series and cover_fname and series.get('cover'):
 132         patchstream.InsertCoverLetter(cover_fname, series, options.count)
 133
 134     # Do a few checks on the series
 135     series.DoChecks()
 136
 137     # Check the patches, and run them through 'git am' just to be sure
 138     ok = checkpatch.CheckPatches(options.verbose, args)
 139     if not gitutil.ApplyPatches(options.verbose, args,
 140             options.count + options.start):
 141         ok = False
 142
 143     # Email the patches out (giving the user time to check / cancel)
 144     cmd = ''
 145     if ok or options.ignore_errors:
 146         cc_file = series.MakeCcFile(options.process_tags)
 147         cmd = gitutil.EmailPatches(series, cover_fname, args,
 148                 options.dry_run, cc_file)
 149         os.remove(cc_file)
 150
 151     # For a dry run, just show our actions as a sanity check
 152     if options.dry_run:
 153         series.ShowActions(args, cmd, options.process_tags)