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