generate-summary.py 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  1. #!/usr/bin/env python3
  2. import argparse
  3. import dataclasses
  4. import os, sys
  5. from enum import Enum
  6. from itertools import groupby
  7. from operator import attrgetter
  8. from typing import List
  9. from jinja2 import Environment, FileSystemLoader
  10. from junit_utils import get_property_value, iter_xml_files
  11. class TestStatus(Enum):
  12. PASS = 0
  13. FAIL = 1
  14. ERROR = 2
  15. SKIP = 3
  16. MUTE = 4
  17. def __lt__(self, other):
  18. return self.value < other.value
  19. @dataclasses.dataclass
  20. class TestResult:
  21. classname: str
  22. name: str
  23. status: TestStatus
  24. @property
  25. def status_display(self):
  26. return {
  27. TestStatus.PASS: "PASS",
  28. TestStatus.FAIL: "FAIL",
  29. TestStatus.ERROR: "ERROR",
  30. TestStatus.SKIP: "SKIP",
  31. TestStatus.MUTE: "MUTE",
  32. }[self.status]
  33. def __str__(self):
  34. return f"{self.full_name:<138} {self.status_display}"
  35. @property
  36. def full_name(self):
  37. return f"{self.classname}/{self.name}"
  38. def render_pm(value, url, diff=None):
  39. if value:
  40. text = f"[{value}]({url})"
  41. else:
  42. text = str(value)
  43. if diff is not None and diff != 0:
  44. if diff == 0:
  45. sign = "±"
  46. elif diff < 0:
  47. sign = "-"
  48. else:
  49. sign = "+"
  50. text = f"{text} {sign}{abs(diff)}"
  51. return text
  52. def render_testlist_html(rows, fn):
  53. TEMPLATES_PATH = os.path.join(os.path.dirname(__file__), "templates")
  54. env = Environment(loader=FileSystemLoader(TEMPLATES_PATH))
  55. rows.sort(key=attrgetter('full_name'))
  56. rows.sort(key=attrgetter('status'), reverse=True)
  57. rows = groupby(rows, key=attrgetter('status'))
  58. content = env.get_template("summary.html").render(test_results=rows)
  59. with open(fn, 'w') as fp:
  60. fp.write(content)
  61. def write_summary(lines: List[str]):
  62. summary_fn = os.environ.get("GITHUB_STEP_SUMMARY")
  63. if summary_fn:
  64. fp = open(summary_fn, "at")
  65. else:
  66. fp = sys.stdout
  67. for line in lines:
  68. fp.write(f"{line}\n")
  69. fp.write("\n")
  70. if summary_fn:
  71. fp.close()
  72. def gen_summary(summary_url_prefix, summary_out_folder, paths, ):
  73. summary = [
  74. "| | TESTS | PASSED | ERRORS | FAILED | SKIPPED | MUTED[^1] |",
  75. "| :--- | ---: | -----: | -----: | -----: | ------: | ----: |",
  76. ]
  77. for title, html_fn, path in paths:
  78. tests = failed = errors = muted = skipped = passed = 0
  79. test_results = []
  80. for fn, suite, case in iter_xml_files(path):
  81. tests += 1
  82. classname, name = case.get("classname"), case.get("name")
  83. if case.find("failure") is not None:
  84. failed += 1
  85. status = TestStatus.FAIL
  86. elif case.find("error") is not None:
  87. errors += 1
  88. status = TestStatus.ERROR
  89. elif get_property_value(case, "mute") is not None:
  90. muted += 1
  91. status = TestStatus.MUTE
  92. elif case.find("skipped") is not None:
  93. skipped += 1
  94. status = TestStatus.SKIP
  95. else:
  96. passed += 1
  97. status = TestStatus.PASS
  98. test_result = TestResult(classname=classname, name=name, status=status)
  99. test_results.append(test_result)
  100. report_url = f'{summary_url_prefix}{html_fn}'
  101. render_testlist_html(test_results, os.path.join(summary_out_folder, html_fn))
  102. summary.append(
  103. " | ".join(
  104. [
  105. title,
  106. render_pm(tests, f'{report_url}', 0),
  107. render_pm(passed, f'{report_url}#PASS', 0),
  108. render_pm(errors, f'{report_url}#ERROR', 0),
  109. render_pm(failed, f'{report_url}#FAIL', 0),
  110. render_pm(skipped, f'{report_url}#SKIP', 0),
  111. render_pm(muted, f'{report_url}#MUTE', 0),
  112. ]
  113. )
  114. )
  115. github_srv = os.environ.get('GITHUB_SERVER_URL', 'https://github.com')
  116. repo = os.environ.get('GITHUB_REPOSITORY', 'ydb-platform/ydb')
  117. summary.append("\n")
  118. summary.append(f"[^1]: All mute rules are defined [here]({github_srv}/{repo}/tree/main/.github/config).")
  119. write_summary(lines=summary)
  120. def main():
  121. parser = argparse.ArgumentParser()
  122. parser.add_argument("--summary-out-path", required=True)
  123. parser.add_argument("--summary-url-prefix", required=True)
  124. parser.add_argument("args", nargs="+", metavar="TITLE html_out path")
  125. args = parser.parse_args()
  126. if len(args.args) % 3 != 0:
  127. print("Invalid argument count")
  128. raise SystemExit(-1)
  129. paths = iter(args.args)
  130. title_path = list(zip(paths, paths, paths))
  131. gen_summary(args.summary_url_prefix, args.summary_out_path, title_path)
  132. if __name__ == "__main__":
  133. main()