🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org
Python agentai-societiesartificial-intelligencecommunicative-aicooperative-aideep-learninglarge-language-modelsmulti-agent-systemsnatural-language-processing
# ========= 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 io
import os
import shutil
from unittest.mock import MagicMock, patch
import pytest
from PIL import Image
from camel.toolkits.browser_toolkit import (
BaseBrowser,
BrowserToolkit,
interactive_region_from_dict,
visual_viewport_from_dict,
)
from camel.toolkits.browser_toolkit_commons import dom_rectangle_from_dict
TEST_URL = "https://example.com"
@pytest.fixture(scope="function")
def base_browser_fixture():
with patch('playwright.sync_api.sync_playwright'):
browser = BaseBrowser(headless=True, cache_dir="test_cache")
yield browser
# Cleanup
if os.path.exists("test_cache"):
shutil.rmtree("test_cache", ignore_errors=True)
@pytest.fixture(scope="function")
def browser_toolkit_fixture():
with patch('playwright.sync_api.sync_playwright'):
toolkit = BrowserToolkit(headless=True, cache_dir="test_cache")
yield toolkit
# Cleanup
if os.path.exists("test_cache"):
shutil.rmtree("test_cache", ignore_errors=True)
def test_base_browser_init(base_browser_fixture):
browser = base_browser_fixture
assert browser.headless is True
assert browser.cache_dir == "test_cache"
assert isinstance(browser.history, list)
assert isinstance(browser.page_history, list)
assert (
browser.user_data_dir is None
) # Added assertion for default user_data_dir
def test_base_browser_init_with_user_data_dir():
test_user_dir = "test_user_data_dir_sync"
try:
with patch('playwright.sync_api.sync_playwright'):
# Mock _ensure_browser_installed to prevent
# actual browser checks during this specific init test
with patch.object(
BaseBrowser, '_ensure_browser_installed', MagicMock()
) as mock_ensure_installed:
browser = BaseBrowser(
headless=True, user_data_dir=test_user_dir
)
mock_ensure_installed.assert_called_once()
assert browser.user_data_dir == test_user_dir
assert os.path.exists(
test_user_dir
) # Check if __init__ created it
finally:
if os.path.exists(test_user_dir):
shutil.rmtree(test_user_dir)
def test_base_browser_initialization_order():
with patch('playwright.sync_api.sync_playwright'):
browser = BaseBrowser(headless=True) # __init__ called
assert browser.browser is None # browser not launched yet
assert browser.page is None # page not created yet
browser.init() # explicit init() call
# This assertion depends on user_data_dir being None. If it were set,
# browser.browser would be None. For default (None), it's not None.
assert browser.browser is not None # browser launched
assert browser.page is not None # page created
def test_base_browser_initialization_order_with_user_data_dir():
test_init_dir = "test_init_user_data_sync"
with (
patch(
'playwright.sync_api.sync_playwright'
) as mock_sync_playwright_entry,
patch.object(
BaseBrowser, '_ensure_browser_installed', MagicMock()
) as mock_ensure_installed_in_init,
):
# Configure the mock for sync_playwright().start()
mock_playwright_api = mock_sync_playwright_entry.return_value
mock_playwright_started_instance = (
mock_playwright_api.start.return_value
)
# Configure the mock for launch_persistent_context
mock_context = MagicMock(name="PersistentContextMock")
mock_page = MagicMock(name="PageMock")
# ruff: noqa: E501
mock_playwright_started_instance.chromium.launch_persistent_context.return_value = mock_context
mock_context.pages = [] # Simulate no pre-existing pages initially
mock_context.new_page.return_value = mock_page
try:
browser = BaseBrowser(headless=True, user_data_dir=test_init_dir)
# Assertions for __init__ behaviour
mock_ensure_installed_in_init.assert_called_once()
assert os.path.exists(
test_init_dir
) # __init__ should have created it
assert browser.browser is None # Before init
assert browser.page is None # Before init
assert browser.context is None # Before init
browser.init()
# Action: This calls
# self.playwright.chromium.launch_persistent_context
# Assertions for init() behaviour with user_data_dir
# ruff: noqa: E501
mock_playwright_started_instance.chromium.launch_persistent_context.assert_called_once()
# ruff: noqa: E501
call_kwargs = mock_playwright_started_instance.chromium.launch_persistent_context.call_args.kwargs
assert call_kwargs['user_data_dir'] == test_init_dir
assert call_kwargs['headless'] is True
assert call_kwargs['channel'] == "chromium" # Default channel
assert call_kwargs['accept_downloads'] is True
assert isinstance(call_kwargs['user_agent'], str)
assert call_kwargs['java_script_enabled'] is True
assert isinstance(call_kwargs['args'], list)
assert browser.browser is None # Key assertion: No separate
# browser object with persistent context
assert browser.context == mock_context
assert browser.page == mock_page
finally:
if os.path.exists(test_init_dir):
shutil.rmtree(test_init_dir)
@pytest.mark.parametrize(
"channel",
[
"chrome",
"msedge",
"chromium",
],
)
def test_browser_channel_selection(channel):
with patch('playwright.sync_api.sync_playwright'):
browser = BaseBrowser(headless=True, channel=channel)
assert browser.channel == channel
def test_browser_visit_page(base_browser_fixture):
browser = base_browser_fixture
browser.init()
# Mock the page methods
browser.page.goto = MagicMock()
browser.page.wait_for_load_state = MagicMock()
browser.visit_page(TEST_URL)
browser.page.goto.assert_called_once_with(TEST_URL)
browser.page.wait_for_load_state.assert_called_once()
def test_browser_get_screenshot(base_browser_fixture):
browser = base_browser_fixture
browser.init()
# Create a mock image for testing
mock_image = Image.new('RGB', (100, 100))
img_byte_arr = io.BytesIO()
mock_image.save(img_byte_arr, format='PNG')
img_byte_arr = img_byte_arr.getvalue()
browser.page.screenshot = MagicMock(return_value=img_byte_arr)
image, file_path = browser.get_screenshot(save_image=False)
assert isinstance(image, Image.Image)
assert file_path is None
def test_browser_toolkit_browse_url(browser_toolkit_fixture):
toolkit = browser_toolkit_fixture
# Mock necessary components
toolkit.browser.visit_page = MagicMock()
toolkit._observe = MagicMock(return_value=("obs", "reason", "stop()"))
toolkit._get_final_answer = MagicMock(return_value="Task completed")
result = toolkit.browse_url(
task_prompt="Test task", start_url=TEST_URL, round_limit=1
)
assert result == "Task completed"
toolkit.browser.visit_page.assert_called_once_with(TEST_URL)
def test_browser_clean_cache(base_browser_fixture):
browser = base_browser_fixture
# Create a test file in cache directory
os.makedirs(browser.cache_dir, exist_ok=True)
test_file = os.path.join(browser.cache_dir, "test.txt")
with open(test_file, "w") as f:
f.write("test")
browser.clean_cache()
assert not os.path.exists(browser.cache_dir)
def test_browser_click_blank_area(base_browser_fixture):
browser = base_browser_fixture
browser.init()
browser.page.mouse.click = MagicMock()
browser.page.wait_for_load_state = MagicMock()
browser.click_blank_area()
browser.page.mouse.click.assert_called_once_with(0, 0)
browser.page.wait_for_load_state.assert_called_once()
def test_browser_get_url(base_browser_fixture):
browser = base_browser_fixture
browser.init()
browser.page.url = TEST_URL
assert browser.get_url() == TEST_URL
def test_browser_back_navigation(base_browser_fixture):
browser = base_browser_fixture
browser.init()
browser.page.go_back = MagicMock()
browser.page.wait_for_load_state = MagicMock()
browser.back()
browser.page.go_back.assert_called_once()
browser.page.wait_for_load_state.assert_called_once()
def test_dom_rectangle_from_dict():
rect_dict = {
"x": 10,
"y": 20,
"width": 100,
"height": 200,
"top": 20,
"right": 110,
"bottom": 220,
"left": 10,
}
rect = dom_rectangle_from_dict(rect_dict)
assert rect["width"] == 100
assert rect["left"] == 10
def test_interactive_region_from_dict():
region_dict = {
"tag_name": "button",
"role": "button",
"aria-name": "Submit",
"v-scrollable": False,
"rects": [
{
"x": 5,
"y": 5,
"width": 50,
"height": 20,
"top": 5,
"right": 55,
"bottom": 25,
"left": 5,
}
],
}
region = interactive_region_from_dict(region_dict)
assert region["tag_name"] == "button"
assert len(region["rects"]) == 1
def test_visual_viewport_from_dict():
viewport_dict = {
"height": 800,
"width": 600,
"offsetLeft": 0,
"offsetTop": 0,
"pageLeft": 0,
"pageTop": 0,
"scale": 1,
"clientWidth": 600,
"clientHeight": 800,
"scrollWidth": 600,
"scrollHeight": 1200,
}
viewport = visual_viewport_from_dict(viewport_dict)
assert viewport["height"] == 800
assert viewport["scrollHeight"] == 1200