langchain/tests/unit_tests/tools/file_management/test_write.py

"""Test the WriteFile tool."""

from pathlib import Path
from tempfile import TemporaryDirectory

from langchain.tools.file_management.utils import (
    INVALID_PATH_TEMPLATE,
)
from langchain.tools.file_management.write import WriteFileTool


def test_write_file_with_root_dir() -> None:
    """Test the WriteFile tool when a root dir is specified."""
    with TemporaryDirectory() as temp_dir:
        tool = WriteFileTool(root_dir=temp_dir)
        tool.run({"file_path": "file.txt", "text": "Hello, world!"})
        assert (Path(temp_dir) / "file.txt").exists()
        assert (Path(temp_dir) / "file.txt").read_text() == "Hello, world!"


def test_write_file_errs_outside_root_dir() -> None:
    """Test the WriteFile tool when a root dir is specified."""
    with TemporaryDirectory() as temp_dir:
        tool = WriteFileTool(root_dir=temp_dir)
        result = tool.run({"file_path": "../file.txt", "text": "Hello, world!"})
        assert result == INVALID_PATH_TEMPLATE.format(
            arg_name="file_path", value="../file.txt"
        )


def test_write_file() -> None:
    """Test the WriteFile tool."""
    with TemporaryDirectory() as temp_dir:
        file_path = str(Path(temp_dir) / "file.txt")
        tool = WriteFileTool()
        tool.run({"file_path": file_path, "text": "Hello, world!"})
        assert (Path(temp_dir) / "file.txt").exists()
        assert (Path(temp_dir) / "file.txt").read_text() == "Hello, world!"
Update File Management Tools to Include Root Directory (#3112) - Permit the specification of a `root_dir` to the read/write file tools to specify a working directory - Add validation for attempts to read/write outside the directory (e.g., through `../../` or symlinks or `/abs/path`'s that don't lie in the correct path) - Add some tests for all One question is whether we should make a default root directory for these? tradeoffs either way 1 year ago			`"""Test the WriteFile tool."""`

			`from pathlib import Path`
			`from tempfile import TemporaryDirectory`

Add Other File Utilities (#3209) Add other File Utilities, include - List Directory - Search for file - Move - Copy - Remove file Bundle as toolkit Add a notebook that connects to the Chat Agent, which somewhat supports multi-arg input tools Update original read/write files to return the original dir paths and better handle unsupported file paths. Add unit tests 1 year ago			`from langchain.tools.file_management.utils import (`
			`INVALID_PATH_TEMPLATE,`
			`)`
Update File Management Tools to Include Root Directory (#3112) - Permit the specification of a `root_dir` to the read/write file tools to specify a working directory - Add validation for attempts to read/write outside the directory (e.g., through `../../` or symlinks or `/abs/path`'s that don't lie in the correct path) - Add some tests for all One question is whether we should make a default root directory for these? tradeoffs either way 1 year ago			`from langchain.tools.file_management.write import WriteFileTool`


			`def test_write_file_with_root_dir() -> None:`
			`"""Test the WriteFile tool when a root dir is specified."""`
			`with TemporaryDirectory() as temp_dir:`
			`tool = WriteFileTool(root_dir=temp_dir)`
			`tool.run({"file_path": "file.txt", "text": "Hello, world!"})`
			`assert (Path(temp_dir) / "file.txt").exists()`
			`assert (Path(temp_dir) / "file.txt").read_text() == "Hello, world!"`


			`def test_write_file_errs_outside_root_dir() -> None:`
			`"""Test the WriteFile tool when a root dir is specified."""`
			`with TemporaryDirectory() as temp_dir:`
			`tool = WriteFileTool(root_dir=temp_dir)`
Add Other File Utilities (#3209) Add other File Utilities, include - List Directory - Search for file - Move - Copy - Remove file Bundle as toolkit Add a notebook that connects to the Chat Agent, which somewhat supports multi-arg input tools Update original read/write files to return the original dir paths and better handle unsupported file paths. Add unit tests 1 year ago			`result = tool.run({"file_path": "../file.txt", "text": "Hello, world!"})`
			`assert result == INVALID_PATH_TEMPLATE.format(`
			`arg_name="file_path", value="../file.txt"`
			`)`
Update File Management Tools to Include Root Directory (#3112) - Permit the specification of a `root_dir` to the read/write file tools to specify a working directory - Add validation for attempts to read/write outside the directory (e.g., through `../../` or symlinks or `/abs/path`'s that don't lie in the correct path) - Add some tests for all One question is whether we should make a default root directory for these? tradeoffs either way 1 year ago

			`def test_write_file() -> None:`
			`"""Test the WriteFile tool."""`
			`with TemporaryDirectory() as temp_dir:`
			`file_path = str(Path(temp_dir) / "file.txt")`
			`tool = WriteFileTool()`
			`tool.run({"file_path": file_path, "text": "Hello, world!"})`
			`assert (Path(temp_dir) / "file.txt").exists()`
			`assert (Path(temp_dir) / "file.txt").read_text() == "Hello, world!"`