Framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks.
Fix: Normalize project names by stripping trailing slashes in crew creation (#3060)
devin-ai-integration[bot]e0b46492fa1a
diff --git a/src/crewai/cli/authentication/main.py b/src/crewai/cli/authentication/main.pyindex 5a335e1f2..12308e3f1 100644--- a/src/crewai/cli/authentication/main.py+++ b/src/crewai/cli/authentication/main.py@@ -5,8 +5,6 @@ from typing import Any, Dictimport requestsfrom rich.console import Console-from crewai.cli.tools.main import ToolCommand-from .constants import AUTH0_AUDIENCE, AUTH0_CLIENT_ID, AUTH0_DOMAINfrom .utils import TokenManager, validate_token@@ -67,6 +65,7 @@ class AuthenticationCommand:self.token_manager.save_tokens(token_data["access_token"], expires_in)try:+ from crewai.cli.tools.main import ToolCommandToolCommand().login()except Exception:console.print(diff --git a/src/crewai/cli/create_crew.py b/src/crewai/cli/create_crew.pyindex c658b0de1..1d3e3ddce 100644--- a/src/crewai/cli/create_crew.py+++ b/src/crewai/cli/create_crew.py@@ -14,8 +14,50 @@ from crewai.cli.utils import copy_template, load_env_vars, write_env_filedef create_folder_structure(name, parent_folder=None):+ import keyword+ import re++ name = name.rstrip('/')++ if not name.strip():+ raise ValueError("Project name cannot be empty or contain only whitespace")+folder_name = name.replace(" ", "_").replace("-", "_").lower()+ folder_name = re.sub(r'[^a-zA-Z0-9_]', '', folder_name)++ # Check if the name starts with invalid characters or is primarily invalid+ if re.match(r'^[^a-zA-Z0-9_-]+', name):+ raise ValueError(f"Project name '{name}' contains no valid characters for a Python module name")++ if not folder_name:+ raise ValueError(f"Project name '{name}' contains no valid characters for a Python module name")++ if folder_name[0].isdigit():+ raise ValueError(f"Project name '{name}' would generate folder name '{folder_name}' which cannot start with a digit (invalid Python module name)")++ if keyword.iskeyword(folder_name):+ raise ValueError(f"Project name '{name}' would generate folder name '{folder_name}' which is a reserved Python keyword")++ if not folder_name.isidentifier():+ raise ValueError(f"Project name '{name}' would generate invalid Python module name '{folder_name}'")+class_name = name.replace("_", " ").replace("-", " ").title().replace(" ", "")++ class_name = re.sub(r'[^a-zA-Z0-9_]', '', class_name)++ if not class_name:+ raise ValueError(f"Project name '{name}' contains no valid characters for a Python class name")++ if class_name[0].isdigit():+ raise ValueError(f"Project name '{name}' would generate class name '{class_name}' which cannot start with a digit")++ # Check if the original name (before title casing) is a keyword+ original_name_clean = re.sub(r'[^a-zA-Z0-9_]', '', name.replace("_", "").replace("-", "").lower())+ if keyword.iskeyword(original_name_clean) or keyword.iskeyword(class_name) or class_name in ('True', 'False', 'None'):+ raise ValueError(f"Project name '{name}' would generate class name '{class_name}' which is a reserved Python keyword")++ if not class_name.isidentifier():+ raise ValueError(f"Project name '{name}' would generate invalid Python class name '{class_name}'")if parent_folder:folder_path = Path(parent_folder) / folder_namediff --git a/tests/cli/authentication/test_auth_main.py b/tests/cli/authentication/test_auth_main.pyindex a0b4fa0d9..5d11d2421 100644--- a/tests/cli/authentication/test_auth_main.py+++ b/tests/cli/authentication/test_auth_main.py@@ -44,7 +44,7 @@ class TestAuthenticationCommand(unittest.TestCase):mock_print.assert_any_call("2. Enter the following code: ", "ABCDEF")mock_open.assert_called_once_with("https://example.com")- @patch("crewai.cli.authentication.main.ToolCommand")+ @patch("crewai.cli.tools.main.ToolCommand")@patch("crewai.cli.authentication.main.requests.post")@patch("crewai.cli.authentication.main.validate_token")@patch("crewai.cli.authentication.main.console.print")diff --git a/tests/cli/test_create_crew.py b/tests/cli/test_create_crew.pynew file mode 100644index 000000000..b645d8522--- /dev/null+++ b/tests/cli/test_create_crew.py@@ -0,0 +1,246 @@+import keyword+import shutil+import tempfile+from pathlib import Path+from unittest import mock++import pytest+from click.testing import CliRunner++from crewai.cli.create_crew import create_crew, create_folder_structure+++def runner():+ return CliRunner()+++def temp_dir():+ temp_path = tempfile.mkdtemp()+ yield temp_path+ shutil.rmtree(temp_path)+++def test_create_folder_structure_strips_single_trailing_slash():+ with tempfile.TemporaryDirectory() as temp_dir:+ folder_path, folder_name, class_name = create_folder_structure("hello/", parent_folder=temp_dir)++ assert folder_name == "hello"+ assert class_name == "Hello"+ assert folder_path.name == "hello"+ assert folder_path.exists()+ assert folder_path.parent == Path(temp_dir)+++def test_create_folder_structure_strips_multiple_trailing_slashes():+ with tempfile.TemporaryDirectory() as temp_dir:+ folder_path, folder_name, class_name = create_folder_structure("hello///", parent_folder=temp_dir)++ assert folder_name == "hello"+ assert class_name == "Hello"+ assert folder_path.name == "hello"+ assert folder_path.exists()+ assert folder_path.parent == Path(temp_dir)+++def test_create_folder_structure_handles_complex_name_with_trailing_slash():+ with tempfile.TemporaryDirectory() as temp_dir:+ folder_path, folder_name, class_name = create_folder_structure("my-awesome_project/", parent_folder=temp_dir)++ assert folder_name == "my_awesome_project"+ assert class_name == "MyAwesomeProject"+ assert folder_path.name == "my_awesome_project"+ assert folder_path.exists()+ assert folder_path.parent == Path(temp_dir)+++def test_create_folder_structure_normal_name_unchanged():+ with tempfile.TemporaryDirectory() as temp_dir:+ folder_path, folder_name, class_name = create_folder_structure("hello", parent_folder=temp_dir)++ assert folder_name == "hello"+ assert class_name == "Hello"+ assert folder_path.name == "hello"+ assert folder_path.exists()+ assert folder_path.parent == Path(temp_dir)++++++def test_create_folder_structure_with_parent_folder():+ with tempfile.TemporaryDirectory() as temp_dir:+ parent_path = Path(temp_dir) / "parent"+ parent_path.mkdir()++ folder_path, folder_name, class_name = create_folder_structure("child/", parent_folder=parent_path)++ assert folder_name == "child"+ assert class_name == "Child"+ assert folder_path.name == "child"+ assert folder_path.parent == parent_path+ assert folder_path.exists()++[email protected]("crewai.cli.create_crew.copy_template")[email protected]("crewai.cli.create_crew.write_env_file")[email protected]("crewai.cli.create_crew.load_env_vars")+def test_create_crew_with_trailing_slash_creates_valid_project(mock_load_env, mock_write_env, mock_copy_template, temp_dir):+ mock_load_env.return_value = {}++ with tempfile.TemporaryDirectory() as work_dir:+ with mock.patch("crewai.cli.create_crew.create_folder_structure") as mock_create_folder:+ mock_folder_path = Path(work_dir) / "test_project"+ mock_create_folder.return_value = (mock_folder_path, "test_project", "TestProject")++ create_crew("test-project/", skip_provider=True)++ mock_create_folder.assert_called_once_with("test-project/", None)+ mock_copy_template.assert_called()+ copy_calls = mock_copy_template.call_args_list++ for call in copy_calls:+ args = call[0]+ if len(args) >= 5:+ folder_name_arg = args[4]+ assert not folder_name_arg.endswith("/"), f"folder_name should not end with slash: {folder_name_arg}"++[email protected]("crewai.cli.create_crew.copy_template")[email protected]("crewai.cli.create_crew.write_env_file")[email protected]("crewai.cli.create_crew.load_env_vars")+def test_create_crew_with_multiple_trailing_slashes(mock_load_env, mock_write_env, mock_copy_template, temp_dir):+ mock_load_env.return_value = {}++ with tempfile.TemporaryDirectory() as work_dir:+ with mock.patch("crewai.cli.create_crew.create_folder_structure") as mock_create_folder:+ mock_folder_path = Path(work_dir) / "test_project"+ mock_create_folder.return_value = (mock_folder_path, "test_project", "TestProject")++ create_crew("test-project///", skip_provider=True)++ mock_create_folder.assert_called_once_with("test-project///", None)++[email protected]("crewai.cli.create_crew.copy_template")[email protected]("crewai.cli.create_crew.write_env_file")[email protected]("crewai.cli.create_crew.load_env_vars")+def test_create_crew_normal_name_still_works(mock_load_env, mock_write_env, mock_copy_template, temp_dir):+ mock_load_env.return_value = {}++ with tempfile.TemporaryDirectory() as work_dir:+ with mock.patch("crewai.cli.create_crew.create_folder_structure") as mock_create_folder:+ mock_folder_path = Path(work_dir) / "normal_project"+ mock_create_folder.return_value = (mock_folder_path, "normal_project", "NormalProject")++ create_crew("normal-project", skip_provider=True)++ mock_create_folder.assert_called_once_with("normal-project", None)+++def test_create_folder_structure_handles_spaces_and_dashes_with_slash():+ with tempfile.TemporaryDirectory() as temp_dir:+ folder_path, folder_name, class_name = create_folder_structure("My Cool-Project/", parent_folder=temp_dir)++ assert folder_name == "my_cool_project"+ assert class_name == "MyCoolProject"+ assert folder_path.name == "my_cool_project"+ assert folder_path.exists()+ assert folder_path.parent == Path(temp_dir)+++def test_create_folder_structure_raises_error_for_invalid_names():+ with tempfile.TemporaryDirectory() as temp_dir:+ invalid_cases = [+ ("123project/", "cannot start with a digit"),+ ("True/", "reserved Python keyword"),+ ("False/", "reserved Python keyword"),+ ("None/", "reserved Python keyword"),+ ("class/", "reserved Python keyword"),+ ("def/", "reserved Python keyword"),+ (" /", "empty or contain only whitespace"),+ ("", "empty or contain only whitespace"),+ ("@#$/", "contains no valid characters"),+ ]++ for invalid_name, expected_error in invalid_cases:+ with pytest.raises(ValueError, match=expected_error):+ create_folder_structure(invalid_name, parent_folder=temp_dir)+++def test_create_folder_structure_validates_names():+ with tempfile.TemporaryDirectory() as temp_dir:+ valid_cases = [+ ("hello/", "hello", "Hello"),+ ("my-project/", "my_project", "MyProject"),+ ("hello_world/", "hello_world", "HelloWorld"),+ ("valid123/", "valid123", "Valid123"),+ ("hello.world/", "helloworld", "HelloWorld"),+ ("hello@world/", "helloworld", "HelloWorld"),+ ]++ for valid_name, expected_folder, expected_class in valid_cases:+ folder_path, folder_name, class_name = create_folder_structure(valid_name, parent_folder=temp_dir)+ assert folder_name == expected_folder+ assert class_name == expected_class++ assert folder_name.isidentifier(), f"folder_name '{folder_name}' should be valid Python identifier"+ assert not keyword.iskeyword(folder_name), f"folder_name '{folder_name}' should not be Python keyword"+ assert not folder_name[0].isdigit(), f"folder_name '{folder_name}' should not start with digit"++ assert class_name.isidentifier(), f"class_name '{class_name}' should be valid Python identifier"+ assert not keyword.iskeyword(class_name), f"class_name '{class_name}' should not be Python keyword"+ assert folder_path.parent == Path(temp_dir)++ if folder_path.exists():+ shutil.rmtree(folder_path)++[email protected]("crewai.cli.create_crew.copy_template")[email protected]("crewai.cli.create_crew.write_env_file")[email protected]("crewai.cli.create_crew.load_env_vars")+def test_create_crew_with_parent_folder_and_trailing_slash(mock_load_env, mock_write_env, mock_copy_template, temp_dir):+ mock_load_env.return_value = {}++ with tempfile.TemporaryDirectory() as work_dir:+ parent_path = Path(work_dir) / "parent"+ parent_path.mkdir()++ create_crew("child-crew/", skip_provider=True, parent_folder=parent_path)++ crew_path = parent_path / "child_crew"+ assert crew_path.exists()+ assert not (crew_path / "src").exists()+++def test_create_folder_structure_folder_name_validation():+ """Test that folder names are validated as valid Python module names"""+ with tempfile.TemporaryDirectory() as temp_dir:+ folder_invalid_cases = [+ ("123invalid/", "cannot start with a digit.*invalid Python module name"),+ ("import/", "reserved Python keyword"),+ ("class/", "reserved Python keyword"),+ ("for/", "reserved Python keyword"),+ ("@#$invalid/", "contains no valid characters.*Python module name"),+ ]++ for invalid_name, expected_error in folder_invalid_cases:+ with pytest.raises(ValueError, match=expected_error):+ create_folder_structure(invalid_name, parent_folder=temp_dir)++ valid_cases = [+ ("hello-world/", "hello_world"),+ ("my.project/", "myproject"),+ ("test@123/", "test123"),+ ("valid_name/", "valid_name"),+ ]++ for valid_name, expected_folder in valid_cases:+ folder_path, folder_name, class_name = create_folder_structure(valid_name, parent_folder=temp_dir)+ assert folder_name == expected_folder+ assert folder_name.isidentifier()+ assert not keyword.iskeyword(folder_name)++ if folder_path.exists():+ shutil.rmtree(folder_path)