Build and run agents you can see, understand and trust.
Python agentchatbotlarge-language-modelsllmllm-agentmcpmulti-agentmulti-modalreact-agentrealtime-agentvoice-agentvoice-assistant
fix(plan): improve plan module test coverage and fix hint bug (#1220)
Cheng Wang593b95815cc5
diff --git a/src/agentscope/plan/_plan_notebook.py b/src/agentscope/plan/_plan_notebook.pyindex 3d8e8c61d..b7277fa22 100644--- a/src/agentscope/plan/_plan_notebook.py+++ b/src/agentscope/plan/_plan_notebook.py@@ -150,6 +150,12 @@ class DefaultPlanToHint:),)+ elif n_done + n_abandoned == len(plan.subtasks):+ # All subtasks are done or abandoned+ hint = self.at_the_end.format(+ plan=plan.to_markdown(),+ )+elif n_in_progress == 0 and n_done > 0:# No subtask is in_progress, and some subtasks are donehint = self.when_no_subtask_in_progress.format(@@ -157,12 +163,6 @@ class DefaultPlanToHint:index=n_done,)- elif n_done + n_abandoned == len(plan.subtasks):- # All subtasks are done or abandoned- hint = self.at_the_end.format(- plan=plan.to_markdown(),- )-if hint:return f"{self.hint_prefix}{hint}{self.hint_suffix}"@@ -334,13 +334,16 @@ class PlanNotebook(StateModule):try:subtask_idx = int(subtask_idx)except ValueError:- pass-- if not isinstance(subtask_idx, int):- response.append(- f"Invalid type for argument 'subtask_idx'. "- f"Expected 'int', but got '{type(subtask_idx)}'.",- )+ return ToolResponse(+ content=[+ TextBlock(+ type="text",+ text=f"Error: Invalid type for argument "+ f"'subtask_idx'. Expected 'int', but got "+ f"'{type(subtask_idx)}'.",+ ),+ ],+ )if action not in ["add", "revise", "delete"]:response.append(@@ -356,20 +359,22 @@ class PlanNotebook(StateModule):self._validate_current_plan()- # validate subtask_idx- if action != "add" and subtask_idx >= len(self.current_plan.subtasks):+ if action != "add" and subtask_idx >= len(+ self.current_plan.subtasks,+ ):response.append(- f"Invalid subtask_idx '{subtask_idx}' for action '{action}'. "- f"Must be between 0 "+ f"Invalid subtask_idx '{subtask_idx}' for action "+ f"'{action}'. Must be between 0 "f"and {len(self.current_plan.subtasks) - 1}.",)if action == "add" and not (0 <= subtask_idx <= len(self.current_plan.subtasks)):+ max_idx = len(self.current_plan.subtasks)response.append(f"Invalid subtask_idx '{subtask_idx}' for action 'add'. "- f"Must be between 0 and {len(self.current_plan.subtasks)}.",+ f"Must be between 0 and {max_idx}.",)if response:diff --git a/tests/plan_test.py b/tests/plan_test.pyindex 12c32be6c..788696a27 100644--- a/tests/plan_test.py+++ b/tests/plan_test.py@@ -610,3 +610,175 @@ Subtask at index 2:self.assertIsNotNone(agent.plan_notebook.current_plan,)++ async def test_hint_generator_all_states(self) -> None:+ """Test DefaultPlanToHint covers all plan states."""+ from agentscope.plan._plan_notebook import DefaultPlanToHint++ hint_gen = DefaultPlanToHint()++ # State 1: No plan+ hint = hint_gen(None)+ assert hint is not None+ self.assertIn("create_plan", hint)++ # State 2: All todo+ plan = Plan(+ name="Test",+ description="desc",+ expected_outcome="outcome",+ subtasks=[+ SubTask(name="t1", description="d", expected_outcome="e"),+ ],+ )+ hint = hint_gen(plan)+ assert hint is not None+ self.assertIn("subtask_idx=0", hint)++ # State 3: In progress+ plan.subtasks[0].state = "in_progress"+ hint = hint_gen(plan)+ assert hint is not None+ self.assertIn("finish_subtask", hint)++ # State 4: Some done, none in progress+ plan.subtasks[0].state = "done"+ plan.subtasks.append(+ SubTask(name="t2", description="d", expected_outcome="e"),+ )+ hint = hint_gen(plan)+ assert hint is not None+ self.assertIn("first 1", hint.lower())++ # State 5: All done+ plan.subtasks[1].state = "done"+ hint = hint_gen(plan)+ assert hint is not None+ self.assertIn("finish_plan", hint)++ # State 6: Mix done and abandoned+ plan.subtasks[1].state = "abandoned"+ hint = hint_gen(plan)+ assert hint is not None+ self.assertIn("finish_plan", hint)++ async def test_error_paths(self) -> None:+ """Test error handling paths to improve coverage."""+ notebook = PlanNotebook()++ # Test operations without plan+ with self.assertRaises(ValueError):+ await notebook.revise_current_plan(0, "delete")++ # Create plan for subsequent tests+ await notebook.create_plan(+ name="Test",+ description="d",+ expected_outcome="e",+ subtasks=[+ SubTask(name="t1", description="d", expected_outcome="e"),+ SubTask(name="t2", description="d", expected_outcome="e"),+ ],+ )++ # Invalid types and values+ # type: ignore+ res = await notebook.revise_current_plan("invalid", "delete")+ self.assertIn("Invalid type", res.content[0].get("text", ""))++ # type: ignore+ res = await notebook.revise_current_plan(0, "bad_action")+ self.assertIn("Invalid action", res.content[0].get("text", ""))++ res = await notebook.revise_current_plan(0, "add", None)+ self.assertIn("must be provided", res.content[0].get("text", ""))++ res = await notebook.revise_current_plan(999, "delete")+ self.assertIn("Invalid subtask_idx", res.content[0].get("text", ""))++ res = await notebook.update_subtask_state(999, "in_progress")+ self.assertIn("Invalid subtask_idx", res.content[0].get("text", ""))++ # type: ignore+ res = await notebook.update_subtask_state(0, "bad_state")+ self.assertIn("Invalid state", res.content[0].get("text", ""))++ # State constraints+ res = await notebook.update_subtask_state(1, "in_progress")+ self.assertIn("not done yet", res.content[0].get("text", ""))++ await notebook.update_subtask_state(0, "in_progress")+ res = await notebook.update_subtask_state(1, "in_progress")+ self.assertIn("not done yet", res.content[0].get("text", ""))++ res = await notebook.finish_subtask(1, "outcome")+ self.assertIn("not done yet", res.content[0].get("text", ""))++ async def test_edge_cases(self) -> None:+ """Test edge cases and special scenarios."""+ notebook = PlanNotebook()++ # Finish plan when no plan exists+ res = await notebook.finish_plan("done", "outcome")+ self.assertIn("no plan", res.content[0].get("text", "").lower())++ # Create and replace plan+ await notebook.create_plan(+ "P1",+ "d",+ "e",+ [SubTask(name="t", description="d", expected_outcome="e")],+ )+ res = await notebook.create_plan(+ "P2",+ "d",+ "e",+ [SubTask(name="t", description="d", expected_outcome="e")],+ )+ self.assertIn("replaced", res.content[0].get("text", "").lower())++ # Auto-activate next subtask+ assert notebook.current_plan is not None+ notebook.current_plan.subtasks.append(+ SubTask(name="t2", description="d", expected_outcome="e"),+ )+ await notebook.update_subtask_state(0, "in_progress")+ res = await notebook.finish_subtask(0, "done")+ self.assertIn("next subtask", res.content[0].get("text", "").lower())+ assert notebook.current_plan is not None+ self.assertEqual(+ notebook.current_plan.subtasks[1].state,+ "in_progress",+ )++ # Historical plans+ await notebook.finish_subtask(1, "done")+ await notebook.finish_plan("done", "final")+ res = await notebook.view_historical_plans()+ self.assertIn("P2", res.content[0].get("text", ""))++ plans = await notebook.storage.get_plans()+ res = await notebook.recover_historical_plan(plans[0].id)+ self.assertIn("recovered", res.content[0].get("text", "").lower())++ res = await notebook.recover_historical_plan("bad_id")+ self.assertIn("cannot find", res.content[0].get("text", "").lower())++ # Hooks+ called = []++ async def hook(_nb: PlanNotebook, _p: Plan | None) -> None:+ called.append(True)++ notebook.register_plan_change_hook("test", hook)+ await notebook.create_plan(+ "P3",+ "d",+ "e",+ [SubTask(name="t", description="d", expected_outcome="e")],+ )+ self.assertTrue(called)++ notebook.remove_plan_change_hook("test")+ with self.assertRaises(ValueError):+ notebook.remove_plan_change_hook("bad_hook")diff --git a/tests/toolkit_basic_test.py b/tests/toolkit_basic_test.pyindex a5101bfcf..ea079e8bb 100644--- a/tests/toolkit_basic_test.py+++ b/tests/toolkit_basic_test.py@@ -909,6 +909,155 @@ class ToolkitBasicTest(IsolatedAsyncioTestCase):],)+ async def test_register_with_valid_json_schema(self) -> None:+ """Test registering a tool with valid custom json_schema."""+ custom_schema = {+ "type": "function",+ "function": {+ "name": "legacy_name",+ "description": "Custom description.",+ "parameters": {+ "properties": {+ "arg1": {+ "type": "integer",+ "description": "Test argument 1.",+ },+ "arg2": {+ "type": "string",+ "description": "Test argument 2.",+ },+ },+ "required": ["arg1"],+ "type": "object",+ },+ },+ }++ self.toolkit.register_tool_function(+ sync_func,+ json_schema=custom_schema,+ func_name="renamed_sync_func",+ func_description="Overridden description.",+ preset_kwargs={"arg1": 10},+ )++ schemas = self.toolkit.get_json_schemas()+ self.assertEqual(len(schemas), 1)+ self.assertEqual(+ schemas[0]["function"]["name"],+ "renamed_sync_func",+ )+ self.assertEqual(+ schemas[0]["function"]["description"],+ "Overridden description.",+ )+ self.assertNotIn(+ "arg1",+ schemas[0]["function"]["parameters"]["properties"],+ )+ self.assertNotIn(+ "required",+ schemas[0]["function"]["parameters"],+ )++ async def test_register_with_invalid_json_schema(self) -> None:+ """Test that invalid json_schema raises AssertionError."""+ invalid_schemas = [+ "not a dict",+ {"function": {"name": "test"}},+ {"type": "object", "function": {"name": "test"}},+ {"type": "function"},+ {"type": "function", "function": "not a dict"},+ ]++ for schema in invalid_schemas:+ with self.assertRaises(+ AssertionError,+ msg=f"Should raise for schema: {schema}",+ ):+ self.toolkit.register_tool_function(+ sync_func,+ json_schema=schema,+ )++ async def test_register_with_custom_json_schema_without_overrides(+ self,+ ) -> None:+ """Test custom json_schema is used as-is when no overrides are set."""+ custom_schema = {+ "type": "function",+ "function": {+ "name": "custom_sync_func",+ "description": "Custom schema description.",+ "parameters": {+ "properties": {+ "arg1": {+ "type": "integer",+ "description": "Argument one.",+ },+ "arg2": {+ "type": "string",+ "description": "Argument two.",+ },+ },+ "required": ["arg1", "arg2"],+ "type": "object",+ },+ },+ }++ self.toolkit.register_tool_function(+ sync_func,+ json_schema=custom_schema,+ func_name="custom_sync_func",+ )++ schemas = self.toolkit.get_json_schemas()+ self.assertEqual(+ schemas[0]["function"]["description"],+ "Custom schema description.",+ )+ self.assertListEqual(+ schemas[0]["function"]["parameters"]["required"],+ ["arg1", "arg2"],+ )++ async def test_register_with_json_schema_preset_kwargs_keep_other_required(+ self,+ ) -> None:+ """Test preset kwargs remove only matched required parameters."""+ custom_schema = {+ "type": "function",+ "function": {+ "name": "sync_func",+ "description": "Custom schema description.",+ "parameters": {+ "properties": {+ "arg1": {"type": "integer"},+ "arg2": {"type": "string"},+ },+ "required": ["arg1", "arg2"],+ "type": "object",+ },+ },+ }++ self.toolkit.register_tool_function(+ sync_func,+ json_schema=custom_schema,+ preset_kwargs={"arg1": 10},+ )++ schemas = self.toolkit.get_json_schemas()+ self.assertNotIn(+ "arg1",+ schemas[0]["function"]["parameters"]["properties"],+ )+ self.assertListEqual(+ schemas[0]["function"]["parameters"]["required"],+ ["arg2"],+ )+async def test_partial_function(self) -> None:"""Test the partial function registration."""