@tdk-landscape/tdk-cli-core 1.3.52 → 1.3.54

package/tests/tilt-engine/test_agents_md_generator.py

@@ -1,341 +0,0 @@
-"""
-Tests for the AGENTS.md generator.
-
-These tests verify that:
-1. The generator creates valid AGENTS.md files with correct content
-2. The generated file warns AI agents not to modify .autogenerated/ files
-3. The generator is properly wired into the generator index
-4. The AGENTS.md constant is defined in manifest constants
-5. The generator is called from manifest_resource orchestrator
-"""
-
-import json
-import pytest
-import re
-from pathlib import Path
-
-pytestmark = [pytest.mark.fast, pytest.mark.generator]
-
-
-class TestAgentsMdGeneratorSource:
-    """Test the agents_md.star generator source code."""
-    
-    @pytest.fixture
-    def generator_path(self) -> Path:
-        """Return path to the agents_md.star generator."""
-        return Path(__file__).parent.parent.parent / "engine" / "topologies" / "tilt" / "generators" / "agents_md.star"
-    
-    def test_generator_file_exists(self, generator_path: Path):
-        """Verify the generator file exists."""
-        assert generator_path.exists(), f"Generator not found: {generator_path}"
-    
-    def test_generator_has_correct_structure(self, generator_path: Path):
-        """Verify generator has expected structure and functions."""
-        content = generator_path.read_text()
-        
-        # Should have the main generation function
-        assert "def generate_agents_md(" in content, "Missing generate_agents_md function"
-        
-        # Should have the public API struct
-        assert "AgentsMd = struct(" in content, "Missing AgentsMd struct export"
-        
-        # Should have generate method in struct
-        assert "generate = generate_agents_md" in content, "Missing generate method in struct"
-    
-    def test_generator_has_required_template_sections(self, generator_path: Path):
-        """Verify template contains all required warning sections."""
-        content = generator_path.read_text()
-        
-        # Required sections that must be in the template
-        required_sections = [
-            "AUTOGENERATED FILES - DO NOT MODIFY",
-            "Why This Folder Exists",
-            "What Happens If You Modify Files Here",
-            "Where to Make Changes Instead",
-            "How Regeneration Works",
-            "For AI Agents",
-            "NEVER",  # AI agent warning (may have markdown formatting)
-            "ALWAYS",  # AI agent instruction (may have markdown formatting)
-            "service.json",
-            ".autogenerated/",
-        ]
-        
-        for section in required_sections:
-            assert section in content, f"Missing required section: {section}"
-    
-    def test_generator_uses_correct_output_path(self, generator_path: Path):
-        """Verify generator writes to correct path."""
-        content = generator_path.read_text()
-        
-        # Should use AUTOGENERATED_FOLDER constant
-        assert "AUTOGENERATED_FOLDER" in content, "Should use AUTOGENERATED_FOLDER constant"
-        
-        # Should write to AGENTS.md
-        assert "AGENTS.md" in content, "Should generate AGENTS.md file"
-    
-    def test_generator_includes_resource_info(self, generator_path: Path):
-        """Verify generator includes service-specific metadata."""
-        content = generator_path.read_text()
-        
-        # Should extract service info from manifest
-        assert "appName" in content, "Should use appName from manifest"
-        assert "appType" in content, "Should use appType from manifest"
-        assert "_servicePath" in content, "Should use _servicePath from manifest"
-        
-        # Should include metadata in output (generator uses resource_name for service name)
-        assert "resource_name" in content, "Should format resource_name into template"
-        assert "app_type" in content, "Should format app_type into template"
-
-
-class TestAgentsMdGeneratorIntegration:
-    """Test integration of AGENTS.md generator into the generator system."""
-    
-    @pytest.fixture
-    def generators_index_path(self) -> Path:
-        """Return path to generators index.star."""
-        return Path(__file__).parent.parent.parent / "engine" / "topologies" / "tilt" / "generators" / "index.star"
-    
-    @pytest.fixture
-    def constants_path(self) -> Path:
-        """Return path to manifest constants."""
-        return Path(__file__).parent.parent.parent / "engine" / "topologies" / "tilt" / "manifest" / "constants.star"
-    
-    @pytest.fixture
-    def manifest_resource_path(self) -> Path:
-        """Return path to manifest_resource orchestrator."""
-        return Path(__file__).parent.parent.parent / "engine" / "topologies" / "tilt" / "resources" / "orchestrator" / "generators" / "manifest_resource.star"
-    
-    def test_generator_loaded_in_index(self, generators_index_path: Path):
-        """Verify agents_md.star is loaded in generators index."""
-        content = generators_index_path.read_text()
-        
-        # Should load the agents_md module
-        assert 'load("./agents_md.star"' in content, "Should load agents_md.star"
-        
-        # Should export AgentsMd in Generators struct
-        assert "AgentsMd=AgentsMd" in content.replace(" ", "") or "AgentsMd = AgentsMd" in content, \
-            "Should export AgentsMd in Generators struct"
-    
-    def test_agents_md_constant_defined(self, constants_path: Path):
-        """Verify AGENTS.md filename constant exists."""
-        content = constants_path.read_text()
-        
-        # Should have agents_md in GENERATED_CONFIG_FILENAMES
-        assert "'agents_md': 'AGENTS.md'" in content, \
-            "Should define agents_md constant in GENERATED_CONFIG_FILENAMES"
-    
-    def test_generator_called_from_orchestrator(self, manifest_resource_path: Path):
-        """Verify generator is called from manifest_resource orchestrator."""
-        content = manifest_resource_path.read_text()
-        
-        # Should call AgentsMd.generate somewhere
-        assert "AgentsMd.generate" in content or "Generators.AgentsMd.generate" in content, \
-            "Should call AgentsMd.generate from orchestrator"
-        
-        # Should mention AGENTS.md generation in comments
-        assert "AGENTS.MD" in content.upper() or "AI agent" in content.lower(), \
-            "Should have comment explaining AGENTS.md generation"
-    
-    def test_agents_md_in_generated_file_list(self, manifest_resource_path: Path):
-        """Verify AGENTS.md is included in generated files list."""
-        content = manifest_resource_path.read_text()
-        
-        # Should add AGENTS.md to the file list for logging
-        assert "agents_md" in content, "Should reference agents_md in file list"
-
-
-class TestGeneratedAgentsMdContent:
-    """Test the content that would be generated by the AGENTS.md generator."""
-    
-    @pytest.fixture
-    def generator_path(self) -> Path:
-        """Return path to the agents_md.star generator."""
-        return Path(__file__).parent.parent.parent / "engine" / "topologies" / "tilt" / "generators" / "agents_md.star"
-    
-    @pytest.fixture
-    def template_content(self, generator_path: Path) -> str:
-        """Extract template content from generator."""
-        content = generator_path.read_text()
-        
-        # Extract TEMPLATE_AGENTS_MD content
-        match = re.search(
-            r'TEMPLATE_AGENTS_MD = """(.*?)"""',
-            content,
-            re.DOTALL
-        )
-        if match:
-            return match.group(1)
-        return ""
-    
-    def test_template_has_frontmatter(self, template_content: str):
-        """Verify template has YAML frontmatter."""
-        assert template_content.startswith("---"), "Should start with YAML frontmatter"
-        assert "title:" in template_content, "Should have title in frontmatter"
-        assert "description:" in template_content, "Should have description in frontmatter"
-        assert "status: autogenerated" in template_content, "Should have autogenerated status"
-    
-    def test_template_warns_against_modification(self, template_content: str):
-        """Verify template clearly warns against modifying autogenerated files."""
-        # Should have strong warning language
-        warning_patterns = [
-            r"DO NOT MODIFY",
-            r"will be overwritten",
-            r"MACHINE[- ]GENERATED",
-            r"NEVER.*write.*edit.*autogenerated",
-            r"ALWAYS.*check.*autogenerated",
-        ]
-        
-        for pattern in warning_patterns:
-            assert re.search(pattern, template_content, re.IGNORECASE), \
-                f"Missing warning pattern: {pattern}"
-    
-    def test_template_explains_manifest_driven_architecture(self, template_content: str):
-        """Verify template explains the manifest-driven pattern."""
-        # Should explain the architecture
-        assert "service.json" in template_content, "Should reference service.json"
-        assert "manifest" in template_content.lower(), "Should explain manifest concept"
-        assert "generator" in template_content.lower(), "Should mention generators"
-    
-    def test_template_lists_all_generated_files(self, template_content: str):
-        """Verify template lists all types of generated files."""
-        expected_files = [
-            "vite.config",
-            "tsconfig",
-            "Dockerfile",
-            "nginx",
-            ".env",
-            "bunfig",
-            ".npmrc",
-            "docker-compose",
-            "playwright",
-            "prisma",
-        ]
-        
-        for file_type in expected_files:
-            assert file_type in template_content, \
-                f"Should mention {file_type} as generated file type"
-    
-    def test_template_shows_correct_alternatives(self, template_content: str):
-        """Verify template shows correct files to edit instead."""
-        # Should have a table or list of alternatives
-        alternatives = [
-            "service.json",
-            "package.json",
-            "src/",
-        ]
-        
-        for alt in alternatives:
-            assert alt in template_content, f"Should mention {alt} as correct file to edit"
-    
-    def test_template_has_ai_agent_instructions(self, template_content: str):
-        """Verify template has specific instructions for AI agents."""
-        # Should have clear AI agent instructions section
-        ai_patterns = [
-            r"For AI Agents",
-            r"CRITICAL INSTRUCTIONS",
-            r"write\(\).*edit\(",
-            r"skill\(.*autogenerated",
-        ]
-        
-        for pattern in ai_patterns:
-            assert re.search(pattern, template_content, re.IGNORECASE), \
-                f"Missing AI agent instruction pattern: {pattern}"
-    
-    def test_template_has_emergency_override_section(self, template_content: str):
-        """Verify template explains emergency override procedure."""
-        assert "Emergency Override" in template_content, \
-            "Should have emergency override section"
-        assert "tilt down" in template_content.lower(), \
-            "Should mention tilt down for emergency changes"
-
-
-class TestAgentsMdGeneratorMetadata:
-    """Test that generator includes proper metadata."""
-    
-    @pytest.fixture
-    def generator_path(self) -> Path:
-        """Return path to the agents_md.star generator."""
-        return Path(__file__).parent.parent.parent / "engine" / "topologies" / "tilt" / "generators" / "agents_md.star"
-    
-    def test_generator_has_proper_header(self, generator_path: Path):
-        """Verify generator has proper file header."""
-        content = generator_path.read_text()
-        
-        # Should have module documentation
-        assert "AGENTS.MD GENERATOR" in content, "Should identify as AGENTS.md generator"
-        assert "Purpose: Generate AGENTS.md" in content, "Should have purpose comment"
-    
-    def test_generator_uses_utils_for_header(self, generator_path: Path):
-        """Verify generator uses Utils.get_template_header for consistency."""
-        content = generator_path.read_text()
-        
-        assert "Utils.get_template_header" in content, \
-            "Should use Utils.get_template_header for file header"
-    
-    def test_generator_has_inline_constants(self, generator_path: Path):
-        """Verify generator follows pattern of inlined constants."""
-        content = generator_path.read_text()
-        
-        # Should have inlined constants section
-        assert "INLINED CONSTANTS" in content, "Should have inlined constants section"
-        assert 'AUTOGENERATED_FOLDER = ".autogenerated"' in content, \
-            "Should define AUTOGENERATED_FOLDER constant"
-
-
-class TestAgentsMdEndToEnd:
-    """End-to-end tests simulating the full generation flow."""
-    
-    def test_agents_md_generation_simulation(self):
-        """Simulate generating AGENTS.md for a sample service."""
-        # This simulates what the generator would produce
-        
-        sample_manifest = {
-            "appName": "test-service-backend",
-            "appType": "backend",
-            "stack": "test",
-            "port": 4000,
-            "_servicePath": "services/product/test/test-service-backend",
-        }
-        
-        # Simulate the generation logic (in reality this runs in Starlark)
-        # We verify the Python equivalent would work
-        
-        # 1. Extract values from manifest
-        app_name = sample_manifest.get("appName", "unknown-service")
-        app_type = sample_manifest.get("appType", "backend")
-        resource_path = sample_manifest.get("_servicePath", "")
-        
-        assert app_name == "test-service-backend"
-        assert app_type == "backend"
-        assert resource_path == "services/product/test/test-service-backend"
-        
-        # 2. Verify output path construction
-        output_path = resource_path + "/.autogenerated/AGENTS.md"
-        assert output_path == "services/product/test/test-service-backend/.autogenerated/AGENTS.md"
-        
-        # 3. Verify content would include service-specific info
-        template_vars = {
-            "resource_name": app_name,
-            "app_type": app_type,
-        }
-        
-        assert template_vars["resource_name"] == "test-service-backend"
-        assert template_vars["app_type"] == "backend"
-    
-    def test_all_required_files_exist(self):
-        """Verify all files in the AGENTS.md generator chain exist."""
-        root = Path(__file__).parent.parent.parent / "engine" / "topologies"
-        
-        required_files = [
-            root / "tilt" / "generators" / "agents_md.star",
-            root / "tilt" / "generators" / "index.star",
-            root / "tilt" / "manifest" / "constants.star",
-            root / "tilt" / "resources" / "orchestrator" / "generators" / "manifest_resource.star",
-        ]
-        
-        for file_path in required_files:
-            assert file_path.exists(), f"Required file missing: {file_path}"
-
-
-if __name__ == "__main__":
-    pytest.main([__file__, "-v"])