|
| 1 | +#!/usr/bin/env python3 |
| 2 | +# |
| 3 | +# ====- code-format-helper, runs code formatters from the ci --*- python -*--==# |
| 4 | +# |
| 5 | +# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| 6 | +# See https://llvm.org/LICENSE.txt for license information. |
| 7 | +# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| 8 | +# |
| 9 | +# ==-------------------------------------------------------------------------==# |
| 10 | + |
| 11 | +import argparse |
| 12 | +import os |
| 13 | +import subprocess |
| 14 | +import sys |
| 15 | +from functools import cached_property |
| 16 | + |
| 17 | +import github |
| 18 | +from github import IssueComment, PullRequest |
| 19 | + |
| 20 | + |
| 21 | +class FormatHelper: |
| 22 | + COMMENT_TAG = "<!--LLVM CODE FORMAT COMMENT: {fmt}-->" |
| 23 | + name = "unknown" |
| 24 | + |
| 25 | + @property |
| 26 | + def comment_tag(self) -> str: |
| 27 | + return self.COMMENT_TAG.replace("fmt", self.name) |
| 28 | + |
| 29 | + def format_run(self, changed_files: [str], args: argparse.Namespace) -> str | None: |
| 30 | + pass |
| 31 | + |
| 32 | + def pr_comment_text(self, diff: str) -> str: |
| 33 | + return f""" |
| 34 | +{self.comment_tag} |
| 35 | +
|
| 36 | +:warning: {self.friendly_name}, {self.name} found issues in your code. :warning: |
| 37 | +
|
| 38 | +<details> |
| 39 | +<summary> |
| 40 | +You can test this locally with the following command: |
| 41 | +</summary> |
| 42 | +
|
| 43 | +``````````bash |
| 44 | +{self.instructions} |
| 45 | +`````````` |
| 46 | +
|
| 47 | +</details> |
| 48 | +
|
| 49 | +<details> |
| 50 | +<summary> |
| 51 | +View the diff from {self.name} here. |
| 52 | +</summary> |
| 53 | +
|
| 54 | +``````````diff |
| 55 | +{diff} |
| 56 | +`````````` |
| 57 | +
|
| 58 | +</details> |
| 59 | +""" |
| 60 | + |
| 61 | + def find_comment( |
| 62 | + self, pr: PullRequest.PullRequest |
| 63 | + ) -> IssueComment.IssueComment | None: |
| 64 | + for comment in pr.as_issue().get_comments(): |
| 65 | + if self.comment_tag in comment.body: |
| 66 | + return comment |
| 67 | + return None |
| 68 | + |
| 69 | + def update_pr(self, diff: str, args: argparse.Namespace): |
| 70 | + repo = github.Github(args.token).get_repo(args.repo) |
| 71 | + pr = repo.get_issue(args.issue_number).as_pull_request() |
| 72 | + |
| 73 | + existing_comment = self.find_comment(pr) |
| 74 | + pr_text = self.pr_comment_text(diff) |
| 75 | + |
| 76 | + if existing_comment: |
| 77 | + existing_comment.edit(pr_text) |
| 78 | + else: |
| 79 | + pr.as_issue().create_comment(pr_text) |
| 80 | + |
| 81 | + def update_pr_success(self, args: argparse.Namespace): |
| 82 | + repo = github.Github(args.token).get_repo(args.repo) |
| 83 | + pr = repo.get_issue(args.issue_number).as_pull_request() |
| 84 | + |
| 85 | + existing_comment = self.find_comment(pr) |
| 86 | + if existing_comment: |
| 87 | + existing_comment.edit( |
| 88 | + f""" |
| 89 | +{self.comment_tag} |
| 90 | +:white_check_mark: With the latest revision this PR passed the {self.friendly_name}. |
| 91 | +""" |
| 92 | + ) |
| 93 | + |
| 94 | + def run(self, changed_files: [str], args: argparse.Namespace): |
| 95 | + diff = self.format_run(changed_files, args) |
| 96 | + if diff: |
| 97 | + self.update_pr(diff, args) |
| 98 | + return False |
| 99 | + else: |
| 100 | + self.update_pr_success(args) |
| 101 | + return True |
| 102 | + |
| 103 | + |
| 104 | +class ClangFormatHelper(FormatHelper): |
| 105 | + name = "clang-format" |
| 106 | + friendly_name = "C/C++ code formatter" |
| 107 | + |
| 108 | + @property |
| 109 | + def instructions(self): |
| 110 | + return " ".join(self.cf_cmd) |
| 111 | + |
| 112 | + @cached_property |
| 113 | + def libcxx_excluded_files(self): |
| 114 | + return [] # HLSL Change - libcxx is not in DXC's repo |
| 115 | + #with open("libcxx/utils/data/ignore_format.txt", "r") as ifd: |
| 116 | + # return [excl.strip() for excl in ifd.readlines()] |
| 117 | + |
| 118 | + def should_be_excluded(self, path: str) -> bool: |
| 119 | + if path in self.libcxx_excluded_files: |
| 120 | + print(f"Excluding file {path}") |
| 121 | + return True |
| 122 | + return False |
| 123 | + |
| 124 | + def filter_changed_files(self, changed_files: [str]) -> [str]: |
| 125 | + filtered_files = [] |
| 126 | + for path in changed_files: |
| 127 | + _, ext = os.path.splitext(path) |
| 128 | + if ext in (".cpp", ".c", ".h", ".hpp", ".hxx", ".cxx"): |
| 129 | + if not self.should_be_excluded(path): |
| 130 | + filtered_files.append(path) |
| 131 | + return filtered_files |
| 132 | + |
| 133 | + def format_run(self, changed_files: [str], args: argparse.Namespace) -> str | None: |
| 134 | + cpp_files = self.filter_changed_files(changed_files) |
| 135 | + if not cpp_files: |
| 136 | + return |
| 137 | + cf_cmd = [ |
| 138 | + "git-clang-format", |
| 139 | + "--diff", |
| 140 | + args.start_rev, |
| 141 | + args.end_rev, |
| 142 | + "--", |
| 143 | + ] + cpp_files |
| 144 | + print(f"Running: {' '.join(cf_cmd)}") |
| 145 | + self.cf_cmd = cf_cmd |
| 146 | + proc = subprocess.run(cf_cmd, capture_output=True) |
| 147 | + |
| 148 | + # formatting needed |
| 149 | + if proc.returncode == 1: |
| 150 | + return proc.stdout.decode("utf-8") |
| 151 | + |
| 152 | + return None |
| 153 | + |
| 154 | + |
| 155 | +class DarkerFormatHelper(FormatHelper): |
| 156 | + name = "darker" |
| 157 | + friendly_name = "Python code formatter" |
| 158 | + |
| 159 | + @property |
| 160 | + def instructions(self): |
| 161 | + return " ".join(self.darker_cmd) |
| 162 | + |
| 163 | + def filter_changed_files(self, changed_files: [str]) -> [str]: |
| 164 | + filtered_files = [] |
| 165 | + for path in changed_files: |
| 166 | + name, ext = os.path.splitext(path) |
| 167 | + if ext == ".py": |
| 168 | + filtered_files.append(path) |
| 169 | + |
| 170 | + return filtered_files |
| 171 | + |
| 172 | + def format_run(self, changed_files: [str], args: argparse.Namespace) -> str | None: |
| 173 | + py_files = self.filter_changed_files(changed_files) |
| 174 | + if not py_files: |
| 175 | + return |
| 176 | + darker_cmd = [ |
| 177 | + "darker", |
| 178 | + "--check", |
| 179 | + "--diff", |
| 180 | + "-r", |
| 181 | + f"{args.start_rev}..{args.end_rev}", |
| 182 | + ] + py_files |
| 183 | + print(f"Running: {' '.join(darker_cmd)}") |
| 184 | + self.darker_cmd = darker_cmd |
| 185 | + proc = subprocess.run(darker_cmd, capture_output=True) |
| 186 | + |
| 187 | + # formatting needed |
| 188 | + if proc.returncode == 1: |
| 189 | + return proc.stdout.decode("utf-8") |
| 190 | + |
| 191 | + return None |
| 192 | + |
| 193 | + |
| 194 | +ALL_FORMATTERS = (DarkerFormatHelper(), ClangFormatHelper()) |
| 195 | + |
| 196 | +if __name__ == "__main__": |
| 197 | + parser = argparse.ArgumentParser() |
| 198 | + parser.add_argument( |
| 199 | + "--token", type=str, required=True, help="GitHub authentiation token" |
| 200 | + ) |
| 201 | + parser.add_argument( |
| 202 | + "--repo", |
| 203 | + type=str, |
| 204 | + default=os.getenv("GITHUB_REPOSITORY", "llvm/llvm-project"), |
| 205 | + help="The GitHub repository that we are working with in the form of <owner>/<repo> (e.g. llvm/llvm-project)", |
| 206 | + ) |
| 207 | + parser.add_argument("--issue-number", type=int, required=True) |
| 208 | + parser.add_argument( |
| 209 | + "--start-rev", |
| 210 | + type=str, |
| 211 | + required=True, |
| 212 | + help="Compute changes from this revision.", |
| 213 | + ) |
| 214 | + parser.add_argument( |
| 215 | + "--end-rev", type=str, required=True, help="Compute changes to this revision" |
| 216 | + ) |
| 217 | + parser.add_argument( |
| 218 | + "--changed-files", |
| 219 | + type=str, |
| 220 | + help="Comma separated list of files that has been changed", |
| 221 | + ) |
| 222 | + |
| 223 | + args = parser.parse_args() |
| 224 | + |
| 225 | + changed_files = [] |
| 226 | + if args.changed_files: |
| 227 | + changed_files = args.changed_files.split(",") |
| 228 | + |
| 229 | + exit_code = 0 |
| 230 | + for fmt in ALL_FORMATTERS: |
| 231 | + if not fmt.run(changed_files, args): |
| 232 | + exit_code = 1 |
| 233 | + |
| 234 | + sys.exit(exit_code) |
0 commit comments