Back to Repositories

Testing FileService Directory Operations in ComfyUI

This test suite validates the FileService component of ComfyUI, focusing on directory listing operations and access control. The tests ensure proper handling of file system operations across allowed directories while maintaining security boundaries.

Test Coverage Overview

The test suite provides comprehensive coverage of the FileService’s directory listing functionality.

Key areas tested include:

Valid directory listing operations
Invalid directory access prevention
Empty directory handling
Multiple allowed directory validation

Integration points focus on file system operations through mock objects.

Implementation Analysis

The testing approach utilizes pytest fixtures to establish consistent test environments and mock external file system dependencies. The implementation leverages pytest’s parametrize feature for testing multiple directory configurations and employs context managers for exception testing.

Key patterns include dependency injection through fixtures and mock objects for isolation.

Technical Details

Testing tools and configuration:

pytest for test framework
unittest.mock for mocking file system operations
Fixtures for service initialization
Parameterized tests for comprehensive directory validation

Best Practices Demonstrated

The test suite exemplifies several testing best practices including isolation of external dependencies, comprehensive edge case coverage, and clear test organization.

Notable practices:

Mock usage for external dependencies
Parameterized testing for multiple scenarios
Explicit assertion messages
Clear test naming conventions

comfyanonymous/comfyui

tests-unit/server/services/file_service_test.py

            
import pytest
from unittest.mock import MagicMock
from api_server.services.file_service import FileService

@pytest.fixture
def mock_file_system_ops():
    return MagicMock()

@pytest.fixture
def file_service(mock_file_system_ops):
    allowed_directories = {
        "models": "/path/to/models",
        "user": "/path/to/user",
        "output": "/path/to/output"
    }
    return FileService(allowed_directories, file_system_ops=mock_file_system_ops)

def test_list_files_valid_directory(file_service, mock_file_system_ops):
    mock_file_system_ops.walk_directory.return_value = [
        {"name": "file1.txt", "path": "file1.txt", "type": "file", "size": 100},
        {"name": "dir1", "path": "dir1", "type": "directory"}
    ]
    
    result = file_service.list_files("models")
    
    assert len(result) == 2
    assert result[0]["name"] == "file1.txt"
    assert result[1]["name"] == "dir1"
    mock_file_system_ops.walk_directory.assert_called_once_with("/path/to/models")

def test_list_files_invalid_directory(file_service):
    # Does not support walking directories outside of the allowed directories
    with pytest.raises(ValueError, match="Invalid directory key"):
        file_service.list_files("invalid_key")

def test_list_files_empty_directory(file_service, mock_file_system_ops):
    mock_file_system_ops.walk_directory.return_value = []
    
    result = file_service.list_files("models")
    
    assert len(result) == 0
    mock_file_system_ops.walk_directory.assert_called_once_with("/path/to/models")

@pytest.mark.parametrize("directory_key", ["models", "user", "output"])
def test_list_files_all_allowed_directories(file_service, mock_file_system_ops, directory_key):
    mock_file_system_ops.walk_directory.return_value = [
        {"name": f"file_{directory_key}.txt", "path": f"file_{directory_key}.txt", "type": "file", "size": 100}
    ]
    
    result = file_service.list_files(directory_key)
    
    assert len(result) == 1
    assert result[0]["name"] == f"file_{directory_key}.txt"
    mock_file_system_ops.walk_directory.assert_called_once_with(f"/path/to/{directory_key}")