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