mirror of
https://github.com/ArchiveBox/ArchiveBox.git
synced 2026-01-03 09:25:42 +10:00
Add tests for accessibility, parse_dom_outlinks, and consolelog plugins
Real integration tests using Chrome sessions with example.com: - accessibility: Tests page outline and accessibility tree extraction - parse_dom_outlinks: Tests link extraction and categorization - consolelog: Tests console output capture
This commit is contained in:
1
archivebox/plugins/accessibility/tests/__init__.py
Normal file
1
archivebox/plugins/accessibility/tests/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
"""Tests for the accessibility plugin."""
|
||||
120
archivebox/plugins/accessibility/tests/test_accessibility.py
Normal file
120
archivebox/plugins/accessibility/tests/test_accessibility.py
Normal file
@@ -0,0 +1,120 @@
|
||||
"""
|
||||
Tests for the accessibility plugin.
|
||||
|
||||
Tests the real accessibility hook with an actual URL to verify
|
||||
accessibility tree and page outline extraction.
|
||||
"""
|
||||
|
||||
import json
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
from django.test import TestCase
|
||||
|
||||
# Import chrome test helpers
|
||||
sys.path.insert(0, str(Path(__file__).parent.parent.parent / 'chrome' / 'tests'))
|
||||
from chrome_test_helpers import (
|
||||
chrome_session,
|
||||
get_test_env,
|
||||
get_plugin_dir,
|
||||
get_hook_script,
|
||||
)
|
||||
|
||||
|
||||
def chrome_available() -> bool:
|
||||
"""Check if Chrome/Chromium is available."""
|
||||
for name in ['chromium', 'chromium-browser', 'google-chrome', 'chrome']:
|
||||
if shutil.which(name):
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
# Get the path to the accessibility hook
|
||||
PLUGIN_DIR = get_plugin_dir(__file__)
|
||||
ACCESSIBILITY_HOOK = get_hook_script(PLUGIN_DIR, 'on_Snapshot__*_accessibility.*')
|
||||
|
||||
|
||||
class TestAccessibilityPlugin(TestCase):
|
||||
"""Test the accessibility plugin."""
|
||||
|
||||
def test_accessibility_hook_exists(self):
|
||||
"""Accessibility hook script should exist."""
|
||||
self.assertIsNotNone(ACCESSIBILITY_HOOK, "Accessibility hook not found in plugin directory")
|
||||
self.assertTrue(ACCESSIBILITY_HOOK.exists(), f"Hook not found: {ACCESSIBILITY_HOOK}")
|
||||
|
||||
|
||||
@pytest.mark.skipif(not chrome_available(), reason="Chrome not installed")
|
||||
class TestAccessibilityWithChrome(TestCase):
|
||||
"""Integration tests for accessibility plugin with Chrome."""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test environment."""
|
||||
self.temp_dir = Path(tempfile.mkdtemp())
|
||||
|
||||
def tearDown(self):
|
||||
"""Clean up."""
|
||||
shutil.rmtree(self.temp_dir, ignore_errors=True)
|
||||
|
||||
def test_accessibility_extracts_page_outline(self):
|
||||
"""Accessibility hook should extract headings and accessibility tree."""
|
||||
test_url = 'https://example.com'
|
||||
snapshot_id = 'test-accessibility-snapshot'
|
||||
|
||||
try:
|
||||
with chrome_session(
|
||||
self.temp_dir,
|
||||
crawl_id='test-accessibility-crawl',
|
||||
snapshot_id=snapshot_id,
|
||||
test_url=test_url,
|
||||
navigate=True,
|
||||
timeout=30,
|
||||
) as (chrome_process, chrome_pid, snapshot_chrome_dir):
|
||||
# Get environment and run the accessibility hook
|
||||
env = get_test_env()
|
||||
env['CHROME_HEADLESS'] = 'true'
|
||||
|
||||
# Run accessibility hook with the active Chrome session
|
||||
result = subprocess.run(
|
||||
['node', str(ACCESSIBILITY_HOOK), f'--url={test_url}', f'--snapshot-id={snapshot_id}'],
|
||||
cwd=str(snapshot_chrome_dir),
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=60,
|
||||
env=env
|
||||
)
|
||||
|
||||
# Check for output file
|
||||
accessibility_output = snapshot_chrome_dir / 'accessibility.json'
|
||||
|
||||
accessibility_data = None
|
||||
|
||||
# Try parsing from file first
|
||||
if accessibility_output.exists():
|
||||
with open(accessibility_output) as f:
|
||||
try:
|
||||
accessibility_data = json.load(f)
|
||||
except json.JSONDecodeError:
|
||||
pass
|
||||
|
||||
# Verify hook ran successfully
|
||||
self.assertEqual(result.returncode, 0, f"Hook failed: {result.stderr}")
|
||||
self.assertNotIn('Traceback', result.stderr)
|
||||
|
||||
# example.com has headings, so we should get accessibility data
|
||||
if accessibility_data:
|
||||
# Verify we got page outline data
|
||||
self.assertIn('headings', accessibility_data, f"Missing headings: {accessibility_data}")
|
||||
self.assertIn('url', accessibility_data, f"Missing url: {accessibility_data}")
|
||||
|
||||
except RuntimeError as e:
|
||||
if 'Chrome' in str(e) or 'CDP' in str(e):
|
||||
self.skipTest(f"Chrome session setup failed: {e}")
|
||||
raise
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
pytest.main([__file__, '-v'])
|
||||
1
archivebox/plugins/consolelog/tests/__init__.py
Normal file
1
archivebox/plugins/consolelog/tests/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
"""Tests for the consolelog plugin."""
|
||||
123
archivebox/plugins/consolelog/tests/test_consolelog.py
Normal file
123
archivebox/plugins/consolelog/tests/test_consolelog.py
Normal file
@@ -0,0 +1,123 @@
|
||||
"""
|
||||
Tests for the consolelog plugin.
|
||||
|
||||
Tests the real consolelog hook with an actual URL to verify
|
||||
console output capture.
|
||||
"""
|
||||
|
||||
import json
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
from django.test import TestCase
|
||||
|
||||
# Import chrome test helpers
|
||||
sys.path.insert(0, str(Path(__file__).parent.parent.parent / 'chrome' / 'tests'))
|
||||
from chrome_test_helpers import (
|
||||
chrome_session,
|
||||
get_test_env,
|
||||
get_plugin_dir,
|
||||
get_hook_script,
|
||||
)
|
||||
|
||||
|
||||
def chrome_available() -> bool:
|
||||
"""Check if Chrome/Chromium is available."""
|
||||
for name in ['chromium', 'chromium-browser', 'google-chrome', 'chrome']:
|
||||
if shutil.which(name):
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
# Get the path to the consolelog hook
|
||||
PLUGIN_DIR = get_plugin_dir(__file__)
|
||||
CONSOLELOG_HOOK = get_hook_script(PLUGIN_DIR, 'on_Snapshot__*_consolelog.*')
|
||||
|
||||
|
||||
class TestConsolelogPlugin(TestCase):
|
||||
"""Test the consolelog plugin."""
|
||||
|
||||
def test_consolelog_hook_exists(self):
|
||||
"""Consolelog hook script should exist."""
|
||||
self.assertIsNotNone(CONSOLELOG_HOOK, "Consolelog hook not found in plugin directory")
|
||||
self.assertTrue(CONSOLELOG_HOOK.exists(), f"Hook not found: {CONSOLELOG_HOOK}")
|
||||
|
||||
|
||||
@pytest.mark.skipif(not chrome_available(), reason="Chrome not installed")
|
||||
class TestConsolelogWithChrome(TestCase):
|
||||
"""Integration tests for consolelog plugin with Chrome."""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test environment."""
|
||||
self.temp_dir = Path(tempfile.mkdtemp())
|
||||
|
||||
def tearDown(self):
|
||||
"""Clean up."""
|
||||
shutil.rmtree(self.temp_dir, ignore_errors=True)
|
||||
|
||||
def test_consolelog_captures_output(self):
|
||||
"""Consolelog hook should capture console output from page."""
|
||||
test_url = 'https://example.com'
|
||||
snapshot_id = 'test-consolelog-snapshot'
|
||||
|
||||
try:
|
||||
with chrome_session(
|
||||
self.temp_dir,
|
||||
crawl_id='test-consolelog-crawl',
|
||||
snapshot_id=snapshot_id,
|
||||
test_url=test_url,
|
||||
navigate=True,
|
||||
timeout=30,
|
||||
) as (chrome_process, chrome_pid, snapshot_chrome_dir):
|
||||
# Get environment and run the consolelog hook
|
||||
env = get_test_env()
|
||||
env['CHROME_HEADLESS'] = 'true'
|
||||
|
||||
# Run consolelog hook with the active Chrome session
|
||||
result = subprocess.run(
|
||||
['node', str(CONSOLELOG_HOOK), f'--url={test_url}', f'--snapshot-id={snapshot_id}'],
|
||||
cwd=str(snapshot_chrome_dir),
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=120, # Longer timeout as it waits for navigation
|
||||
env=env
|
||||
)
|
||||
|
||||
# Check for output file
|
||||
console_output = snapshot_chrome_dir / 'console.jsonl'
|
||||
|
||||
# Verify hook ran (may succeed or timeout waiting for navigation)
|
||||
# The hook is designed to wait for page_loaded.txt from chrome_navigate
|
||||
# In test mode, that file may not exist, so hook may timeout
|
||||
# But it should still create the console.jsonl file
|
||||
|
||||
# At minimum, verify no crash
|
||||
self.assertNotIn('Traceback', result.stderr)
|
||||
|
||||
# If output file exists, verify it's valid JSONL
|
||||
if console_output.exists():
|
||||
with open(console_output) as f:
|
||||
content = f.read().strip()
|
||||
if content:
|
||||
for line in content.split('\n'):
|
||||
if line.strip():
|
||||
try:
|
||||
record = json.loads(line)
|
||||
# Verify structure
|
||||
self.assertIn('timestamp', record)
|
||||
self.assertIn('type', record)
|
||||
except json.JSONDecodeError:
|
||||
pass # Some lines may be incomplete
|
||||
|
||||
except RuntimeError as e:
|
||||
if 'Chrome' in str(e) or 'CDP' in str(e):
|
||||
self.skipTest(f"Chrome session setup failed: {e}")
|
||||
raise
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
pytest.main([__file__, '-v'])
|
||||
1
archivebox/plugins/parse_dom_outlinks/tests/__init__.py
Normal file
1
archivebox/plugins/parse_dom_outlinks/tests/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
"""Tests for the parse_dom_outlinks plugin."""
|
||||
@@ -0,0 +1,121 @@
|
||||
"""
|
||||
Tests for the parse_dom_outlinks plugin.
|
||||
|
||||
Tests the real DOM outlinks hook with an actual URL to verify
|
||||
link extraction and categorization.
|
||||
"""
|
||||
|
||||
import json
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
from django.test import TestCase
|
||||
|
||||
# Import chrome test helpers
|
||||
sys.path.insert(0, str(Path(__file__).parent.parent.parent / 'chrome' / 'tests'))
|
||||
from chrome_test_helpers import (
|
||||
chrome_session,
|
||||
get_test_env,
|
||||
get_plugin_dir,
|
||||
get_hook_script,
|
||||
)
|
||||
|
||||
|
||||
def chrome_available() -> bool:
|
||||
"""Check if Chrome/Chromium is available."""
|
||||
for name in ['chromium', 'chromium-browser', 'google-chrome', 'chrome']:
|
||||
if shutil.which(name):
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
# Get the path to the parse_dom_outlinks hook
|
||||
PLUGIN_DIR = get_plugin_dir(__file__)
|
||||
OUTLINKS_HOOK = get_hook_script(PLUGIN_DIR, 'on_Snapshot__*_parse_dom_outlinks.*')
|
||||
|
||||
|
||||
class TestParseDomOutlinksPlugin(TestCase):
|
||||
"""Test the parse_dom_outlinks plugin."""
|
||||
|
||||
def test_outlinks_hook_exists(self):
|
||||
"""DOM outlinks hook script should exist."""
|
||||
self.assertIsNotNone(OUTLINKS_HOOK, "DOM outlinks hook not found in plugin directory")
|
||||
self.assertTrue(OUTLINKS_HOOK.exists(), f"Hook not found: {OUTLINKS_HOOK}")
|
||||
|
||||
|
||||
@pytest.mark.skipif(not chrome_available(), reason="Chrome not installed")
|
||||
class TestParseDomOutlinksWithChrome(TestCase):
|
||||
"""Integration tests for parse_dom_outlinks plugin with Chrome."""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test environment."""
|
||||
self.temp_dir = Path(tempfile.mkdtemp())
|
||||
|
||||
def tearDown(self):
|
||||
"""Clean up."""
|
||||
shutil.rmtree(self.temp_dir, ignore_errors=True)
|
||||
|
||||
def test_outlinks_extracts_links_from_page(self):
|
||||
"""DOM outlinks hook should extract and categorize links from page."""
|
||||
test_url = 'https://example.com'
|
||||
snapshot_id = 'test-outlinks-snapshot'
|
||||
|
||||
try:
|
||||
with chrome_session(
|
||||
self.temp_dir,
|
||||
crawl_id='test-outlinks-crawl',
|
||||
snapshot_id=snapshot_id,
|
||||
test_url=test_url,
|
||||
navigate=True,
|
||||
timeout=30,
|
||||
) as (chrome_process, chrome_pid, snapshot_chrome_dir):
|
||||
# Get environment and run the outlinks hook
|
||||
env = get_test_env()
|
||||
env['CHROME_HEADLESS'] = 'true'
|
||||
|
||||
# Run outlinks hook with the active Chrome session
|
||||
result = subprocess.run(
|
||||
['node', str(OUTLINKS_HOOK), f'--url={test_url}', f'--snapshot-id={snapshot_id}'],
|
||||
cwd=str(snapshot_chrome_dir),
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=60,
|
||||
env=env
|
||||
)
|
||||
|
||||
# Check for output file
|
||||
outlinks_output = snapshot_chrome_dir / 'outlinks.json'
|
||||
|
||||
outlinks_data = None
|
||||
|
||||
# Try parsing from file first
|
||||
if outlinks_output.exists():
|
||||
with open(outlinks_output) as f:
|
||||
try:
|
||||
outlinks_data = json.load(f)
|
||||
except json.JSONDecodeError:
|
||||
pass
|
||||
|
||||
# Verify hook ran successfully
|
||||
self.assertEqual(result.returncode, 0, f"Hook failed: {result.stderr}")
|
||||
self.assertNotIn('Traceback', result.stderr)
|
||||
|
||||
# Verify we got outlinks data with expected categories
|
||||
if outlinks_data:
|
||||
self.assertIn('url', outlinks_data, f"Missing url: {outlinks_data}")
|
||||
self.assertIn('hrefs', outlinks_data, f"Missing hrefs: {outlinks_data}")
|
||||
# example.com has at least one link (to iana.org)
|
||||
self.assertIsInstance(outlinks_data['hrefs'], list)
|
||||
|
||||
except RuntimeError as e:
|
||||
if 'Chrome' in str(e) or 'CDP' in str(e):
|
||||
self.skipTest(f"Chrome session setup failed: {e}")
|
||||
raise
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
pytest.main([__file__, '-v'])
|
||||
Reference in New Issue
Block a user