Spaces:
Build error
Build error
File size: 19,587 Bytes
2550bb7 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 | """Unit tests for Strands HeadroomHookProvider.
These tests use mocks and do NOT require AWS credentials or strands-agents.
They test the internal logic of HeadroomHookProvider in isolation.
For real integration tests, see test_hooks.py.
"""
from __future__ import annotations
import json
import threading
from datetime import datetime, timezone
from unittest.mock import MagicMock
import pytest
# Check if strands-agents is installed for proper skip handling
try:
import strands # noqa: F401
STRANDS_AVAILABLE = True
except ImportError:
STRANDS_AVAILABLE = False
# Skip all tests if Strands not installed
pytestmark = pytest.mark.skipif(not STRANDS_AVAILABLE, reason="strands-agents not installed")
class TestHeadroomHookProviderInit:
"""Tests for HeadroomHookProvider initialization."""
def test_init_with_defaults(self):
"""Initialize with default settings."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider()
assert hook.compress_tool_outputs is True
assert hook.min_tokens_to_compress == 100
assert hook.preserve_errors is True
assert hook.total_tokens_saved == 0
assert hook.metrics_history == []
def test_init_with_custom_config(self):
"""Initialize with custom configuration."""
from headroom import HeadroomConfig
from headroom.integrations.strands import HeadroomHookProvider
config = HeadroomConfig()
config.smart_crusher.min_tokens_to_crush = 200
config.smart_crusher.max_items_after_crush = 20
hook = HeadroomHookProvider(
compress_tool_outputs=False,
min_tokens_to_compress=500,
config=config,
preserve_errors=False,
)
assert hook.compress_tool_outputs is False
assert hook.min_tokens_to_compress == 500
assert hook.config is config
assert hook.preserve_errors is False
def test_init_creates_default_config_if_none(self):
"""Initialize creates a default HeadroomConfig if none provided."""
from headroom import HeadroomConfig
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider()
assert hook.config is not None
assert isinstance(hook.config, HeadroomConfig)
class TestRegisterHooks:
"""Tests for HeadroomHookProvider.register_hooks method."""
def test_register_hooks_adds_callback_to_registry(self):
"""register_hooks adds AfterToolCallEvent callback to registry."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider(compress_tool_outputs=True)
mock_registry = MagicMock()
hook.register_hooks(mock_registry)
# Should have registered exactly one callback for AfterToolCallEvent
assert mock_registry.add_callback.call_count == 1
def test_register_hooks_skips_when_compression_disabled(self):
"""register_hooks does not register callbacks when compression is disabled."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider(compress_tool_outputs=False)
mock_registry = MagicMock()
hook.register_hooks(mock_registry)
# Should not have registered any callbacks
assert mock_registry.add_callback.call_count == 0
class TestCrusherLazyInit:
"""Tests for SmartCrusher lazy initialization."""
def test_crusher_is_lazily_initialized(self):
"""SmartCrusher is not created until first access."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider()
# Directly check internal state - crusher should be None initially
assert hook._crusher is None
# Access the crusher property
crusher = hook.crusher
# Now it should be initialized
assert crusher is not None
assert hook._crusher is crusher
def test_crusher_uses_configured_min_tokens(self):
"""SmartCrusher uses min_tokens_to_compress from hook config."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider(min_tokens_to_compress=250)
crusher = hook.crusher
# The crusher config should have our min_tokens setting
assert crusher.config.min_tokens_to_crush == 250
class TestTokenEstimation:
"""Tests for _estimate_tokens helper method."""
def test_estimate_tokens_empty_string(self):
"""Estimate returns 0 for empty string."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider()
assert hook._estimate_tokens("") == 0
def test_estimate_tokens_short_string(self):
"""Estimate uses ~4 chars per token heuristic."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider()
# 12 chars = 3 tokens (12 // 4)
assert hook._estimate_tokens("hello world!") == 3
# 20 chars = 5 tokens
assert hook._estimate_tokens("a" * 20) == 5
class TestExtractTextContent:
"""Tests for _extract_text_content helper method."""
def test_extract_from_text_content(self):
"""Extract text from content with text field."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider()
result = {"content": [{"text": "Hello world"}]}
extracted = hook._extract_text_content(result)
assert extracted == "Hello world"
def test_extract_from_json_content(self):
"""Extract and serialize JSON content."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider()
result = {"content": [{"json": {"key": "value"}}]}
extracted = hook._extract_text_content(result)
assert extracted == '{"key": "value"}'
def test_extract_empty_content(self):
"""Return empty string for empty content."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider()
result = {"content": []}
extracted = hook._extract_text_content(result)
assert extracted == ""
def test_extract_missing_content(self):
"""Return empty string for missing content key."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider()
result = {}
extracted = hook._extract_text_content(result)
assert extracted == ""
class TestShouldSkipCompression:
"""Tests for _should_skip_compression helper method."""
def test_skip_when_compression_disabled(self):
"""Skip compression when compress_tool_outputs is False."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider(compress_tool_outputs=False)
result = {"content": [{"text": "data"}]}
skip_reason = hook._should_skip_compression(result)
assert skip_reason == "compression_disabled"
def test_skip_error_results_when_preserve_errors_true(self):
"""Skip error results when preserve_errors is True."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider(preserve_errors=True)
result = {"status": "error", "content": [{"text": "Error message"}]}
skip_reason = hook._should_skip_compression(result)
assert skip_reason == "error_result_preserved"
def test_allow_error_results_when_preserve_errors_false(self):
"""Allow error results when preserve_errors is False."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider(preserve_errors=False)
result = {"status": "error", "content": [{"text": "Error message"}]}
skip_reason = hook._should_skip_compression(result)
assert skip_reason is None
def test_skip_empty_content(self):
"""Skip results with empty content."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider()
result = {"content": []}
skip_reason = hook._should_skip_compression(result)
assert skip_reason == "empty_content"
def test_allow_valid_content(self):
"""Allow results with valid content."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider()
result = {"content": [{"text": "some data"}]}
skip_reason = hook._should_skip_compression(result)
assert skip_reason is None
class TestCompressToolResult:
"""Tests for _compress_tool_result hook handler."""
def test_compress_large_tool_output(self):
"""Compresses large tool output and tracks metrics."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider(
compress_tool_outputs=True,
min_tokens_to_compress=10, # Low threshold for testing
)
# Create large JSON output (50 items)
large_data = [{"id": i, "value": f"item-{i}", "data": "x" * 50} for i in range(50)]
large_json = json.dumps(large_data)
mock_event = MagicMock()
mock_event.tool_use = {"name": "get_items", "toolUseId": "tool-123"}
mock_event.result = {"content": [{"text": large_json}]}
hook._compress_tool_result(mock_event)
# Verify metrics were recorded
assert len(hook.metrics_history) == 1
metrics = hook.metrics_history[0]
assert metrics.tool_name == "get_items"
assert metrics.tool_use_id == "tool-123"
assert metrics.tokens_before > 0
def test_skip_compression_below_threshold(self):
"""Does not compress output below token threshold."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider(
compress_tool_outputs=True,
min_tokens_to_compress=10000, # High threshold
)
mock_event = MagicMock()
mock_event.tool_use = {"name": "small_tool", "toolUseId": "tool-456"}
mock_event.result = {"content": [{"text": '{"status": "ok"}'}]}
hook._compress_tool_result(mock_event)
# Metrics should show skipped compression
assert len(hook.metrics_history) == 1
metrics = hook.metrics_history[0]
assert metrics.was_compressed is False
assert "below_threshold" in metrics.skip_reason
def test_skip_compression_when_disabled(self):
"""Does not compress when compression is disabled."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider(compress_tool_outputs=False)
mock_event = MagicMock()
mock_event.tool_use = {"name": "test_tool", "toolUseId": "tool-789"}
mock_event.result = {"content": [{"text": '{"data": "value"}'}]}
hook._compress_tool_result(mock_event)
# Metrics should show compression disabled
assert len(hook.metrics_history) == 1
metrics = hook.metrics_history[0]
assert metrics.was_compressed is False
assert metrics.skip_reason == "compression_disabled"
class TestMetricsTracking:
"""Tests for metrics tracking and aggregation."""
def test_total_tokens_saved_accumulates(self):
"""total_tokens_saved accumulates across compressions."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider(
compress_tool_outputs=True,
min_tokens_to_compress=10,
)
# Simulate two compressions with savings
for i in range(2):
large_data = [{"id": j, "data": "x" * 100} for j in range(50)]
mock_event = MagicMock()
mock_event.tool_use = {"name": f"tool_{i}", "toolUseId": f"id_{i}"}
mock_event.result = {"content": [{"text": json.dumps(large_data)}]}
hook._compress_tool_result(mock_event)
# Should have accumulated some savings
compressed_count = sum(1 for m in hook.metrics_history if m.was_compressed)
if compressed_count > 0:
assert hook.total_tokens_saved >= 0
def test_metrics_history_bounded_to_100(self):
"""metrics_history keeps only last 100 entries."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider(
compress_tool_outputs=True,
min_tokens_to_compress=10,
)
# Directly add 150 metrics
for i in range(150):
hook._record_metrics(
request_id=f"req_{i}",
tool_name=f"tool_{i}",
tool_use_id=f"id_{i}",
tokens_before=100,
tokens_after=50,
was_compressed=True,
skip_reason=None,
)
# Should be bounded at 100
assert len(hook.metrics_history) == 100
# Should contain the most recent entries
last_metric = hook.metrics_history[-1]
assert last_metric.request_id == "req_149"
class TestGetSavingsSummary:
"""Tests for get_savings_summary method."""
def test_empty_summary(self):
"""Returns zero values when no metrics recorded."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider()
summary = hook.get_savings_summary()
assert summary["total_requests"] == 0
assert summary["compressed_requests"] == 0
assert summary["total_tokens_saved"] == 0
assert summary["average_savings_percent"] == 0.0
def test_summary_with_compressions(self):
"""Returns correct summary with recorded compressions."""
from headroom.integrations.strands import HeadroomHookProvider
from headroom.integrations.strands.hooks import CompressionMetrics
hook = HeadroomHookProvider()
# Add metrics manually
hook._metrics_history = [
CompressionMetrics(
request_id="1",
timestamp=datetime.now(timezone.utc),
tool_name="tool_a",
tool_use_id="id_1",
tokens_before=100,
tokens_after=60,
tokens_saved=40,
savings_percent=40.0,
was_compressed=True,
skip_reason=None,
),
CompressionMetrics(
request_id="2",
timestamp=datetime.now(timezone.utc),
tool_name="tool_b",
tool_use_id="id_2",
tokens_before=200,
tokens_after=100,
tokens_saved=100,
savings_percent=50.0,
was_compressed=True,
skip_reason=None,
),
CompressionMetrics(
request_id="3",
timestamp=datetime.now(timezone.utc),
tool_name="tool_c",
tool_use_id="id_3",
tokens_before=50,
tokens_after=50,
tokens_saved=0,
savings_percent=0.0,
was_compressed=False,
skip_reason="below_threshold",
),
]
hook._total_tokens_saved = 140
summary = hook.get_savings_summary()
assert summary["total_requests"] == 3
assert summary["compressed_requests"] == 2
assert summary["total_tokens_saved"] == 140
assert summary["average_savings_percent"] == 45.0 # (40 + 50) / 2
assert summary["total_tokens_before"] == 350
assert summary["total_tokens_after"] == 210
class TestReset:
"""Tests for reset method."""
def test_reset_clears_all_state(self):
"""reset() clears all tracked state."""
from headroom.integrations.strands import HeadroomHookProvider
from headroom.integrations.strands.hooks import CompressionMetrics
hook = HeadroomHookProvider()
# Add some state
hook._metrics_history = [
CompressionMetrics(
request_id="1",
timestamp=datetime.now(timezone.utc),
tool_name="test",
tool_use_id="id_1",
tokens_before=100,
tokens_after=50,
tokens_saved=50,
savings_percent=50.0,
was_compressed=True,
)
]
hook._total_tokens_saved = 50
# Reset
hook.reset()
# Verify all state cleared
assert hook._metrics_history == []
assert hook._total_tokens_saved == 0
assert hook.total_tokens_saved == 0
assert len(hook.metrics_history) == 0
class TestThreadSafety:
"""Tests for thread-safety of metrics tracking."""
def test_concurrent_metric_recording(self):
"""Metrics recording is thread-safe."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider()
def record_metrics(thread_id):
for i in range(10):
hook._record_metrics(
request_id=f"thread_{thread_id}_req_{i}",
tool_name=f"tool_{thread_id}_{i}",
tool_use_id=f"id_{thread_id}_{i}",
tokens_before=100,
tokens_after=50,
was_compressed=True,
skip_reason=None,
)
threads = []
for t_id in range(5):
t = threading.Thread(target=record_metrics, args=(t_id,))
threads.append(t)
t.start()
for t in threads:
t.join()
# Should have recorded 50 metrics (5 threads * 10 each)
# But bounded to 100, so if we had more it would be truncated
assert len(hook.metrics_history) == 50
assert hook.total_tokens_saved == 50 * 50 # 50 metrics * 50 tokens each
class TestUpdateResultContent:
"""Tests for _update_result_content helper method."""
def test_update_preserves_json_structure(self):
"""Updates preserve JSON structure when possible."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider()
result = {"content": [{"json": {"original": "data"}}]}
compressed = '{"compressed": "data"}'
hook._update_result_content(result, compressed)
# Should update with parsed JSON
assert result["content"] == [{"json": {"compressed": "data"}}]
def test_update_uses_text_for_non_json(self):
"""Updates use text format for non-JSON content."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider()
result = {"content": [{"text": "original text"}]}
compressed = "compressed text"
hook._update_result_content(result, compressed)
assert result["content"] == [{"text": "compressed text"}]
def test_update_creates_content_if_empty(self):
"""Creates content list if missing."""
from headroom.integrations.strands import HeadroomHookProvider
hook = HeadroomHookProvider()
result = {"content": []}
hook._update_result_content(result, "new content")
assert result["content"] == [{"text": "new content"}]
|