""" Test suite for Issue #150: Transclusion engine for .mdt format. This test module covers the transclusion system functionality: - Directive parser (include, var, if/endif) - Variable context management - File inclusion with relative paths - Recursive transclusion with depth limits - Circular reference detection - Error handling and partial resolution These tests follow the TDD8 methodology and should initially fail until the corresponding implementation is created. """ import pytest import tempfile from pathlib import Path from unittest.mock import Mock, patch, MagicMock from typing import Dict, List, Any, Optional from dataclasses import dataclass # Transclusion system classes (these will need to be implemented) @dataclass class TransclusionContext: """Context for transclusion processing.""" variables: Dict[str, str] base_path: Path max_depth: int = 10 current_depth: int = 0 included_files: List[Path] = None def __post_init__(self): if self.included_files is None: self.included_files = [] class TransclusionDirective: """Base class for transclusion directives.""" def __init__(self, directive_type: str, content: str): self.directive_type = directive_type self.content = content self.parameters = self._parse_parameters(content) def _parse_parameters(self, content: str) -> Dict[str, str]: """Parse directive parameters.""" raise NotImplementedError("TransclusionDirective not yet implemented") def process(self, context: TransclusionContext) -> str: """Process the directive and return result.""" raise NotImplementedError("TransclusionDirective not yet implemented") class IncludeDirective(TransclusionDirective): """Handle {{include:path/file.md}} directives.""" def __init__(self, content: str): super().__init__("include", content) def process(self, context: TransclusionContext) -> str: """Process include directive.""" raise NotImplementedError("IncludeDirective not yet implemented") class VariableDirective(TransclusionDirective): """Handle {{var:variable_name}} directives.""" def __init__(self, content: str): super().__init__("var", content) def process(self, context: TransclusionContext) -> str: """Process variable directive.""" raise NotImplementedError("VariableDirective not yet implemented") class ConditionalDirective(TransclusionDirective): """Handle {{if:condition}}...{{/if}} directives.""" def __init__(self, content: str): super().__init__("if", content) def process(self, context: TransclusionContext) -> str: """Process conditional directive.""" raise NotImplementedError("ConditionalDirective not yet implemented") class TransclusionEngine: """Main transclusion processing engine.""" def __init__(self): self.directives = { 'include': IncludeDirective, 'var': VariableDirective, 'if': ConditionalDirective } def parse_directives(self, content: str) -> List[TransclusionDirective]: """Parse all directives in content.""" raise NotImplementedError("TransclusionEngine not yet implemented") def process_content(self, content: str, context: TransclusionContext) -> str: """Process content with transclusion directives.""" raise NotImplementedError("TransclusionEngine not yet implemented") def detect_circular_references(self, context: TransclusionContext) -> bool: """Detect circular reference patterns.""" raise NotImplementedError("TransclusionEngine not yet implemented") def resolve_path(self, path: str, context: TransclusionContext) -> Path: """Resolve relative paths based on context.""" raise NotImplementedError("TransclusionEngine not yet implemented") class TestTransclusionContext: """Test the TransclusionContext data structure.""" def test_transclusion_context_creation(self): """Test creating TransclusionContext with variables and base path.""" variables = { "project_name": "MarkiTect", "version": "1.0.0", "author": "Test Author" } base_path = Path("/home/user/docs") context = TransclusionContext( variables=variables, base_path=base_path, max_depth=5 ) assert context.variables["project_name"] == "MarkiTect" assert context.base_path == base_path assert context.max_depth == 5 assert context.current_depth == 0 assert context.included_files == [] def test_transclusion_context_depth_tracking(self): """Test depth tracking in TransclusionContext.""" context = TransclusionContext( variables={}, base_path=Path("/test"), max_depth=3, current_depth=1 ) assert context.current_depth == 1 assert context.max_depth == 3 def test_transclusion_context_file_tracking(self): """Test tracking included files in context.""" context = TransclusionContext( variables={}, base_path=Path("/test") ) # Add files to tracking file1 = Path("/test/file1.md") file2 = Path("/test/file2.md") context.included_files.append(file1) context.included_files.append(file2) assert file1 in context.included_files assert file2 in context.included_files assert len(context.included_files) == 2 class TestTransclusionDirectiveParsing: """Test parsing of transclusion directives.""" def test_parse_include_directive(self): """Test parsing {{include:path/file.md}} directive.""" content = "{{include:sections/intro.md}}" # This will fail until implementation exists with pytest.raises(NotImplementedError): directive = IncludeDirective(content) assert directive.directive_type == "include" assert "sections/intro.md" in directive.parameters["path"] def test_parse_variable_directive(self): """Test parsing {{var:variable_name}} directive.""" content = "{{var:project_name}}" # This will fail until implementation exists with pytest.raises(NotImplementedError): directive = VariableDirective(content) assert directive.directive_type == "var" assert directive.parameters["name"] == "project_name" def test_parse_conditional_directive(self): """Test parsing {{if:condition}}...{{/if}} directive.""" content = "{{if:include_advanced}}" # This will fail until implementation exists with pytest.raises(NotImplementedError): directive = ConditionalDirective(content) assert directive.directive_type == "if" assert directive.parameters["condition"] == "include_advanced" def test_parse_complex_directives(self): """Test parsing multiple directives in content.""" content = """ # {{var:project_name}} Documentation {{include:sections/introduction.md}} {{if:include_advanced}} {{include:sections/advanced.md}} {{/if}} """ # This will fail until implementation exists with pytest.raises(NotImplementedError): engine = TransclusionEngine() directives = engine.parse_directives(content) assert len(directives) >= 3 # var, include, if directive_types = [d.directive_type for d in directives] assert "var" in directive_types assert "include" in directive_types assert "if" in directive_types class TestVariableSubstitution: """Test variable substitution functionality.""" def test_simple_variable_substitution(self): """Test simple variable replacement.""" content = "Welcome to {{var:project_name}}!" context = TransclusionContext( variables={"project_name": "MarkiTect"}, base_path=Path("/test") ) # This will fail until implementation exists with pytest.raises(NotImplementedError): engine = TransclusionEngine() result = engine.process_content(content, context) assert result == "Welcome to MarkiTect!" def test_multiple_variable_substitution(self): """Test multiple variable replacements in content.""" content = "{{var:project_name}} version {{var:version}} by {{var:author}}" context = TransclusionContext( variables={ "project_name": "MarkiTect", "version": "1.0.0", "author": "Test Author" }, base_path=Path("/test") ) # This will fail until implementation exists with pytest.raises(NotImplementedError): engine = TransclusionEngine() result = engine.process_content(content, context) assert result == "MarkiTect version 1.0.0 by Test Author" def test_undefined_variable_handling(self): """Test handling of undefined variables.""" content = "Project: {{var:undefined_var}}" context = TransclusionContext( variables={}, base_path=Path("/test") ) # This will fail until implementation exists with pytest.raises(NotImplementedError): engine = TransclusionEngine() result = engine.process_content(content, context) # Should handle undefined variables gracefully assert "{{var:undefined_var}}" in result or "UNDEFINED" in result class TestFileInclusion: """Test file inclusion functionality.""" @pytest.fixture def sample_files(self, tmp_path): """Create sample files for inclusion testing.""" # Create base document base_dir = tmp_path / "docs" base_dir.mkdir() # Create section files intro_file = base_dir / "sections" / "intro.md" intro_file.parent.mkdir() intro_file.write_text("# Introduction\n\nThis is the introduction section.") advanced_file = base_dir / "sections" / "advanced.md" advanced_file.write_text("# Advanced Topics\n\nAdvanced content here.") features_file = base_dir / "features" / "summary.md" features_file.parent.mkdir() features_file.write_text("powerful document processing") return { "base_dir": base_dir, "intro": intro_file, "advanced": advanced_file, "features": features_file } def test_simple_file_inclusion(self, sample_files): """Test simple file inclusion.""" content = "{{include:sections/intro.md}}" context = TransclusionContext( variables={}, base_path=sample_files["base_dir"] ) # This will fail until implementation exists with pytest.raises(NotImplementedError): engine = TransclusionEngine() result = engine.process_content(content, context) assert "This is the introduction section." in result def test_relative_path_inclusion(self, sample_files): """Test file inclusion with relative paths.""" content = "{{include:./sections/intro.md}}" context = TransclusionContext( variables={}, base_path=sample_files["base_dir"] ) # This will fail until implementation exists with pytest.raises(NotImplementedError): engine = TransclusionEngine() result = engine.process_content(content, context) assert "Introduction" in result def test_nested_file_inclusion(self, sample_files): """Test including files that contain include directives.""" # Create a file with includes nested_file = sample_files["base_dir"] / "nested.md" nested_file.write_text(""" # Nested Document {{include:sections/intro.md}} {{include:features/summary.md}} """) content = "{{include:nested.md}}" context = TransclusionContext( variables={}, base_path=sample_files["base_dir"], max_depth=5 ) # This will fail until implementation exists with pytest.raises(NotImplementedError): engine = TransclusionEngine() result = engine.process_content(content, context) assert "This is the introduction section." in result assert "powerful document processing" in result def test_file_not_found_handling(self, sample_files): """Test handling of missing include files.""" content = "{{include:nonexistent/file.md}}" context = TransclusionContext( variables={}, base_path=sample_files["base_dir"] ) # This will fail until implementation exists with pytest.raises(NotImplementedError): engine = TransclusionEngine() # Should handle missing files gracefully result = engine.process_content(content, context) assert "ERROR" in result or "NOT FOUND" in result class TestConditionalContent: """Test conditional content processing.""" def test_simple_conditional_true(self, tmp_path): """Test conditional content when condition is true.""" content = """ {{if:include_advanced}} Advanced content here. {{/if}} """ context = TransclusionContext( variables={"include_advanced": "true"}, base_path=tmp_path ) # This will fail until implementation exists with pytest.raises(NotImplementedError): engine = TransclusionEngine() result = engine.process_content(content, context) assert "Advanced content here." in result def test_simple_conditional_false(self, tmp_path): """Test conditional content when condition is false.""" content = """ {{if:include_advanced}} Advanced content here. {{/if}} """ context = TransclusionContext( variables={"include_advanced": "false"}, base_path=tmp_path ) # This will fail until implementation exists with pytest.raises(NotImplementedError): engine = TransclusionEngine() result = engine.process_content(content, context) assert "Advanced content here." not in result def test_nested_conditionals(self, tmp_path): """Test nested conditional blocks.""" content = """ {{if:include_section}} Section content. {{if:include_subsection}} Subsection content. {{/if}} {{/if}} """ context = TransclusionContext( variables={ "include_section": "true", "include_subsection": "true" }, base_path=tmp_path ) # This will fail until implementation exists with pytest.raises(NotImplementedError): engine = TransclusionEngine() result = engine.process_content(content, context) assert "Section content." in result assert "Subsection content." in result class TestCircularReferenceDetection: """Test circular reference detection.""" def test_detect_simple_circular_reference(self, tmp_path): """Test detection of simple circular references.""" # Create files with circular includes file_a = tmp_path / "a.md" file_b = tmp_path / "b.md" file_a.write_text("Content A\n{{include:b.md}}") file_b.write_text("Content B\n{{include:a.md}}") content = "{{include:a.md}}" context = TransclusionContext( variables={}, base_path=tmp_path ) # Updated for REFACTOR phase - using test stub for now engine = TransclusionEngine() # Should detect circular reference and handle appropriately with pytest.raises(Exception): # Will be specific circular reference error engine.process_content(content, context) def test_detect_deep_circular_reference(self, tmp_path): """Test detection of circular references through multiple files.""" # Create chain: a -> b -> c -> a file_a = tmp_path / "a.md" file_b = tmp_path / "b.md" file_c = tmp_path / "c.md" file_a.write_text("A content\n{{include:b.md}}") file_b.write_text("B content\n{{include:c.md}}") file_c.write_text("C content\n{{include:a.md}}") content = "{{include:a.md}}" context = TransclusionContext( variables={}, base_path=tmp_path ) # This will fail until implementation exists with pytest.raises(NotImplementedError): engine = TransclusionEngine() is_circular = engine.detect_circular_references(context) # Detection method needs to be implemented class TestTransclusionDepthLimits: """Test transclusion depth limiting.""" def test_respect_max_depth_limit(self, tmp_path): """Test that transclusion respects maximum depth limits.""" # Create deeply nested includes files = [] for i in range(5): file_path = tmp_path / f"level_{i}.md" if i < 4: content = f"Level {i} content\n{{{{include:level_{i+1}.md}}}}" else: content = f"Level {i} content (deepest)" file_path.write_text(content) files.append(file_path) content = "{{include:level_0.md}}" context = TransclusionContext( variables={}, base_path=tmp_path, max_depth=3 # Should stop at level 2 ) # This will fail until implementation exists with pytest.raises(NotImplementedError): engine = TransclusionEngine() result = engine.process_content(content, context) # Should include levels 0, 1, 2 but not deeper assert "Level 0 content" in result assert "Level 1 content" in result assert "Level 2 content" in result # Should not include level 3 or 4 due to depth limit class TestTransclusionErrorHandling: """Test error handling in transclusion processing.""" def test_partial_resolution_on_errors(self, tmp_path): """Test that transclusion continues processing after errors.""" content = """ # Document {{var:valid_var}} {{include:nonexistent.md}} {{var:another_valid_var}} """ context = TransclusionContext( variables={ "valid_var": "Valid Content", "another_valid_var": "More Valid Content" }, base_path=tmp_path ) # This will fail until implementation exists with pytest.raises(NotImplementedError): engine = TransclusionEngine() result = engine.process_content(content, context) # Should process valid variables despite include error assert "Valid Content" in result assert "More Valid Content" in result def test_error_reporting_in_context(self, tmp_path): """Test that errors are properly reported in processing context.""" content = "{{include:missing.md}}" context = TransclusionContext( variables={}, base_path=tmp_path ) # This will fail until implementation exists with pytest.raises(NotImplementedError): engine = TransclusionEngine() result = engine.process_content(content, context) # Context should track errors for reporting assert hasattr(context, 'errors') or 'error' in result.lower() if __name__ == "__main__": pytest.main([__file__])