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