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 argparse import ArgumentParser
  10 import os
  11 import re
  12 import sys
  13 import traceback
  14 import unittest
  15
  16 if __name__ == "__main__":
  17     # Allow 'from patman import xxx to work'
  18     our_path = os.path.dirname(os.path.realpath(__file__))
  19     sys.path.append(os.path.join(our_path, '..'))
  20
  21 # Our modules
  22 from patman import command
  23 from patman import control
  24 from patman import gitutil
  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 def AddCommonArgs(parser):
  32     parser.add_argument('-b', '--branch', type=str,
  33         help="Branch to process (by default, the current branch)")
  34     parser.add_argument('-c', '--count', dest='count', type=int,
  35         default=-1, help='Automatically create patches from top n commits')
  36     parser.add_argument('-e', '--end', type=int, default=0,
  37         help='Commits to skip at end of patch list')
  38     parser.add_argument('-D', '--debug', action='store_true',
  39         help='Enabling debugging (provides a full traceback on error)')
  40     parser.add_argument('-s', '--start', dest='start', type=int,
  41         default=0, help='Commit to start creating patches from (0 = HEAD)')
  42
  43 epilog = '''Create patches from commits in a branch, check them and email them
  44 as specified by tags you place in the commits. Use -n to do a dry run first.'''
  45
  46 parser = ArgumentParser(epilog=epilog)
  47 subparsers = parser.add_subparsers(dest='cmd')
  48 send = subparsers.add_parser('send')
  49 send.add_argument('-H', '--full-help', action='store_true', dest='full_help',
  50        default=False, help='Display the README file')
  51 send.add_argument('-i', '--ignore-errors', action='store_true',
  52        dest='ignore_errors', default=False,
  53        help='Send patches email even if patch errors are found')
  54 send.add_argument('-l', '--limit-cc', dest='limit', type=int, default=None,
  55        help='Limit the cc list to LIMIT entries [default: %(default)s]')
  56 send.add_argument('-m', '--no-maintainers', action='store_false',
  57        dest='add_maintainers', default=True,
  58        help="Don't cc the file maintainers automatically")
  59 send.add_argument('-n', '--dry-run', action='store_true', dest='dry_run',
  60        default=False, help="Do a dry run (create but don't email patches)")
  61 send.add_argument('-p', '--project', default=project.DetectProject(),
  62                   help="Project name; affects default option values and "
  63                   "aliases [default: %(default)s]")
  64 send.add_argument('-r', '--in-reply-to', type=str, action='store',
  65                   help="Message ID that this series is in reply to")
  66 send.add_argument('-t', '--ignore-bad-tags', action='store_true',
  67                   default=False, help='Ignore bad tags / aliases')
  68 send.add_argument('-v', '--verbose', action='store_true', dest='verbose',
  69        default=False, help='Verbose output of errors and warnings')
  70 send.add_argument('-T', '--thread', action='store_true', dest='thread',
  71                   default=False, help='Create patches as a single thread')
  72 send.add_argument('--cc-cmd', dest='cc_cmd', type=str, action='store',
  73        default=None, help='Output cc list for patch file (used by git)')
  74 send.add_argument('--no-binary', action='store_true', dest='ignore_binary',
  75                   default=False,
  76                   help="Do not output contents of changes in binary files")
  77 send.add_argument('--no-check', action='store_false', dest='check_patch',
  78                   default=True,
  79                   help="Don't check for patch compliance")
  80 send.add_argument('--no-tags', action='store_false', dest='process_tags',
  81                   default=True, help="Don't process subject tags as aliases")
  82 send.add_argument('--smtp-server', type=str,
  83                   help="Specify the SMTP server to 'git send-email'")
  84 AddCommonArgs(send)
  85
  86 send.add_argument('patchfiles', nargs='*')
  87
  88 test_parser = subparsers.add_parser('test', help='Run tests')
  89 test_parser.add_argument('testname', type=str, default=None, nargs='?',
  90                          help="Specify the test to run")
  91 AddCommonArgs(test_parser)
  92
  93 # Parse options twice: first to get the project and second to handle
  94 # defaults properly (which depends on project).
  95 argv = sys.argv[1:]
  96 if len(argv) < 1 or argv[0].startswith('-'):
  97     argv = ['send'] + argv
  98 args = parser.parse_args(argv)
  99 if hasattr(args, 'project'):
 100     settings.Setup(gitutil, send, args.project, '')
 101     args = parser.parse_args(argv)
 102
 103 if __name__ != "__main__":
 104     pass
 105
 106 if not args.debug:
 107     sys.tracebacklimit = 0
 108
 109 # Run our meagre tests
 110 if args.cmd == 'test':
 111     import doctest
 112     from patman import func_test
 113
 114     sys.argv = [sys.argv[0]]
 115     result = unittest.TestResult()
 116     suite = unittest.TestSuite()
 117     loader = unittest.TestLoader()
 118     for module in (test_checkpatch.TestPatch, func_test.TestFunctional):
 119         if args.testname:
 120             try:
 121                 suite.addTests(loader.loadTestsFromName(args.testname, module))
 122             except AttributeError:
 123                 continue
 124         else:
 125             suite.addTests(loader.loadTestsFromTestCase(module))
 126     suite.run(result)
 127
 128     for module in ['gitutil', 'settings', 'terminal']:
 129         suite = doctest.DocTestSuite(module)
 130         suite.run(result)
 131
 132     sys.exit(test_util.ReportResult('patman', args.testname, result))
 133
 134 # Process commits, produce patches files, check them, email them
 135 elif args.cmd == 'send':
 136     # Called from git with a patch filename as argument
 137     # Printout a list of additional CC recipients for this patch
 138     if args.cc_cmd:
 139         fd = open(args.cc_cmd, 'r')
 140         re_line = re.compile('(\S*) (.*)')
 141         for line in fd.readlines():
 142             match = re_line.match(line)
 143             if match and match.group(1) == args.patchfiles[0]:
 144                 for cc in match.group(2).split('\0'):
 145                     cc = cc.strip()
 146                     if cc:
 147                         print(cc)
 148         fd.close()
 149
 150     elif args.full_help:
 151         pager = os.getenv('PAGER')
 152         if not pager:
 153             pager = 'more'
 154         fname = os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])),
 155                              'README')
 156         command.Run(pager, fname)
 157
 158     else:
 159         control.send(args)