Visual Documentation Index
Organized access to all framework architecture and flow diagrams
This page provides organized access to all framework diagrams and flowcharts. Each diagram is designed using Mermaid ↗ syntax for clear, interactive visualization of framework architecture, workflows, and data flows.
Available Diagrams
🏗️ Architecture Overview
Comprehensive view of the framework's 8-layer architecture
Complete layer breakdown, test execution flow, HTTP audit pipeline, mAi Advisor™ flow
🚀 Maven to First Test Case
Complete execution path from Maven command to first test
Maven phases, Surefire plugin, JUnit lifecycle, WebDriver creation
🔍 Test Assets Scanner
Test suite discovery and metrics collection process
Maven Antrun trigger, test discovery, annotation processing
📊 Data Collection Pipeline
Test step data flow from execution to CSV storage
Batch processing, queue management, CSV generation
☁️ BigQuery Upload Process
v2.0.0Complete post-test data pipeline from CSV to Google BigQuery
OpenCSV, dataset/table management, archiving, error handling
🔒 HTTP Audit Pipeline
HTTP security assessment flow and analysis phases
Security headers, SSL/TLS, cookies, compliance checking
💡 mAi Advisor™ Flow
Intelligent recommendation generation workflow
Two-tier model, audience filtering, template matching
Suggested Reading Order
For New Developers
- Architecture Overview - Get the big picture
- Maven to First Test Case - See how tests run
- Data Collection Pipeline - Understand data flow
For Test Writers
- Maven to First Test Case - Learn test lifecycle
- Test Assets Scanner - Understand test discovery
- Architecture Overview - See available components
For DevOps Engineers
- Architecture Overview - System design overview
- BigQuery Upload Process - Cloud setup
- Maven to First Test Case - CI/CD integration
For Framework Maintainers
- Architecture Overview - Core design
- Test Assets Scanner - Discovery mechanics
- Data Collection Pipeline - Data handling
- BigQuery Upload Process - Cloud integration
Use Case Guide
| Question | Diagram |
|---|---|
| "How does the framework execute tests?" | Maven to First Test Case |
| "What is the overall architecture?" | Architecture Overview |
| "How does test discovery work?" | Test Assets Scanner |
| "How is test data collected?" | Data Collection Pipeline |
| "How does data get to BigQuery?" | BigQuery Upload Process |
| "What happens in @BeforeAll and @BeforeEach?" | Maven to First Test Case |
| "How does HTTP security assessment work?" | HTTP Audit Pipeline |
| "How does mAi Advisor™ generate recommendations?" | mAi Advisor™ Flow |
Diagram Technologies
All diagrams in this framework use Mermaid syntax for:
- ✅ Version control friendly (text-based)
- ✅ Renders in GitHub, GitLab, VS Code
- ✅ Easy to update and maintain
- ✅ Interactive in supported viewers
- ✅ Exports to PNG/SVG/PDF
Viewing Diagrams
- GitHub/GitLab: Diagrams render automatically in Markdown preview
- VS Code: Install "Markdown Preview Mermaid Support" extension
- IntelliJ/WebStorm: Built-in Mermaid support in Markdown preview
- CLI: Use
mmdc(mermaid-cli) to export to images
Related Documentation
| Document | Description |
|---|---|
| Framework Overview | High-level introduction |
| Test Development Guide | Writing tests |
| Setup Instructions | Installation and configuration |
| Test Execution Guide | Running tests |