areusch commented on code in PR #12367: URL: https://github.com/apache/tvm/pull/12367#discussion_r943732215
########## tests/scripts/check_pr.py: ########## @@ -0,0 +1,151 @@ +#!/usr/bin/env python3 +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +import argparse +import re +import os +import textwrap +from dataclasses import dataclass +from typing import Any, List, Callable + + +from git_utils import GitHubRepo, parse_remote, git +from cmd_utils import init_log, tags_from_title + + +GITHUB_USERNAME_REGEX = re.compile(r"(@[a-zA-Z0-9-]+)", flags=re.MULTILINE) +OK = object() + + +@dataclass +class Check: + # check to run, returning OK means it passed, anything else means it failed + check: Callable[[str], Any] + + # function to call to generate the error message + error_fn: Callable[[Any], str] + + +def non_empty(s: str): + if len(s) == 0: Review Comment: should we s.trim()? ########## tests/scripts/check_pr.py: ########## @@ -0,0 +1,151 @@ +#!/usr/bin/env python3 +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +import argparse +import re +import os +import textwrap +from dataclasses import dataclass +from typing import Any, List, Callable + + +from git_utils import GitHubRepo, parse_remote, git +from cmd_utils import init_log, tags_from_title + + +GITHUB_USERNAME_REGEX = re.compile(r"(@[a-zA-Z0-9-]+)", flags=re.MULTILINE) +OK = object() + + +@dataclass +class Check: + # check to run, returning OK means it passed, anything else means it failed + check: Callable[[str], Any] + + # function to call to generate the error message + error_fn: Callable[[Any], str] + + +def non_empty(s: str): + if len(s) == 0: + return False + return OK + + +def usernames(s: str): + m = GITHUB_USERNAME_REGEX.findall(s) + if m and len(m) > 0: + return m + return OK + + +def tags(s: str): + items = tags_from_title(s) + if len(items) == 0: + return False + return OK + + +def trailing_period(s: str): + if s.endswith("."): + return False + return OK + + +title_checks = [ + Check(check=non_empty, error_fn=lambda d: "PR must have a title but title was empty"), + Check(check=trailing_period, error_fn=lambda d: "PR must not end in a tailing '.'"), + Check( + check=usernames, + error_fn=lambda d: f"PR title must not tag anyone but found these usernames: {d}", + ), + Check( + check=tags, + error_fn=lambda d: f"PR title must have a topic tag like [the_topic] (e.g. [tir], [relay], etc.) but found none", + ), +] +body_checks = [ + Check(check=non_empty, error_fn=lambda d: "PR must have a body but body was empty"), + Check( + check=usernames, + error_fn=lambda d: f"PR body must not tag anyone but found these usernames: {d}", + ), +] + + +def run_checks(checks: List[Check], s: str, name: str) -> bool: + errors = [(c, c.check(s)) for c in checks] + errors = [item for item in errors if item[1] != OK] + errors = [] + print(f"Running checks for {name}") + print(textwrap.indent(s, prefix=" ")) + passed = True + print(" Checks:") + for i, check in enumerate(checks): + result = check.check(s) + if result == OK: + print(f" [{i+1}] {check.check.__name__}: PASSED") + else: + passed = False + msg = check.error_fn(result) + print(f" [{i+1}] {check.check.__name__}: FAILED: {msg}") + + return passed + + +if __name__ == "__main__": + init_log() + help = "Check a PR's title and body for conformance to guidelines" + parser = argparse.ArgumentParser(description=help) + parser.add_argument("--pr", required=True) + parser.add_argument("--remote", default="origin", help="ssh remote to parse") + parser.add_argument( + "--pr-body", help="(testing) PR body to use instead of fetching from GitHub" + ) + parser.add_argument( + "--pr-title", help="(testing) PR title to use instead of fetching from GitHub" + ) + args = parser.parse_args() + + try: + pr = int(args.pr) + except ValueError: + print(f"PR was not a number: {args.pr}") + exit(0) + + if args.pr_body: + body = args.pr_body + title = args.pr_title + else: + remote = git(["config", "--get", f"remote.{args.remote}.url"]) + user, repo = parse_remote(remote) + + github = GitHubRepo(token=os.environ["GITHUB_TOKEN"], user=user, repo=repo) + pr = github.get(f"pulls/{args.pr}") + body = pr["body"] Review Comment: wondering if we should just pass `pr` to a check function and not have title/body separately? ########## tests/scripts/check_pr.py: ########## @@ -0,0 +1,151 @@ +#!/usr/bin/env python3 +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +import argparse +import re +import os +import textwrap +from dataclasses import dataclass +from typing import Any, List, Callable + + +from git_utils import GitHubRepo, parse_remote, git +from cmd_utils import init_log, tags_from_title + + +GITHUB_USERNAME_REGEX = re.compile(r"(@[a-zA-Z0-9-]+)", flags=re.MULTILINE) +OK = object() + + +@dataclass +class Check: + # check to run, returning OK means it passed, anything else means it failed + check: Callable[[str], Any] + + # function to call to generate the error message + error_fn: Callable[[Any], str] + + +def non_empty(s: str): + if len(s) == 0: + return False Review Comment: could consider just adding a dedicated `FAIL` here too ########## tests/scripts/check_pr.py: ########## @@ -0,0 +1,151 @@ +#!/usr/bin/env python3 +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +import argparse +import re +import os +import textwrap +from dataclasses import dataclass +from typing import Any, List, Callable + + +from git_utils import GitHubRepo, parse_remote, git +from cmd_utils import init_log, tags_from_title + + +GITHUB_USERNAME_REGEX = re.compile(r"(@[a-zA-Z0-9-]+)", flags=re.MULTILINE) +OK = object() Review Comment: :clap: ########## tests/scripts/check_pr.py: ########## @@ -0,0 +1,151 @@ +#!/usr/bin/env python3 +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +import argparse +import re +import os +import textwrap +from dataclasses import dataclass +from typing import Any, List, Callable + + +from git_utils import GitHubRepo, parse_remote, git +from cmd_utils import init_log, tags_from_title + + +GITHUB_USERNAME_REGEX = re.compile(r"(@[a-zA-Z0-9-]+)", flags=re.MULTILINE) +OK = object() + + +@dataclass +class Check: + # check to run, returning OK means it passed, anything else means it failed + check: Callable[[str], Any] + + # function to call to generate the error message + error_fn: Callable[[Any], str] + + +def non_empty(s: str): + if len(s) == 0: + return False + return OK + + +def usernames(s: str): + m = GITHUB_USERNAME_REGEX.findall(s) + if m and len(m) > 0: Review Comment: i think len(m) check isn't needed -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
