ara-cli 0.1.10.5__py3-none-any.whl → 0.1.13.3__py3-none-any.whl

tests/test_chat_script_runner.py

@@ -0,0 +1,454 @@
+"""
+Unit tests for chat_script_runner modules.
+
+Provides full test coverage for:
+- script_completer.py
+- script_finder.py
+- script_lister.py
+- script_runner.py
+"""
+
+import pytest
+import os
+import tempfile
+from unittest.mock import patch, MagicMock
+from ara_cli.chat_script_runner.script_completer import ScriptCompleter
+from ara_cli.chat_script_runner.script_finder import ScriptFinder
+from ara_cli.chat_script_runner.script_lister import ScriptLister
+from ara_cli.chat_script_runner.script_runner import ScriptRunner
+
+
+# =============================================================================
+# Tests for ScriptFinder
+# =============================================================================
+
+
+class TestScriptFinder:
+    """Tests for ScriptFinder class."""
+
+    @patch("ara_cli.chat_script_runner.script_finder.ConfigManager.get_config")
+    def test_get_custom_scripts_dir(self, mock_get_config):
+        """Returns custom scripts directory path."""
+        mock_config = MagicMock()
+        mock_config.local_prompt_templates_dir = "/path/to/templates"
+        mock_get_config.return_value = mock_config
+
+        finder = ScriptFinder()
+        result = finder.get_custom_scripts_dir()
+
+        assert result == os.path.join("/path/to/templates", "custom-scripts")
+
+    @patch("ara_cli.chat_script_runner.script_finder.ConfigManager.get_config")
+    def test_get_global_scripts_dir(self, mock_get_config):
+        """Returns global scripts directory path."""
+        mock_config = MagicMock()
+        mock_config.local_prompt_templates_dir = "/path/to/templates"
+        mock_get_config.return_value = mock_config
+
+        finder = ScriptFinder()
+        result = finder.get_global_scripts_dir()
+
+        assert result == os.path.join("/path/to/templates", "global-scripts")
+
+    @patch("ara_cli.chat_script_runner.script_finder.ConfigManager.get_config")
+    @patch("os.path.exists")
+    def test_find_script_with_global_prefix(self, mock_exists, mock_get_config):
+        """Finds script with global/ prefix."""
+        mock_config = MagicMock()
+        mock_config.local_prompt_templates_dir = "/templates"
+        mock_get_config.return_value = mock_config
+        mock_exists.return_value = True
+
+        finder = ScriptFinder()
+        result = finder.find_script("global/test.py")
+
+        expected_path = os.path.join("/templates", "global-scripts", "test.py")
+        assert result == expected_path
+
+    @patch("ara_cli.chat_script_runner.script_finder.ConfigManager.get_config")
+    @patch("os.path.exists")
+    def test_find_script_in_custom_first(self, mock_exists, mock_get_config):
+        """Finds script in custom-scripts first."""
+        mock_config = MagicMock()
+        mock_config.local_prompt_templates_dir = "/templates"
+        mock_get_config.return_value = mock_config
+
+        # Custom script exists
+        def exists_side_effect(path):
+            return "custom-scripts" in path
+
+        mock_exists.side_effect = exists_side_effect
+
+        finder = ScriptFinder()
+        result = finder.find_script("test.py")
+
+        assert "custom-scripts" in result
+
+    @patch("ara_cli.chat_script_runner.script_finder.ConfigManager.get_config")
+    @patch("os.path.exists")
+    def test_find_script_falls_back_to_global(self, mock_exists, mock_get_config):
+        """Falls back to global-scripts when not in custom."""
+        mock_config = MagicMock()
+        mock_config.local_prompt_templates_dir = "/templates"
+        mock_get_config.return_value = mock_config
+
+        # Only global script exists
+        def exists_side_effect(path):
+            return "global-scripts" in path
+
+        mock_exists.side_effect = exists_side_effect
+
+        finder = ScriptFinder()
+        result = finder.find_script("test.py")
+
+        assert "global-scripts" in result
+
+    @patch("ara_cli.chat_script_runner.script_finder.ConfigManager.get_config")
+    @patch("os.path.exists", return_value=False)
+    def test_find_script_returns_none_when_not_found(
+        self, mock_exists, mock_get_config
+    ):
+        """Returns None when script not found."""
+        mock_config = MagicMock()
+        mock_config.local_prompt_templates_dir = "/templates"
+        mock_get_config.return_value = mock_config
+
+        finder = ScriptFinder()
+        result = finder.find_script("nonexistent.py")
+
+        assert result is None
+
+    @patch("ara_cli.chat_script_runner.script_finder.ConfigManager.get_config")
+    def test_stores_absolute_path_on_init(self, mock_get_config):
+        """Stores absolute path at init time, enabling script discovery after chdir.
+        
+        This test reproduces the bug where 'ara prompt chat' couldn't find custom
+        scripts because Chat.start() changes the working directory and the relative
+        path './ara/.araconfig' no longer resolved correctly.
+        """
+        mock_config = MagicMock()
+        mock_config.local_prompt_templates_dir = "./ara/.araconfig"
+        mock_get_config.return_value = mock_config
+
+        # Create finder from original working directory
+        original_cwd = os.getcwd()
+        finder = ScriptFinder()
+
+        # Verify it stored an absolute path
+        assert os.path.isabs(finder.local_prompt_templates_dir)
+        
+        # The path should resolve to cwd + relative path
+        expected_abs = os.path.abspath("./ara/.araconfig")
+        assert finder.local_prompt_templates_dir == expected_abs
+
+    @patch("ara_cli.chat_script_runner.script_finder.ConfigManager.get_config")
+    def test_scripts_found_after_chdir(self, mock_get_config):
+        """Scripts are found even after changing working directory.
+        
+        Simulates the 'ara prompt chat' scenario where the working directory
+        changes to the artefact data directory after ScriptFinder is created.
+        """
+        # Use a temp directory to simulate the scenario
+        with tempfile.TemporaryDirectory() as tmpdir:
+            # Setup: Create directories simulating project structure
+            project_root = os.path.join(tmpdir, "project")
+            custom_scripts_dir = os.path.join(project_root, "ara", ".araconfig", "custom-scripts")
+            artefact_data_dir = os.path.join(project_root, "ara", "capabilities", "test.data")
+            os.makedirs(custom_scripts_dir)
+            os.makedirs(artefact_data_dir)
+            
+            # Create a test script
+            test_script = os.path.join(custom_scripts_dir, "test_script.py")
+            with open(test_script, "w") as f:
+                f.write("print('hello')")
+            
+            original_cwd = os.getcwd()
+            try:
+                # Change to project root (simulating ara cli startup)
+                os.chdir(project_root)
+                
+                mock_config = MagicMock()
+                mock_config.local_prompt_templates_dir = "./ara/.araconfig"
+                mock_get_config.return_value = mock_config
+                
+                # Create ScriptFinder while in project root
+                finder = ScriptFinder()
+                
+                # Now change to artefact data dir (simulating Chat.start())
+                os.chdir(artefact_data_dir)
+                
+                # ScriptFinder should still find the script
+                result = finder.find_script("test_script.py")
+                assert result is not None
+                assert result == test_script
+            finally:
+                os.chdir(original_cwd)
+
+
+# =============================================================================
+# Tests for ScriptLister
+# =============================================================================
+
+
+class TestScriptLister:
+    """Tests for ScriptLister class."""
+
+    @patch("ara_cli.chat_script_runner.script_lister.ScriptFinder")
+    @patch("os.path.isdir", return_value=True)
+    @patch("glob.glob")
+    def test_get_custom_scripts(self, mock_glob, mock_isdir, mock_finder_class):
+        """Returns list of custom script basenames."""
+        mock_finder = MagicMock()
+        mock_finder.get_custom_scripts_dir.return_value = "/templates/custom-scripts"
+        mock_finder_class.return_value = mock_finder
+        mock_glob.return_value = [
+            "/templates/custom-scripts/script1.py",
+            "/templates/custom-scripts/script2.py",
+        ]
+
+        lister = ScriptLister()
+        result = lister.get_custom_scripts()
+
+        assert result == ["script1.py", "script2.py"]
+
+    @patch("ara_cli.chat_script_runner.script_lister.ScriptFinder")
+    @patch("os.path.isdir", return_value=True)
+    @patch("glob.glob")
+    def test_get_global_scripts(self, mock_glob, mock_isdir, mock_finder_class):
+        """Returns list of global script basenames."""
+        mock_finder = MagicMock()
+        mock_finder.get_global_scripts_dir.return_value = "/templates/global-scripts"
+        mock_finder_class.return_value = mock_finder
+        mock_glob.return_value = ["/templates/global-scripts/global1.py"]
+
+        lister = ScriptLister()
+        result = lister.get_global_scripts()
+
+        assert result == ["global1.py"]
+
+    @patch("ara_cli.chat_script_runner.script_lister.ScriptFinder")
+    @patch("os.path.isdir", return_value=False)
+    def test_get_custom_scripts_returns_empty_when_dir_not_exists(
+        self, mock_isdir, mock_finder_class
+    ):
+        """Returns empty list when custom scripts dir doesn't exist."""
+        mock_finder = MagicMock()
+        mock_finder.get_custom_scripts_dir.return_value = "/nonexistent"
+        mock_finder_class.return_value = mock_finder
+
+        lister = ScriptLister()
+        result = lister.get_custom_scripts()
+
+        assert result == []
+
+    @patch("ara_cli.chat_script_runner.script_lister.ScriptFinder")
+    @patch("os.path.isdir", return_value=True)
+    @patch("glob.glob")
+    def test_get_all_scripts_combines_and_prefixes(
+        self, mock_glob, mock_isdir, mock_finder_class
+    ):
+        """Combines custom and global scripts with global/ prefix."""
+        mock_finder = MagicMock()
+        mock_finder.get_custom_scripts_dir.return_value = "/templates/custom-scripts"
+        mock_finder.get_global_scripts_dir.return_value = "/templates/global-scripts"
+        mock_finder_class.return_value = mock_finder
+
+        def glob_side_effect(pattern):
+            if "custom" in pattern:
+                return ["/templates/custom-scripts/custom.py"]
+            return ["/templates/global-scripts/global.py"]
+
+        mock_glob.side_effect = glob_side_effect
+
+        lister = ScriptLister()
+        result = lister.get_all_scripts()
+
+        assert "custom.py" in result
+        assert "global/global.py" in result
+
+
+# =============================================================================
+# Tests for ScriptRunner
+# =============================================================================
+
+
+class TestScriptRunner:
+    """Tests for ScriptRunner class."""
+
+    @patch("ara_cli.chat_script_runner.script_runner.ScriptFinder")
+    @patch("ara_cli.chat_script_runner.script_runner.ScriptLister")
+    def test_run_script_returns_error_when_not_found(
+        self, mock_lister, mock_finder_class
+    ):
+        """Returns error message when script not found."""
+        mock_finder = MagicMock()
+        mock_finder.find_script.return_value = None
+        mock_finder_class.return_value = mock_finder
+
+        runner = ScriptRunner(chat_instance=MagicMock())
+        result = runner.run_script("nonexistent.py")
+
+        assert "not found" in result
+
+    @patch("ara_cli.chat_script_runner.script_runner.ScriptFinder")
+    @patch("ara_cli.chat_script_runner.script_runner.ScriptLister")
+    @patch("subprocess.run")
+    def test_run_script_returns_stdout_on_success(
+        self, mock_run, mock_lister, mock_finder_class
+    ):
+        """Returns stdout when script runs successfully."""
+        mock_finder = MagicMock()
+        mock_finder.find_script.return_value = "/path/to/script.py"
+        mock_finder_class.return_value = mock_finder
+
+        mock_result = MagicMock()
+        mock_result.stdout = "Script output"
+        mock_run.return_value = mock_result
+
+        runner = ScriptRunner(chat_instance=MagicMock())
+        result = runner.run_script("script.py")
+
+        assert result == "Script output"
+
+    @patch("ara_cli.chat_script_runner.script_runner.ScriptFinder")
+    @patch("ara_cli.chat_script_runner.script_runner.ScriptLister")
+    @patch("subprocess.run")
+    def test_run_script_with_args(
+        self, mock_run, mock_lister, mock_finder_class
+    ):
+        """Passes arguments to the script."""
+        mock_finder = MagicMock()
+        mock_finder.find_script.return_value = "/path/to/script.py"
+        mock_finder_class.return_value = mock_finder
+
+        mock_result = MagicMock()
+        mock_result.stdout = "Output with args"
+        mock_run.return_value = mock_result
+
+        runner = ScriptRunner(chat_instance=MagicMock())
+        result = runner.run_script("script.py", args=["arg1", "arg2"])
+
+        mock_run.assert_called_with(
+            ["python", "/path/to/script.py", "arg1", "arg2"],
+            capture_output=True,
+            text=True,
+            check=True,
+        )
+        assert result == "Output with args"
+
+    @patch("ara_cli.chat_script_runner.script_runner.ScriptFinder")
+    @patch("ara_cli.chat_script_runner.script_runner.ScriptLister")
+    @patch("subprocess.run")
+    def test_run_script_returns_error_on_failure(
+        self, mock_run, mock_lister, mock_finder_class
+    ):
+        """Returns error message when script fails."""
+        import subprocess
+
+        mock_finder = MagicMock()
+        mock_finder.find_script.return_value = "/path/to/script.py"
+        mock_finder_class.return_value = mock_finder
+
+        mock_run.side_effect = subprocess.CalledProcessError(
+            1, "python", stderr="Error details"
+        )
+
+        runner = ScriptRunner(chat_instance=MagicMock())
+        result = runner.run_script("script.py")
+
+        assert "Error running script" in result
+
+    @patch("ara_cli.chat_script_runner.script_runner.ScriptFinder")
+    @patch("ara_cli.chat_script_runner.script_runner.ScriptLister")
+    def test_get_available_scripts(self, mock_lister_class, mock_finder):
+        """Returns all available scripts."""
+        mock_lister = MagicMock()
+        mock_lister.get_all_scripts.return_value = ["script1.py", "script2.py"]
+        mock_lister_class.return_value = mock_lister
+
+        runner = ScriptRunner(chat_instance=MagicMock())
+        result = runner.get_available_scripts()
+
+        assert result == ["script1.py", "script2.py"]
+
+    @patch("ara_cli.chat_script_runner.script_runner.ScriptFinder")
+    @patch("ara_cli.chat_script_runner.script_runner.ScriptLister")
+    def test_get_global_scripts(self, mock_lister_class, mock_finder):
+        """Returns global scripts."""
+        mock_lister = MagicMock()
+        mock_lister.get_global_scripts.return_value = ["global.py"]
+        mock_lister_class.return_value = mock_lister
+
+        runner = ScriptRunner(chat_instance=MagicMock())
+        result = runner.get_global_scripts()
+
+        assert result == ["global.py"]
+
+
+# =============================================================================
+# Tests for ScriptCompleter
+# =============================================================================
+
+
+class TestScriptCompleter:
+    """Tests for ScriptCompleter class."""
+
+    @patch("ara_cli.chat_script_runner.script_completer.ScriptLister")
+    def test_completes_all_scripts_by_default(self, mock_lister_class):
+        """Returns all scripts when not global prefix."""
+        mock_lister = MagicMock()
+        mock_lister.get_all_scripts.return_value = [
+            "script1.py",
+            "script2.py",
+            "global/test.py",
+        ]
+        mock_lister_class.return_value = mock_lister
+
+        completer = ScriptCompleter()
+        result = completer("", "rpy ", 4, 4)
+
+        assert "script1.py" in result
+        assert "script2.py" in result
+
+    @patch("ara_cli.chat_script_runner.script_completer.ScriptLister")
+    def test_filters_scripts_by_prefix(self, mock_lister_class):
+        """Filters scripts by text prefix."""
+        mock_lister = MagicMock()
+        mock_lister.get_all_scripts.return_value = [
+            "script1.py",
+            "script2.py",
+            "other.py",
+        ]
+        mock_lister_class.return_value = mock_lister
+
+        completer = ScriptCompleter()
+        result = completer("script", "rpy script", 4, 10)
+
+        assert "script1.py" in result
+        assert "script2.py" in result
+        assert "other.py" not in result
+
+    @patch("ara_cli.chat_script_runner.script_completer.ScriptLister")
+    def test_completes_global_scripts_with_prefix(self, mock_lister_class):
+        """Returns only global scripts when using global/ prefix."""
+        mock_lister = MagicMock()
+        mock_lister.get_global_scripts.return_value = ["global1.py", "global2.py"]
+        mock_lister_class.return_value = mock_lister
+
+        completer = ScriptCompleter()
+        result = completer("", "rpy global/", 11, 11)
+
+        assert "global1.py" in result
+        assert "global2.py" in result
+
+    @patch("ara_cli.chat_script_runner.script_completer.ScriptLister")
+    def test_returns_all_when_text_empty(self, mock_lister_class):
+        """Returns all scripts when text is empty."""
+        mock_lister = MagicMock()
+        mock_lister.get_all_scripts.return_value = ["a.py", "b.py"]
+        mock_lister_class.return_value = mock_lister
+
+        completer = ScriptCompleter()
+        result = completer("", "rpy ", 4, 4)
+
+        assert result == ["a.py", "b.py"]

tests/test_llm_utils.py

@@ -0,0 +1,164 @@
+"""
+Unit tests for llm_utils.py
+
+Provides full test coverage for LLM utility functions.
+"""
+
+import pytest
+from unittest.mock import patch, MagicMock
+from ara_cli.llm_utils import (
+    get_configured_conversion_llm_model,
+    create_pydantic_ai_agent,
+    FALLBACK_MODEL,
+)
+
+
+# =============================================================================
+# Tests for get_configured_conversion_llm_model
+# =============================================================================
+
+
+class TestGetConfiguredConversionLlmModel:
+    """Tests for get_configured_conversion_llm_model function."""
+
+    @patch("ara_cli.llm_utils.ConfigManager.get_config")
+    def test_returns_fallback_when_no_config(self, mock_get_config):
+        """Returns fallback model when config is missing."""
+        mock_get_config.side_effect = Exception("Config not found")
+
+        result = get_configured_conversion_llm_model()
+
+        assert result == FALLBACK_MODEL
+
+    @patch("ara_cli.llm_utils.ConfigManager.get_config")
+    def test_returns_fallback_when_conversion_llm_not_set(self, mock_get_config):
+        """Returns fallback when conversion_llm is not set."""
+        mock_config = MagicMock()
+        mock_config.conversion_llm = None
+        mock_get_config.return_value = mock_config
+
+        result = get_configured_conversion_llm_model()
+
+        assert result == FALLBACK_MODEL
+
+    @patch("ara_cli.llm_utils.ConfigManager.get_config")
+    def test_returns_fallback_when_key_not_in_llm_config(self, mock_get_config):
+        """Returns fallback when conversion_llm key not in llm_config."""
+        mock_config = MagicMock()
+        mock_config.conversion_llm = "nonexistent_key"
+        mock_config.llm_config = {}
+        mock_get_config.return_value = mock_config
+
+        result = get_configured_conversion_llm_model()
+
+        assert result == FALLBACK_MODEL
+
+    @patch("ara_cli.llm_utils.ConfigManager.get_config")
+    def test_converts_litellm_format_to_pydantic_format(self, mock_get_config):
+        """Converts LiteLLM model format (/) to PydanticAI format (:)."""
+        mock_config = MagicMock()
+        mock_config.conversion_llm = "default"
+        mock_llm_item = MagicMock()
+        mock_llm_item.model = "openai/gpt-4o"
+        mock_config.llm_config = {"default": mock_llm_item}
+        mock_get_config.return_value = mock_config
+
+        result = get_configured_conversion_llm_model()
+
+        assert result == "openai:gpt-4o"
+
+    @patch("ara_cli.llm_utils.ConfigManager.get_config")
+    def test_keeps_pydantic_format_unchanged(self, mock_get_config):
+        """Keeps PydanticAI format unchanged."""
+        mock_config = MagicMock()
+        mock_config.conversion_llm = "default"
+        mock_llm_item = MagicMock()
+        mock_llm_item.model = "openai:gpt-4o"
+        mock_config.llm_config = {"default": mock_llm_item}
+        mock_get_config.return_value = mock_config
+
+        result = get_configured_conversion_llm_model()
+
+        assert result == "openai:gpt-4o"
+
+    @patch("ara_cli.llm_utils.ConfigManager.get_config")
+    def test_handles_model_without_prefix(self, mock_get_config):
+        """Handles model name without provider prefix."""
+        mock_config = MagicMock()
+        mock_config.conversion_llm = "default"
+        mock_llm_item = MagicMock()
+        mock_llm_item.model = "gpt-4o"
+        mock_config.llm_config = {"default": mock_llm_item}
+        mock_get_config.return_value = mock_config
+
+        result = get_configured_conversion_llm_model()
+
+        assert result == "gpt-4o"
+
+
+# =============================================================================
+# Tests for create_pydantic_ai_agent
+# =============================================================================
+
+
+class TestCreatePydanticAiAgent:
+    """Tests for create_pydantic_ai_agent function."""
+
+    @patch("ara_cli.llm_utils.Agent")
+    @patch("ara_cli.llm_utils.get_configured_conversion_llm_model")
+    def test_uses_configured_model_when_not_provided(self, mock_get_model, mock_agent):
+        """Uses configured model when model_name not provided."""
+        mock_get_model.return_value = "configured:model"
+        mock_output_type = MagicMock()
+
+        create_pydantic_ai_agent(output_type=mock_output_type)
+
+        mock_agent.assert_called_once_with(
+            model="configured:model",
+            output_type=mock_output_type,
+            instrument=True,
+        )
+
+    @patch("ara_cli.llm_utils.Agent")
+    @patch("ara_cli.llm_utils.get_configured_conversion_llm_model")
+    def test_uses_provided_model_name(self, mock_get_model, mock_agent):
+        """Uses provided model_name instead of configured model."""
+        mock_output_type = MagicMock()
+
+        create_pydantic_ai_agent(
+            output_type=mock_output_type, model_name="custom:model"
+        )
+
+        mock_agent.assert_called_once_with(
+            model="custom:model",
+            output_type=mock_output_type,
+            instrument=True,
+        )
+        mock_get_model.assert_not_called()
+
+    @patch("ara_cli.llm_utils.Agent")
+    @patch("ara_cli.llm_utils.get_configured_conversion_llm_model")
+    def test_sets_instrument_flag(self, mock_get_model, mock_agent):
+        """Sets instrument flag correctly."""
+        mock_get_model.return_value = "test:model"
+        mock_output_type = MagicMock()
+
+        create_pydantic_ai_agent(output_type=mock_output_type, instrument=False)
+
+        mock_agent.assert_called_once_with(
+            model="test:model",
+            output_type=mock_output_type,
+            instrument=False,
+        )
+
+    @patch("ara_cli.llm_utils.Agent")
+    @patch("ara_cli.llm_utils.get_configured_conversion_llm_model")
+    def test_returns_agent_instance(self, mock_get_model, mock_agent):
+        """Returns the created agent instance."""
+        mock_get_model.return_value = "test:model"
+        mock_agent_instance = MagicMock()
+        mock_agent.return_value = mock_agent_instance
+
+        result = create_pydantic_ai_agent(output_type=MagicMock())
+
+        assert result == mock_agent_instance