Files
wehub-resource-sync 2cab53bc94
Test Vector Database Adaptors / Test MCP Vector DB Tools (push) Has been cancelled
Tests / Code Quality (Ruff & Mypy) (push) Has been cancelled
Tests / Fast Unit Tests (parallel) (macos-latest, 3.11) (push) Has been cancelled
Tests / Fast Unit Tests (parallel) (macos-latest, 3.12) (push) Has been cancelled
Tests / Tests (push) Has been cancelled
Docker Publish / Build and Push Docker Images (map[description:Skill Seekers CLI - Convert documentation to AI skills dockerfile:Dockerfile name:skill-seekers]) (push) Has been cancelled
Docker Publish / Build and Push Docker Images (map[description:Skill Seekers MCP Server - 25 tools for AI assistants dockerfile:Dockerfile.mcp name:skill-seekers-mcp]) (push) Has been cancelled
Docker Publish / Test Docker Images (push) Has been cancelled
Tests / Fast Unit Tests (parallel) (ubuntu-latest, 3.10) (push) Has been cancelled
Tests / Fast Unit Tests (parallel) (ubuntu-latest, 3.11) (push) Has been cancelled
Tests / Fast Unit Tests (parallel) (ubuntu-latest, 3.12) (push) Has been cancelled
Tests / Serial / Integration / E2E Tests (push) Has been cancelled
Tests / MCP Server Tests (push) Has been cancelled
Test Vector Database Adaptors / Test chroma Adaptor (push) Has been cancelled
Test Vector Database Adaptors / Test faiss Adaptor (push) Has been cancelled
Test Vector Database Adaptors / Test qdrant Adaptor (push) Has been cancelled
Test Vector Database Adaptors / Test weaviate Adaptor (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 12:46:28 +08:00

635 lines
23 KiB
Python

#!/usr/bin/env python3
"""
Tests for PDF Scraper (cli/pdf_scraper.py)
Tests cover:
- Config-based PDF extraction
- Direct PDF path conversion
- JSON-based workflow
- Skill structure generation
- Categorization
- Error handling
"""
import json
import shutil
import tempfile
import unittest
from pathlib import Path
try:
import fitz # noqa: F401 PyMuPDF
PYMUPDF_AVAILABLE = True
except ImportError:
PYMUPDF_AVAILABLE = False
class TestPDFToSkillConverter(unittest.TestCase):
"""Test PDFToSkillConverter initialization and basic functionality"""
def setUp(self):
if not PYMUPDF_AVAILABLE:
self.skipTest("PyMuPDF not installed")
from skill_seekers.cli.pdf_scraper import PDFToSkillConverter
self.PDFToSkillConverter = PDFToSkillConverter
# Create temporary directory for test output
self.temp_dir = tempfile.mkdtemp()
self.output_dir = Path(self.temp_dir)
def tearDown(self):
# Clean up temporary directory
if hasattr(self, "temp_dir"):
shutil.rmtree(self.temp_dir, ignore_errors=True)
def test_init_with_name_and_pdf_path(self):
"""Test initialization with name and PDF path"""
config = {"name": "test_skill", "pdf_path": "test.pdf"}
converter = self.PDFToSkillConverter(config)
self.assertEqual(converter.name, "test_skill")
self.assertEqual(converter.pdf_path, "test.pdf")
def test_reference_filename_matches_nav_and_index(self):
"""Regression (DOC-07): nav/index/writer all derive the reference
filename from _reference_filename, so links match real files (range-based
names, not sanitized titles)."""
converter = self.PDFToSkillConverter({"name": "guide", "pdf_path": "guide.pdf"})
cat = {"title": "Getting Started", "pages": [{"page_number": 3}, {"page_number": 7}]}
# Multi-section → basename + page range derived from the PDF stem.
multi = converter._reference_filename(cat, section_num=2, total_sections=3)
self.assertEqual(multi, "guide_p3-p7.md")
# Single-section → bare PDF stem.
single = converter._reference_filename(cat, section_num=1, total_sections=1)
self.assertEqual(single, "guide.md")
# Never the old sanitized-title form.
self.assertNotIn("getting", multi.lower())
def test_init_with_config(self):
"""Test initialization with config file"""
# Create test config
config = {
"name": "config_skill",
"description": "Test skill",
"pdf_path": "docs/test.pdf",
"extract_options": {"chunk_size": 10, "min_quality": 5.0},
}
converter = self.PDFToSkillConverter(config)
self.assertEqual(converter.name, "config_skill")
self.assertEqual(converter.config.get("description"), "Test skill")
def test_init_requires_name_or_config(self):
"""Test that initialization requires config dict with 'name' field"""
with self.assertRaises((ValueError, TypeError, KeyError)):
self.PDFToSkillConverter({})
class TestCategorization(unittest.TestCase):
"""Test content categorization functionality"""
def setUp(self):
if not PYMUPDF_AVAILABLE:
self.skipTest("PyMuPDF not installed")
from skill_seekers.cli.pdf_scraper import PDFToSkillConverter
self.PDFToSkillConverter = PDFToSkillConverter
self.temp_dir = tempfile.mkdtemp()
def tearDown(self):
shutil.rmtree(self.temp_dir, ignore_errors=True)
def test_categorize_by_keywords(self):
"""Test categorization using keyword matching"""
config = {
"name": "test",
"pdf_path": "test.pdf",
"categories": {
"getting_started": ["introduction", "getting started"],
"api": ["api", "reference", "function"],
},
}
converter = self.PDFToSkillConverter(config)
# Mock extracted data with different content
converter.extracted_data = {
"pages": [
{
"page_number": 1,
"text": "Introduction to the API",
"chapter": "Chapter 1: Getting Started",
},
{"page_number": 2, "text": "API reference for functions", "chapter": None},
]
}
categories = converter.categorize_content()
# With single PDF source, should use single-file strategy
# Category named after PDF basename (test.pdf -> test)
self.assertIn("test", categories)
self.assertEqual(len(categories), 1)
self.assertEqual(len(categories["test"]["pages"]), 2)
def test_categorize_by_chapters(self):
"""Test categorization using chapter information"""
config = {"name": "test", "pdf_path": "test.pdf"}
converter = self.PDFToSkillConverter(config)
# Mock data with chapters
converter.extracted_data = {
"pages": [
{"page_number": 1, "text": "Content here", "chapter": "Chapter 1: Introduction"},
{"page_number": 2, "text": "More content", "chapter": "Chapter 1: Introduction"},
{"page_number": 3, "text": "New chapter", "chapter": "Chapter 2: Advanced Topics"},
]
}
categories = converter.categorize_content()
# Should create categories based on chapters
self.assertIsInstance(categories, dict)
self.assertGreater(len(categories), 0)
def test_categorize_handles_no_chapters(self):
"""Test categorization when no chapters are detected"""
config = {"name": "test", "pdf_path": "test.pdf"}
converter = self.PDFToSkillConverter(config)
# Mock data without chapters
converter.extracted_data = {
"pages": [{"page_number": 1, "text": "Some content", "chapter": None}]
}
categories = converter.categorize_content()
# Should still create categories (fallback to "other")
self.assertIsInstance(categories, dict)
class TestSkillBuilding(unittest.TestCase):
"""Test skill structure generation"""
def setUp(self):
if not PYMUPDF_AVAILABLE:
self.skipTest("PyMuPDF not installed")
from skill_seekers.cli.pdf_scraper import PDFToSkillConverter
self.PDFToSkillConverter = PDFToSkillConverter
self.temp_dir = tempfile.mkdtemp()
def tearDown(self):
shutil.rmtree(self.temp_dir, ignore_errors=True)
def test_build_skill_creates_structure(self):
"""Test that build_skill creates required directory structure"""
config = {"name": "test_skill", "pdf_path": "test.pdf"}
converter = self.PDFToSkillConverter(config)
# Override skill_dir to use temp directory
converter.skill_dir = str(Path(self.temp_dir) / "test_skill")
# Mock extracted data
converter.extracted_data = {
"pages": [{"page_number": 1, "text": "Test content", "code_blocks": [], "images": []}],
"total_pages": 1,
}
# Mock categorization
converter.categories = {"getting_started": [converter.extracted_data["pages"][0]]}
converter.build_skill()
# Check directory structure
skill_dir = Path(self.temp_dir) / "test_skill"
self.assertTrue(skill_dir.exists())
self.assertTrue((skill_dir / "references").exists())
self.assertTrue((skill_dir / "scripts").exists())
self.assertTrue((skill_dir / "assets").exists())
def test_build_skill_creates_skill_md(self):
"""Test that SKILL.md is created"""
config = {"name": "test_skill", "pdf_path": "test.pdf", "description": "Test description"}
converter = self.PDFToSkillConverter(config)
# Override skill_dir to use temp directory
converter.skill_dir = str(Path(self.temp_dir) / "test_skill")
converter.extracted_data = {
"pages": [{"page_number": 1, "text": "Test", "code_blocks": [], "images": []}],
"total_pages": 1,
}
converter.categories = {"test": [converter.extracted_data["pages"][0]]}
converter.build_skill()
skill_md = Path(self.temp_dir) / "test_skill" / "SKILL.md"
self.assertTrue(skill_md.exists())
# Check content
content = skill_md.read_text()
self.assertIn("test_skill", content)
self.assertIn("Test description", content)
def test_build_skill_creates_reference_files(self):
"""Test that reference files are created for categories"""
config = {"name": "test_skill", "pdf_path": "test.pdf"}
converter = self.PDFToSkillConverter(config)
# Override skill_dir to use temp directory
converter.skill_dir = str(Path(self.temp_dir) / "test_skill")
converter.extracted_data = {
"pages": [
{"page_number": 1, "text": "Getting started", "code_blocks": [], "images": []},
{"page_number": 2, "text": "API reference", "code_blocks": [], "images": []},
],
"total_pages": 2,
}
converter.build_skill()
# Check reference files exist
# With single PDF source, uses single-file strategy (named after PDF basename)
refs_dir = Path(self.temp_dir) / "test_skill" / "references"
self.assertTrue((refs_dir / "test.md").exists())
self.assertTrue((refs_dir / "index.md").exists())
class TestCodeBlockHandling(unittest.TestCase):
"""Test code block extraction and inclusion in references"""
def setUp(self):
if not PYMUPDF_AVAILABLE:
self.skipTest("PyMuPDF not installed")
from skill_seekers.cli.pdf_scraper import PDFToSkillConverter
self.PDFToSkillConverter = PDFToSkillConverter
self.temp_dir = tempfile.mkdtemp()
def tearDown(self):
shutil.rmtree(self.temp_dir, ignore_errors=True)
def test_code_blocks_included_in_references(self):
"""Test that code blocks are included in reference files"""
config = {"name": "test_skill", "pdf_path": "test.pdf"}
converter = self.PDFToSkillConverter(config)
# Override skill_dir to use temp directory
converter.skill_dir = str(Path(self.temp_dir) / "test_skill")
# Mock data with code blocks
converter.extracted_data = {
"pages": [
{
"page_number": 1,
"text": "Example code",
"code_blocks": [
{
"code": "def hello():\n print('world')",
"language": "python",
"quality": 8.0,
}
],
"images": [],
}
],
"total_pages": 1,
}
converter.build_skill()
# Check code block in reference file
# With single PDF source, uses single-file strategy (named after PDF basename)
ref_file = Path(self.temp_dir) / "test_skill" / "references" / "test.md"
content = ref_file.read_text()
self.assertIn("```python", content)
self.assertIn("def hello()", content)
self.assertIn("print('world')", content)
def test_high_quality_code_preferred(self):
"""Test that high-quality code blocks are prioritized"""
config = {"name": "test_skill", "pdf_path": "test.pdf"}
converter = self.PDFToSkillConverter(config)
# Override skill_dir to use temp directory
converter.skill_dir = str(Path(self.temp_dir) / "test_skill")
# Mock data with varying quality
converter.extracted_data = {
"pages": [
{
"page_number": 1,
"text": "Code examples",
"code_blocks": [
{"code": "x = 1", "language": "python", "quality": 2.0},
{
"code": "def process():\n return result",
"language": "python",
"quality": 9.0,
},
],
"images": [],
}
],
"total_pages": 1,
}
converter.build_skill()
# With single PDF source, uses single-file strategy (named after PDF basename)
ref_file = Path(self.temp_dir) / "test_skill" / "references" / "test.md"
content = ref_file.read_text()
# High quality code should be included
self.assertIn("def process()", content)
class TestImageHandling(unittest.TestCase):
"""Test image extraction and handling"""
def setUp(self):
if not PYMUPDF_AVAILABLE:
self.skipTest("PyMuPDF not installed")
from skill_seekers.cli.pdf_scraper import PDFToSkillConverter
self.PDFToSkillConverter = PDFToSkillConverter
self.temp_dir = tempfile.mkdtemp()
def tearDown(self):
shutil.rmtree(self.temp_dir, ignore_errors=True)
def test_images_saved_to_assets(self):
"""Test that images are saved to assets directory"""
config = {"name": "test_skill", "pdf_path": "test.pdf"}
converter = self.PDFToSkillConverter(config)
# Override skill_dir to use temp directory
converter.skill_dir = str(Path(self.temp_dir) / "test_skill")
# Mock image data (1x1 white PNG)
mock_image_bytes = b"\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00\x00\x01\x08\x06\x00\x00\x00\x1f\x15\xc4\x89\x00\x00\x00\nIDATx\x9cc\x00\x01\x00\x00\x05\x00\x01\r\n-\xb4\x00\x00\x00\x00IEND\xaeB`\x82"
converter.extracted_data = {
"pages": [
{
"page_number": 1,
"text": "See diagram",
"code_blocks": [],
"images": [
{
"page": 1,
"index": 0,
"width": 100,
"height": 100,
"data": mock_image_bytes,
}
],
}
],
"total_pages": 1,
}
converter.categories = {"diagrams": [converter.extracted_data["pages"][0]]}
converter.build_skill()
# Check assets directory has image
assets_dir = Path(self.temp_dir) / "test_skill" / "assets"
image_files = list(assets_dir.glob("*.png"))
self.assertGreater(len(image_files), 0)
def test_image_references_in_markdown(self):
"""Test that images are referenced in markdown files"""
config = {"name": "test_skill", "pdf_path": "test.pdf"}
converter = self.PDFToSkillConverter(config)
# Override skill_dir to use temp directory
converter.skill_dir = str(Path(self.temp_dir) / "test_skill")
mock_image_bytes = b"\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00\x00\x01\x08\x06\x00\x00\x00\x1f\x15\xc4\x89\x00\x00\x00\nIDATx\x9cc\x00\x01\x00\x00\x05\x00\x01\r\n-\xb4\x00\x00\x00\x00IEND\xaeB`\x82"
converter.extracted_data = {
"pages": [
{
"page_number": 1,
"text": "Architecture diagram",
"code_blocks": [],
"images": [
{
"page": 1,
"index": 0,
"width": 200,
"height": 150,
"data": mock_image_bytes,
}
],
}
],
"total_pages": 1,
}
converter.build_skill()
# Check markdown has image reference
# With single PDF source, uses single-file strategy (named after PDF basename)
ref_file = Path(self.temp_dir) / "test_skill" / "references" / "test.md"
content = ref_file.read_text()
self.assertIn("![", content) # Markdown image syntax
self.assertIn("../assets/", content) # Relative path to assets
def test_extracted_images_references_in_markdown(self):
"""Test that extracted_images (pdf_extractor_poc format) are referenced in markdown"""
config = {"name": "test_skill", "pdf_path": "test.pdf"}
converter = self.PDFToSkillConverter(config)
converter.skill_dir = str(Path(self.temp_dir) / "test_skill")
converter.extracted_data = {
"pages": [
{
"page_number": 18,
"text": "Architecture diagram",
"code_blocks": [],
"extracted_images": [
{
"filename": "test_page18_img1.png",
"path": "/tmp/test_page18_img1.png",
"page_number": 18,
"width": 200,
"height": 150,
"format": "png",
"size_bytes": 3,
}
],
}
],
"total_pages": 1,
}
converter.build_skill()
# Check reference file has image markdown reference
ref_file = Path(self.temp_dir) / "test_skill" / "references" / "test.md"
content = ref_file.read_text()
self.assertIn("![Image from page 18]", content)
self.assertIn("../assets/images/test_page18_img1.png", content)
class TestErrorHandling(unittest.TestCase):
"""Test error handling for invalid inputs"""
def setUp(self):
if not PYMUPDF_AVAILABLE:
self.skipTest("PyMuPDF not installed")
from skill_seekers.cli.pdf_scraper import PDFToSkillConverter
self.PDFToSkillConverter = PDFToSkillConverter
self.temp_dir = tempfile.mkdtemp()
def tearDown(self):
shutil.rmtree(self.temp_dir, ignore_errors=True)
def test_missing_pdf_file(self):
"""Test error when PDF file doesn't exist"""
config = {"name": "test", "pdf_path": "nonexistent.pdf"}
converter = self.PDFToSkillConverter(config)
with self.assertRaises((FileNotFoundError, RuntimeError)):
converter.extract_pdf()
def test_invalid_config_file(self):
"""Test error when config dict is invalid"""
invalid_config = "invalid string not a dict"
with self.assertRaises((ValueError, TypeError, AttributeError)):
self.PDFToSkillConverter(invalid_config)
def test_missing_required_config_fields(self):
"""Test error when config is missing required fields"""
config = {"description": "Missing name and pdf_path"}
with self.assertRaises((ValueError, KeyError)):
converter = self.PDFToSkillConverter(config)
converter.extract_pdf()
class TestJSONWorkflow(unittest.TestCase):
"""Test building skills from extracted JSON"""
def setUp(self):
if not PYMUPDF_AVAILABLE:
self.skipTest("PyMuPDF not installed")
from skill_seekers.cli.pdf_scraper import PDFToSkillConverter
self.PDFToSkillConverter = PDFToSkillConverter
self.temp_dir = tempfile.mkdtemp()
def tearDown(self):
shutil.rmtree(self.temp_dir, ignore_errors=True)
def test_load_from_json(self):
"""Test loading extracted data from JSON file"""
# Create mock extracted JSON
extracted_data = {
"pages": [{"page_number": 1, "text": "Test content", "code_blocks": [], "images": []}],
"total_pages": 1,
"metadata": {"title": "Test PDF"},
}
json_path = Path(self.temp_dir) / "extracted.json"
json_path.write_text(json.dumps(extracted_data, indent=2))
config = {"name": "test_skill", "pdf_path": "test.pdf"}
converter = self.PDFToSkillConverter(config)
converter.load_extracted_data(str(json_path))
self.assertEqual(converter.extracted_data["total_pages"], 1)
self.assertEqual(len(converter.extracted_data["pages"]), 1)
def test_build_from_json_without_extraction(self):
"""Test that from_json workflow skips PDF extraction"""
extracted_data = {
"pages": [{"page_number": 1, "text": "Content", "code_blocks": [], "images": []}],
"total_pages": 1,
}
json_path = Path(self.temp_dir) / "extracted.json"
json_path.write_text(json.dumps(extracted_data))
config = {"name": "test_skill", "pdf_path": "test.pdf"}
converter = self.PDFToSkillConverter(config)
converter.load_extracted_data(str(json_path))
# Should have data loaded without calling extract_pdf()
self.assertIsNotNone(converter.extracted_data)
self.assertEqual(converter.extracted_data["total_pages"], 1)
class TestPDFExtractionReal(unittest.TestCase):
"""Test extraction and build with real PDF fixture files."""
def setUp(self):
if not PYMUPDF_AVAILABLE:
self.skipTest("PyMuPDF not installed")
from skill_seekers.cli.pdf_scraper import PDFToSkillConverter
self.PDFToSkillConverter = PDFToSkillConverter
self.temp_dir = tempfile.mkdtemp()
self.fixture_dir = Path(__file__).parent / "fixtures" / "synthetic"
def tearDown(self):
if hasattr(self, "temp_dir"):
shutil.rmtree(self.temp_dir, ignore_errors=True)
def test_extract_real_pdf(self):
pdf_path = self.fixture_dir / "document.pdf"
if not pdf_path.exists():
self.skipTest("Fixture document.pdf not found")
config = {"name": "test_pdf_real", "pdf_path": str(pdf_path)}
converter = self.PDFToSkillConverter(config)
ok = converter.extract()
self.assertTrue(ok)
result = converter.extracted_data
self.assertIsNotNone(result)
self.assertIn("pages", result)
self.assertGreater(len(result["pages"]), 0)
self.assertGreater(result["total_pages"], 0)
def test_extracted_data_structure(self):
pdf_path = self.fixture_dir / "document.pdf"
if not pdf_path.exists():
self.skipTest("Fixture document.pdf not found")
config = {"name": "test_pdf_real", "pdf_path": str(pdf_path)}
converter = self.PDFToSkillConverter(config)
converter.extract()
result = converter.extracted_data
self.assertIsInstance(result, dict)
self.assertIn("pages", result)
self.assertIn("total_pages", result)
for key in ["page_number", "text"]:
found = any(key in p for p in result["pages"])
self.assertTrue(found, f"Key {key} not found in any page")
self.assertIn("total_code_blocks", result)
self.assertIn("total_images", result)
self.assertIn("extracted_images", result)
self.assertIn("metadata", result)
self.assertIn("languages_detected", result)
def test_extract_handles_missing_file(self):
config = {"name": "test_missing", "pdf_path": "nonexistent.pdf"}
converter = self.PDFToSkillConverter(config)
with self.assertRaises((FileNotFoundError, RuntimeError, Exception)):
converter.extract()
if __name__ == "__main__":
unittest.main()