step

Author: pillo79

extra/ci_collect_logs.py

@@ -5,16 +5,38 @@
 import json
 import re
 
-def artifact_count(count, icon):
+SKIP = -1
+PASS = 0
+WARNING = 1
+ERROR = 2
+FAILURE = 3
+
+TEST_STATUS = [
+		":green_circle:",
+		":yellow_circle:",
+		":red_circle:",
+		":fire:",
+		":new_moon:" # -1
+]
+
+BOARD_STATUS = [
+		":white_check_mark:",
+		":grey_exclamation:",
+		":x:",
+		":fire:",
+		":new_moon:" # -1
+}
+
+def artifact_count(count, status, icons):
 	"""
 	Formats a count and an icon for display. If count is 0,
 	it returns an empty string for the count and replaces the icon with :new_moon:.
 	"""
-	if count == 0:
+	if not count or status == SKIP:
 		count = ""
-		icon = ":new_moon:"
+		status = SKIP
 
-	return f"<code>{count:>3}</code>{icon}"
+	return f"<code>{count:>3}</code>{icons[status]}"
 
 def example_name(sketch_name):
 	match = re.search(r'libraries/([^/]+)/(.*)', sketch_name)
@@ -28,7 +50,7 @@ def example_name(sketch_name):
 TEST_MATRIX = {}
 BOARD_SUMMARY = {}
 
-def log_test(name, board, icon, issues, job_link=None):
+def log_test(name, board, status, issues, job_link=None):
 	"""
 	Logs individual test results into the TEST_MATRIX dictionary.
 	"""
@@ -39,7 +61,7 @@ def log_test(name, board, icon, issues, job_link=None):
 			'errors': 0,
 			'warnings': 0,
 			'job_link': job_link,
-			'icon': ':white_check_mark:'
+			'status': 0
 		}
 
 	board_info = BOARD_SUMMARY[board]
@@ -48,22 +70,18 @@ def log_test(name, board, icon, issues, job_link=None):
 		issues = [ issues ]
 
 	board_info['tests'] += 1
-	if icon == ":fire:":
-		board_info['icon'] = ":fire:"
-	elif icon == ":red_circle:":
-		board_info['icon'] = ":x:"
-		board_info['errors'] += 1
-	elif icon == ":yellow_circle:":
+	if status == WARNING:
 		board_info['warnings'] += 1
-		# Only set to warning if not already an error
-		if not board_info['icon']:
-			board_info['icon'] = ":white_check_mark::grey_exclamation:"
+	elif status == ERROR:
+		board_info['errors'] += 1
+
+	board_info['status'] = max(board_info['status'], status)
 
 	if name not in TEST_MATRIX:
 		TEST_MATRIX[name] = {}
 
 	TEST_MATRIX[name][board] = {
-		'icon': icon,
+		'status': status,
 		'issues': issues
 	}
 
@@ -86,24 +104,24 @@ def process_build_reports():
 
 	for board_data in ALL_BOARD_DATA:
 		# Extract common fields
-		board = board_data.get('board')
-		variant = board_data.get('variant')
-		subarch = board_data.get('subarch')
+		board = board_data['board']
+		variant = board_data['variant']
+		subarch = board_data['subarch']
 
 		# Filename preparation
 		REPORT_FILE = f"arduino-{subarch}-{board}.json"
 
 		# 5. Report File Check
 		if not os.path.exists(REPORT_FILE):
-			log_test('CI test', board, ":fire:", "Report file not found.")
+			log_test('CI test', board, FAILURE, "Report file not found.")
 			continue # Skip to the next board
 
 		# 6. Process Report File
 		try:
 			with open(REPORT_FILE, 'r') as f:
 				report_data = json.load(f)
 		except Exception as e:
-			log_test('CI test', board, ":fire:", f"Error reading report file: {e}")
+			log_test('CI test', board, FAILURE, f"Error reading report file: {e}")
 			continue # Skip to the next board
 
 		# Extract data from the report file
@@ -112,7 +130,7 @@ def process_build_reports():
 
 		reports = report_data.get('boards', [{}])[0].get('sketches', [])
 		if not reports:
-			log_test('CI test', board, ":fire:", "Test report is empty, check full log.", job_link)
+			log_test('CI test', board, FAILURE, "Test report is empty, check full log.", job_link)
 			continue # Skip to the next board
 
 		# 7. Sketch Loop: Iterate through individual sketch reports
@@ -126,17 +144,13 @@ def process_build_reports():
 
 			# Logic to update counters and DETAILS string
 			if not compilation_success:
-				test_icon = ":red_circle:"
+				status = ERROR
 			elif len(sketch_issues): # Implies warnings/non-critical issues
-				test_icon = ":yellow_circle:"
+				status = WARNING
 			else:
-				test_icon = ":green_circle:"
+				status = PASS
 
-			log_test(SKETCH_NAME, board, test_icon, sketch_issues, job_link)
-
-		if not BOARD_SUMMARY[board]['icon']:
-			# If no errors, set to green
-			BOARD_SUMMARY[board]['icon'] = ":white_check_mark:"
+			log_test(SKETCH_NAME, board, status, sketch_issues, job_link)
 
 	artifacts = set(item['artifact'] for item in ALL_BOARD_DATA)
 
@@ -154,25 +168,25 @@ def process_build_reports():
 			board_name = board['board']
 			summary = BOARD_SUMMARY[board_name]
 			job_link = summary['job_link']
-			board_icon = summary['icon']
+			status = summary['status']
 			board_link = f"<a href='{job_link}'>{board_name}</a>" if job_link else board_name
 
-			print(f"<td><code>{board_link}</code></td><td align='center'>{board_icon}</td>")
-			if board_icon == ":fire:":
+			print(f"<td><code>{board_link}</code></td><td align='center'>{BOARD_STATUS[status]}</td>")
+			if status == FAILURE:
 				print(f"<td colspan=3>{TEST_MATRIX['CI test'][board_name]['issues'][0]}</td></tr>")
 			else:
 				print(f"<td align='right'>{(summary['tests'] - summary['errors']) or '-'}</td><td align='right'>{summary['warnings'] or '-'}</td><td align='right'>{summary['errors'] or '-'}</td></tr>")
 	print("</table>\n")
 
 	for artifact in sorted(list(artifacts), reverse=True):
 		artifact_boards = [ item for item in ALL_BOARD_DATA
-							if item['artifact'] == artifact and BOARD_SUMMARY[item['board']]['icon'] != ":fire:" ]
+							if item['artifact'] == artifact and BOARD_SUMMARY[item['board']]['status'] != FAILURE ]
 
 		if not artifact_boards:
 			continue
 
 		print("\n---\n")
-		print(f"<a id='#{artifact}'>\n\n### `{artifact}` test results:\n</a>")
+		print(f"### `{artifact}` test results:")
 
 		# Print the test matrix
 
@@ -188,29 +202,24 @@ def process_build_reports():
 			header_row += f"<th>{header_col}</th>"
 		header_row += "</tr>"
 
-		print("<table>")
+		print("<table id='#{artifact}'>")
 		print(header_row)
 
 		artifact_matrix = { sketch: results for sketch, results in TEST_MATRIX.items() if any(board_data['board'] in results for board_data in artifact_boards) }
 
 		for sketch_name, board_results in artifact_matrix.items():
-			sketch_icon = None
+			sketch_status = SKIP
 			row_data = ""
 			for board_data in artifact_boards:
 				board_name = board_data['board']
-				test_result = board_results.get(board_name, {})
-				icon = test_result['icon'] if test_result else ":new_moon:"
-				if icon == ":fire:" or icon == ":red_circle:":
-					sketch_icon = icon
-				elif icon == ":yellow_circle:" and not sketch_icon:
-					sketch_icon = icon
+				test_result = board_results.get(board_name)
+				status = test_result['status'] if test_result else SKIP
+				sketch_status = max(sketch_status, status)
 				issues = test_result['issues'] if test_result else ""
 				sketch_id = sketch_name.replace('/', '_').replace(' ', '_').replace('-', '_')
 				icon_link = f"<a href='#{sketch_id}_{board_name}'>{icon}</a>" if issues else icon
 				row_data += f"<td align='center'>{icon_link}</a></td>"
-			if not sketch_icon:
-				sketch_icon = ":green_circle:"
-			print(f"<tr><td>{sketch_icon}</td><td><code>{example_name(sketch_name)}</code></td>{row_data}</tr>")
+			print(f"<tr><td>{TEST_STATUS[sketch_status]}</td><td><code>{example_name(sketch_name)}</code></td>{row_data}</tr>")
 		print("</table>\n")
 
 		print(f"<details><summary><b>Error and warning logs for <code>{artifact}</code></b></summary>\n")
@@ -224,7 +233,7 @@ def process_build_reports():
 					continue
 
 				test_result = board_results[board_name]
-				icon = test_result['icon']
+				icon = TEST_STATUS[test_result['status']]
 				issues = test_result['issues']
 				if not issues:
 					continue