Enhance: Implement code quality improvements from review feedback

Co-Authored-By: Joe Moura <joao@crewai.com>
This commit is contained in:
Devin AI
2025-05-15 18:07:42 +00:00
parent 4a32d9310c
commit c1c64d9b8b
2 changed files with 66 additions and 23 deletions

View File

@@ -1,19 +1,37 @@
import logging
import subprocess
from typing import List
import click
UV_COMMAND = "uv"
SYNC_COMMAND = "sync"
ACTIVE_FLAG = "--active"
def install_crew(proxy_options: list[str]) -> None:
logger = logging.getLogger(__name__)
def install_crew(proxy_options: List[str]) -> None:
"""
Install the crew by running the UV command to lock and install.
Args:
proxy_options (List[str]): List of proxy-related command options.
Note:
Uses --active flag to ensure proper virtual environment detection.
"""
if not isinstance(proxy_options, list):
raise ValueError("proxy_options must be a list")
try:
command = ["uv", "sync", "--active"] + proxy_options
command = [UV_COMMAND, SYNC_COMMAND, ACTIVE_FLAG] + proxy_options
logger.debug(f"Executing command: {' '.join(command)}")
subprocess.run(command, check=True, capture_output=False, text=True)
except subprocess.CalledProcessError as e:
click.echo(f"An error occurred while running the crew: {e}", err=True)
click.echo(e.output, err=True)
if e.output is not None:
click.echo(e.output, err=True)
except Exception as e:
click.echo(f"An unexpected error occurred: {e}", err=True)

View File

@@ -1,37 +1,39 @@
from unittest import mock
from typing import List, Any
import pytest
import subprocess
from crewai.cli.install_crew import install_crew
from crewai.cli.install_crew import install_crew, UV_COMMAND, SYNC_COMMAND, ACTIVE_FLAG
@pytest.mark.parametrize(
"proxy_options,expected_command",
[
([], [UV_COMMAND, SYNC_COMMAND, ACTIVE_FLAG]),
(
["--index-url", "https://custom-pypi.org/simple"],
[UV_COMMAND, SYNC_COMMAND, ACTIVE_FLAG, "--index-url", "https://custom-pypi.org/simple"],
),
],
)
@mock.patch("subprocess.run")
def test_install_crew_with_active_flag(mock_subprocess):
"""Test that install_crew includes the --active flag."""
install_crew([])
mock_subprocess.assert_called_once_with(
["uv", "sync", "--active"], check=True, capture_output=False, text=True
)
@mock.patch("subprocess.run")
def test_install_crew_with_proxy_options(mock_subprocess):
"""Test that install_crew correctly passes proxy options."""
proxy_options = ["--index-url", "https://custom-pypi.org/simple"]
def test_install_crew_with_options(
mock_subprocess: mock.MagicMock, proxy_options: List[str], expected_command: List[str]
) -> None:
"""Test that install_crew correctly passes options to the command."""
install_crew(proxy_options)
mock_subprocess.assert_called_once_with(
["uv", "sync", "--active", "--index-url", "https://custom-pypi.org/simple"],
check=True,
capture_output=False,
text=True,
expected_command, check=True, capture_output=False, text=True
)
@mock.patch("subprocess.run")
@mock.patch("click.echo")
def test_install_crew_with_subprocess_error(mock_echo, mock_subprocess):
def test_install_crew_with_subprocess_error(
mock_echo: mock.MagicMock, mock_subprocess: mock.MagicMock
) -> None:
"""Test that install_crew handles subprocess errors correctly."""
error = subprocess.CalledProcessError(1, "uv sync --active")
error = subprocess.CalledProcessError(1, f"{UV_COMMAND} {SYNC_COMMAND} {ACTIVE_FLAG}")
error.output = "Error output"
mock_subprocess.side_effect = error
@@ -44,7 +46,24 @@ def test_install_crew_with_subprocess_error(mock_echo, mock_subprocess):
@mock.patch("subprocess.run")
@mock.patch("click.echo")
def test_install_crew_with_generic_exception(mock_echo, mock_subprocess):
def test_install_crew_with_subprocess_error_empty_output(
mock_echo: mock.MagicMock, mock_subprocess: mock.MagicMock
) -> None:
"""Test that install_crew handles subprocess errors with empty output correctly."""
error = subprocess.CalledProcessError(1, f"{UV_COMMAND} {SYNC_COMMAND} {ACTIVE_FLAG}")
error.output = None
mock_subprocess.side_effect = error
install_crew([])
mock_echo.assert_called_once_with(f"An error occurred while running the crew: {error}", err=True)
@mock.patch("subprocess.run")
@mock.patch("click.echo")
def test_install_crew_with_generic_exception(
mock_echo: mock.MagicMock, mock_subprocess: mock.MagicMock
) -> None:
"""Test that install_crew handles generic exceptions correctly."""
error = Exception("Generic error")
mock_subprocess.side_effect = error
@@ -52,3 +71,9 @@ def test_install_crew_with_generic_exception(mock_echo, mock_subprocess):
install_crew([])
mock_echo.assert_called_once_with(f"An unexpected error occurred: {error}", err=True)
def test_install_crew_with_invalid_proxy_options() -> None:
"""Test that install_crew validates the proxy_options parameter."""
with pytest.raises(ValueError, match="proxy_options must be a list"):
install_crew("not a list") # type: ignore