14704150874

Committed 28 Apr 2025 09:01AM UTC coverage: 58.885% (+0.05%) from 58.84%

Build # 14704150874

Build Type

Pull #1331

github

Committed by

web-flow

Commit Message

Merge e2980d3b5 into f5f06fd65

Pull Request Pull Request #1331: Add mypy, autoflake and ruff pre-commit checks

Run Details

164 of 216 new or added lines in 21 files covered. (75.93%)

11 existing lines in 7 files now uncovered.

1236 of 2099 relevant lines covered (58.89%)

0.59 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

16.67

/scripts/get-good-commit.py

#!/bin/env python3

import argparse
import logging

from github import Github


def get_good_commit(
    token: str,
    project: str,
    start_ref: str,
    max_tries: int,
    required_checks: list[str],
) -> str:
    """
    Takes a github project and walks up the chain of commits beginning with
    `start_ref`. All the checks in `required_checks` must have run for the commit to
    be considered the best of the `max_tries` commits.

    :param str token: to be used for github token authentication
    :param str project: the github project to work with
    :param str start_ref: the git ref to check first (can be a SHA, a branch name, or a tag name)
    :param int max_tries: the number of parents that the algorithm tries before giving up and returning an empty string
    :param list[str] required_checks: the list of checks that must exist for a commit to be classified as "good"
    """
    g = Github(login_or_token=token)
    repo = g.get_repo(project)
    next_sha = start_ref
    logging.basicConfig(level=logging.INFO)
    logging.info(
        f"""
Scanning for best of commit
Project:         {project}
Start ref:       {start_ref}
Max tries:       {max_tries}
Required checks: {required_checks}
"""
    )

    required_checks_set = {(check, "success") for check in required_checks}
    for i in range(0, max_tries):
        commit = repo.get_commit(sha=next_sha)
        commit_url = f"https://github.com/{project}/commit/{commit.sha}"
        next_sha = commit.parents[0].sha

        logging.info(
            f"{i}. Checking commit {commit_url} (Date: {commit.commit.committer.date}, Combined status: {commit.get_combined_status().state})"
        )
        # Makes sure the required checks are among the ones that have been run
        # on the commit.
        actual_checks = {
            (status.context, status.state) for status in commit.get_statuses()
        }
        if not required_checks_set.issubset(actual_checks):
            logging.warning(
                f"- Ignoring commit because of missing or failed check(s): {required_checks_set - actual_checks}"
            )
            continue

        logging.info(f"Found good commit: {commit_url}")
        return str(commit.sha)

    sha = repo.get_commit(sha=start_ref).sha
    logging.info(f"No good commit found, using the initial one: {start_ref}, aka {sha}")
    return str(sha)


def main() -> None:
    parser = argparse.ArgumentParser(
        description="Find the latest commit that passed tests or return the start-ref commit sha"
    )
    parser.add_argument(
        "--token",
        dest="token",
        type=str,
        default="YOUR-TOKEN-HERE",
        help="your github token",
    )
    parser.add_argument(
        "--project",
        dest="project",
        type=str,
        default="llvm/llvm-project",
        help="github project to use (default: llvm/llvm-project)",
    )
    parser.add_argument(
        "--start-ref",
        dest="start_ref",
        type=str,
        default="main",
        help="git reference (e.g. branch name or sha1) to check first (default: main)",
    )
    parser.add_argument(
        "--max-tries",
        dest="max_tries",
        type=int,
        default="20",
        help="how many commit to try before giving up (default: 20)",
    )
    parser.add_argument(
        "--required-checks",
        dest="required_checks",
        metavar="CHECK",
        nargs="+",
        default=["clang-x86_64-debian-fast"],
        type=str,
        help="list check names that must have run (default: clang-x86_64-debian-fast)",
    )
    args = parser.parse_args()

    sha = get_good_commit(
        token=args.token,
        project=args.project,
        start_ref=args.start_ref,
        required_checks=args.required_checks,
        max_tries=args.max_tries,
    )

    print(sha)


if __name__ == "__main__":
    main()

1	#!/bin/env python3
2
3	import argparse	1✔
4	import logging	1✔
5
6	from github import Github	1✔
7
8
9	def get_good_commit(	1✔
10	token: str,
11	project: str,
12	start_ref: str,
13	max_tries: int,
14	required_checks: list[str],
15	) -> str:
16	"""
17	Takes a github project and walks up the chain of commits beginning with
18	`start_ref`. All the checks in `required_checks` must have run for the commit to
19	be considered the best of the `max_tries` commits.
20
21	:param str token: to be used for github token authentication
22	:param str project: the github project to work with
23	:param str start_ref: the git ref to check first (can be a SHA, a branch name, or a tag name)
24	:param int max_tries: the number of parents that the algorithm tries before giving up and returning an empty string
25	:param list[str] required_checks: the list of checks that must exist for a commit to be classified as "good"
26	"""
27	g = Github(login_or_token=token)	×
28	repo = g.get_repo(project)	×
29	next_sha = start_ref	×
30	logging.basicConfig(level=logging.INFO)	×
31	logging.info(	×
32	f"""
33	Scanning for best of commit
34	Project: {project}
35	Start ref: {start_ref}
36	Max tries: {max_tries}
37	Required checks: {required_checks}
38	"""
39	)
40
NEW 41	required_checks_set = {(check, "success") for check in required_checks}	×
42	for i in range(0, max_tries):	×
43	commit = repo.get_commit(sha=next_sha)	×
44	commit_url = f"https://github.com/{project}/commit/{commit.sha}"	×
45	next_sha = commit.parents[0].sha	×
46
47	logging.info(	×
48	f"{i}. Checking commit {commit_url} (Date: {commit.commit.committer.date}, Combined status: {commit.get_combined_status().state})"
49	)
50	# Makes sure the required checks are among the ones that have been run
51	# on the commit.
52	actual_checks = {	×
53	(status.context, status.state) for status in commit.get_statuses()
54	}
NEW 55	if not required_checks_set.issubset(actual_checks):	×
56	logging.warning(	×
57	f"- Ignoring commit because of missing or failed check(s): {required_checks_set - actual_checks}"
58	)
59	continue	×
60
61	logging.info(f"Found good commit: {commit_url}")	×
NEW 62	return str(commit.sha)	×
63
64	sha = repo.get_commit(sha=start_ref).sha	×
65	logging.info(f"No good commit found, using the initial one: {start_ref}, aka {sha}")	×
NEW 66	return str(sha)	×
67
68
69	def main() -> None:	1✔
70	parser = argparse.ArgumentParser(	×
71	description="Find the latest commit that passed tests or return the start-ref commit sha"
72	)
73	parser.add_argument(	×
74	"--token",
75	dest="token",
76	type=str,
77	default="YOUR-TOKEN-HERE",
78	help="your github token",
79	)
80	parser.add_argument(	×
81	"--project",
82	dest="project",
83	type=str,
84	default="llvm/llvm-project",
85	help="github project to use (default: llvm/llvm-project)",
86	)
87	parser.add_argument(	×
88	"--start-ref",
89	dest="start_ref",
90	type=str,
91	default="main",
92	help="git reference (e.g. branch name or sha1) to check first (default: main)",
93	)
94	parser.add_argument(	×
95	"--max-tries",
96	dest="max_tries",
97	type=int,
98	default="20",
99	help="how many commit to try before giving up (default: 20)",
100	)
101	parser.add_argument(	×
102	"--required-checks",
103	dest="required_checks",
104	metavar="CHECK",
105	nargs="+",
106	default=["clang-x86_64-debian-fast"],
107	type=str,
108	help="list check names that must have run (default: clang-x86_64-debian-fast)",
109	)
110	args = parser.parse_args()	×
111
112	sha = get_good_commit(	×
113	token=args.token,
114	project=args.project,
115	start_ref=args.start_ref,
116	required_checks=args.required_checks,
117	max_tries=args.max_tries,
118	)
119
120	print(sha)	×
121
122
123	if __name__ == "__main__":	1✔
124	main()	×

fedora-llvm-team / llvm-snapshots / 14704150874

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous