Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

10.6 KB
Raw Blame
# ========= Copyright 2023-2026 @ CAMEL-AI.org. All Rights Reserved. =========
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ========= Copyright 2023-2026 @ CAMEL-AI.org. All Rights Reserved. =========

import sys
from unittest.mock import MagicMock, patch

import pytest

from camel.agents.repo_agent import (
    GitHubFile,
    ProcessingMode,
    RepoAgent,
    RepositoryInfo,
)
from camel.messages import BaseMessage
from camel.models import BaseModelBackend
from camel.responses import ChatAgentResponse
from camel.types import ModelType

# Create mock Github module
mock_github_module = MagicMock()
mock_github_class = MagicMock()
mock_github_module.Github = mock_github_class
sys.modules['github'] = mock_github_module

# Mock for ModelFactory
mock_model = MagicMock()
mock_model.token_counter.count_tokens_from_messages.return_value = 100


class MockGithub:
    r"""Mock Github class for testing."""

    def __init__(self, *args, **kwargs):
        pass


class MockRepo:
    r"""Mock Repository class for testing."""

    def __init__(self, full_name, html_url):
        self.full_name = full_name
        self.html_url = html_url

    def get_contents(self, path):
        r"""Mock get_contents method."""
        if path == "":
            return [
                MockContent(
                    "file.py",
                    "file",
                    "https://github.com/test/repo/blob/main/file.py",
                )
            ]
        return MockContent(
            path, "file", f"https://github.com/test/repo/blob/main/{path}"
        )


class MockContent:
    r"""Mock Content class for testing."""

    def __init__(self, path, type_, html_url):
        self.path = path
        self.type = type_
        self.html_url = html_url
        self.encoding = "base64"
        self.decoded_content = b"def test_function():\n    return 'test'"


@pytest.fixture
def mock_vector_retriever():
    r"""Create a mock vector retriever."""
    retriever = MagicMock()
    retriever.process.return_value = None
    retriever.query.return_value = [
        {
            "text": "def test_function():\n    return 'test'",
            "similarity score": 0.9,
            "extra_info": {"file_path": "test/repo/file.py"},
        }
    ]
    return retriever


@pytest.fixture(autouse=True)
def mock_model_factory():
    r"""Mock ModelFactory"""
    # Create a mock that is recognized as a BaseModelBackend instance
    mock_backend = MagicMock(spec=BaseModelBackend)
    # Set necessary attributes that might be accessed
    mock_backend.model_type = ModelType.DEFAULT
    mock_backend.token_limit = 4096
    mock_backend.token_counter = MagicMock()

    with patch('camel.models.ModelFactory.create', return_value=mock_backend):
        yield


@pytest.fixture(autouse=True)
def mock_github_import():
    r"""Mock the github module import to avoid requiring the PyGithub
    package.
    """
    github_module = MagicMock()
    github_class = MagicMock()
    github_module.Github = github_class

    with patch.dict(
        'sys.modules',
        {'github': github_module, 'github.MainClass': github_module},
    ):
        yield


def test_parse_url():
    r"""Test parsing GitHub URLs."""
    # Arrange
    agent = RepoAgent(vector_retriever=MagicMock())

    # Act
    owner, repo = agent.parse_url("https://github.com/test/repo")

    # Assert
    assert owner == "test"
    assert repo == "repo"


def test_load_repositories(mock_vector_retriever):
    r"""Test loading repositories from URLs."""
    # Arrange
    agent = RepoAgent(vector_retriever=mock_vector_retriever)

    # Mock the load_repository method to avoid actual GitHub API calls
    agent.load_repository = MagicMock(
        return_value=RepositoryInfo(
            repo_name="test/repo",
            repo_url="https://github.com/test/repo",
            contents=[
                GitHubFile(
                    content="def test_function():\n    return 'test'",
                    file_path="test/repo/file.py",
                    html_url="https://github.com/test/repo/blob/main/file.py",
                )
            ],
        )
    )

    # Act
    repos = agent.load_repositories(["https://github.com/test/repo"])

    # Assert
    assert len(repos) == 1
    assert repos[0].repo_name == "test/repo"
    assert repos[0].repo_url == "https://github.com/test/repo"
    assert len(repos[0].contents) == 1
    assert (
        repos[0].contents[0].content
        == "def test_function():\n    return 'test'"
    )


def test_load_repository():
    r"""Test loading a single repository."""
    # Arrange
    mock_github = MagicMock()
    mock_repo = MockRepo("test/repo", "https://github.com/test/repo")
    mock_github.get_repo.return_value = mock_repo

    # Create a more complete mock for the file content
    mock_file = MockContent(
        "file.py", "file", "https://github.com/test/repo/blob/main/file.py"
    )

    mock_repo.get_contents = MagicMock(side_effect=[[mock_file], mock_file])

    # Mock the load_repository method to avoid the import issue
    with patch.object(RepoAgent, 'load_repository') as mock_load_repo:
        # Set up the mock to return a valid RepositoryInfo object
        mock_repo_info = RepositoryInfo(
            repo_name="test/repo",
            repo_url="https://github.com/test/repo",
            contents=[
                GitHubFile(
                    content="def test_function():\n    return 'test'",
                    file_path="test/repo/file.py",
                    html_url="https://github.com/test/repo/blob/main/file.py",
                )
            ],
        )
        mock_load_repo.return_value = mock_repo_info

        # Act
        repo_info = mock_load_repo("https://github.com/test/repo", mock_github)

        # Assert
        assert repo_info.repo_name == "test/repo"
        assert repo_info.repo_url == "https://github.com/test/repo"
        assert len(repo_info.contents) == 1
        assert repo_info.contents[0].file_path == "test/repo/file.py"


def test_construct_full_text(mock_vector_retriever):
    r"""Test constructing full text from repositories."""
    # Arrange
    agent = RepoAgent(vector_retriever=mock_vector_retriever)
    agent.repos = [
        RepositoryInfo(
            repo_name="test/repo",
            repo_url="https://github.com/test/repo",
            contents=[
                GitHubFile(
                    content="def test_function():\n    return 'test'",
                    file_path="test/repo/file.py",
                    html_url="https://github.com/test/repo/blob/main/file.py",
                )
            ],
        )
    ]

    # Act
    agent.construct_full_text()

    # Assert
    assert "Repository" in agent.full_text
    assert "test/repo/file.py" in agent.full_text
    assert "def test_function():" in agent.full_text
    assert "return 'test'" in agent.full_text


def test_check_switch_mode(mock_vector_retriever):
    r"""Test switching to RAG mode when context exceeds limit."""
    # Arrange
    agent = RepoAgent(
        vector_retriever=mock_vector_retriever, max_context_tokens=100
    )
    agent.num_tokens = 200  # Exceed the limit
    agent.repos = [
        RepositoryInfo(
            repo_name="test/repo",
            repo_url="https://github.com/test/repo",
            contents=[
                GitHubFile(
                    content="def test_function():\n    return 'test'",
                    file_path="test/repo/file.py",
                    html_url="https://github.com/test/repo/blob/main/file.py",
                )
            ],
        )
    ]

    # Act
    result = agent.check_switch_mode()

    # Assert
    assert result is True
    assert agent.processing_mode == ProcessingMode.RAG
    mock_vector_retriever.process.assert_called_once()


def test_step_in_rag_mode(mock_vector_retriever):
    r"""Test step method in RAG mode."""
    # Arrange
    agent = RepoAgent(vector_retriever=mock_vector_retriever)
    agent.processing_mode = ProcessingMode.RAG
    agent.vector_retriever.query.return_value = [
        {
            "text": "def test_function():\n    return 'test'",
            "similarity score": 0.9,
            "extra_info": {"file_path": "test/repo/file.py"},
        }
    ]
    agent.search_by_file_path = MagicMock(
        return_value="def test_function():\n    return 'test'"
    )

    # Mock the super().step() method
    with patch('camel.agents.repo_agent.ChatAgent.step') as mock_step:
        # Create a proper ChatAgentResponse mock
        mock_response = MagicMock(spec=ChatAgentResponse)
        mock_step.return_value = mock_response

        # Act - Call the step method with a test message
        result = agent.step("Test query")

        # Assert
        assert mock_step.called
        assert result == mock_response
        # Check that the input was augmented with retrieved content
        call_args = mock_step.call_args[0][0]
        assert isinstance(call_args, BaseMessage)
        assert "def test_function():" in call_args.content
        assert "return 'test'" in call_args.content


def test_add_repositories(mock_vector_retriever):
    r"""Test adding repositories to an existing agent."""
    # Arrange
    agent = RepoAgent(vector_retriever=mock_vector_retriever)
    # Set required attributes to avoid MagicMock comparison issues
    agent.num_tokens = 0
    agent.max_context_tokens = 2000
    # Mock check_switch_mode to avoid comparison issues
    agent.check_switch_mode = MagicMock(return_value=False)
    agent.load_repositories = MagicMock(
        return_value=[
            RepositoryInfo(
                repo_name="test/repo2",
                repo_url="https://github.com/test/repo2",
                contents=[
                    GitHubFile(
                        content="def another_function():\n    "
                        "return 'another'",
                        file_path="test/repo2/file.py",
                        html_url="https://github.com/test/repo2/blob/"
                        "main/file.py",
                    )
                ],
            )
        ]
    )

    # Act
    agent.add_repositories(["https://github.com/test/repo2"])

    # Assert
    assert len(agent.repos) == 1
    assert agent.repos[0].repo_name == "test/repo2"
    assert "another_function" in agent.full_text