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