ReMe/tests/unit/test_base_component.py
jinliyl e7d44f6f3b
Some checks are pending
Pre-commit / run (ubuntu-latest) (push) Waiting to run
Tests ReMe / Unit Tests - py3.11 (push) Waiting to run
Tests ReMe / Unit Tests - py3.12 (push) Waiting to run
Tests ReMe / Unit Tests - py3.13 (push) Waiting to run
Windows Smoke / CLI smoke - py3.11 (push) Waiting to run
refactor(agent): unify agent subprocess env, sessions, skills, and MCP/service jobs (#382)
* feat(config): add environment variable configuration for agent subprocesses

- Add environment field to ApplicationConfig to store variables for agent subprocesses
- Remove dynamic loading of .env files in agent wrappers
- Introduce subprocess_environment property in base agent wrapper
- Pass application-level environment variables to Claude Code and Codex agents
- Load environment variables once at startup and pass to ReMe application
- Remove dependency on load_env utility in agent wrapper implementations
- Update tests to use configured environment instead of dynamic loading
- Remove unused environment loading utilities and related test cases

* refactor(mcp): remove channel notification system and related components

- Removed channel notification step implementation
- Removed claim channel step implementation
- Removed ChannelSink class from MCP service
- Removed channel-related documentation from AGENTS.md
- Removed channel instruction text from MCP service
- Removed all channel-related tests
- Updated application context metadata comment to remove channel sink reference
- Removed channel module initialization and imports

* feat(service): add job whitelisting capability to BaseService

- Add optional jobs parameter to BaseService.__init__ to configure job whitelist
- Store jobs as set in self.jobs attribute for efficient lookup operations
- Modify add_jobs method to filter jobs based on whitelist configuration
- Update documentation in both English and Chinese to describe new feature
- Add comprehensive unit tests for job whitelisting behavior
- Implement flowchart update showing new filtering logic
- Preserve existing enable_serve flag behavior alongside new whitelisting

* refactor(service): enhance service job validation and MCP tool injection

- Add strict validation for service jobs whitelist with detailed error messages
- Implement injected job arguments support for MCP services with conflict detection
- Add tool error handling for unsuccessful responses in MCP services
- Remove duplicate job names in Codex agent wrapper using dict.fromkeys
- Update MCP server argument format from single JSON array to repeated --job flags
- Add comprehensive test coverage for job injection and error handling scenarios
- Update documentation to reflect service job validation and MCP features
- Ensure application cleanup occurs even when service lifespan encounters errors

* feat(agent): update skill handling to preserve existing Claude skills

- Change skills parameter processing to use 'all' instead of filtered list
- Add logic to select project skills without restricting Claude's existing skills
- Update variable naming from 'skills' to 'selected_skills' for clarity
- Modify application context metadata documentation to clarify in-memory state usage
- Add test case to verify configured skills are added without filtering existing skills
- Update internal skill directory handling to use renamed variable consistently

* refactor(agent): restructure agent wrapper components and session storage

- Move CcFileSessionStore to separate module for better organization
- Add SDK package version logging in base agent wrapper
- Update Claude Code agent to use new session store structure with project keys
- Refactor Claude Code agent wrapper to use proper type hints and SDK integration
- Add support for server tool use events in Claude Code message processing
- Improve error handling and resource cleanup in streaming operations
- Update Codex agent wrapper with proper type annotations and configuration
- Remove deprecated system prompt mode handling from Claude Code wrapper
- Fix session path construction for Claude Code transcript storage
- Update dependency injection and configuration handling patterns

* fix(cc_agent_wrapper): resolve Claude Code SDK integration issues

- Added dataclass import and created _BlockState for content block metadata tracking
- Implemented proper MCP server name constant and tool context ID validation
- Fixed tool_context_id injection to prevent duplicate assignment errors
- Resolved skills parameter handling in build_options method
- Enhanced job tools integration with MCP servers mapping validation
- Replaced deprecated block_ids/block_types/tool_call_names with block_states dict
- Updated message_delta to emit USAGE chunks instead of REPLY_END
- Fixed stream result handling to ensure proper REPLY_END emission
- Improved error handling for session mirror failures and rate limits
- Added proper cleanup for expected trailing errors in streams
- Refactored Codex agent wrapper initialization and configuration management
- Removed obsolete system_prompt_mode from default config
- Enhanced test coverage for new block state and error handling features
- Fixed async generator handling with aclosing context manager
- Improved chunk type mapping for Claude Code SDK events

* refactor(tests): remove demo config tests from config parser test suite

- Removed test_demo_config_registers_llm_jobs function and its assertions
- Eliminated verification of LLM demo job configurations
- Removed checks for agent wrapper component settings
- Deleted assertions for model configurations and parameters
- Cleaned up deprecated test cases related to demo config parsing

* refactor(evolve): simplify Claude Code session store path structure

- Removed redundant project key subdirectory from session link generation
- Updated CcFileSessionStore initialization to use direct session directory path
- Maintained existing session layout compatibility for backward compatibility
- Added unit tests to verify session persistence behavior with existing transcripts
- Ensured UUID-based session files remain accessible at expected locations
- Preserved existing session directory structure without additional nesting

* refactor(agent): defer optional Codex SDK imports until first use

- Moved openai-codex imports inside functions to avoid mandatory dependencies
- Added TYPE_CHECKING guard for development time type checking only
- Implemented lazy loading mechanism with _get_async_codex_class function
- Updated AsyncCodex initialization to occur on demand rather than at module level
- Maintained backward compatibility while improving import performance
- Added test case to verify package import works without optional Codex SDK
- Updated agentscope dependency to version 2.0.4.post1 in pyproject.toml

* test(embedded): add compatibility tests for in-process ReMe embedding

- Add test suite for QwenPaw-style embedded configurations
- Verify optional defaults remain preserved in embedded configs
- Ensure in-process application API stays compatible
- Test model injection and lifecycle management compatibility
- Remove obsolete hermes agent plugin tests
- Update CLI import test to cover multiple optional SDKs
- Block claude_agent_sdk and openai_codex during import testing
2026-07-20 23:52:14 +08:00

358 lines
9.9 KiB
Python

"""Tests for BaseComponent, Dependency, and ComponentMixin."""
# pylint: disable=protected-access,missing-function-docstring,missing-class-docstring,attribute-defined-outside-init
import asyncio
import os
import tempfile
import pytest
from reme.components.base_component import BaseComponent, ComponentMixin, Dependency
from reme.enumeration import ComponentEnum
# -- Test subclasses ----------------------------------------------------------
class StubComponent(BaseComponent):
component_type = ComponentEnum.FILE_CHUNKER
def __init__(self, **kwargs):
super().__init__(**kwargs)
self.start_count = 0
self.close_count = 0
async def _start(self):
self.start_count += 1
async def _close(self):
self.close_count += 1
class DepTarget(BaseComponent):
component_type = ComponentEnum.KEYWORD_INDEX
class RequiredDepTarget(BaseComponent):
component_type = ComponentEnum.FILE_GRAPH
class FailCloseComponent(StubComponent):
async def _close(self):
await super()._close()
raise RuntimeError("close failed")
# -- Dependency ---------------------------------------------------------------
def test_dependency_getattr_raises():
dep = Dependency(ComponentEnum.FILE_CHUNKER, "my_parser")
with pytest.raises(RuntimeError, match="accessed before start"):
_ = dep.some_method
# -- bind ---------------------------------------------------------------------
def test_bind_returns_none_for_empty_name():
result = BaseComponent.bind(None, DepTarget)
assert result is None
result = BaseComponent.bind("", DepTarget)
assert result is None
def test_bind_returns_dependency_placeholder():
result = BaseComponent.bind("my_index", DepTarget)
assert isinstance(result, Dependency)
assert result.ctype == ComponentEnum.KEYWORD_INDEX
assert result.name == "my_index"
def test_bind_rejects_base_component_type():
class BadTarget(BaseComponent):
component_type = ComponentEnum.BASE
with pytest.raises(TypeError, match="non-BASE"):
BaseComponent.bind("x", BadTarget)
def test_bind_rejects_no_component_type():
class NoType:
pass
with pytest.raises(TypeError, match="non-BASE"):
BaseComponent.bind("x", NoType)
def test_bind_with_default_factory():
def factory():
return DepTarget(name="default")
result = BaseComponent.bind("idx", DepTarget, default_factory=factory)
assert isinstance(result, Dependency)
assert result.default_factory is factory
def test_bind_optional_flag():
dep = BaseComponent.bind("idx", DepTarget, optional=False)
assert dep.optional is False
# -- dependencies property ----------------------------------------------------
def test_dependencies_lists_unresolved():
comp = StubComponent()
comp.dep1 = Dependency(ComponentEnum.KEYWORD_INDEX, "a")
comp.dep2 = Dependency(ComponentEnum.FILE_GRAPH, "b")
comp.normal_attr = "not a dep"
deps = comp.dependencies
assert len(deps) == 2
# -- lifecycle ----------------------------------------------------------------
def test_start_close_idempotent():
async def run():
comp = StubComponent()
await comp.start()
await comp.start()
assert comp.start_count == 1
assert comp.is_started is True
await comp.close()
await comp.close()
assert comp.close_count == 1
assert comp.is_started is False
asyncio.run(run())
def test_restart():
async def run():
comp = StubComponent()
await comp.start()
await comp.restart()
assert comp.start_count == 2
assert comp.close_count == 1
assert comp.is_started is True
await comp.close()
asyncio.run(run())
def test_async_context_manager():
async def run():
comp = StubComponent()
async with comp as c:
assert c is comp
assert comp.is_started is True
assert comp.is_started is False
asyncio.run(run())
def test_close_closes_owned_when_parent_close_fails():
async def run():
owned = StubComponent(name="owned")
parent = FailCloseComponent(name="parent")
parent.dep = BaseComponent.bind(
"sub",
StubComponent,
default_factory=lambda: owned,
)
await parent.start()
with pytest.raises(RuntimeError, match="close failed"):
await parent.close()
assert owned.is_started is False
assert owned.close_count == 1
assert parent.is_started is False
asyncio.run(run())
# -- standalone resolution ----------------------------------------------------
def test_resolve_standalone_optional_becomes_none():
async def run():
comp = StubComponent()
comp.dep = BaseComponent.bind("idx", DepTarget)
await comp.start()
assert comp.dep is None
await comp.close()
asyncio.run(run())
def test_resolve_standalone_with_default_factory():
async def run():
comp = StubComponent()
comp.dep = BaseComponent.bind(
"idx",
DepTarget,
default_factory=lambda: DepTarget(name="auto"),
)
await comp.start()
assert isinstance(comp.dep, DepTarget)
assert comp.dep.name == "auto"
assert comp.dep in comp._owned
await comp.close()
asyncio.run(run())
def test_resolve_standalone_required_no_factory_keeps_placeholder():
async def run():
comp = StubComponent()
comp.dep = BaseComponent.bind("idx", DepTarget, optional=False)
await comp.start()
assert isinstance(comp.dep, Dependency)
await comp.close()
asyncio.run(run())
# -- owned component lifecycle cascade ----------------------------------------
def test_owned_components_started_and_closed():
async def run():
owned = StubComponent(name="owned")
parent = StubComponent(name="parent")
parent.dep = BaseComponent.bind(
"sub",
StubComponent,
default_factory=lambda: owned,
)
await parent.start()
assert owned.is_started is True
await parent.close()
assert owned.is_started is False
asyncio.run(run())
# -- context-bound resolution -------------------------------------------------
def test_resolve_from_context():
async def run():
from reme.components.application_context import ApplicationContext
target = DepTarget(name="real_index")
ctx = ApplicationContext()
ctx.components = {ComponentEnum.KEYWORD_INDEX: {"real_index": target}}
comp = StubComponent(app_context=ctx)
comp.dep = BaseComponent.bind("real_index", DepTarget)
await comp.start()
assert comp.dep is target
await comp.close()
asyncio.run(run())
def test_resolve_from_context_optional_missing():
async def run():
from reme.components.application_context import ApplicationContext
ctx = ApplicationContext()
ctx.components = {}
comp = StubComponent(app_context=ctx)
comp.dep = BaseComponent.bind("missing", DepTarget, optional=True)
await comp.start()
assert comp.dep is None
await comp.close()
asyncio.run(run())
def test_resolve_from_context_required_missing_raises():
async def run():
from reme.components.application_context import ApplicationContext
ctx = ApplicationContext()
ctx.components = {}
comp = StubComponent(app_context=ctx)
comp.dep = BaseComponent.bind("missing", RequiredDepTarget, optional=False)
with pytest.raises(ValueError, match="not found"):
await comp.start()
asyncio.run(run())
# -- ComponentMixin paths -----------------------------------------------------
def test_workspace_path_no_context():
mixin = ComponentMixin()
from pathlib import Path
assert mixin.workspace_path == Path.cwd()
def test_to_workspace_relative_inside_workspace():
with tempfile.TemporaryDirectory() as tmpdir:
old_cwd = os.getcwd()
os.chdir(tmpdir)
try:
mixin = ComponentMixin()
abs_path = mixin.workspace_path / "sub" / "file.md"
rel = mixin.to_workspace_relative(abs_path)
assert rel == str(abs_path.relative_to(mixin.workspace_path))
finally:
os.chdir(old_cwd)
def test_to_workspace_relative_outside_workspace():
mixin = ComponentMixin()
result = mixin.to_workspace_relative("/some/other/path")
assert result == "/some/other/path"
# -- workspace metadata paths -----------------------------------------------------
def test_workspace_metadata_path_no_context():
comp = StubComponent()
assert comp.workspace_metadata_path.name == "metadata"
def test_component_metadata_path():
comp = StubComponent()
assert comp.component_metadata_path.name == ComponentEnum.FILE_CHUNKER.value
if __name__ == "__main__":
print("\n=== BaseComponent Tests ===")
test_dependency_getattr_raises()
test_bind_returns_none_for_empty_name()
test_bind_returns_dependency_placeholder()
test_bind_rejects_base_component_type()
test_bind_rejects_no_component_type()
test_bind_with_default_factory()
test_bind_optional_flag()
test_dependencies_lists_unresolved()
test_start_close_idempotent()
test_restart()
test_async_context_manager()
test_close_closes_owned_when_parent_close_fails()
test_resolve_standalone_optional_becomes_none()
test_resolve_standalone_with_default_factory()
test_resolve_standalone_required_no_factory_keeps_placeholder()
test_owned_components_started_and_closed()
test_resolve_from_context()
test_resolve_from_context_optional_missing()
test_resolve_from_context_required_missing_raises()
test_workspace_path_no_context()
test_to_workspace_relative_outside_workspace()
test_workspace_metadata_path_no_context()
test_component_metadata_path()
print("\n所有测试通过!")