|
| 1 | +#!/usr/bin/env python3 |
| 2 | +"""ITK Compatibility Metrics Processor. |
| 3 | +
|
| 4 | +Compiles test outcomes from raw JSON results, retrieves and aggregates historical |
| 5 | +runs from GitHub Release assets, and outputs the updated historical metrics log. |
| 6 | +""" |
| 7 | + |
| 8 | +import datetime |
| 9 | +import json |
| 10 | +import logging |
| 11 | +import os |
| 12 | +import pathlib |
| 13 | +import sys |
| 14 | +import urllib.error |
| 15 | +import urllib.request |
| 16 | + |
| 17 | + |
| 18 | +# --- CONSTANTS --- |
| 19 | +RESULTS_FILE = 'raw_results.json' |
| 20 | +HISTORY_OUTPUT_FILE = 'itk_python.json' |
| 21 | +HISTORY_URL = 'https://github.com/a2aproject/a2a-python/releases/download/nightly-metrics/itk_python.json' |
| 22 | +DEFAULT_HISTORY_LIMIT = 1 |
| 23 | + |
| 24 | +HTTP_STATUS_OK = 200 |
| 25 | +HTTP_STATUS_NOT_FOUND = 404 |
| 26 | + |
| 27 | +# Configure logging to match standard ITK formatting |
| 28 | +logging.basicConfig( |
| 29 | + level=logging.INFO, |
| 30 | +) |
| 31 | +logger = logging.getLogger(__name__) |
| 32 | + |
| 33 | + |
| 34 | +def load_raw_results(filepath: str) -> dict: |
| 35 | + """Loads the raw compatibility results from raw_results.json.""" |
| 36 | + path = pathlib.Path(filepath) |
| 37 | + if not path.exists(): |
| 38 | + logger.error('Results file %s not found.', filepath) |
| 39 | + raise SystemExit(1) |
| 40 | + |
| 41 | + try: |
| 42 | + with path.open() as f: |
| 43 | + return json.load(f) |
| 44 | + except (OSError, json.JSONDecodeError): |
| 45 | + logger.exception('Error loading results JSON') |
| 46 | + raise SystemExit(1) from None |
| 47 | + |
| 48 | + |
| 49 | +def fetch_existing_history(url: str) -> list: |
| 50 | + """Fetches the existing compatibility history from the GitHub release asset. |
| 51 | +
|
| 52 | + If the asset does not exist (HTTP 404), a fresh empty history list is returned. |
| 53 | + For all other network or server errors, the script exits with a non-zero status |
| 54 | + to prevent overwriting and losing historical metrics. |
| 55 | + """ |
| 56 | + try: |
| 57 | + req = urllib.request.Request( # noqa: S310 |
| 58 | + url, headers={'User-Agent': 'Mozilla/5.0'} |
| 59 | + ) |
| 60 | + with urllib.request.urlopen(req, timeout=15) as response: # noqa: S310 |
| 61 | + if response.status == HTTP_STATUS_OK: |
| 62 | + history = json.loads(response.read().decode('utf-8')) |
| 63 | + logger.info( |
| 64 | + 'Successfully retrieved history. Current entries: %d', |
| 65 | + len(history), |
| 66 | + ) |
| 67 | + return history |
| 68 | + logger.error( |
| 69 | + 'Unexpected HTTP status when downloading existing history: %d', |
| 70 | + response.status, |
| 71 | + ) |
| 72 | + raise SystemExit(1) # noqa: TRY301 |
| 73 | + except urllib.error.HTTPError as e: |
| 74 | + if e.code == HTTP_STATUS_NOT_FOUND: |
| 75 | + logger.warning( |
| 76 | + 'No existing history found (HTTP %d). Initializing fresh history.', |
| 77 | + e.code, |
| 78 | + ) |
| 79 | + return [] |
| 80 | + logger.exception( |
| 81 | + 'HTTP error downloading existing history: %d. Aborting to preserve metrics.', |
| 82 | + e.code, |
| 83 | + ) |
| 84 | + raise SystemExit(1) from None |
| 85 | + except Exception: |
| 86 | + logger.exception( |
| 87 | + 'Failed to download existing history. Aborting to preserve metrics.' |
| 88 | + ) |
| 89 | + raise SystemExit(1) from None |
| 90 | + |
| 91 | + |
| 92 | +def load_scenarios(filepath: str) -> list: |
| 93 | + """Loads the list of tests from the scenarios.json definitions.""" |
| 94 | + path = pathlib.Path(filepath) |
| 95 | + if not path.exists(): |
| 96 | + logger.error('Scenarios file %s not found.', filepath) |
| 97 | + raise SystemExit(1) |
| 98 | + |
| 99 | + try: |
| 100 | + with path.open() as f: |
| 101 | + data = json.load(f) |
| 102 | + return data['tests'] |
| 103 | + except (OSError, json.JSONDecodeError, KeyError): |
| 104 | + logger.exception('Failed to load scenarios.json definitions') |
| 105 | + raise SystemExit(1) from None |
| 106 | + |
| 107 | + |
| 108 | +def save_history(filepath: str, history: list) -> None: |
| 109 | + """Saves the updated history back to disk as a release asset candidate.""" |
| 110 | + path = pathlib.Path(filepath) |
| 111 | + try: |
| 112 | + with path.open('w') as f: |
| 113 | + json.dump(history, f, indent=2) |
| 114 | + logger.info( |
| 115 | + 'Successfully compiled and wrote nightly history to: %s', |
| 116 | + filepath, |
| 117 | + ) |
| 118 | + except (OSError, TypeError): |
| 119 | + logger.exception('Error writing history file') |
| 120 | + sys.exit(1) |
| 121 | + |
| 122 | + |
| 123 | +def main() -> None: |
| 124 | + """Orchestrates nightly ITK metrics processing and compiles rolling history.""" |
| 125 | + # 1. Load raw compatibility results |
| 126 | + data = load_raw_results(RESULTS_FILE) |
| 127 | + all_passed = data.get('all_passed', False) |
| 128 | + results = data.get('results', {}) |
| 129 | + |
| 130 | + # 2. Fetch existing history from rolling release |
| 131 | + history = fetch_existing_history(HISTORY_URL) |
| 132 | + |
| 133 | + # 3. Load scenarios list for base metadata |
| 134 | + scenarios_file = ( |
| 135 | + 'scenarios_full.json' |
| 136 | + if os.environ.get('ITK_NIGHTLY_RUN') == 'True' |
| 137 | + else 'scenarios.json' |
| 138 | + ) |
| 139 | + base_scenarios = load_scenarios(scenarios_file) |
| 140 | + # Merge definitions with current outcomes dynamically |
| 141 | + compiled_scenarios = [] |
| 142 | + for name, details in results.items(): |
| 143 | + # Extract the parent scenario name cleanly by splitting on the subtest suffix |
| 144 | + parent_name = name.split('-sub-')[0] |
| 145 | + |
| 146 | + # Find the matching base scenario with an EXACT match! |
| 147 | + matched_base = None |
| 148 | + for base in base_scenarios: |
| 149 | + if parent_name == base['name']: |
| 150 | + matched_base = base |
| 151 | + break |
| 152 | + |
| 153 | + if not matched_base: |
| 154 | + logger.warning( |
| 155 | + 'No matching base scenario found for result key: %s', name |
| 156 | + ) |
| 157 | + continue |
| 158 | + |
| 159 | + # Build the metadata-rich scenario record |
| 160 | + passed = False |
| 161 | + sdks = matched_base.get('sdks', []) |
| 162 | + edges = matched_base.get('edges') |
| 163 | + |
| 164 | + if isinstance(details, dict): |
| 165 | + passed = details.get('passed', False) |
| 166 | + sdks = details.get('sdks', sdks) |
| 167 | + edges = details.get('edges', edges) |
| 168 | + elif isinstance(details, bool): |
| 169 | + passed = details |
| 170 | + |
| 171 | + record = { |
| 172 | + 'name': name, |
| 173 | + 'sdks': sdks, |
| 174 | + 'edges': edges, |
| 175 | + 'protocols': matched_base.get('protocols'), |
| 176 | + 'behavior': matched_base.get('behavior'), |
| 177 | + 'traversal': matched_base.get('traversal', 'euler'), |
| 178 | + 'passed': passed, |
| 179 | + } |
| 180 | + if 'streaming' in matched_base: |
| 181 | + record['streaming'] = matched_base['streaming'] |
| 182 | + if 'build_subtests' in matched_base: |
| 183 | + record['build_subtests'] = matched_base['build_subtests'] |
| 184 | + |
| 185 | + compiled_scenarios.append(record) |
| 186 | + |
| 187 | + # 4. Compile new run metadata |
| 188 | + new_run = { |
| 189 | + 'timestamp': datetime.datetime.now(datetime.timezone.utc).isoformat(), |
| 190 | + 'commit_sha': os.environ.get('GITHUB_SHA', 'local-dev'), |
| 191 | + 'github_run_id': os.environ.get('GITHUB_RUN_ID', '0'), |
| 192 | + 'all_passed': all_passed, |
| 193 | + 'scenarios': compiled_scenarios, |
| 194 | + } |
| 195 | + |
| 196 | + # 5. Merge and Prune rolling window |
| 197 | + history.append(new_run) |
| 198 | + history_limit = int( |
| 199 | + os.environ.get('ITK_HISTORY_LIMIT', str(DEFAULT_HISTORY_LIMIT)) |
| 200 | + ) |
| 201 | + if len(history) > history_limit: |
| 202 | + history = history[-history_limit:] |
| 203 | + logger.info('Pruned history to last %d entries.', history_limit) |
| 204 | + |
| 205 | + # 6. Save candidates back to disk |
| 206 | + save_history(HISTORY_OUTPUT_FILE, history) |
| 207 | + sys.exit(0) |
| 208 | + |
| 209 | + |
| 210 | +if __name__ == '__main__': |
| 211 | + main() |
0 commit comments