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 epilog = '''Create patches from commits in a branch, check them and email them
  32 as specified by tags you place in the commits. Use -n to do a dry run first.'''
  33
  34 parser = ArgumentParser(epilog=epilog)
  35 parser.add_argument('-b', '--branch', type=str,
  36     help="Branch to process (by default, the current branch)")
  37 parser.add_argument('-c', '--count', dest='count', type=int,
  38     default=-1, help='Automatically create patches from top n commits')
  39 parser.add_argument('-e', '--end', type=int, default=0,
  40     help='Commits to skip at end of patch list')
  41 parser.add_argument('-D', '--debug', action='store_true',
  42     help='Enabling debugging (provides a full traceback on error)')
  43 parser.add_argument('-p', '--project', default=project.DetectProject(),
  44                     help="Project name; affects default option values and "
  45                     "aliases [default: %(default)s]")
  46 parser.add_argument('-P', '--patchwork-url',
  47                     default='https://patchwork.ozlabs.org',
  48                     help='URL of patchwork server [default: %(default)s]')
  49 parser.add_argument('-s', '--start', dest='start', type=int,
  50     default=0, help='Commit to start creating patches from (0 = HEAD)')
  51 parser.add_argument('-v', '--verbose', action='store_true', dest='verbose',
  52                     default=False, help='Verbose output of errors and warnings')
  53 parser.add_argument('-H', '--full-help', action='store_true', dest='full_help',
  54                     default=False, help='Display the README file')
  55
  56 subparsers = parser.add_subparsers(dest='cmd')
  57 send = subparsers.add_parser('send')
  58 send.add_argument('-i', '--ignore-errors', action='store_true',
  59        dest='ignore_errors', default=False,
  60        help='Send patches email even if patch errors are found')
  61 send.add_argument('-l', '--limit-cc', dest='limit', type=int, default=None,
  62        help='Limit the cc list to LIMIT entries [default: %(default)s]')
  63 send.add_argument('-m', '--no-maintainers', action='store_false',
  64        dest='add_maintainers', default=True,
  65        help="Don't cc the file maintainers automatically")
  66 send.add_argument('-n', '--dry-run', action='store_true', dest='dry_run',
  67        default=False, help="Do a dry run (create but don't email patches)")
  68 send.add_argument('-r', '--in-reply-to', type=str, action='store',
  69                   help="Message ID that this series is in reply to")
  70 send.add_argument('-t', '--ignore-bad-tags', action='store_true',
  71                   default=False, help='Ignore bad tags / aliases')
  72 send.add_argument('-T', '--thread', action='store_true', dest='thread',
  73                   default=False, help='Create patches as a single thread')
  74 send.add_argument('--cc-cmd', dest='cc_cmd', type=str, action='store',
  75        default=None, help='Output cc list for patch file (used by git)')
  76 send.add_argument('--no-binary', action='store_true', dest='ignore_binary',
  77                   default=False,
  78                   help="Do not output contents of changes in binary files")
  79 send.add_argument('--no-check', action='store_false', dest='check_patch',
  80                   default=True,
  81                   help="Don't check for patch compliance")
  82 send.add_argument('--no-tags', action='store_false', dest='process_tags',
  83                   default=True, help="Don't process subject tags as aliases")
  84 send.add_argument('--no-signoff', action='store_false', dest='add_signoff',
  85                   default=True, help="Don't add Signed-off-by to patches")
  86 send.add_argument('--smtp-server', type=str,
  87                   help="Specify the SMTP server to 'git send-email'")
  88
  89 send.add_argument('patchfiles', nargs='*')
  90
  91 test_parser = subparsers.add_parser('test', help='Run tests')
  92 test_parser.add_argument('testname', type=str, default=None, nargs='?',
  93                          help="Specify the test to run")
  94
  95 status = subparsers.add_parser('status',
  96                                help='Check status of patches in patchwork')
  97 status.add_argument('-C', '--show-comments', action='store_true',
  98                     help='Show comments from each patch')
  99 status.add_argument('-d', '--dest-branch', type=str,
 100                     help='Name of branch to create with collected responses')
 101 status.add_argument('-f', '--force', action='store_true',
 102                     help='Force overwriting an existing branch')
 103
 104 # Parse options twice: first to get the project and second to handle
 105 # defaults properly (which depends on project)
 106 # Use parse_known_args() in case 'cmd' is omitted
 107 argv = sys.argv[1:]
 108 args, rest = parser.parse_known_args(argv)
 109 if hasattr(args, 'project'):
 110     settings.Setup(gitutil, parser, args.project, '')
 111     args, rest = parser.parse_known_args(argv)
 112
 113 # If we have a command, it is safe to parse all arguments
 114 if args.cmd:
 115     args = parser.parse_args(argv)
 116 else:
 117     # No command, so insert it after the known arguments and before the ones
 118     # that presumably relate to the 'send' subcommand
 119     nargs = len(rest)
 120     argv = argv[:-nargs] + ['send'] + rest
 121     args = parser.parse_args(argv)
 122
 123 if __name__ != "__main__":
 124     pass
 125
 126 if not args.debug:
 127     sys.tracebacklimit = 0
 128
 129 # Run our meagre tests
 130 if args.cmd == 'test':
 131     import doctest
 132     from patman import func_test
 133
 134     sys.argv = [sys.argv[0]]
 135     result = unittest.TestResult()
 136     suite = unittest.TestSuite()
 137     loader = unittest.TestLoader()
 138     for module in (test_checkpatch.TestPatch, func_test.TestFunctional):
 139         if args.testname:
 140             try:
 141                 suite.addTests(loader.loadTestsFromName(args.testname, module))
 142             except AttributeError:
 143                 continue
 144         else:
 145             suite.addTests(loader.loadTestsFromTestCase(module))
 146     suite.run(result)
 147
 148     for module in ['gitutil', 'settings', 'terminal']:
 149         suite = doctest.DocTestSuite(module)
 150         suite.run(result)
 151
 152     sys.exit(test_util.ReportResult('patman', args.testname, result))
 153
 154 # Process commits, produce patches files, check them, email them
 155 elif args.cmd == 'send':
 156     # Called from git with a patch filename as argument
 157     # Printout a list of additional CC recipients for this patch
 158     if args.cc_cmd:
 159         fd = open(args.cc_cmd, 'r')
 160         re_line = re.compile('(\S*) (.*)')
 161         for line in fd.readlines():
 162             match = re_line.match(line)
 163             if match and match.group(1) == args.patchfiles[0]:
 164                 for cc in match.group(2).split('\0'):
 165                     cc = cc.strip()
 166                     if cc:
 167                         print(cc)
 168         fd.close()
 169
 170     elif args.full_help:
 171         pager = os.getenv('PAGER')
 172         if not pager:
 173             pager = 'more'
 174         fname = os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])),
 175                              'README')
 176         command.Run(pager, fname)
 177
 178     else:
 179         control.send(args)
 180
 181 # Check status of patches in patchwork
 182 elif args.cmd == 'status':
 183     ret_code = 0
 184     try:
 185         control.patchwork_status(args.branch, args.count, args.start, args.end,
 186                                  args.dest_branch, args.force,
 187                                  args.show_comments, args.patchwork_url)
 188     except Exception as e:
 189         terminal.Print('patman: %s: %s' % (type(e).__name__, e),
 190                        colour=terminal.Color.RED)
 191         if args.debug:
 192             print()
 193             traceback.print_exc()
 194         ret_code = 1
 195     sys.exit(ret_code)