Welcome to mAi™ Framework
Intelligent Test Automation with Multi-Audience Guidance
Welcome to the mAi™ Automation Framework documentation. This comprehensive guide will help you understand, set up, and effectively use the framework for automated testing.
Quick Start
New to the framework? Start here:
1
📖 Overview
Understand the 8-layer architecture
2
🛠️ Setup Guide
Install and configure your environment
3
✏️ Test Development
Write your first test
4
▶️ Test Execution
Run tests in VSCode
Documentation Sections
Core Documentation
| Document | Description |
|---|---|
| Framework Overview | Architecture, features, and components |
| Setup Instructions | Installation and configuration guide |
| Test Development | Writing tests with best practices |
| Test Execution | Running tests and generating reports |
| mAi Advisor™ | Intelligent recommendation system |
| HTTP Assessment | Security auditing and analysis |
| Network Diagnostics | Ping, traceroute, and speed tests |
Architecture Diagrams
| Diagram | Description |
|---|---|
| Architecture Overview | Framework component relationships |
| Maven to Test Case | Test execution flow |
| Test Assets Scanner | Test discovery process |
| Data Collection | Test data pipeline |
| BigQuery Integration | Cloud data upload |
| Advisor Flow | mAi Advisor recommendation process |
| HTTP Audit Pipeline | Security assessment workflow |
Role-Based Guides
| Guide | Description |
|---|---|
| Complete Reading Guide | Linear path through all documentation |
| Test Writer's Guide | QA Engineers, SDET focus |
| DevOps Guide | CI/CD integration and cloud setup |
| Framework Maintainer's Guide | Architecture and extension points |
Framework Features ?
🎯 Key Capabilities
- mAi Advisor™ intelligent recommendation engine with multi-audience guidance
- HTTP Security Auditing with automated vulnerability detection and compliance checking
- Network Diagnostics (ping, traceroute, speed test) for connectivity validation
- JUnit 5 test framework with modern assertions
- Selenium WebDriver 4 for browser automation
- Page Object Model for maintainable tests
- Allure Reports for detailed test results
- Google BigQuery integration for analytics
- Cross-browser testing support
- Parallel execution capabilities
🏗️ Architecture Highlights
- Modular component design with 8 architectural layers
- Custom assertion library with screenshots
- Comprehensive test lifecycle management
- UTC-standardized timestamp tracking
- Thread-safe data collection
- Cloud-ready data pipeline
Advanced Capabilities NEW
🧠 mAi Advisor™ Intelligent Guidance System ?
- Multi-Audience Recommendations: Specialized guidance for 6 audience types (Developer, DevOps, QA, Security, PM, Executive)
- 16+ JSON-Based Templates: Covering Security, Performance, Compliance, and Infrastructure categories
- Framework-Specific Solutions: Code examples for Spring Boot, Express.js, Nginx, Apache, ASP.NET
- Two-Tier Knowledge Model: Understanding tier (all audiences) + Action tier (implementers only)
- Automated Finding Analysis: HTTP audit findings automatically mapped to relevant recommendations
Template Categories:
- Security (8 templates): SSL, CSP, HSTS, Cookie Security, HTTPS, Permissions Policy, Referrer Policy, X-Frame-Options
- Performance (3 templates): Compression, Caching, Response Time
- Compliance (2 templates): GDPR, PCI-DSS
- Infrastructure (2 templates): Server Config, DNS
🔒 HTTP Security Assessment ?
- Automated Security Audits: Validates 12+ security headers and SSL/TLS configuration
- Performance Analysis: Response time, compression, and caching metrics
- Compliance Validation: GDPR cookie consent, PCI-DSS header requirements
- 18 Report Configurations: 3 depths × 6 audiences for role-specific output
- Comprehensive Reporting: HTML diagnostic reports with color-coded findings
- Framework Detection: Identifies Spring Boot, ASP.NET, Express, Laravel, and more
- Test Suite Integration: TS_HttpAssessment_JUnit for automated security testing
🌐 Network Diagnostics ?
- Ping Testing: Connectivity validation with packet loss and latency metrics
- Traceroute Analysis: Hop-by-hop network path mapping with response times
- Speed Testing: Upload/download bandwidth measurement for performance baselining
- Network Details Collection: Comprehensive system and network configuration capture
- Test Suite Integration: TS_Network_JUnit for automated network validation
Common Commands
Run all tests
mvn verify
Run specific test
mvn test -Dtest=TestClassName
Run HTTP audit
mvn test -Dtest=TS_HttpAssessment_JUnit
Run network tests
mvn test -Dtest=TS_Network_JUnit
Generate Allure report
allure open
Create JavaDocs
mvn site
Clean artifacts
mvn clean
Getting Started
Ready to begin? Follow these steps:
- Install Prerequisites - Follow the Setup Guide
- Understand the Architecture - Review the Framework Overview
- Write Your First Test - Check out Test Development
- Run Tests - Learn about Test Execution
- Explore Advanced Features - Try HTTP Audits and mAi Advisor™ recommendations
Getting Help
Having issues? Check these resources:
| Issue | Resource |
|---|---|
| Installation problems | Setup Troubleshooting |
| Test execution errors | Execution Issues |
| Understanding architecture | Framework Overview |
| API reference | JavaDocs (run mvn site first) |