VectorCAST Report Analyser 📊

A powerful Python tool for analyzing VectorCAST test reports, generating comprehensive Excel summaries with directory structures, and providing detailed test metrics analysis for automotive software testing projects.

🎯 Overview

The VectorCAST Report Analyser automates the process of collecting, analyzing, and organizing VectorCAST test reports from complex directory structures. It provides project managers, test engineers, and quality assurance teams with comprehensive insights into test coverage, execution results, and project metrics.

🏆 Key Benefits

Time Efficiency: Reduces manual report collection time from hours to minutes
Comprehensive Analysis: Processes multiple report types simultaneously
Professional Output: Generates formatted Excel reports with multiple worksheets
Project Management: Provides directory tree visualization and file organization
Scalable: Handles large project structures with thousands of files

✨ Features

📋 Report Processing

Multi-Report Support: Processes Full Reports, Metrics Reports, Test Case Management Reports, Coverage Reports, and Execution Reports
Intelligent Pattern Matching: Uses regex patterns to identify VectorCAST report files
Metadata Extraction: Collects file size, modification dates, and directory structure information
Duplicate Handling: Automatically removes duplicate entries

📁 Directory Analysis

Visual Directory Tree: Generates hierarchical directory structure with file icons
Path Resolution: Handles both absolute and relative path references
Permission Handling: Gracefully handles access-restricted directories
File Classification: Categorizes files by type with appropriate icons

📈 Excel Reporting

Multi-Sheet Workbooks: Organizes data across multiple themed worksheets
Summary Dashboard: Provides overview statistics and key metrics
Professional Formatting: Applies headers, colors, and auto-sized columns
Data Visualization: Includes charts and formatted tables

🛠️ Technical Features

Command Line Interface: Flexible CLI with multiple configuration options
Logging System: Comprehensive logging for debugging and audit trails
Error Handling: Robust exception handling with graceful degradation
Cross-Platform: Works on Windows, macOS, and Linux systems

🔧 Prerequisites

System Requirements

Python 3.9+ (recommended 3.11+)
Memory: Minimum 512MB RAM (2GB+ for large projects)
Storage: Varies based on project size and report count

Required Python Packages

pandas>=1.5.0          # Data manipulation and analysis
openpyxl>=3.0.0        # Excel file operations
pathlib                # Path handling (standard library)
re                     # Regular expressions (standard library)
logging                # Logging system (standard library)
argparse               # Command line parsing (standard library)

📥 Installation

Option 1: Clone Repository

git clone https://github.com/suduli/VectorCAST_Report_Analyser.git
cd VectorCAST_Report_Analyser
pip install -r requirements.txt

Option 2: Direct Download

wget https://github.com/suduli/VectorCAST_Report_Analyser/archive/main.zip
unzip main.zip
cd VectorCAST_Report_Analyser-main
pip install pandas openpyxl

Option 3: Development Setup

git clone https://github.com/suduli/VectorCAST_Report_Analyser.git
cd VectorCAST_Report_Analyser
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt

🚀 Usage

Basic Usage

# Analyze current directory
python VectorCAST_Report_Analyser.py

# Analyze specific directory
python VectorCAST_Report_Analyser.py -d /path/to/project

# Custom output filename
python VectorCAST_Report_Analyser.py -o custom_analysis.xlsx

# Verbose logging
python VectorCAST_Report_Analyser.py -v

Advanced Usage

# Complete analysis with all options
python VectorCAST_Report_Analyser.py \
    --directory "/path/to/vectorcast/project" \
    --output "project_analysis_2024.xlsx" \
    --verbose

Command Line Options

Option	Short	Description	Default
`--directory`	`-d`	Root directory to scan	Current directory
`--output`	`-o`	Output Excel filename	`vectorcast_analysis.xlsx`
`--verbose`	`-v`	Enable verbose logging	False
`--help`	`-h`	Show help message	-

📊 Output Structure

The tool generates a comprehensive Excel workbook with the following sheets:

1. Summary Sheet

Report Type Overview: Count and size statistics for each report type
Total Metrics: Aggregate statistics across all reports
Latest Activity: Most recent modification dates
Size Analysis: Total and average file sizes

2. Individual Report Sheets

Full Reports: Complete test execution reports
Metrics Reports: Code coverage and quality metrics
Test Case Reports: Test case management and traceability
Coverage Reports: Code coverage analysis
Execution Reports: Test execution results and timing

3. Directory Tree Sheet

Visual Structure: Hierarchical view of project directories
File Classification: Icons and categorization by file type
Path Information: Full and relative path references

🔍 Report Types Detected

The analyser automatically detects and processes these VectorCAST report types:

Report Type	Pattern	Description
Full Report	`*.Full_Report.html`	Complete test execution and coverage
Metrics Report	`*.Metrics_Report.html`	Code quality and coverage metrics
Test Case Report	`*.Testcase_Management_Report.html`	Test case traceability and management
Coverage Report	`*.Coverage_Report.html`	Detailed code coverage analysis
Execution Report	`*.Execution_Report.html`	Test execution results and timing

📁 Example Project Structure

VectorCAST_Project/
├── 📁 Module1/
│   ├── 🌐 Module1.Full_Report.html
│   ├── 📊 Module1.Metrics_Report.html
│   └── 📋 Module1.Testcase_Management_Report.html
├── 📁 Module2/
│   ├── 🌐 Module2.Full_Report.html
│   ├── 📊 Module2.Coverage_Report.html
│   └── 📃 Module2.Execution_Report.html
├── 📁 Integration/
│   └── 🌐 Integration.Full_Report.html
└── 📈 vectorcast_analysis.xlsx (Generated Output)

⚙️ Configuration

Custom Report Patterns

You can modify the report patterns in the code to match your specific naming conventions:

self.report_patterns = {
    'full_report': r'.*\.Full_Report\.html$',
    'metrics_report': r'.*\.Metrics_Report\.html$',
    'testcase_report': r'.*\.Testcase_Management_Report\.html$',
    'coverage_report': r'.*\.Coverage_Report\.html$',
    'execution_report': r'.*\.Execution_Report\.html$'
}

Logging Configuration

Adjust logging levels for different use cases:

# For development/debugging
logging.getLogger().setLevel(logging.DEBUG)

# For production use
logging.getLogger().setLevel(logging.INFO)

# For quiet operation
logging.getLogger().setLevel(logging.WARNING)

🔧 API Reference