tests: add unit tests, rename, fixes

Author: lkomali

src/aiperf/exporters/__init__.py

@@ -8,8 +8,8 @@
 ## ⚠️        This file is auto-generated by mkinit                 ⚠️ ##
 ## ⚠️             Do not edit below this line                      ⚠️ ##
 ########################################################################
-from aiperf.exporters.console_api_error_insight_exporter import (
-    ConsoleApiErrorInsightExporter,
+from aiperf.exporters.console_api_error_exporter import (
+    ConsoleApiErrorExporter,
     ErrorInsight,
     MaxCompletionTokensDetector,
 )
@@ -60,7 +60,7 @@
 )
 
 __all__ = [
-    "ConsoleApiErrorInsightExporter",
+    "ConsoleApiErrorExporter",
     "ConsoleErrorExporter",
     "ConsoleExperimentalMetricsExporter",
     "ConsoleInternalMetricsExporter",

src/aiperf/exporters/console_api_error_insight_exporter.py renamed to src/aiperf/exporters/console_api_error_exporter.py

@@ -79,6 +79,7 @@ def detect(error_summary):
                     fixes=[
                         "Remove --output-tokens-mean.",
                         'Or use --extra-inputs "max_tokens:<value>".',
+                        "Or run AIPerf with '--use-legacy-max-tokens' to force use of the legacy 'max_tokens' field instead of 'max_completion_tokens'.",
                     ],
                 )
 
@@ -87,7 +88,7 @@ def detect(error_summary):
 
 @implements_protocol(ConsoleExporterProtocol)
 @ConsoleExporterFactory.register(ConsoleExporterType.API_ERRORS)
-class ConsoleApiErrorInsightExporter(AIPerfLoggerMixin):
+class ConsoleApiErrorExporter(AIPerfLoggerMixin):
     """Displays helpful diagnostic panels for known API error patterns."""
 
     DETECTORS = [

tests/unit/exporters/test_console_api_error_exporter.py

@@ -0,0 +1,122 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+import json
+from unittest.mock import MagicMock
+
+import pytest
+from rich.console import Console
+
+from aiperf.exporters.console_api_error_exporter import (
+    ConsoleApiErrorExporter,
+    MaxCompletionTokensDetector,
+)
+from aiperf.exporters.exporter_config import ExporterConfig
+
+
+class MockErrorDetails:
+    def __init__(
+        self, code=400, type="Bad Request", message="", cause=None, details=None
+    ):
+        self.code = code
+        self.type = type
+        self.message = message
+        self.cause = cause
+        self.details = details
+
+
+class MockErrorDetailsCount:
+    def __init__(self, error_details, count):
+        self.error_details = error_details
+        self.count = count
+
+
+def make_summary(err):
+    return [MockErrorDetailsCount(err, 1)]
+
+
+@pytest.fixture
+def basic_error_payload():
+    return json.dumps(
+        {
+            "message": "[{'type': 'extra_forbidden','loc': ('body','max_completion_tokens'),"
+            "'msg': 'Extra inputs are not permitted'}]"
+        }
+    )
+
+
+def test_detector_detects_max_completion_tokens_error(basic_error_payload):
+    """Detector should return an ErrorInsight when TRT-LLM style error appears."""
+    err = MockErrorDetails(message=basic_error_payload)
+    summary = make_summary(err)
+
+    detector = MaxCompletionTokensDetector()
+    insight = detector.detect(summary)
+
+    assert insight is not None
+    assert "max_completion_tokens" in insight.problem
+    assert "max_tokens" in insight.problem
+    assert any("max_completion_tokens" in c for c in insight.causes)
+
+
+def test_detector_returns_none_for_unrelated_error():
+    err = MockErrorDetails(message='{"message": "context_length_exceeded"}')
+    summary = make_summary(err)
+
+    detector = MaxCompletionTokensDetector()
+    assert detector.detect(summary) is None
+
+
+def test_detector_returns_none_when_no_errors():
+    detector = MaxCompletionTokensDetector()
+    assert detector.detect(None) is None
+    assert detector.detect([]) is None
+
+
+def test_exporter_prints_panel_for_detected_error(basic_error_payload):
+    """Exporter should print a Rich panel when the detector returns an insight."""
+    mock_console = MagicMock(spec=Console)
+
+    err = MockErrorDetails(message=basic_error_payload)
+    error_summary = make_summary(err)
+
+    exporter_config = MagicMock(spec=ExporterConfig)
+    exporter_config.results = MagicMock()
+    exporter_config.results.error_summary = error_summary
+
+    exporter = ConsoleApiErrorExporter(exporter_config)
+
+    import asyncio
+
+    asyncio.run(exporter.export(mock_console))
+
+    assert mock_console.print.call_count >= 2
+
+    _, args, _ = mock_console.print.mock_calls[1]
+    panel = args[0]
+
+    assert hasattr(panel, "renderable")
+    panel_text = str(panel.renderable)
+    panel_title = str(panel.title)
+
+    assert "Unsupported Parameter: max_completion_tokens" in panel_title
+
+    assert "The backend rejected 'max_completion_tokens'" in panel_text
+    assert "This backend only supports 'max_tokens'." in panel_text
+
+    assert "--use-legacy-max-tokens" in panel_text
+
+
+def test_exporter_skips_when_no_insight():
+    mock_console = MagicMock(spec=Console)
+
+    exporter_config = MagicMock(spec=ExporterConfig)
+    exporter_config.results = MagicMock()
+    exporter_config.results.error_summary = []
+
+    exporter = ConsoleApiErrorExporter(exporter_config)
+
+    import asyncio
+
+    asyncio.run(exporter.export(mock_console))
+
+    assert mock_console.print.call_count == 0