Tool integration tests

ToolsIntegrationTests

Bases: ToolsTests

Base class for tools integration tests.

METHOD	DESCRIPTION
test_no_overrides_DO_NOT_OVERRIDE	Test that no standard tests are overridden.
tool	Tool fixture.
test_invoke_matches_output_schema	Test invoke matches output schema.
test_async_invoke_matches_output_schema	Test async invoke matches output schema.
test_invoke_no_tool_call	Test invoke without ToolCall.
test_async_invoke_no_tool_call	Test async invoke without ToolCall.

tool_constructor abstractmethod property

tool_constructor: type[BaseTool] | BaseTool

Returns a class or instance of a tool to be tested.

tool_constructor_params property

tool_constructor_params: dict

Returns a dictionary of parameters to pass to the tool constructor.

tool_invoke_params_example property

tool_invoke_params_example: dict

Returns a dictionary representing the "args" of an example tool call.

This should NOT be a ToolCall dict - it should not have {"name", "id", "args"} keys.

test_no_overrides_DO_NOT_OVERRIDE

test_no_overrides_DO_NOT_OVERRIDE() -> None

Test that no standard tests are overridden.

tool

tool() -> BaseTool

Tool fixture.

test_invoke_matches_output_schema

test_invoke_matches_output_schema(tool: BaseTool) -> None

Test invoke matches output schema.

If invoked with a ToolCall, the tool should return a valid ToolMessage content.

If you have followed the custom tool guide, this test should always pass because ToolCall inputs are handled by the langchain_core.tools.BaseTool class.

If you have not followed this guide, you should ensure that your tool's invoke method returns a valid ToolMessage content when it receives a dict representing a ToolCall as input (as opposed to distinct args).

test_async_invoke_matches_output_schema async

test_async_invoke_matches_output_schema(tool: BaseTool) -> None

Test async invoke matches output schema.

If ainvoked with a ToolCall, the tool should return a valid ToolMessage content.

For debugging tips, see test_invoke_matches_output_schema.

test_invoke_no_tool_call

test_invoke_no_tool_call(tool: BaseTool) -> None

Test invoke without ToolCall.

If invoked without a ToolCall, the tool can return anything but it shouldn't throw an error.

If this test fails, your tool may not be handling the input you defined in tool_invoke_params_example correctly, and it's throwing an error.

This test doesn't have any checks. It's just to ensure that the tool doesn't throw an error when invoked with a dict of **kwargs.

test_async_invoke_no_tool_call async

test_async_invoke_no_tool_call(tool: BaseTool) -> None

Test async invoke without ToolCall.

If ainvoked without a ToolCall, the tool can return anything but it shouldn't throw an error.

For debugging tips, see test_invoke_no_tool_call.