Files
Aperant/tests/qa_test_helpers.py
T
StillKnotKnown ed93df698b test: improve backend agent test coverage to 94% (#1779)
* fix: add mock reset fixtures and resolve async iterator mock issues

- Add pytest_runtest_setup and pytest_runtest_teardown hooks to reset
  shared module-level mocks between tests
- Add module-specific mock reset fixtures for test_qa_fixer and
  test_qa_reviewer to prevent test interference
- Fix async iterator mock for receive_response to properly return
  an AsyncIteratorMock instance
- Update test_qa_fixer.py and test_qa_reviewer.py with proper mock
  setup for isolated test execution

* docs(agents): add CLAUDE.md documentation for agents module

Documents the agents module architecture including:
- Module components (coder, planner, session, memory_manager, base)
- Single-agent architecture without external parallelism
- Subagent architecture clarification

* Revert "docs(agents): add CLAUDE.md documentation for agents module"

This reverts commit bf1ddd7da08f2f34352d11a5d823da981f1a98bb.

* chore: update gitignore to allow agents/tests/

* fix(tests): resolve mock isolation and path permission issues

- Fix test_tool_concurrency_error_detection by patching where functions
  are used (qa.fixer) instead of where they're defined
- Add Path.exists/is_dir/glob mocks to avoid permission errors on
  nonexistent directories in test_validation_strategy.py
- Add helper function clean_project_index_files() to reduce code
  duplication in prereqs_validator tests
- Add comprehensive tests for spec validation validators
  (context, prereqs, spec_document)
- Fix similar mock/path issues in test_qa_reviewer.py,
  test_service_orchestrator.py, test_ci_discovery.py,
  test_prompt_generator.py, test_security_scanner.py

All 2103 tests now pass.

* fix(tests): remove unused imports and fix double assignment

- Remove unused 'patch' import from validator test files
- Remove unused 'pytest' import where not needed
- Fix double assignment typo in test_error_message_includes_filename

* fix(tests): move agents tests to tests/agents/ directory

- Move test_agent_architecture.py, test_agent_configs.py, and
  test_agent_flow.py from apps/backend/agents/tests/ to tests/agents/
- Fix path resolution to work from new location
- Remove gitignore exception for agents/tests/ (no longer needed)

This resolves the issue where tests were not included in the PR
because they were in an untracked location.

* fix(tests): simplify conftest.py mock management

- Remove redundant pytest_runtest_teardown and pytest_runtest_call hooks
  (autouse fixtures in test files already handle mock reset)
- Add prompts_pkg.project_context to potentially mocked modules list
- Remove prompts_pkg from test_qa_fixer entry (not used there)

This reduces maintenance burden by having mock reset in one place.

* refactor(tests): consolidate duplicate mock setup into shared helper

- Create tests/qa_test_helpers.py with shared mock infrastructure:
  - AsyncIteratorMock and ReceiveResponseMock classes
  - setup_qa_mocks(), cleanup_qa_mocks(), reset_qa_mocks() functions
  - Mock response creation helpers
  - Accessor functions for mock objects
- Refactor test_qa_fixer.py to use shared helpers
- Reduces ~80 lines of duplicated code per test file
- Fixes potential mock binding issues by using accessor functions

This addresses code quality issues identified in PR review:
- Duplicate mock setup between test_qa_fixer.py and test_qa_reviewer.py
- Duplicated _AsyncIteratorMock class across files

* refactor(tests): consolidate test_qa_reviewer.py with shared helpers

- Refactor test_qa_reviewer.py to use shared qa_test_helpers
- Remove ~170 lines of duplicated mock setup and helper functions
- Fix unused imports in test_qa_fixer.py (json, sys, MagicMock, etc.)
- Fix rate limit error detection tests to patch where functions are used
- Consolidate duplicated _create_*_response helper methods to module level

Addresses CodeQL warnings about unused imports and reduces code
duplication between test_qa_fixer.py and test_qa_reviewer.py.

* fix(tests): remove unused Path import from test_qa_reviewer.py

* fix(tests): address all PR review findings

PR Review Fixes:
- Remove unused create_mock_qa_approved_response/rejected_response functions
- Guard against overwriting _original_modules on second setup_qa_mocks() call
- Clear _original_modules in cleanup_qa_mocks() to prevent stale state
- Add prompts_pkg.project_context to test_qa_reviewer preserved_mocks in conftest
- Convert asyncio.run() pattern to native async tests in test_agent_flow.py
- Remove redundant @pytest.mark.asyncio decorators (asyncio_mode=auto)
- Remove unused pytest import from qa_test_helpers.py
- Fix structural duplication by keeping fixtures in test files

Code Quality:
- Removed ~100 lines of duplicated/unused code
- Consistent async test patterns across all QA test files
- Proper mock state management to prevent test pollution

* fix(tests): save original modules individually in setup_qa_mocks

The boolean guard `setup_done` prevented saving original modules on
subsequent calls with different parameters. When setup_qa_mocks was
called first with include_prompts_pkg=False, then with True, the
prompts_pkg modules were never saved to _original_modules. During
cleanup, these unsaved modules were deleted from sys.modules instead
of being restored, causing ModuleNotFoundError in subsequent tests.

Now checks each module individually before mocking, ensuring all
originals are saved across multiple setup calls.

* fix(tests): address all PR review findings including low priority

- Fix path in test_no_subtask_worker_config (parent.parent.parent)
- Add guard to prevent double setup in setup_qa_mocks()
- Don't clear _original_modules in cleanup to fix multi-module cleanup

* fix(tests): address PR review follow-up findings

- Fix module-level mock setup ordering dependency: now tracks
  include_prompts_pkg config and allows incremental setup when
  test_qa_fixer.py (False) is imported before test_qa_reviewer.py (True)
- Remove unused asyncio import from test_agent_flow.py
- Replace os.chdir() with monkeypatch.chdir() in prereqs validator
  tests for safe parallel test execution

---------

Co-authored-by: StillKnotKnown <stillknotknown@users.noreply.github.com>
2026-02-12 15:06:25 +01:00

377 lines
12 KiB
Python

#!/usr/bin/env python3
"""
Shared QA Test Helpers
======================
Consolidates duplicated mock setup and utilities for test_qa_fixer.py and test_qa_reviewer.py.
This module provides:
- AsyncIteratorMock: Async iterator mock for receive_response
- ReceiveResponseMock: Smart wrapper supporting both .set_messages() and .return_value
- setup_qa_mocks(): Module-level mock setup
- cleanup_qa_mocks(): Module-level cleanup
- reset_qa_mocks(): Reset shared mocks to default state
- get_mock_*(): Accessor functions for mock objects
- Mock response creation helpers
- Shared pytest fixtures
"""
import sys
from pathlib import Path
from unittest.mock import AsyncMock, MagicMock
# Add apps/backend to path for imports
sys.path.insert(0, str(Path(__file__).parent.parent / "apps" / "backend"))
# =============================================================================
# ASYNC ITERATOR MOCKS
# =============================================================================
class AsyncIteratorMock:
"""Async iterator mock that yields stored messages and acts as async context manager."""
def __init__(self):
self._messages = []
self._index = 0
def __aiter__(self):
return self
async def __anext__(self):
if self._index >= len(self._messages):
raise StopAsyncIteration
msg = self._messages[self._index]
self._index += 1
return msg
async def __aenter__(self):
return self
async def __aexit__(self, exc_type, exc_val, exc_tb):
return False
def set_messages(self, messages):
self._messages = messages
self._index = 0
class ReceiveResponseMock:
"""Mock for receive_response that supports both .set_messages() and .return_value assignment."""
def __init__(self):
self._iterator = AsyncIteratorMock()
self.called = False # MagicMock compatibility
def __call__(self, *args, **kwargs):
self.called = True
return self._iterator
@property
def return_value(self):
return self._iterator
@return_value.setter
def return_value(self, value):
# When tests do mock_client.receive_response.return_value = list,
# we set the messages on the iterator
self._iterator.set_messages(value)
# =============================================================================
# MODULE-LEVEL MOCKS
# =============================================================================
# Store original modules for cleanup
_original_modules = {}
_mocked_module_names = [
'claude_agent_sdk',
'ui',
'progress',
'task_logger',
'linear_updater',
'client',
'prompts_pkg',
'prompts_pkg.project_context',
'agents.memory_manager',
'agents.base',
'core.error_utils',
'security.tool_input_validator',
'debug',
]
# Mock objects (initialized by setup_qa_mocks)
_mock_state = {
'sdk': None,
'prompts_pkg': None,
'project_context': None,
'memory_manager': None,
'agents_base': None,
'error_utils': None,
'validator': None,
'debug': None,
'ui': None,
'progress': None,
'task_logger': None,
'linear': None,
'client_module': None,
'setup_done': False,
'include_prompts_pkg': False, # Track what config was used
}
def get_mock_error_utils():
"""Get the mock_error_utils object after setup."""
return _mock_state['error_utils']
def get_mock_memory_manager():
"""Get the mock_memory_manager object after setup."""
return _mock_state['memory_manager']
def setup_qa_mocks(include_prompts_pkg: bool = False):
"""Set up module-level mocks for QA tests.
Args:
include_prompts_pkg: If True, mock prompts_pkg (needed for reviewer, not fixer)
Call this at module level before importing from qa modules.
"""
# Guard against redundant setup when called with same parameters
# But allow prompts_pkg to be added if a later call needs it
if _mock_state['setup_done']:
# If prompts_pkg is already set up OR current call doesn't need it, skip
if _mock_state['include_prompts_pkg'] or not include_prompts_pkg:
return
# Otherwise, we need to add prompts_pkg to existing setup
# Fall through to only set up prompts_pkg below
# If setup is done but we need to add prompts_pkg, only do that part
if _mock_state['setup_done'] and include_prompts_pkg and not _mock_state['include_prompts_pkg']:
# Save originals before mocking
for name in ['prompts_pkg', 'prompts_pkg.project_context']:
if name in sys.modules and name not in _original_modules:
_original_modules[name] = sys.modules[name]
# Only set up prompts_pkg
mock_prompts_pkg = MagicMock()
mock_prompts_pkg.get_qa_reviewer_prompt = MagicMock(return_value="Test QA prompt")
sys.modules['prompts_pkg'] = mock_prompts_pkg
_mock_state['prompts_pkg'] = mock_prompts_pkg
mock_project_context = MagicMock()
mock_prompts_pkg.project_context = mock_project_context
sys.modules['prompts_pkg.project_context'] = mock_project_context
_mock_state['project_context'] = mock_project_context
_mock_state['include_prompts_pkg'] = True
return
# Save originals for each module individually before mocking
# This handles multiple setup calls with different parameters
for name in _mocked_module_names:
if name in sys.modules and name not in _original_modules:
_original_modules[name] = sys.modules[name]
# Mock claude_agent_sdk FIRST
mock_sdk = MagicMock()
mock_sdk.ClaudeSDKClient = MagicMock()
mock_sdk.ClaudeAgentOptions = MagicMock()
mock_sdk.ClaudeCodeOptions = MagicMock()
sys.modules['claude_agent_sdk'] = mock_sdk
_mock_state['sdk'] = mock_sdk
# Mock prompts_pkg if needed
if include_prompts_pkg:
mock_prompts_pkg = MagicMock()
mock_prompts_pkg.get_qa_reviewer_prompt = MagicMock(return_value="Test QA prompt")
sys.modules['prompts_pkg'] = mock_prompts_pkg
_mock_state['prompts_pkg'] = mock_prompts_pkg
# Also mock prompts_pkg.project_context for imports in core/client.py
mock_project_context = MagicMock()
mock_prompts_pkg.project_context = mock_project_context
sys.modules['prompts_pkg.project_context'] = mock_project_context
_mock_state['project_context'] = mock_project_context
# Mock agents.memory_manager
mock_memory_manager = MagicMock()
mock_memory_manager.get_graphiti_context = AsyncMock(return_value=None)
mock_memory_manager.save_session_memory = AsyncMock(return_value=None)
sys.modules['agents.memory_manager'] = mock_memory_manager
_mock_state['memory_manager'] = mock_memory_manager
# Mock agents.base
mock_agents_base = MagicMock()
mock_agents_base.sanitize_error_message = lambda x: x
sys.modules['agents.base'] = mock_agents_base
_mock_state['agents_base'] = mock_agents_base
# Mock core.error_utils
mock_error_utils = MagicMock()
mock_error_utils.is_rate_limit_error = MagicMock(return_value=False)
mock_error_utils.is_tool_concurrency_error = MagicMock(return_value=False)
sys.modules['core.error_utils'] = mock_error_utils
_mock_state['error_utils'] = mock_error_utils
# Mock security.tool_input_validator
mock_validator = MagicMock()
mock_validator.get_safe_tool_input = lambda block: getattr(block, 'input', {})
sys.modules['security.tool_input_validator'] = mock_validator
_mock_state['validator'] = mock_validator
# Mock debug
mock_debug = MagicMock()
sys.modules['debug'] = mock_debug
_mock_state['debug'] = mock_debug
# Mock UI module
mock_ui = MagicMock()
sys.modules['ui'] = mock_ui
_mock_state['ui'] = mock_ui
# Mock progress module
mock_progress = MagicMock()
sys.modules['progress'] = mock_progress
_mock_state['progress'] = mock_progress
# Mock task_logger
mock_task_logger = MagicMock()
mock_task_logger.LogPhase = MagicMock()
mock_task_logger.LogEntryType = MagicMock()
mock_task_logger.get_task_logger = MagicMock(return_value=None)
sys.modules['task_logger'] = mock_task_logger
_mock_state['task_logger'] = mock_task_logger
# Mock linear_updater
mock_linear = MagicMock()
sys.modules['linear_updater'] = mock_linear
_mock_state['linear'] = mock_linear
# Mock client - create a factory that returns properly configured clients
def _create_mock_client():
"""Factory function that creates a properly configured mock client."""
client = MagicMock()
client.query = AsyncMock()
client.receive_response = ReceiveResponseMock()
return client
mock_client_module = MagicMock()
mock_client_module.create_client = _create_mock_client
sys.modules['client'] = mock_client_module
_mock_state['client_module'] = mock_client_module
_mock_state['setup_done'] = True
_mock_state['include_prompts_pkg'] = include_prompts_pkg
def cleanup_qa_mocks():
"""Restore original modules after tests complete.
Call this in a module-scoped autouse fixture.
"""
for name in _mocked_module_names:
if name in _original_modules:
sys.modules[name] = _original_modules[name]
elif name in sys.modules:
del sys.modules[name]
_mock_state['setup_done'] = False
_mock_state['include_prompts_pkg'] = False
# Note: We do NOT clear _original_modules here because:
# 1. Multiple test modules may call cleanup, and clearing would break subsequent cleanups
# 2. The 'if name not in _original_modules' guard in setup_qa_mocks prevents stale state
# 3. Originals are saved per-module, so different setups can coexist
def reset_qa_mocks():
"""Reset shared mocks to default state.
Call this before and after each test to ensure isolation.
"""
mock_error_utils = _mock_state.get('error_utils')
mock_memory_manager = _mock_state.get('memory_manager')
if mock_error_utils is not None:
mock_error_utils.is_rate_limit_error.return_value = False
mock_error_utils.is_tool_concurrency_error.return_value = False
if mock_memory_manager is not None:
mock_memory_manager.get_graphiti_context.reset_mock()
mock_memory_manager.save_session_memory.reset_mock()
# =============================================================================
# MOCK RESPONSE HELPERS
# =============================================================================
def create_mock_response(text: str = "Session complete."):
"""Create a standard mock assistant+user message pair.
Args:
text: Text content for the AssistantMessage's TextBlock
Returns:
List of mock messages [AssistantMessage, UserMessage]
"""
msg1 = MagicMock()
msg1.__class__.__name__ = "AssistantMessage"
text_block = MagicMock()
text_block.__class__.__name__ = "TextBlock"
text_block.text = text
msg1.content = [text_block]
msg2 = MagicMock()
msg2.__class__.__name__ = "UserMessage"
msg2.content = []
return [msg1, msg2]
def create_mock_fixed_response():
"""Create mock response for fixed QA.
Returns:
List of mock messages [AssistantMessage with 'Fixes applied successfully.', UserMessage]
"""
return create_mock_response("Fixes applied successfully.")
def create_mock_tool_use_response(tool_name: str = "Bash", tool_input: dict = None):
"""Create mock response with tool use.
Args:
tool_name: Name of the tool being used
tool_input: Input dict for the tool
Returns:
List of mock messages [AssistantMessage with ToolUseBlock, UserMessage]
"""
if tool_input is None:
tool_input = {"command": "echo test"}
msg1 = MagicMock()
msg1.__class__.__name__ = "AssistantMessage"
tool_block = MagicMock()
tool_block.__class__.__name__ = "ToolUseBlock"
tool_block.name = tool_name
tool_block.input = tool_input
msg1.content = [tool_block]
msg2 = MagicMock()
msg2.__class__.__name__ = "UserMessage"
msg2.content = []
return [msg1, msg2]
# =============================================================================
# FIXTURE HELPERS
# =============================================================================
def create_mock_client():
"""Create a mock Claude SDK client for use in fixtures.
Returns:
MagicMock configured as a Claude SDK client
"""
client = MagicMock()
client.query = AsyncMock()
client.receive_response = ReceiveResponseMock()
return client