From 43512c4be8add4e04c6437bec19e4df8edd4edbd Mon Sep 17 00:00:00 2001 From: Shinwell Hu Date: Mon, 7 Sep 2020 07:35:23 +0000 Subject: [PATCH 1/6] initial draft of tc_review --- advisors/gitee.py | 34 ++++++++++++++--- advisors/tc_review | 91 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 119 insertions(+), 6 deletions(-) create mode 100755 advisors/tc_review diff --git a/advisors/gitee.py b/advisors/gitee.py index 47b45012..46ecffb7 100755 --- a/advisors/gitee.py +++ b/advisors/gitee.py @@ -55,11 +55,12 @@ class Gitee(object): print("WARNING:" + str(err.headers)) return False - def fork_repo(self, repo): + def fork_repo(self, repo, owner="src-openeuler"): """ Fork repository in gitee """ - url = "https://gitee.com/api/v5/repos/src-openeuler/{repo}/forks".format(repo=repo) + url_template = "https://gitee.com/api/v5/repos/{owner}/{repo}/forks" + url = url_template.format(owner=owner, repo=repo) values = {} values["access_token"] = self.token["access_token"] #headers["User-Agent"] = "curl/7.66.0" @@ -79,14 +80,15 @@ class Gitee(object): Yours openEuler-Advisor.""" self.post_issue(repo, title, body) - def get_reviewers(self, repo): + def get_reviewers(self, repo, owner="src-openeuler"): """ Get reviewers of pkg """ - url = "https://gitee.com/api/v5/repos/src-openeuler/{pkg}/collaborators".format(pkg=repo) + url_template = "https://gitee.com/api/v5/repos/{owner}/{pkg}/collaborators" + url = url_template.format(owner=owner, pkg=repo) return self.get_gitee(url) - def create_pr(self, head, repo, version, branch): + def create_pr(self, head, repo, version, branch, owner="src-openeuler"): """ Create PR in gitee """ @@ -95,7 +97,8 @@ class Gitee(object): if reviewer_info: reviewer_list = json.loads(reviewer_info) assignees = ",".join(reviewer["login"] for reviewer in reviewer_list) - url = "https://gitee.com/api/v5/repos/src-openeuler/{pkg}/pulls".format(pkg=repo) + url_template = "https://gitee.com/api/v5/repos/{owner}/{pkg}/pulls" + url = url_template.format(owner=owner, pkg=repo) values = {} values["access_token"] = self.token["access_token"] values["title"] = "Upgrade {pkg} to {ver}".format(pkg=repo, ver=version) @@ -109,6 +112,17 @@ class Gitee(object): Yours openEuler-Advisor.""" return self.post_gitee(url, values) + def create_pr_comment(self, repo, number, body, owner="src-openeuler"): + """ + Post comment to the given specific PR + """ + url_template = "https://gitee.com/api/v5/repos/{owner}/{repo}/pulls/{number}/comments" + url = url_template.format(owner=owner, repo=repo, number=number) + values = {} + values["access_token"] = self.token["access_token"] + values["body"] = body + return self.post_gitee(url, values) + def get_gitee(self, url, headers=None): """ GET from gitee api @@ -123,6 +137,14 @@ class Gitee(object): except urllib.error.HTTPError: return None + def get_pr(self, repo, num, owner="src-openeuler"): + """ + Get detailed information of the given specific PR + """ + url_template = "https://gitee.com/api/v5/repos/{owner}/{repo}/pulls/{number}" + url = url_template.format(owner=owner,repo=repo,number=num) + return self.get_gitee_json(url) + def get_gitee_json(self, url): """ Get and load gitee json response diff --git a/advisors/tc_review b/advisors/tc_review new file mode 100755 index 00000000..1922a02b --- /dev/null +++ b/advisors/tc_review @@ -0,0 +1,91 @@ +#!/usr/bin/python3 +#****************************************************************************** +# Copyright (c) Huawei Technologies Co., Ltd. 2020-2020. All rights reserved. +# licensed under the Mulan PSL v2. +# You can use this software according to the terms and conditions of the Mulan PSL v2. +# You may obtain a copy of Mulan PSL v2 at: +# http://license.coscl.org.cn/MulanPSL2 +# THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR +# PURPOSE. +# See the Mulan PSL v2 for more details. +# ******************************************************************************/ +""" +Review tool for openEuler submission +""" +import os +import argparse +import subprocess + +import gitee + +def check_repository_changes(): + lst_files = subprocess.getoutput("git diff --name-only remotes/origin/master..") + for item in lst_files.splitlines(): + if item.startswith("sig/sigs.yaml"): + return True + else: + return False + +def check_maintainer_changes(): + """ + return a list of SIGs with changed maintainer + """ + sigs = [] + lst_files = subprocess.getoutput("git diff --name-only remotes/origin/master..") + for item in lst_files.splitlines(): + if item.startswith("sig") and item.endswith("OWNERS"): + sigs.append(item.split("/")[1]) + return sigs + + +def review(pr): + review_body = "" + review_body += "[ ] Is the Title of this PR self-explain ?\n" + review_body += "[ ] Is the description of this PR detailed ?\n" + review_body += "[ ] Does the PR match the code changes ?\n" + sigs = check_maintainer_changes() + if sigs: + review_body += "Changes in maintainship detected: \n" + review_body += "[ ] If new maintainer added, are there any assertion on his/her capability on maintainship ?\n" + for sig in sigs: + review_body += "[ ] Do other maintainers of {sig} also agree to add/remove his/her as a maintainer ?\n".format(sig=sig) + if check_repository_changes(): + review_body += "Changes in sigs.yaml detected: \n" + review_body += "[ ] Are all changed repositories managed by proper SIG ?\n" + review_body += "[ ] Do all affected SIG maintainers agree the change ?\n" + return review_body + +def main(): + """ + Main entrance of the functionality + """ + pars = argparse.ArgumentParser() + pars.add_argument("-p", "--pull", type=str, help="Number ID of Pull Request", required=True) + pars.add_argument("-r", "--reuse", help="Reuse current local git dirctory", action="store_true") + + args = pars.parse_args() + + user_gitee = gitee.Gitee() + + gitee_url = "git@gitee.com:openeuler/community" + + if not args.reuse: + subprocess.call(["git", "clone", gitee_url]) + os.chdir(args.repo.split('/')[1]) + + subprocess.call(["git", "fetch", gitee_url, + "pull/{n}/head:pr_{n}".format(n=args.pull)]) + + print("You are reviewing pull {n}".format(n=args.pull)) + + subprocess.call(["git", "checkout", "pr_{n}".format(n=args.pull)]) + subprocess.call(["git", "merge", "--no-edit", "master"]) + + pr = user_gitee.get_pr("community", args.pull, "openeuler") + review_comment = review(pr) + + user_gitee.create_pr_comment("community", args.pull, review_comment, "openeuler") + +if __name__ == "__main__": + main() -- Gitee From 50131b2fae0692fa2c90ee0e4bc7746434a746c2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9C=A8=E5=BE=97=E6=84=9F=E6=83=85=E7=9A=84openEuler?= =?UTF-8?q?=E6=9C=BA=E5=99=A8=E4=BA=BA?= Date: Mon, 7 Sep 2020 15:45:26 +0800 Subject: [PATCH 2/6] add chinese information --- advisors/tc_review | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/advisors/tc_review b/advisors/tc_review index 1922a02b..92c119d9 100755 --- a/advisors/tc_review +++ b/advisors/tc_review @@ -42,18 +42,27 @@ def check_maintainer_changes(): def review(pr): review_body = "" review_body += "[ ] Is the Title of this PR self-explain ?\n" + review_body += " PR的标题是否清晰易懂 ?\n" review_body += "[ ] Is the description of this PR detailed ?\n" + review_body += " PR的内容描述是否详细具体 ?\n" review_body += "[ ] Does the PR match the code changes ?\n" + review_body += " PR和实际代码修改是否一致 ?\n" sigs = check_maintainer_changes() if sigs: review_body += "Changes in maintainship detected: \n" + review_body += "发现维护者变更: \n" review_body += "[ ] If new maintainer added, are there any assertion on his/her capability on maintainship ?\n" + review_body += " 如果新增维护者，有没有对他/她能力的客观说明 ?\n" for sig in sigs: review_body += "[ ] Do other maintainers of {sig} also agree to add/remove his/her as a maintainer ?\n".format(sig=sig) + review_body += " {sig} 中的其他维护者是否同意 增加/删除 维护者 ?\n".format(sig=sig) if check_repository_changes(): review_body += "Changes in sigs.yaml detected: \n" + review_body += "发现 sigs.yaml 变更: \n" review_body += "[ ] Are all changed repositories managed by proper SIG ?\n" + review_body += " 是否所有变更的代码仓都被恰当的 SIG 管理 ?\n" review_body += "[ ] Do all affected SIG maintainers agree the change ?\n" + review_body += " 是否所有受影响的 SIG 的维护者都同意这个变更 ?\n" return review_body def main(): -- Gitee From 90eac65f0ed4e85f58071011ce0538d9e36217b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9C=A8=E5=BE=97=E6=84=9F=E6=83=85=E7=9A=84openEuler?= =?UTF-8?q?=E6=9C=BA=E5=99=A8=E4=BA=BA?= Date: Mon, 7 Sep 2020 16:15:01 +0800 Subject: [PATCH 3/6] add check --- advisors/tc_review | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/advisors/tc_review b/advisors/tc_review index 92c119d9..fa051093 100755 --- a/advisors/tc_review +++ b/advisors/tc_review @@ -20,6 +20,14 @@ import subprocess import gitee def check_repository_changes(): + lst_files = subprocess.getoutput("git diff --name-only remotes/origin/master..") + for item in lst_files.splitlines(): + if item.startswith("repository/src-openeuler.yaml"): + return True + else: + return False + +def check_repository_mgmt_changes(): lst_files = subprocess.getoutput("git diff --name-only remotes/origin/master..") for item in lst_files.splitlines(): if item.startswith("sig/sigs.yaml"): @@ -56,13 +64,16 @@ def review(pr): for sig in sigs: review_body += "[ ] Do other maintainers of {sig} also agree to add/remove his/her as a maintainer ?\n".format(sig=sig) review_body += " {sig} 中的其他维护者是否同意 增加/删除 维护者 ?\n".format(sig=sig) - if check_repository_changes(): + if check_repository_mgmt_changes(): review_body += "Changes in sigs.yaml detected: \n" review_body += "发现 sigs.yaml 变更: \n" review_body += "[ ] Are all changed repositories managed by proper SIG ?\n" review_body += " 是否所有变更的代码仓都被恰当的 SIG 管理 ?\n" review_body += "[ ] Do all affected SIG maintainers agree the change ?\n" review_body += " 是否所有受影响的 SIG 的维护者都同意这个变更 ?\n" + if check_repository_changes(): + review_body += "[ ] Do newly introduced repository license compatible with openEuler ?\n" + review_body += " 新引入的代码仓的license授权是否都与 openEuler 兼容 ?\n" return review_body def main(): -- Gitee From 5365f21b7fe377dc2095785221d38a7ff63d5d81 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9C=A8=E5=BE=97=E6=84=9F=E6=83=85=E7=9A=84openEuler?= =?UTF-8?q?=E6=9C=BA=E5=99=A8=E4=BA=BA?= Date: Mon, 7 Sep 2020 18:55:49 +0800 Subject: [PATCH 4/6] =?UTF-8?q?=E6=94=B9=E8=BF=9B=E5=86=85=E5=AE=B9?= =?UTF-8?q?=E6=8F=90=E7=A4=BA=E6=A0=BC=E5=BC=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- advisors/tc_review | 30 ++++++++++-------------------- 1 file changed, 10 insertions(+), 20 deletions(-) diff --git a/advisors/tc_review b/advisors/tc_review index fa051093..03eba151 100755 --- a/advisors/tc_review +++ b/advisors/tc_review @@ -49,31 +49,21 @@ def check_maintainer_changes(): def review(pr): review_body = "" - review_body += "[ ] Is the Title of this PR self-explain ?\n" - review_body += " PR的标题是否清晰易懂 ?\n" - review_body += "[ ] Is the description of this PR detailed ?\n" - review_body += " PR的内容描述是否详细具体 ?\n" - review_body += "[ ] Does the PR match the code changes ?\n" - review_body += " PR和实际代码修改是否一致 ?\n" + review_body += "[ ] PR的标题是否清晰易懂 ? / Is the Title of this PR self-explain ?\n" + review_body += "[ ] PR的内容描述是否详细具体 ? / Is the description of this PR detailed ?\n" + review_body += "[ ] PR和实际代码修改是否一致 ? / Does the PR match the code changes ?\n" sigs = check_maintainer_changes() if sigs: - review_body += "Changes in maintainship detected: \n" - review_body += "发现维护者变更: \n" - review_body += "[ ] If new maintainer added, are there any assertion on his/her capability on maintainship ?\n" - review_body += " 如果新增维护者，有没有对他/她能力的客观说明 ?\n" + review_body += "发现维护者变更 / Changes in maintainship detected: \n" + review_body += "[ ] 如果新增维护者，有没有对他/她能力的客观说明 ? / If new maintainer added, are there any assertion on his/her capability on maintainship ?\n" for sig in sigs: - review_body += "[ ] Do other maintainers of {sig} also agree to add/remove his/her as a maintainer ?\n".format(sig=sig) - review_body += " {sig} 中的其他维护者是否同意 增加/删除 维护者 ?\n".format(sig=sig) + review_body += "[ ] {sig} 中的其他维护者是否同意 增加/删除 维护者 ? / Do other maintainers of {sig} also agree to add/remove his/her as a maintainer ?\n".format(sig=sig) if check_repository_mgmt_changes(): - review_body += "Changes in sigs.yaml detected: \n" - review_body += "发现 sigs.yaml 变更: \n" - review_body += "[ ] Are all changed repositories managed by proper SIG ?\n" - review_body += " 是否所有变更的代码仓都被恰当的 SIG 管理 ?\n" - review_body += "[ ] Do all affected SIG maintainers agree the change ?\n" - review_body += " 是否所有受影响的 SIG 的维护者都同意这个变更 ?\n" + review_body += "发现 sigs.yaml 变更 / Changes in sigs.yaml detected: \n" + review_body += "[ ] 是否所有变更的代码仓都被恰当的 SIG 管理 ? / Are all changed repositories managed by proper SIG ?\n" + review_body += "[ ] 是否所有受影响的 SIG 的维护者都同意这个变更 ? / Do all affected SIG maintainers agree the change ?\n" if check_repository_changes(): - review_body += "[ ] Do newly introduced repository license compatible with openEuler ?\n" - review_body += " 新引入的代码仓的license授权是否都与 openEuler 兼容 ?\n" + review_body += "[ ] 新引入的代码仓的license授权是否都与 openEuler 兼容 ? / Do newly introduced repository license compatible with openEuler ?\n" return review_body def main(): -- Gitee From 9887a2b9452af46aca2a809f192ad59d368de6a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9C=A8=E5=BE=97=E6=84=9F=E6=83=85=E7=9A=84openEuler?= =?UTF-8?q?=E6=9C=BA=E5=99=A8=E4=BA=BA?= Date: Tue, 8 Sep 2020 09:27:13 +0800 Subject: [PATCH 5/6] =?UTF-8?q?=E5=8F=98=E6=9B=B4review=E4=BF=A1=E6=81=AF?= =?UTF-8?q?=E6=A0=BC=E5=BC=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- advisors/tc_review | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/advisors/tc_review b/advisors/tc_review index 03eba151..6f845b8f 100755 --- a/advisors/tc_review +++ b/advisors/tc_review @@ -48,22 +48,23 @@ def check_maintainer_changes(): def review(pr): - review_body = "" - review_body += "[ ] PR的标题是否清晰易懂 ? / Is the Title of this PR self-explain ?\n" - review_body += "[ ] PR的内容描述是否详细具体 ? / Is the description of this PR detailed ?\n" - review_body += "[ ] PR和实际代码修改是否一致 ? / Does the PR match the code changes ?\n" + review_body = "**以下为 openEuler-Advisor 的 tc_review 生成审视要求清单**\n" + review_body += "[Y] 审视者确认符合要求 [N] 审视者认为不符合要求 [?] 审视者无法确认是否符合要求 [] 审视过程中\n" + review_body += "|审视情况|审视要求|审视要求说明|\n" + review_body += "|:--:|:--|:--|\n" + review_body += "|[ ]|PR的标题是否清晰易懂?|提交标题应该一句话说明本提交实现的内容。|\n" + review_body += "|[ ]|PR的内容描述是否详细具体?|提交的描述应该用一段话说明本提交的背景和实现原理。|\n" + review_body += "|[ ]|PR和实际代码修改是否一致?|提交的说明文字应该和实际代码修改内容保持一致。|\n" sigs = check_maintainer_changes() if sigs: - review_body += "发现维护者变更 / Changes in maintainship detected: \n" - review_body += "[ ] 如果新增维护者，有没有对他/她能力的客观说明 ? / If new maintainer added, are there any assertion on his/her capability on maintainship ?\n" + review_body += "|[ ]|如果新增维护者，有没有对他/她能力的客观说明?|PR提交者需要提出相应的举证说明维护者候选人的技术能力与社区活跃程度。|\n" for sig in sigs: - review_body += "[ ] {sig} 中的其他维护者是否同意 增加/删除 维护者 ? / Do other maintainers of {sig} also agree to add/remove his/her as a maintainer ?\n".format(sig=sig) + review_body += "|[ ]|{sig} 中的其他维护者是否同意增加/删除维护者?|{sig}当前维护者需要有代表确认是否同意接纳或者移除维护者。|\n".format(sig=sig) if check_repository_mgmt_changes(): - review_body += "发现 sigs.yaml 变更 / Changes in sigs.yaml detected: \n" - review_body += "[ ] 是否所有变更的代码仓都被恰当的 SIG 管理 ? / Are all changed repositories managed by proper SIG ?\n" - review_body += "[ ] 是否所有受影响的 SIG 的维护者都同意这个变更 ? / Do all affected SIG maintainers agree the change ?\n" + review_body += "|[ ]|是否所有变更的代码仓都被恰当的 SIG 管理?|代码仓应当由有能力且有意愿的SIG管理，同一类的软件尽量归属同一个SIG。|\n" + review_body += "|[ ]|是否所有受影响的 SIG 的维护者都同意这个变更?|每一个涉及的 SIG 都需要有维护者代表确认是否同意变更。|\n" if check_repository_changes(): - review_body += "[ ] 新引入的代码仓的license授权是否都与 openEuler 兼容 ? / Do newly introduced repository license compatible with openEuler ?\n" + review_body += "|[ ]|新引入的代码仓的 license 授权是否都与 openEuler 兼容?|openEuler只能接纳可以被允许集成的软件|\n" return review_body def main(): -- Gitee From 389c2cf1f849973ac1fc3b86afab859eeb18c987 Mon Sep 17 00:00:00 2001 From: Shinwell Hu Date: Tue, 8 Sep 2020 08:49:32 +0000 Subject: [PATCH 6/6] fix gitee style warning --- advisors/gitee.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/advisors/gitee.py b/advisors/gitee.py index 46ecffb7..8d0b89ad 100755 --- a/advisors/gitee.py +++ b/advisors/gitee.py @@ -142,7 +142,7 @@ class Gitee(object): Get detailed information of the given specific PR """ url_template = "https://gitee.com/api/v5/repos/{owner}/{repo}/pulls/{number}" - url = url_template.format(owner=owner,repo=repo,number=num) + url = url_template.format(owner=owner, repo=repo, number=num) return self.get_gitee_json(url) def get_gitee_json(self, url): -- Gitee