robotframework-failuresummary 1.0.0__py3-none-any.whl

RobotFailureSummary/__init__.py

@@ -0,0 +1,10 @@
+from .listener import ROBOT_LISTENER_API_VERSION, start_suite, start_test, output_file, log_file, close
+
+__all__ = [
+    "ROBOT_LISTENER_API_VERSION",
+    "start_suite",
+    "start_test",
+    "output_file",
+    "log_file",
+    "close"
+]

RobotFailureSummary/js/expander.js

@@ -0,0 +1,34 @@
+function openLogTab(url) {
+    var tab = window.open('', 'rf_log_viewer');
+    if (tab) {
+        var parts = url.split('#');
+        var base = parts[0];
+        var hash = parts[1] ? parts[1] : '';
+        var separator = base.indexOf('?') !== -1 ? '&' : '?';
+        
+        // Cache-buster forces log.html to evaluate fresh parameters even on repetitive clicks
+        tab.location.href = base + separator + 'cb=' + new Date().getTime() + (hash ? '#' + hash : '');
+        
+        if (hash) {
+            var checks = 0;
+            var interval = setInterval(function() {
+                checks++;
+                if (tab.util && tab.util.expandElementWithId) {
+                    clearInterval(interval);
+                    try {
+                        // Direct call to RF internal framework to force full ancestral layout tree expansion
+                        tab.util.expandElementWithId(hash);
+                        var element = tab.document.getElementById(hash);
+                        if (element) {
+                            element.scrollIntoView({ block: "center", behavior: "smooth" });
+                        }
+                    } catch(e) {
+                        console.log("Deep expand injection waiting...", e);
+                    }
+                }
+                if (checks > 50) clearInterval(interval);
+            }, 100);
+        }
+        tab.focus();
+    }
+}

RobotFailureSummary/listener.py

@@ -0,0 +1,250 @@
+import atexit
+import logging
+import os
+from robot.api import ExecutionResult
+import html as html_escaper
+import sys
+from urllib3.util.retry import Retry
+import glob
+
+Retry.DEFAULT = Retry(0)
+ROBOT_LISTENER_API_VERSION = 3
+
+_output_dir = None
+_is_pipeline = os.environ.get('RF_SUMMARY_PIPELINE_MODE', 'false').lower() == 'true'
+_close_called = False
+
+_SCREENSHOT_PATTERNS = [
+    'selenium-screenshot-*.png', 'screenshot-*.png', '*-screenshot-*.png', 'selenium-*.png',
+    'browser-screenshot-*.png', 'playwright-screenshot-*.png', 'playwright-*.png',
+    'robotframework-browser-screenshot-*.png', 'browser-*.png', '*.webm', 'trace-*.zip',
+]
+
+_SELENIUM_LOGGERS = ['SeleniumLibrary', 'selenium.webdriver.remote.remote_connection', 'urllib3.connectionpool']
+_BROWSER_LOGGERS = ['Browser', 'Browser.utils', 'Browser.playwright', 'grpc', 'asyncio']
+
+
+def _resolve_output_dir_from_argv():
+    global _output_dir
+    if _output_dir:
+        return _output_dir
+    args = sys.argv
+    for i, arg in enumerate(args):
+        if arg in ('-d', '--outputdir') and i + 1 < len(args):
+            resolved = os.path.abspath(args[i + 1])
+            _output_dir = resolved
+            return resolved
+    return None
+
+
+def find_deepest_failures(item):
+    failures = []
+    if hasattr(item, 'body') and item.body:
+        failing_children = [k for k in item.body if hasattr(k, 'status') and k.status == 'FAIL']
+        if not failing_children:
+            if hasattr(item, 'status') and item.status == 'FAIL':
+                failures.append(item)
+        else:
+            for child in failing_children:
+                failures.extend(find_deepest_failures(child))
+    elif hasattr(item, 'status') and item.status == 'FAIL':
+        failures.append(item)
+    return failures
+
+
+def extract_fail_details(failure):
+    fail_msg = None
+    exception_lines = []
+    raw_messages = []
+    if hasattr(failure, 'messages'):
+        raw_messages.extend(list(failure.messages))
+    if hasattr(failure, 'body'):
+        for item in failure.body:
+            if hasattr(item, 'message') and hasattr(item, 'level'):
+                raw_messages.append(item)
+
+    for msg in raw_messages:
+        level = getattr(msg, 'level', '') or ''
+        text = getattr(msg, 'message', '') or ''
+        if level == 'FAIL' and not fail_msg:
+            fail_msg = text.strip()
+        for raw_line in text.splitlines():
+            line = raw_line.strip()
+            if not line or line == 'None':
+                continue
+            if any(x in line for x in ('Error:', 'Exception:', 'Fault:', 'Warning:')):
+                if line not in exception_lines:
+                    exception_lines.append(line)
+    return fail_msg, exception_lines
+
+
+def _generate_summary():
+    global _close_called, _output_dir
+    if _close_called:
+        return
+    _close_called = True
+
+    print("##[section]Generating failure summary...")
+    _resolve_output_dir_from_argv()
+    output_dir = _output_dir if _output_dir else '.'
+    output_xml = os.path.join(output_dir, 'output.xml')
+    summary_path = os.path.join(output_dir, 'failure_summary.html')
+
+    if not os.path.exists(output_xml):
+        print("##[warning]Could not find output.xml at: " + output_xml)
+        return
+
+    try:
+        result = ExecutionResult(output_xml)
+    except Exception as e:
+        print("##[error]Could not read output.xml. Error: " + str(e))
+        return
+
+    final_report_data = []
+
+    def collect_failures_from_suite(suite):
+        for test in suite.tests:
+            if test.status == 'FAIL':
+                deepest_failure_objects = []
+                if test.setup and test.setup.status == 'FAIL':
+                    deepest_failure_objects.extend(find_deepest_failures(test.setup))
+                for item in test.body:
+                    if hasattr(item, 'status') and item.status == 'FAIL':
+                        deepest_failure_objects.extend(find_deepest_failures(item))
+                if test.teardown and test.teardown.status == 'FAIL':
+                    deepest_failure_objects.extend(find_deepest_failures(test.teardown))
+
+                unique_failures = {failure.id: failure for failure in deepest_failure_objects}.values()
+
+                for failure in unique_failures:
+                    path = []
+                    current = failure
+                    while current and hasattr(current, 'parent') and current.id != test.id:
+                        name_or_type = getattr(current, 'name', None) or getattr(current, 'type', None)
+                        if name_or_type:
+                            path.insert(0, str(name_or_type))
+                        current = current.parent
+
+                    fail_msg, exception_lines = extract_fail_details(failure)
+                    final_report_data.append({
+                        'test_name': test.name,
+                        'test_id': test.id,
+                        'failure_path': ' > '.join(path),
+                        'failure_id': failure.id,
+                        'fail_msg': fail_msg,
+                        'exception_lines': exception_lines
+                    })
+        for child_suite in suite.suites:
+            collect_failures_from_suite(child_suite)
+
+    collect_failures_from_suite(result.suite)
+
+    if not final_report_data:
+        print("##[section]No failures found - all tests passed!")
+        if os.path.exists(summary_path):
+            try: os.remove(summary_path)
+            except Exception: pass
+        return
+
+    # Modern package asset extraction via importlib
+    try:
+        from importlib.resources import files
+        html_template = files("RobotFailureSummary").joinpath("templates", "summary.html").read_text(encoding="utf-8")
+        javascript_code = files("RobotFailureSummary").joinpath("js", "expander.js").read_text(encoding="utf-8")
+    except Exception:
+        current_dir = os.path.dirname(os.path.abspath(__file__))
+        with open(os.path.join(current_dir, 'templates', 'summary.html'), 'r', encoding='utf-8') as tmpl:
+            html_template = tmpl.read()
+        with open(os.path.join(current_dir, 'js', 'expander.js'), 'r', encoding='utf-8') as js_file:
+            javascript_code = js_file.read()
+
+    cards_html = ""
+    for f in final_report_data:
+        path_display = " → ".join([f'<span>{html_escaper.escape(p)}</span>' for p in f['failure_path'].split(' > ') if p])
+        link = f"log.html?expand={f['failure_id']}#{f['failure_id']}"
+        fail_block = f'<div class="detail-block"><div class="detail-label">⛔ Fail Message:</div><div class="fail-text">{html_escaper.escape(f["fail_msg"])}</div></div>' if f.get('fail_msg') else ""
+        
+        exception_block = ""
+        if f.get('exception_lines'):
+            exception_rows = "".join(f'<div class="exception-text">{html_escaper.escape(line)}</div>' for line in f['exception_lines'])
+            exception_block = f'<div class="detail-block"><div class="detail-label">🔴 Exception / Error:</div>{exception_rows}</div>'
+
+        cards_html += f"""
+        <div class="failure-card">
+            <span class="test-name">{html_escaper.escape(f['test_name'])}</span>
+            <div class="path">{path_display}</div>
+            {fail_block}
+            {exception_block}
+            <a class="jump-btn" onclick="openLogTab('{link}')">Jump to Failing Keyword ↗</a>
+        </div>
+        """
+
+    final_html = html_template.replace("{{JAVASCRIPT}}", javascript_code).replace("{{CARDS}}", cards_html)
+
+    try:
+        with open(summary_path, "w", encoding="utf-8") as f:
+            f.write(final_html)
+        print("Failure Summary generated successfully: " + summary_path)
+    except Exception as e:
+        print("##[error]Failed to write failure_summary.html: " + str(e))
+
+
+atexit.register(_generate_summary)
+
+def _mute_noisy_loggers():
+    for name in _SELENIUM_LOGGERS + _BROWSER_LOGGERS:
+        logging.getLogger(name).setLevel(logging.INFO)
+
+def start_suite(data, result):
+    global _output_dir
+    from robot.running.context import EXECUTION_CONTEXTS
+    if EXECUTION_CONTEXTS.current:
+        EXECUTION_CONTEXTS.current.output.set_log_level('TRACE')
+    if hasattr(result, 'suite') and hasattr(result.suite, 'source'):
+        _output_dir = os.path.dirname(result.suite.source)
+    if not _output_dir:
+        _output_dir = os.environ.get('ROBOT_OUTPUT_DIR', None)
+    if not _is_pipeline:
+        cleanup_old_files()
+    _mute_noisy_loggers()
+
+def cleanup_old_files():
+    global _output_dir
+    output_dir = _output_dir if _output_dir else '.'
+    if not os.path.exists(output_dir): return
+    try:
+        for pattern in _SCREENSHOT_PATTERNS:
+            for file_path in glob.glob(os.path.join(output_dir, pattern)):
+                try: os.remove(file_path)
+                except Exception: pass
+        for sub in ('browser', 'screenshots', 'playwright-report'):
+            sub_path = os.path.join(output_dir, sub)
+            if os.path.isdir(sub_path):
+                for pattern in _SCREENSHOT_PATTERNS:
+                    for file_path in glob.glob(os.path.join(sub_path, pattern)):
+                        try: os.remove(file_path)
+                        except Exception: pass
+        summary_path = os.path.join(output_dir, 'failure_summary.html')
+        if os.path.exists(summary_path): os.remove(summary_path)
+    except Exception: pass
+
+def start_test(data, result):
+    from robot.running.context import EXECUTION_CONTEXTS
+    if EXECUTION_CONTEXTS.current:
+        EXECUTION_CONTEXTS.current.output.set_log_level('TRACE')
+
+def output_file(path):
+    global _output_dir
+    _output_dir = os.path.dirname(path)
+
+def log_file(path):
+    try:
+        with open(path, 'r', encoding='utf-8') as f:
+            content = f.read()
+        content = content.replace('"minLevel":"INFO"', '"minLevel":"TRACE"').replace("'minLevel':'INFO'", "'minLevel':'TRACE'")
+        with open(path, 'w', encoding='utf-8') as f:
+            f.write(content)
+    except Exception: pass
+
+def close():
+    _generate_summary()

RobotFailureSummary/templates/summary.html

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Failure Summary</title>
+    <style>
+        body { font-family: Arial, sans-serif; padding: 20px; background: #1a1a2e; color: #eee; }
+        h2 { color: #e94560; }
+        .failure-card { background: #16213e; border-left: 4px solid #e94560; padding: 12px 16px; margin: 10px 0; border-radius: 4px; }
+        .test-name { font-weight: bold; color: #0f3460; background: #e94560; padding: 2px 8px; border-radius: 3px; font-size: 12px; }
+        .path { margin: 8px 0; color: #aaa; font-size: 13px; word-break: break-all; }
+        .path span { color: #fff; }
+        a.jump-btn { display: inline-block; margin-top: 6px; background: #e94560; color: white; padding: 4px 12px; border-radius: 4px; text-decoration: none; font-size: 13px; cursor: pointer; }
+        a.jump-btn:hover { background: #c73652; }
+        .detail-block { margin-top: 10px; padding: 8px 12px; background: #0f1b33; border-radius: 4px; font-size: 13px; border: 1px solid #2a2a4a; }
+        .detail-label { color: #e94560; font-weight: bold; font-size: 11px; letter-spacing: 0.8px; text-transform: uppercase; margin-bottom: 4px; }
+        .fail-text { color: #ffcdd2; font-family: monospace; white-space: pre-wrap; word-break: break-all; }
+        .exception-text { color: #ff6b6b; font-family: monospace; white-space: pre-wrap; word-break: break-all; margin: 2px 0; }
+    </style>
+</head>
+<body>
+    <h2>⚠ Failure Summary — Click to Jump to Root Cause</h2>
+    
+    {{CARDS}}
+
+    <script>
+        {{JAVASCRIPT}}
+    </script>
+</body>
+</html>

robotframework_failuresummary-1.0.0.data/data/RobotFailureSummary/js/expander.js

@@ -0,0 +1,34 @@
+function openLogTab(url) {
+    var tab = window.open('', 'rf_log_viewer');
+    if (tab) {
+        var parts = url.split('#');
+        var base = parts[0];
+        var hash = parts[1] ? parts[1] : '';
+        var separator = base.indexOf('?') !== -1 ? '&' : '?';
+        
+        // Cache-buster forces log.html to evaluate fresh parameters even on repetitive clicks
+        tab.location.href = base + separator + 'cb=' + new Date().getTime() + (hash ? '#' + hash : '');
+        
+        if (hash) {
+            var checks = 0;
+            var interval = setInterval(function() {
+                checks++;
+                if (tab.util && tab.util.expandElementWithId) {
+                    clearInterval(interval);
+                    try {
+                        // Direct call to RF internal framework to force full ancestral layout tree expansion
+                        tab.util.expandElementWithId(hash);
+                        var element = tab.document.getElementById(hash);
+                        if (element) {
+                            element.scrollIntoView({ block: "center", behavior: "smooth" });
+                        }
+                    } catch(e) {
+                        console.log("Deep expand injection waiting...", e);
+                    }
+                }
+                if (checks > 50) clearInterval(interval);
+            }, 100);
+        }
+        tab.focus();
+    }
+}

robotframework_failuresummary-1.0.0.data/data/RobotFailureSummary/templates/summary.html

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Failure Summary</title>
+    <style>
+        body { font-family: Arial, sans-serif; padding: 20px; background: #1a1a2e; color: #eee; }
+        h2 { color: #e94560; }
+        .failure-card { background: #16213e; border-left: 4px solid #e94560; padding: 12px 16px; margin: 10px 0; border-radius: 4px; }
+        .test-name { font-weight: bold; color: #0f3460; background: #e94560; padding: 2px 8px; border-radius: 3px; font-size: 12px; }
+        .path { margin: 8px 0; color: #aaa; font-size: 13px; word-break: break-all; }
+        .path span { color: #fff; }
+        a.jump-btn { display: inline-block; margin-top: 6px; background: #e94560; color: white; padding: 4px 12px; border-radius: 4px; text-decoration: none; font-size: 13px; cursor: pointer; }
+        a.jump-btn:hover { background: #c73652; }
+        .detail-block { margin-top: 10px; padding: 8px 12px; background: #0f1b33; border-radius: 4px; font-size: 13px; border: 1px solid #2a2a4a; }
+        .detail-label { color: #e94560; font-weight: bold; font-size: 11px; letter-spacing: 0.8px; text-transform: uppercase; margin-bottom: 4px; }
+        .fail-text { color: #ffcdd2; font-family: monospace; white-space: pre-wrap; word-break: break-all; }
+        .exception-text { color: #ff6b6b; font-family: monospace; white-space: pre-wrap; word-break: break-all; margin: 2px 0; }
+    </style>
+</head>
+<body>
+    <h2>⚠ Failure Summary — Click to Jump to Root Cause</h2>
+    
+    {{CARDS}}
+
+    <script>
+        {{JAVASCRIPT}}
+    </script>
+</body>
+</html>

robotframework_failuresummary-1.0.0.dist-info/METADATA

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: robotframework-failuresummary
+Version: 1.0.0
+Summary: A standard Robot Framework listener that mutes background engine noise and generates an interactive, deep-linking failure summary report.
+Project-URL: Homepage, https://github.com/Srinivasan2802/robotframework-failuresummary
+Author-email: Srinivasan A <sriniagt.cse@gmail.com>
+License: MIT
+Classifier: Framework :: Robot Framework
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.9
+Requires-Dist: robotframework>=5.0
+Requires-Dist: urllib3

robotframework_failuresummary-1.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+RobotFailureSummary/__init__.py,sha256=ojyMGL_hoyXzyqOdJ9eoH8Wy2tTftzC_keX3WuGpGzc,245
+RobotFailureSummary/listener.py,sha256=rJqaK5P0SJ3K8Xqh8NL06nQragnrVM2WvbBqDsAXjBc,10263
+RobotFailureSummary/js/expander.js,sha256=HzjMMIfHS8dSrby2VhDYW5eXeJmhmXwFwFqx_uNIMM8,1440
+RobotFailureSummary/templates/summary.html,sha256=0xPlByOF9Ps_SPekVg--_PjeN6lzMPFWzvNO8f-ENE8,1619
+robotframework_failuresummary-1.0.0.data/data/RobotFailureSummary/js/expander.js,sha256=HzjMMIfHS8dSrby2VhDYW5eXeJmhmXwFwFqx_uNIMM8,1440
+robotframework_failuresummary-1.0.0.data/data/RobotFailureSummary/templates/summary.html,sha256=0xPlByOF9Ps_SPekVg--_PjeN6lzMPFWzvNO8f-ENE8,1619
+robotframework_failuresummary-1.0.0.dist-info/METADATA,sha256=zjUVEjFGQKnrZgs1Qytbtwzqj1h2y5HGOOOx7ncyxws,693
+robotframework_failuresummary-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+robotframework_failuresummary-1.0.0.dist-info/RECORD,,

robotframework_failuresummary-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any