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