tools/patman/patman.py

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