Testing Guide

🧪 Quality Assurance & Testing Guide

This guide establishes the comprehensive testing protocol for VisualMark Studio, covering automated backend tests, frontend production bundle validation, and desktop runtime verification.

---

🤖 1. Automated Test Suites

Backend API Test Suite

The FastAPI backend includes automated tests verifying API contract integrity, documentation AST generation, and SSRF security sanitization:

cd backend
python -m pytest tests/test_api.py -v

Expected Results:

• test_health_check $\rightarrow$ PASSED
• test_generate_readme_from_description $\rightarrow$ PASSED
• test_generate_readme_missing_inputs $\rightarrow$ PASSED
• test_resolve_image_ssrf_protection $\rightarrow$ PASSED

Frontend Production Build Test

Verify code-splitting, tree-shaking, and TypeScript/JSX syntax validation without starting the app:

cd frontend
npm run build

Expected Results:

• Build outputs generated in frontend/dist/.
• Zero bundle errors or missing import warnings.

---

🖥️ 2. Desktop Verification Checklist

When releasing a new build or reviewing major changes, perform this end-to-end QA checklist:

File System & I/O

• Open File (Ctrl+O): Pick a .md file from disk; verify Monaco loads contents and tab displays filename.
• Save File (Ctrl+S): Make an edit, save; verify dirty indicator clears and changes write to disk.
• Workspace Explorer (Ctrl+Shift+O): Pick a repository folder; verify tree loads with file icons.

Monaco Editor & HUD Toolbar

• Multi-cursor editing works with Alt + Click.
• Highlighting text summons the Floating HUD Toolbar.
• Clicking H2, Bold, or Code Block in HUD applies formatting cleanly to selection.
• Proportional split preview scrolls synchronously with cursor position.

Studio Modules

• Badges Studio: Adding badges updates preview and Markdown output immediately.
• Mermaid Studio: Typing flowchart syntax renders live SVG diagram with no lag.
• Tables Studio: Adding rows and cells properly updates Markdown pipe table.
• README Auditor: Clicking "Audit" generates letter grade (A+ to F) and checkmarks.

Bottom Panel Drawer

• Pressing Ctrl+J toggles the bottom panel drawer.
• Switching between Terminal, Problems / Diagnostics, and Output tabs works smoothly.

---

Return to Home or continue to Packaging & Deployment.