mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-21 13:58:15 +00:00
Enhance EnterpriseActionTool with improved schema processing and erro… (#371)
* Enhance EnterpriseActionTool with improved schema processing and error handling - Added methods for sanitizing names and processing schema types, including support for nested models and nullable types. - Improved error handling during schema creation and processing, with warnings for failures. - Updated parameter handling in the `_run` method to clean up `kwargs` before sending requests. - Introduced a detailed description generation for nested schema structures to enhance tool documentation. * Add tests for EnterpriseActionTool schema conversion and validation - Introduced a new test class for validating complex nested schemas in EnterpriseActionTool. - Added tests for schema conversion, optional fields, enum validation, and required nested fields. - Implemented execution tests to ensure the tool can handle complex validated input correctly. - Verified model naming conventions and added tests for simpler schemas with basic enum validation. - Enhanced overall test coverage for the EnterpriseActionTool functionality. * Update chromadb dependency version in pyproject.toml and uv.lock - Changed chromadb version from >=0.4.22 to ==0.5.23 in both pyproject.toml and uv.lock to ensure compatibility and stability. * Update test workflow configuration - Changed EMBEDCHAIN_DB_URI to point to a temporary test database location. - Added CHROMA_PERSIST_PATH for specifying the path to the Chroma test database. - Cleaned up the test run command in the workflow file. * reverted
This commit is contained in:
Lorenze Jay
@@ -2,9 +2,11 @@ import os
|
||||
import unittest
|
||||
from unittest.mock import patch, MagicMock
|
||||
|
||||
|
||||
from crewai.tools import BaseTool
|
||||
from crewai_tools.tools import CrewaiEnterpriseTools
|
||||
from crewai_tools.adapters.tool_collection import ToolCollection
|
||||
from crewai_tools.adapters.enterprise_adapter import EnterpriseActionTool
|
||||
|
||||
|
||||
class TestCrewaiEnterpriseTools(unittest.TestCase):
|
||||
@@ -86,3 +88,269 @@ class TestCrewaiEnterpriseTools(unittest.TestCase):
|
||||
self.assertEqual(len(tools), 2)
|
||||
self.assertEqual(tools[0].name, "tool1")
|
||||
self.assertEqual(tools[1].name, "tool3")
|
||||
|
||||
|
||||
class TestEnterpriseActionToolSchemaConversion(unittest.TestCase):
|
||||
"""Test the enterprise action tool schema conversion and validation."""
|
||||
|
||||
def setUp(self):
|
||||
self.test_schema = {
|
||||
"type": "function",
|
||||
"function": {
|
||||
"name": "TEST_COMPLEX_ACTION",
|
||||
"description": "Test action with complex nested structure",
|
||||
"parameters": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"filterCriteria": {
|
||||
"type": "object",
|
||||
"description": "Filter criteria object",
|
||||
"properties": {
|
||||
"operation": {"type": "string", "enum": ["AND", "OR"]},
|
||||
"rules": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"field": {
|
||||
"type": "string",
|
||||
"enum": ["name", "email", "status"],
|
||||
},
|
||||
"operator": {
|
||||
"type": "string",
|
||||
"enum": ["equals", "contains"],
|
||||
},
|
||||
"value": {"type": "string"},
|
||||
},
|
||||
"required": ["field", "operator", "value"],
|
||||
},
|
||||
},
|
||||
},
|
||||
"required": ["operation", "rules"],
|
||||
},
|
||||
"options": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"limit": {"type": "integer"},
|
||||
"offset": {"type": "integer"},
|
||||
},
|
||||
"required": [],
|
||||
},
|
||||
},
|
||||
"required": [],
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
def test_complex_schema_conversion(self):
|
||||
"""Test that complex nested schemas are properly converted to Pydantic models."""
|
||||
tool = EnterpriseActionTool(
|
||||
name="gmail_search_for_email",
|
||||
description="Test tool",
|
||||
enterprise_action_token="test_token",
|
||||
action_name="GMAIL_SEARCH_FOR_EMAIL",
|
||||
action_schema=self.test_schema,
|
||||
)
|
||||
|
||||
self.assertEqual(tool.name, "gmail_search_for_email")
|
||||
self.assertEqual(tool.action_name, "GMAIL_SEARCH_FOR_EMAIL")
|
||||
|
||||
schema_class = tool.args_schema
|
||||
self.assertIsNotNone(schema_class)
|
||||
|
||||
schema_fields = schema_class.model_fields
|
||||
self.assertIn("filterCriteria", schema_fields)
|
||||
self.assertIn("options", schema_fields)
|
||||
|
||||
# Test valid input structure
|
||||
valid_input = {
|
||||
"filterCriteria": {
|
||||
"operation": "AND",
|
||||
"rules": [
|
||||
{"field": "name", "operator": "contains", "value": "test"},
|
||||
{"field": "status", "operator": "equals", "value": "active"},
|
||||
],
|
||||
},
|
||||
"options": {"limit": 10},
|
||||
}
|
||||
|
||||
# This should not raise an exception
|
||||
validated_input = schema_class(**valid_input)
|
||||
self.assertIsNotNone(validated_input.filterCriteria)
|
||||
self.assertIsNotNone(validated_input.options)
|
||||
|
||||
def test_optional_fields_validation(self):
|
||||
"""Test that optional fields work correctly."""
|
||||
tool = EnterpriseActionTool(
|
||||
name="gmail_search_for_email",
|
||||
description="Test tool",
|
||||
enterprise_action_token="test_token",
|
||||
action_name="GMAIL_SEARCH_FOR_EMAIL",
|
||||
action_schema=self.test_schema,
|
||||
)
|
||||
|
||||
schema_class = tool.args_schema
|
||||
|
||||
minimal_input = {}
|
||||
validated_input = schema_class(**minimal_input)
|
||||
self.assertIsNone(validated_input.filterCriteria)
|
||||
self.assertIsNone(validated_input.options)
|
||||
|
||||
partial_input = {"options": {"limit": 10}}
|
||||
validated_input = schema_class(**partial_input)
|
||||
self.assertIsNone(validated_input.filterCriteria)
|
||||
self.assertIsNotNone(validated_input.options)
|
||||
|
||||
def test_enum_validation(self):
|
||||
"""Test that enum values are properly validated."""
|
||||
tool = EnterpriseActionTool(
|
||||
name="gmail_search_for_email",
|
||||
description="Test tool",
|
||||
enterprise_action_token="test_token",
|
||||
action_name="GMAIL_SEARCH_FOR_EMAIL",
|
||||
action_schema=self.test_schema,
|
||||
)
|
||||
|
||||
schema_class = tool.args_schema
|
||||
|
||||
invalid_input = {
|
||||
"filterCriteria": {
|
||||
"operation": "INVALID_OPERATOR",
|
||||
"rules": [],
|
||||
}
|
||||
}
|
||||
|
||||
with self.assertRaises(Exception):
|
||||
schema_class(**invalid_input)
|
||||
|
||||
def test_required_nested_fields(self):
|
||||
"""Test that required fields in nested objects are validated."""
|
||||
tool = EnterpriseActionTool(
|
||||
name="gmail_search_for_email",
|
||||
description="Test tool",
|
||||
enterprise_action_token="test_token",
|
||||
action_name="GMAIL_SEARCH_FOR_EMAIL",
|
||||
action_schema=self.test_schema,
|
||||
)
|
||||
|
||||
schema_class = tool.args_schema
|
||||
|
||||
incomplete_input = {
|
||||
"filterCriteria": {
|
||||
"operation": "OR",
|
||||
"rules": [
|
||||
{
|
||||
"field": "name",
|
||||
"operator": "contains",
|
||||
}
|
||||
],
|
||||
}
|
||||
}
|
||||
|
||||
with self.assertRaises(Exception):
|
||||
schema_class(**incomplete_input)
|
||||
|
||||
@patch("requests.post")
|
||||
def test_tool_execution_with_complex_input(self, mock_post):
|
||||
"""Test that the tool can execute with complex validated input."""
|
||||
mock_response = MagicMock()
|
||||
mock_response.ok = True
|
||||
mock_response.json.return_value = {"success": True, "results": []}
|
||||
mock_post.return_value = mock_response
|
||||
|
||||
tool = EnterpriseActionTool(
|
||||
name="gmail_search_for_email",
|
||||
description="Test tool",
|
||||
enterprise_action_token="test_token",
|
||||
action_name="GMAIL_SEARCH_FOR_EMAIL",
|
||||
action_schema=self.test_schema,
|
||||
)
|
||||
|
||||
tool._run(
|
||||
filterCriteria={
|
||||
"operation": "OR",
|
||||
"rules": [
|
||||
{"field": "name", "operator": "contains", "value": "test"},
|
||||
{"field": "status", "operator": "equals", "value": "active"},
|
||||
],
|
||||
},
|
||||
options={"limit": 10},
|
||||
)
|
||||
|
||||
mock_post.assert_called_once()
|
||||
call_args = mock_post.call_args
|
||||
payload = call_args[1]["json"]
|
||||
|
||||
self.assertEqual(payload["action"], "GMAIL_SEARCH_FOR_EMAIL")
|
||||
self.assertIn("filterCriteria", payload["parameters"])
|
||||
self.assertIn("options", payload["parameters"])
|
||||
self.assertEqual(payload["parameters"]["filterCriteria"]["operation"], "OR")
|
||||
|
||||
def test_model_naming_convention(self):
|
||||
"""Test that generated model names follow proper conventions."""
|
||||
tool = EnterpriseActionTool(
|
||||
name="gmail_search_for_email",
|
||||
description="Test tool",
|
||||
enterprise_action_token="test_token",
|
||||
action_name="GMAIL_SEARCH_FOR_EMAIL",
|
||||
action_schema=self.test_schema,
|
||||
)
|
||||
|
||||
schema_class = tool.args_schema
|
||||
self.assertIsNotNone(schema_class)
|
||||
|
||||
self.assertTrue(schema_class.__name__.endswith("Schema"))
|
||||
self.assertTrue(schema_class.__name__[0].isupper())
|
||||
|
||||
complex_input = {
|
||||
"filterCriteria": {
|
||||
"operation": "OR",
|
||||
"rules": [
|
||||
{"field": "name", "operator": "contains", "value": "test"},
|
||||
{"field": "status", "operator": "equals", "value": "active"},
|
||||
],
|
||||
},
|
||||
"options": {"limit": 10},
|
||||
}
|
||||
|
||||
validated = schema_class(**complex_input)
|
||||
self.assertIsNotNone(validated.filterCriteria)
|
||||
|
||||
def test_simple_schema_with_enums(self):
|
||||
"""Test a simpler schema with basic enum validation."""
|
||||
simple_schema = {
|
||||
"type": "function",
|
||||
"function": {
|
||||
"name": "SIMPLE_TEST",
|
||||
"description": "Simple test function",
|
||||
"parameters": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
"enum": ["active", "inactive", "pending"],
|
||||
},
|
||||
"priority": {"type": "integer", "enum": [1, 2, 3]},
|
||||
},
|
||||
"required": ["status"],
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
tool = EnterpriseActionTool(
|
||||
name="simple_test",
|
||||
description="Simple test tool",
|
||||
enterprise_action_token="test_token",
|
||||
action_name="SIMPLE_TEST",
|
||||
action_schema=simple_schema,
|
||||
)
|
||||
|
||||
schema_class = tool.args_schema
|
||||
|
||||
valid_input = {"status": "active", "priority": 2}
|
||||
validated = schema_class(**valid_input)
|
||||
self.assertEqual(validated.status, "active")
|
||||
self.assertEqual(validated.priority, 2)
|
||||
|
||||
with self.assertRaises(Exception):
|
||||
schema_class(status="invalid_status")
|
||||
|
||||
Reference in New Issue
Block a user