chia7712 commented on code in PR #16966:
URL: https://github.com/apache/kafka/pull/16966#discussion_r1728703148
##########
.github/workflows/pr.yml:
##########
@@ -98,3 +98,17 @@ jobs:
-PignoreFailures=true -PmaxParallelForks=2 \
-PmaxTestRetries=1 -PmaxTestRetryFailures=10 \
test
+ - name: Archive JUnit reports
+ if: always()
+ uses: actions/upload-artifact@v4
+ with:
+ name: junit-reports-${{ matrix.java }}
+ path: |
+ **/test-results/**/*.xml
+ **/build/reports/tests/test/index.html
Review Comment:
If we archive only the `index.html`, developers can't trace the "error
stack" from the `index.html` as the linked class page is nonexistent. Maybe we
should cache whole folder of `/build/reports/tests/test/` instead of
`/test-results/**/*.xml`?
##########
.github/scripts/junit.py:
##########
@@ -0,0 +1,175 @@
+# 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 dataclasses
+import datetime
+from functools import partial
+from glob import glob
+import logging
+import os
+import os.path
+import sys
+from typing import Tuple, Optional, List, Iterable
+import xml.etree.ElementTree
+
+
+logger = logging.getLogger()
+logger.setLevel(logging.DEBUG)
+handler = logging.StreamHandler(sys.stderr)
+handler.setLevel(logging.DEBUG)
+logger.addHandler(handler)
+
+
+def get_env(key: str) -> str:
+ value = os.getenv(key)
+ logger.debug(f"Read env {key}: {value}")
+ return value
+
+
[email protected]
+class TestCase:
+ test_name: str
+ class_name: str
+ time: float
+ failure_message: Optional[str]
+ failure_class: Optional[str]
+ failure_stack_trace: Optional[str]
+
+
[email protected]
+class TestSuite:
+ name: str
+ path: str
+ tests: int
+ skipped: int
+ failures: int
+ errors: int
+ time: float
+ test_failures: List[TestCase]
+ skipped_tests: List[TestCase]
+
+ def errors_and_failures() -> int:
+ return self.errors + self.failures
+
+
+def parse_report(workspace_path, report_path, fp) -> Iterable[TestSuite]:
+ stack = []
+ cur_suite = None
+ partial_test_failure = None
+ for (event, elem) in xml.etree.ElementTree.iterparse(fp, events=["start",
"end"]):
+ if event == "start":
+ stack.append(elem)
+ if elem.tag == "testsuite":
+ name = elem.get("name")
+ tests = int(elem.get("tests", 0))
+ skipped = int(elem.get("skipped", 0))
+ failures = int(elem.get("failures", 0))
+ errors = int(elem.get("errors", 0))
+ suite_time = float(elem.get("time", 0.0))
+ cur_suite = TestSuite(name, report_path, tests, skipped,
failures, errors, suite_time, [], [])
+ elif elem.tag == "testcase":
+ test_name = elem.get("name")
+ class_name = elem.get("classname")
+ test_time = float(elem.get("time", 0.0))
+ partial_test_case = partial(TestCase, test_name, class_name,
test_time)
+ elif elem.tag == "failure":
+ failure_message = elem.get("message")
+ failure_class = elem.get("type")
+ failure_stack_trace = elem.text
+ failure = partial_test_case(failure_message, failure_class,
failure_stack_trace)
+ cur_suite.test_failures.append(failure)
+ #print(f"{cur_suite}#{cur_test} {elem.attrib}: {elem.text}")
+ elif elem.tag == "skipped":
+ skipped = partial_test_case(None, None, None)
+ cur_suite.skipped_tests.append(skipped)
+ else:
+ pass
+ elif event == "end":
+ stack.pop()
+ if elem.tag == "testsuite":
+ yield cur_suite
+ cur_suite = None
+ partial_test_failure = None
+ else:
+ logger.error(f"Unhandled xml event {event}: {elem}")
+
+
+def pretty_time_duration(seconds: float) -> str:
+ time_min, time_sec = divmod(int(seconds), 60)
+ time_hour, time_min = divmod(time_min, 60)
+ time_fmt = ""
+ if time_hour > 0:
+ time_fmt += f"{time_hour}h"
+ if time_min > 0:
+ time_fmt += f"{time_min}m"
+ time_fmt += f"{time_sec}s"
+ return time_fmt
+
+
+if __name__ == "__main__":
+ """
+ Parse JUnit XML reports and generate GitHub job summary in Markdown format.
+
+ Exits with status code 0 if no tests failed, 1 otherwise.
+ """
+ if not os.getenv("GITHUB_WORKSPACE"):
+ print("This script is intended to by run by GitHub Actions.")
+ exit(1)
+
+ reports = glob(pathname="**/test-results/**/*.xml", recursive=True)
+ logger.debug(f"Found {len(reports)} JUnit results")
+ workspace_path = get_env("GITHUB_WORKSPACE") # e.g.,
/home/runner/work/apache/kafka
+
+ total_file_count = 0
+ total_tests = 0
+ total_skipped = 0
+ total_failures = 0
+ total_errors = 0
+ total_time = 0
+ table = []
+ for report in reports:
+ with open(report, "r") as fp:
+ logger.debug(f"Parsing {report}")
+ for suite in parse_report(workspace_path, report, fp):
+ total_tests += suite.tests
+ total_skipped += suite.skipped
+ total_failures += suite.failures
+ total_errors += suite.errors
+ total_time += suite.time
+ for test_failure in suite.test_failures:
+ logger.debug(f"Found test failure: {test_failure}")
+ simple_class_name = test_failure.class_name.split(".")[-1]
+ table.append(("❌", simple_class_name,
test_failure.test_name, test_failure.failure_message,
f"{test_failure.time:0.2f}s"))
+ for skipped_test in suite.skipped_tests:
+ simple_class_name = skipped_test.class_name.split(".")[-1]
+ logger.debug(f"Found skipped test: {skipped_test}")
+ table.append(("⚠️", simple_class_name,
skipped_test.test_name, "Skipped", ""))
+ duration = pretty_time_duration(total_time)
+ print(f"{total_tests} tests run in {duration}, {total_failures} failed ❌,
{total_skipped} skipped ⚠️, {total_errors} errors.")
Review Comment:
Could we add the artifact url link? contributors can download the total
reports when they check this great summary? the link
(https://github.com/actions/upload-artifact/issues/50#issuecomment-1856471599)
shows how to get the artifact url and we can pass it through env. WDYT?
--
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]
