tools/patman/main.py

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