blob: 6035536fce34c97c96e7b5c9e9ddd59ab6d4caac [file] [log] [blame]
Patrick Williams45c70172021-03-04 20:25:26 -06001#!/usr/bin/env -S python3 -B
Andrew Jefferyf4019fe2018-05-18 16:42:18 +09302#
3# SPDX-License-Identifier: Apache-2.0
4# Copyright (C) 2018 IBM Corp.
5#
6# Push changes to Gerrit, automatically adding reviewers to the patches by
7# parsing the OpenBMC-style MAINTAINERS file in the root of the repository (if
8# it exists).
9
10from obmc import maintainers
Patrick Williams2deb2e32021-06-21 15:15:20 -050011from typing import cast, Callable, List, Optional
Andrew Jefferyf4019fe2018-05-18 16:42:18 +093012import argparse
13import os
Patrick Williams2deb2e32021-06-21 15:15:20 -050014import sh # type: ignore
Andrew Jefferyf4019fe2018-05-18 16:42:18 +093015import sys
16
Patrick Williams2deb2e32021-06-21 15:15:20 -050017git: Callable[..., str] = sh.git.bake()
Andrew Jefferyf4019fe2018-05-18 16:42:18 +093018
Patrick Williams9a014392021-06-21 14:57:29 -050019
20def get_reviewers(root: Optional[str] = None, mname: str = "MAINTAINERS") -> List[str]:
Patrick Williams2deb2e32021-06-21 15:15:20 -050021 reviewers: List[str] = list()
Andrew Jefferyf4019fe2018-05-18 16:42:18 +093022 if not root:
Patrick Williams9a014392021-06-21 14:57:29 -050023 root = git("rev-parse", "--show-toplevel").strip()
Andrew Jefferyf4019fe2018-05-18 16:42:18 +093024 mfile = os.path.join(root, mname)
Andrew Jeffery39654b12018-05-22 12:38:53 +093025 if not os.path.exists(mfile):
26 return reviewers
Patrick Williams9a014392021-06-21 14:57:29 -050027 with open(mfile, "r") as mstream:
Andrew Jefferyf4019fe2018-05-18 16:42:18 +093028 maintainers.trash_preamble(mstream)
29 block = maintainers.parse_block(mstream)
30 if not block:
31 return reviewers
Patrick Williams9a014392021-06-21 14:57:29 -050032 mlist = cast(
33 List[maintainers.Identity], block[maintainers.LineType.MAINTAINER]
34 )
Andrew Jefferyf4019fe2018-05-18 16:42:18 +093035 reviewers.extend(i.email.address for i in mlist)
36 if maintainers.LineType.REVIEWER in block:
Patrick Williams9a014392021-06-21 14:57:29 -050037 rlist = cast(
38 List[maintainers.Identity], block[maintainers.LineType.REVIEWER]
39 )
Andrew Jefferyf4019fe2018-05-18 16:42:18 +093040 reviewers.extend(i.email.address for i in rlist)
41 return reviewers
42
Patrick Williams9a014392021-06-21 14:57:29 -050043
44def gerrit_refspec_args(
45 reviewers: Optional[List[str]] = None, topic: str = None
46) -> str:
Patrick Williams2deb2e32021-06-21 15:15:20 -050047 argl: List[str] = []
Andrew Jefferyf4019fe2018-05-18 16:42:18 +093048 if reviewers:
Andrew Jeffery3512b932020-06-15 13:09:16 +093049 argl.extend("r={}".format(addr) for addr in reviewers)
50 if topic:
Lei YU8e56c312020-07-30 10:14:47 +000051 argl.append("topic={}".format(topic))
Andrew Jeffery3512b932020-06-15 13:09:16 +093052 return ",".join(argl)
Andrew Jefferyf4019fe2018-05-18 16:42:18 +093053
Patrick Williams9a014392021-06-21 14:57:29 -050054
Andrew Jeffery3512b932020-06-15 13:09:16 +093055def decorate_refspec(refspec: str, topic: str) -> str:
56 gargs = gerrit_refspec_args(get_reviewers(), topic)
Andrew Jeffery39654b12018-05-22 12:38:53 +093057 if not gargs:
58 return refspec
Patrick Williams9a014392021-06-21 14:57:29 -050059 if "%" in refspec:
Andrew Jefferyf4019fe2018-05-18 16:42:18 +093060 return "{},{}".format(refspec, gargs)
61 return "{}%{}".format(refspec, gargs)
62
Patrick Williams9a014392021-06-21 14:57:29 -050063
Andrew Jefferyf4019fe2018-05-18 16:42:18 +093064def do_push(args: argparse.Namespace) -> None:
Patrick Williams2deb2e32021-06-21 15:15:20 -050065 git(
66 "push",
Patrick Williams9a014392021-06-21 14:57:29 -050067 args.remote,
68 decorate_refspec(args.refspec, args.topic),
69 _in=sys.stdin,
70 _out=sys.stdout,
71 _err=sys.stderr,
72 )
73
Andrew Jefferyf4019fe2018-05-18 16:42:18 +093074
75parser = argparse.ArgumentParser()
Patrick Williams9a014392021-06-21 14:57:29 -050076subbies = parser.add_subparsers(dest="subcommand")
Andrew Jefferyf4019fe2018-05-18 16:42:18 +093077subbies.required = True
78push = subbies.add_parser("push", help="Push changes to Gerrit with reviewers")
79push.add_argument("remote")
80push.add_argument("refspec")
Patrick Williams9a014392021-06-21 14:57:29 -050081push.add_argument("topic", nargs="?", default=None)
Andrew Jefferyf4019fe2018-05-18 16:42:18 +093082push.set_defaults(func=do_push)
83
84args = parser.parse_args()
85args.func(args)