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 parser.add_option('-T', '--thread', action='store_true', dest='thread',
  65                   default=False, help='Create patches as a single thread')
  66
  67 parser.usage += """
  68
  69 Create patches from commits in a branch, check them and email them as
  70 specified by tags you place in the commits. Use -n to do a dry run first."""
  71
  72
  73 # Parse options twice: first to get the project and second to handle
  74 # defaults properly (which depends on project).
  75 (options, args) = parser.parse_args()
  76 settings.Setup(parser, options.project, '')
  77 (options, args) = parser.parse_args()
  78
  79 if __name__ != "__main__":
  80     pass
  81
  82 # Run our meagre tests
  83 elif options.test:
  84     import doctest
  85
  86     sys.argv = [sys.argv[0]]
  87     suite = unittest.TestLoader().loadTestsFromTestCase(test.TestPatch)
  88     result = unittest.TestResult()
  89     suite.run(result)
  90
  91     for module in ['gitutil', 'settings']:
  92         suite = doctest.DocTestSuite(module)
  93         suite.run(result)
  94
  95     # TODO: Surely we can just 'print' result?
  96     print(result)
  97     for test, err in result.errors:
  98         print(err)
  99     for test, err in result.failures:
 100         print(err)
 101
 102 # Called from git with a patch filename as argument
 103 # Printout a list of additional CC recipients for this patch
 104 elif options.cc_cmd:
 105     fd = open(options.cc_cmd, 'r')
 106     re_line = re.compile('(\S*) (.*)')
 107     for line in fd.readlines():
 108         match = re_line.match(line)
 109         if match and match.group(1) == args[0]:
 110             for cc in match.group(2).split(', '):
 111                 cc = cc.strip()
 112                 if cc:
 113                     print(cc)
 114     fd.close()
 115
 116 elif options.full_help:
 117     pager = os.getenv('PAGER')
 118     if not pager:
 119         pager = 'more'
 120     fname = os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])),
 121                          'README')
 122     command.Run(pager, fname)
 123
 124 # Process commits, produce patches files, check them, email them
 125 else:
 126     gitutil.Setup()
 127
 128     if options.count == -1:
 129         # Work out how many patches to send if we can
 130         options.count = gitutil.CountCommitsToBranch() - options.start
 131
 132     col = terminal.Color()
 133     if not options.count:
 134         str = 'No commits found to process - please use -c flag'
 135         sys.exit(col.Color(col.RED, str))
 136
 137     # Read the metadata from the commits
 138     if options.count:
 139         series = patchstream.GetMetaData(options.start, options.count)
 140         cover_fname, args = gitutil.CreatePatches(options.start, options.count,
 141                 series)
 142
 143     # Fix up the patch files to our liking, and insert the cover letter
 144     series = patchstream.FixPatches(series, args)
 145     if series and cover_fname and series.get('cover'):
 146         patchstream.InsertCoverLetter(cover_fname, series, options.count)
 147
 148     # Do a few checks on the series
 149     series.DoChecks()
 150
 151     # Check the patches, and run them through 'git am' just to be sure
 152     if options.check_patch:
 153         ok = checkpatch.CheckPatches(options.verbose, args)
 154     else:
 155         ok = True
 156
 157     cc_file = series.MakeCcFile(options.process_tags, cover_fname,
 158                                 not options.ignore_bad_tags,
 159                                 options.add_maintainers)
 160
 161     # Email the patches out (giving the user time to check / cancel)
 162     cmd = ''
 163     its_a_go = ok or options.ignore_errors
 164     if its_a_go:
 165         cmd = gitutil.EmailPatches(series, cover_fname, args,
 166                 options.dry_run, not options.ignore_bad_tags, cc_file,
 167                 in_reply_to=options.in_reply_to, thread=options.thread)
 168     else:
 169         print(col.Color(col.RED, "Not sending emails due to errors/warnings"))
 170
 171     # For a dry run, just show our actions as a sanity check
 172     if options.dry_run:
 173         series.ShowActions(args, cmd, options.process_tags)
 174         if not its_a_go:
 175             print(col.Color(col.RED, "Email would not be sent"))
 176
 177     os.remove(cc_file)