|
| 1 | +import sys |
| 2 | +import os |
| 3 | +import settings |
| 4 | +import difflib |
| 5 | +import utils |
| 6 | + |
| 7 | +""" |
| 8 | +This script compares the generated CSV coverage files with the ones in the codebase. |
| 9 | +""" |
| 10 | + |
| 11 | + |
| 12 | +def check_file_exists(file): |
| 13 | + if not os.path.exists(file): |
| 14 | + print("Expected file '" + file + "' doesn't exist.", file=sys.stderr) |
| 15 | + return False |
| 16 | + return True |
| 17 | + |
| 18 | + |
| 19 | +def ignore_line_ending(ch): |
| 20 | + return difflib.IS_CHARACTER_JUNK(ch, ws=" \r\n") |
| 21 | + |
| 22 | + |
| 23 | +def compare_files(file1, file2): |
| 24 | + messages = compare_files_str(file1, file2) |
| 25 | + if messages == "": |
| 26 | + return True |
| 27 | + |
| 28 | + print(messages, end="", file=sys.stderr) |
| 29 | + |
| 30 | + return False |
| 31 | + |
| 32 | + |
| 33 | +def compare_files_str(file1, file2): |
| 34 | + diff = difflib.ndiff(open(file1).readlines(), |
| 35 | + open(file2).readlines(), None, ignore_line_ending) |
| 36 | + ret = "" |
| 37 | + for line in diff: |
| 38 | + if line.startswith("+") or line.startswith("-"): |
| 39 | + ret += line |
| 40 | + |
| 41 | + return ret |
| 42 | + |
| 43 | + |
| 44 | +def comment_pr(folder1, folder2, output_file, repo, pr_number, run_id): |
| 45 | + compare_folders(folder1, folder2, output_file) |
| 46 | + size = os.path.getsize(output_file) |
| 47 | + if size == 0: |
| 48 | + print("No difference in the coverage reports") |
| 49 | + return |
| 50 | + |
| 51 | + comment = ":warning: The head of this PR and the base branch were compared for differences in the framework coverage reports. " + \ |
| 52 | + "The generated reports are available in the [artifacts of this workflow run](https://github.com/" + repo + "/actions/runs/" + run_id + "). " + \ |
| 53 | + "The differences will be picked up by the nightly job after the PR gets merged. " |
| 54 | + |
| 55 | + if size < 2000: |
| 56 | + print("There's a small change in the CSV framework coverage reports") |
| 57 | + comment += "The following differences were found: \n\n" |
| 58 | + with open(output_file, 'r') as file: |
| 59 | + comment += file.read() |
| 60 | + else: |
| 61 | + print("There's a large change in the CSV framework coverage reports") |
| 62 | + comment += "The differences can be found in the " + \ |
| 63 | + output_file + " artifact of this job." |
| 64 | + |
| 65 | + post_comment(comment, repo, pr_number) |
| 66 | + |
| 67 | + |
| 68 | +def post_comment(comment, repo, pr_number): |
| 69 | + print("Posting comment to PR #" + str(pr_number)) |
| 70 | + utils.subprocess_run(["gh", "pr", "comment", pr_number, |
| 71 | + "--repo", repo, "--body", comment]) |
| 72 | + |
| 73 | + |
| 74 | +def compare_folders(folder1, folder2, output_file): |
| 75 | + languages = ['java'] |
| 76 | + |
| 77 | + return_md = "" |
| 78 | + |
| 79 | + for lang in languages: |
| 80 | + expected_files = "" |
| 81 | + |
| 82 | + generated_output_rst = settings.generated_output_rst.format( |
| 83 | + language=lang) |
| 84 | + generated_output_csv = settings.generated_output_csv.format( |
| 85 | + language=lang) |
| 86 | + |
| 87 | + # check if files exist in both folder1 and folder 2 |
| 88 | + if not check_file_exists(folder1 + "/" + generated_output_rst): |
| 89 | + expected_files += "- " + generated_output_rst + \ |
| 90 | + " doesn't exist in folder " + folder1 + "\n" |
| 91 | + if not check_file_exists(folder2 + "/" + generated_output_rst): |
| 92 | + expected_files += "- " + generated_output_rst + \ |
| 93 | + " doesn't exist in folder " + folder2 + "\n" |
| 94 | + if not check_file_exists(folder1 + "/" + generated_output_csv): |
| 95 | + expected_files += "- " + generated_output_csv + \ |
| 96 | + " doesn't exist in folder " + folder1 + "\n" |
| 97 | + if not check_file_exists(folder2 + "/" + generated_output_csv): |
| 98 | + expected_files += "- " + generated_output_csv + \ |
| 99 | + " doesn't exist in folder " + folder2 + "\n" |
| 100 | + |
| 101 | + if expected_files != "": |
| 102 | + print("Expected files are missing", file=sys.stderr) |
| 103 | + return_md += "\n### " + lang + "\n\n#### Expected files are missing for " + \ |
| 104 | + lang + "\n" + expected_files + "\n" |
| 105 | + continue |
| 106 | + |
| 107 | + # compare contents of files |
| 108 | + cmp1 = compare_files_str( |
| 109 | + folder1 + "/" + generated_output_rst, folder2 + "/" + generated_output_rst) |
| 110 | + cmp2 = compare_files_str( |
| 111 | + folder1 + "/" + generated_output_csv, folder2 + "/" + generated_output_csv) |
| 112 | + |
| 113 | + if cmp1 != "" or cmp2 != "": |
| 114 | + print("Generated file contents are not matching", file=sys.stderr) |
| 115 | + return_md += "\n### " + lang + "\n\n#### Generated file changes for " + \ |
| 116 | + lang + "\n\n" |
| 117 | + if cmp1 != "": |
| 118 | + return_md += "- Changes to " + generated_output_rst + \ |
| 119 | + ":\n```diff\n" + cmp1 + "```\n\n" |
| 120 | + if cmp2 != "": |
| 121 | + return_md += "- Changes to " + generated_output_csv + \ |
| 122 | + ":\n```diff\n" + cmp2 + "```\n\n" |
| 123 | + |
| 124 | + with open(output_file, 'w', newline='') as out: |
| 125 | + out.write(return_md) |
| 126 | + |
| 127 | + |
| 128 | +comment_pr(sys.argv[1], sys.argv[2], sys.argv[3], |
| 129 | + sys.argv[4], sys.argv[5], sys.argv[6]) |
| 130 | + |
| 131 | + |
| 132 | +# def compare_generated_and_repo_files(): |
| 133 | +# languages = ['java'] |
| 134 | + |
| 135 | +# all_ok = True |
| 136 | + |
| 137 | +# for lang in languages: |
| 138 | +# repo_output_rst = settings.repo_output_rst.format(language=lang) |
| 139 | +# repo_output_csv = settings.repo_output_csv.format(language=lang) |
| 140 | + |
| 141 | +# generated_output_rst = settings.generated_output_rst.format( |
| 142 | +# language=lang) |
| 143 | +# generated_output_csv = settings.generated_output_csv.format( |
| 144 | +# language=lang) |
| 145 | + |
| 146 | +# exists = check_file_exists(repo_output_rst) |
| 147 | +# if not exists: |
| 148 | +# sys.exit(1) |
| 149 | + |
| 150 | +# exists = check_file_exists(repo_output_csv) |
| 151 | +# if not exists: |
| 152 | +# sys.exit(1) |
| 153 | + |
| 154 | +# exists = check_file_exists(generated_output_rst) |
| 155 | +# if not exists: |
| 156 | +# sys.exit(1) |
| 157 | + |
| 158 | +# exists = check_file_exists(generated_output_csv) |
| 159 | +# if not exists: |
| 160 | +# sys.exit(1) |
| 161 | + |
| 162 | +# docs_folder = settings.documentation_folder_no_prefix.format( |
| 163 | +# language=lang) |
| 164 | + |
| 165 | +# rst_ok = compare_files(repo_output_rst, generated_output_rst) |
| 166 | +# if not rst_ok: |
| 167 | +# print("The generated file doesn't match the one in the codebase. Please check and fix file '" + |
| 168 | +# docs_folder + settings.output_rst_file_name + "'.", file=sys.stderr) |
| 169 | +# csv_ok = compare_files(repo_output_csv, generated_output_csv) |
| 170 | +# if not csv_ok: |
| 171 | +# print("The generated file doesn't match the one in the codebase. Please check and fix file '" + |
| 172 | +# docs_folder + settings.output_csv_file_name + "'.", file=sys.stderr) |
| 173 | + |
| 174 | +# if not rst_ok or not csv_ok: |
| 175 | +# print("The generated CSV coverage report files for '" + lang + "' don't match the ones in the codebase. Please update the files in '" + |
| 176 | +# docs_folder + "'. The new files can be downloaded from the artifacts of this job.", file=sys.stderr) |
| 177 | +# all_ok = False |
| 178 | +# else: |
| 179 | +# print("The generated files for '" + lang + |
| 180 | +# "' match the ones in the codebase.") |
| 181 | + |
| 182 | +# if not all_ok: |
| 183 | +# sys.exit(1) |
0 commit comments