Skip to content

Commit 2247a45

Browse files
sarojroutcopybara-github
authored andcommitted
feat(agents): add validation for unique sub-agent names (#3557)
Merge #3576 **Please ensure you have read the [contribution guide](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) before creating a pull request.** ### Link to Issue or Description of Change **1. Link to an existing issue (if applicable):** - Closes: #3557 - Related: #_issue_number_ **2. Or, if no issue exists, describe the change:** _If applicable, please follow the issue templates to provide as much detail as possible._ **Problem:** When creating a BaseAgent with multiple sub-agents, there was no validation to ensure that all sub-agents have unique names. This could lead to confusion when trying to find or reference specific sub-agents by name, as duplicate names would make it ambiguous which agent is being referenced. **Solution:** Added a @field_validator for the sub_agents field in BaseAgent that validates all sub-agents have unique names. The validator: Checks for duplicate names in the sub-agents list Raises a ValueError with a clear error message listing all duplicate names found Returns the validated list if all names are unique Handles edge cases like empty lists gracefully ### Testing Plan _Please describe the tests that you ran to verify your changes. This is required for all PRs that are not small documentation or typo fixes._ **Unit Tests:** - [x] I have added or updated unit tests for my change. - [x] All unit tests pass locally. _Please include a summary of passed `pytest` results._ Added 4 new test cases in tests/unittests/agents/test_base_agent.py: test_validate_sub_agents_unique_names_single_duplicate: Verifies that a single duplicate name raises ValueError test_validate_sub_agents_unique_names_multiple_duplicates: Verifies that multiple duplicate names are all reported in the error message test_validate_sub_agents_unique_names_no_duplicates: Verifies that unique names pass validation successfully test_validate_sub_agents_unique_names_empty_list: Verifies that empty sub-agents list passes validation All tests pass locally. You can run with: pytest tests/unittests/agents/test_base_agent.py::test_validate_sub_agents_unique_names_single_duplicate tests/unittests/agents/test_base_agent.py::test_validate_sub_agents_unique_names_multiple_duplicates tests/unittests/agents/test_base_agent.py::test_validate_sub_agents_unique_names_no_duplicates tests/unittests/agents/test_base_agent.py::test_validate_sub_agents_unique_names_empty_list -v **Manual End-to-End (E2E) Tests:** _Please provide instructions on how to manually test your changes, including any necessary setup or configuration. Please provide logs or screenshots to help reviewers better understand the fix._ Test Case 1: Duplicate names should raise error from google.adk.agents import Agent agent1 = Agent(name="sub_agent", model="gemini-2.5-flash") agent2 = Agent(name="sub_agent", model="gemini-2.5-flash") # Same name # This should raise ValueError try: parent = Agent( name="parent", model="gemini-2.5-flash", sub_agents=[agent1, agent2] ) except ValueError as e: print(f"Expected error: {e}") # Output: Found duplicate sub-agent names: `sub_agent`. All sub-agents must have unique names. Test Case 2: Unique names should work from google.adk.agents import Agent agent1 = Agent(name="agent1", model="gemini-2.5-flash") agent2 = Agent(name="agent2", model="gemini-2.5-flash") # This should work without error parent = Agent( name="parent", model="gemini-2.5-flash", sub_agents=[agent1, agent2] ) print("Success: Unique names validated correctly") ### Checklist - [x] I have read the [CONTRIBUTING.md](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) document. - [x] I have performed a self-review of my own code. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have added tests that prove my fix is effective or that my feature works. - [x] New and existing unit tests pass locally with my changes. - [x] I have manually tested my changes end-to-end. - [x] Any dependent changes have been merged and published in downstream modules. ### Additional context This change adds validation at the BaseAgent level, so it automatically applies to all agent types that inherit from BaseAgent (e.g., LlmAgent, LoopAgent, etc.). The validation uses Pydantic's field validator system, which runs during object initialization, ensuring the constraint is enforced early and consistently. The error message clearly identifies which names are duplicated, making it easy for developers to fix the issue: COPYBARA_INTEGRATE_REVIEW=#3576 from sarojrout:feat/validate-unique-sub-agent-names 07adf1f PiperOrigin-RevId: 835358118
1 parent 609c617 commit 2247a45

File tree

2 files changed

+144
-0
lines changed

2 files changed

+144
-0
lines changed

src/google/adk/agents/base_agent.py

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -563,6 +563,46 @@ def validate_name(cls, value: str):
563563
)
564564
return value
565565

566+
@field_validator('sub_agents', mode='after')
567+
@classmethod
568+
def validate_sub_agents_unique_names(
569+
cls, value: list[BaseAgent]
570+
) -> list[BaseAgent]:
571+
"""Validates that all sub-agents have unique names.
572+
573+
Args:
574+
value: The list of sub-agents to validate.
575+
576+
Returns:
577+
The validated list of sub-agents.
578+
579+
Raises:
580+
ValueError: If duplicate sub-agent names are found.
581+
"""
582+
if not value:
583+
return value
584+
585+
seen_names: set[str] = set()
586+
duplicates: set[str] = set()
587+
588+
for sub_agent in value:
589+
name = sub_agent.name
590+
if name in seen_names:
591+
duplicates.add(name)
592+
else:
593+
seen_names.add(name)
594+
595+
if duplicates:
596+
duplicate_names_str = ', '.join(
597+
f'`{name}`' for name in sorted(duplicates)
598+
)
599+
raise ValueError(
600+
f'Found duplicate sub-agent names: {duplicate_names_str}. '
601+
'All sub-agents must have unique names.'
602+
)
603+
604+
return value
605+
566606
def __set_parent_agent_for_sub_agents(self) -> BaseAgent:
567607
for sub_agent in self.sub_agents:
568608
if sub_agent.parent_agent is not None:

tests/unittests/agents/test_base_agent.py

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -854,6 +854,110 @@ def test_set_parent_agent_for_sub_agent_twice(
854854
)
855855

856856

857+
def test_validate_sub_agents_unique_names_single_duplicate(
858+
request: pytest.FixtureRequest,
859+
):
860+
"""Test that duplicate sub-agent names raise ValueError."""
861+
duplicate_name = f'{request.function.__name__}_duplicate_agent'
862+
sub_agent_1 = _TestingAgent(name=duplicate_name)
863+
sub_agent_2 = _TestingAgent(name=duplicate_name)
864+
865+
with pytest.raises(ValueError, match='Found duplicate sub-agent names'):
866+
_ = _TestingAgent(
867+
name=f'{request.function.__name__}_parent',
868+
sub_agents=[sub_agent_1, sub_agent_2],
869+
)
870+
871+
872+
def test_validate_sub_agents_unique_names_multiple_duplicates(
873+
request: pytest.FixtureRequest,
874+
):
875+
"""Test that multiple duplicate sub-agent names are all reported."""
876+
duplicate_name_1 = f'{request.function.__name__}_duplicate_1'
877+
duplicate_name_2 = f'{request.function.__name__}_duplicate_2'
878+
879+
sub_agents = [
880+
_TestingAgent(name=duplicate_name_1),
881+
_TestingAgent(name=f'{request.function.__name__}_unique'),
882+
_TestingAgent(name=duplicate_name_1), # First duplicate
883+
_TestingAgent(name=duplicate_name_2),
884+
_TestingAgent(name=duplicate_name_2), # Second duplicate
885+
]
886+
887+
with pytest.raises(ValueError) as exc_info:
888+
_ = _TestingAgent(
889+
name=f'{request.function.__name__}_parent',
890+
sub_agents=sub_agents,
891+
)
892+
893+
error_message = str(exc_info.value)
894+
# Verify each duplicate name appears exactly once in the error message
895+
assert error_message.count(duplicate_name_1) == 1
896+
assert error_message.count(duplicate_name_2) == 1
897+
# Verify both duplicate names are present
898+
assert duplicate_name_1 in error_message
899+
assert duplicate_name_2 in error_message
900+
901+
902+
def test_validate_sub_agents_unique_names_triple_duplicate(
903+
request: pytest.FixtureRequest,
904+
):
905+
"""Test that a name appearing three times is reported only once."""
906+
duplicate_name = f'{request.function.__name__}_triple_duplicate'
907+
908+
sub_agents = [
909+
_TestingAgent(name=duplicate_name),
910+
_TestingAgent(name=f'{request.function.__name__}_unique'),
911+
_TestingAgent(name=duplicate_name), # Second occurrence
912+
_TestingAgent(name=duplicate_name), # Third occurrence
913+
]
914+
915+
with pytest.raises(ValueError) as exc_info:
916+
_ = _TestingAgent(
917+
name=f'{request.function.__name__}_parent',
918+
sub_agents=sub_agents,
919+
)
920+
921+
error_message = str(exc_info.value)
922+
# Verify the duplicate name appears exactly once in the error message
923+
# (not three times even though it appears three times in the list)
924+
assert error_message.count(duplicate_name) == 1
925+
assert duplicate_name in error_message
926+
927+
928+
def test_validate_sub_agents_unique_names_no_duplicates(
929+
request: pytest.FixtureRequest,
930+
):
931+
"""Test that unique sub-agent names pass validation."""
932+
sub_agents = [
933+
_TestingAgent(name=f'{request.function.__name__}_sub_agent_1'),
934+
_TestingAgent(name=f'{request.function.__name__}_sub_agent_2'),
935+
_TestingAgent(name=f'{request.function.__name__}_sub_agent_3'),
936+
]
937+
938+
parent = _TestingAgent(
939+
name=f'{request.function.__name__}_parent',
940+
sub_agents=sub_agents,
941+
)
942+
943+
assert len(parent.sub_agents) == 3
944+
assert parent.sub_agents[0].name == f'{request.function.__name__}_sub_agent_1'
945+
assert parent.sub_agents[1].name == f'{request.function.__name__}_sub_agent_2'
946+
assert parent.sub_agents[2].name == f'{request.function.__name__}_sub_agent_3'
947+
948+
949+
def test_validate_sub_agents_unique_names_empty_list(
950+
request: pytest.FixtureRequest,
951+
):
952+
"""Test that empty sub-agents list passes validation."""
953+
parent = _TestingAgent(
954+
name=f'{request.function.__name__}_parent',
955+
sub_agents=[],
956+
)
957+
958+
assert len(parent.sub_agents) == 0
959+
960+
857961
if __name__ == '__main__':
858962
pytest.main([__file__])
859963

0 commit comments

Comments
 (0)