Compare commits

..

4 Commits

5 changed files with 13 additions and 147 deletions

View File

@@ -1,34 +1,12 @@
import subprocess
from pathlib import Path
from typing import List
import click
def _check_pyproject_exists() -> bool:
"""
Check if pyproject.toml exists in the current directory.
Returns:
bool: True if pyproject.toml exists, False otherwise.
"""
if not Path("pyproject.toml").exists():
click.echo("Error: No pyproject.toml found in current directory.", err=True)
click.echo("This command must be run from the root of a crew project.", err=True)
return False
return True
def install_crew(proxy_options: List[str]) -> None:
def install_crew(proxy_options: list[str]) -> None:
"""
Install the crew by running the UV command to lock and install.
Args:
proxy_options: List of proxy options to pass to UV.
"""
if not _check_pyproject_exists():
return
try:
command = ["uv", "sync"] + proxy_options
subprocess.run(command, check=True, capture_output=False, text=True)

View File

@@ -14,13 +14,13 @@ class Knowledge(BaseModel):
Knowledge is a collection of sources and setup for the vector store to save and query relevant context.
Args:
sources: List[BaseKnowledgeSource] = Field(default_factory=list)
storage: KnowledgeStorage = Field(default_factory=KnowledgeStorage)
storage: Optional[KnowledgeStorage] = Field(default=None)
embedder_config: Optional[Dict[str, Any]] = None
"""
sources: List[BaseKnowledgeSource] = Field(default_factory=list)
model_config = ConfigDict(arbitrary_types_allowed=True)
storage: KnowledgeStorage = Field(default_factory=KnowledgeStorage)
storage: Optional[KnowledgeStorage] = Field(default=None)
embedder_config: Optional[Dict[str, Any]] = None
collection_name: Optional[str] = None

View File

@@ -22,7 +22,7 @@ class BaseFileKnowledgeSource(BaseKnowledgeSource, ABC):
default_factory=list, description="The path to the file"
)
content: Dict[Path, str] = Field(init=False, default_factory=dict)
storage: KnowledgeStorage = Field(default_factory=KnowledgeStorage)
storage: Optional[KnowledgeStorage] = Field(default=None)
safe_file_paths: List[Path] = Field(default_factory=list)
@field_validator("file_path", "file_paths", mode="before")
@@ -62,7 +62,10 @@ class BaseFileKnowledgeSource(BaseKnowledgeSource, ABC):
def _save_documents(self):
"""Save the documents to the storage."""
self.storage.save(self.chunks)
if self.storage:
self.storage.save(self.chunks)
else:
raise ValueError("No storage found to save documents.")
def convert_to_path(self, path: Union[Path, str]) -> Path:
"""Convert a path to a Path object."""

View File

@@ -16,7 +16,7 @@ class BaseKnowledgeSource(BaseModel, ABC):
chunk_embeddings: List[np.ndarray] = Field(default_factory=list)
model_config = ConfigDict(arbitrary_types_allowed=True)
storage: KnowledgeStorage = Field(default_factory=KnowledgeStorage)
storage: Optional[KnowledgeStorage] = Field(default=None)
metadata: Dict[str, Any] = Field(default_factory=dict) # Currently unused
collection_name: Optional[str] = Field(default=None)
@@ -46,4 +46,7 @@ class BaseKnowledgeSource(BaseModel, ABC):
Save the documents to the storage.
This method should be called after the chunks and embeddings are generated.
"""
self.storage.save(self.chunks)
if self.storage:
self.storage.save(self.chunks)
else:
raise ValueError("No storage found to save documents.")

View File

@@ -1,118 +0,0 @@
import subprocess
from pathlib import Path
from typing import List
from unittest import mock
import pytest
from click.testing import CliRunner
from crewai.cli.install_crew import _check_pyproject_exists, install_crew
TEST_CONSTANTS = {
"ERROR_NO_PYPROJECT": "Error: No pyproject.toml found in current directory.",
"ERROR_MUST_RUN_FROM_ROOT": "This command must be run from the root of a crew project.",
"ERROR_RUNNING_CREW": "An error occurred while running the crew",
"ERROR_UNEXPECTED": "An unexpected error occurred: Test exception",
}
@pytest.fixture
def mock_subprocess_run() -> mock.MagicMock:
"""Mock subprocess.run for testing."""
with mock.patch("subprocess.run") as mock_run:
yield mock_run
@pytest.fixture
def mock_path_exists() -> mock.MagicMock:
"""Mock Path.exists for testing."""
with mock.patch("pathlib.Path.exists") as mock_exists:
yield mock_exists
@pytest.mark.parametrize(
"proxy_options,expected_command",
[
([], ["uv", "sync"]),
(["--proxy", "http://proxy.com"], ["uv", "sync", "--proxy", "http://proxy.com"]),
],
)
def test_install_crew_pyproject_exists(
mock_subprocess_run: mock.MagicMock,
mock_path_exists: mock.MagicMock,
proxy_options: List[str],
expected_command: List[str],
) -> None:
"""Test install_crew when pyproject.toml exists."""
mock_path_exists.return_value = True
install_crew(proxy_options)
mock_subprocess_run.assert_called_once_with(
expected_command, check=True, capture_output=False, text=True
)
def test_install_crew_pyproject_not_exists(
mock_subprocess_run: mock.MagicMock,
mock_path_exists: mock.MagicMock,
capsys: pytest.CaptureFixture,
) -> None:
"""Test install_crew when pyproject.toml does not exist."""
mock_path_exists.return_value = False
proxy_options: List[str] = []
install_crew(proxy_options)
mock_subprocess_run.assert_not_called()
captured = capsys.readouterr()
assert TEST_CONSTANTS["ERROR_NO_PYPROJECT"] in captured.err
assert TEST_CONSTANTS["ERROR_MUST_RUN_FROM_ROOT"] in captured.err
def test_install_crew_subprocess_error(
mock_subprocess_run: mock.MagicMock,
mock_path_exists: mock.MagicMock,
capsys: pytest.CaptureFixture,
) -> None:
"""Test install_crew when subprocess raises CalledProcessError."""
mock_path_exists.return_value = True
mock_subprocess_run.side_effect = subprocess.CalledProcessError(
cmd=["uv", "sync"], returncode=1
)
proxy_options: List[str] = []
install_crew(proxy_options)
captured = capsys.readouterr()
assert TEST_CONSTANTS["ERROR_RUNNING_CREW"] in captured.err
def test_install_crew_general_exception(
mock_subprocess_run: mock.MagicMock,
mock_path_exists: mock.MagicMock,
capsys: pytest.CaptureFixture,
) -> None:
"""Test install_crew when a general exception occurs."""
mock_path_exists.return_value = True
mock_subprocess_run.side_effect = Exception("Test exception")
proxy_options: List[str] = []
install_crew(proxy_options)
captured = capsys.readouterr()
assert TEST_CONSTANTS["ERROR_UNEXPECTED"] in captured.err
def test_check_pyproject_exists(
mock_path_exists: mock.MagicMock, capsys: pytest.CaptureFixture
) -> None:
"""Test _check_pyproject_exists function."""
mock_path_exists.return_value = True
assert _check_pyproject_exists() is True
mock_path_exists.return_value = False
assert _check_pyproject_exists() is False
captured = capsys.readouterr()
assert TEST_CONSTANTS["ERROR_NO_PYPROJECT"] in captured.err
assert TEST_CONSTANTS["ERROR_MUST_RUN_FROM_ROOT"] in captured.err