BerryCrush Developer Guide

Welcome to the BerryCrush developer documentation. This guide is intended for contributors and developers who want to understand the internal architecture and extend BerryCrush.

Contents

Architecture & Design

• BerryCrush Architecture
  • System Overview
  • Core Components
  • Data Flow
  • Key Design Decisions
  • Thread Safety
  • Error Handling
• Module Structure
  • Project Layout
  • Module Dependencies
  • Module Details
  • Build Commands
  • Version Catalog
  • Publishing Coordinates
• Class Hierarchy
  • Core Module (berrycrush/core)
  • JUnit Module (berrycrush/junit)
  • Spring Module (berrycrush/spring)
  • Class Relationships
  • Key Extension Points

Implementation Details

• Scenario File Syntax
  • File Types
  • File Encoding
  • Complete Grammar (EBNF)
  • Tags
  • Features and Background
  • Quick Reference
  • Step Keywords
  • Step Directives
  • Auto-Generated Tests (auto:)
  • Parameters Block
  • Variable Substitution
  • Parameterized Scenarios (Scenario Outline)
  • Fragment Files
  • Comments
  • Custom Steps
  • Custom Assertions
  • Best Practices
  • Error Messages
• Parameters Scope Architecture
  • Overview
  • Scope Hierarchy
  • Current Implementation (File-Level Only)
  • Proposed: Feature-Level Parameters
  • Parameter Inheritance
  • Variable Sharing Behavior
  • Variable Lifecycle
  • AST Structure
  • Implementation Notes
  • See Also
• Auto-Test Provider Extensibility
  • Overview
  • Built-in Providers
  • Creating Custom Providers
  • Provider Priority
  • Excluding Test Types
  • Programmatic Registration
  • Test Type Naming Conventions
  • Multi-Test Providers
  • Kotlin DSL Auto-Test API
• OpenAPI Version Support
  • Supported Versions
  • Architecture
  • Feature Detection
  • OpenAPI 3.1.x Features
  • Implementation Details
  • Best Practices
  • Test Fixtures
  • See Also

Development Tools

• Development Tools
  • Build System
  • Code Formatting
  • Documentation
  • Dependency Management
  • Testing
  • IDE Setup
  • Git Workflow
  • Continuous Integration
  • Debugging
  • Useful Commands Reference
  • Troubleshooting
• Contributing to BerryCrush
  • Getting Started
  • Development Workflow
  • Code Quality Standards
  • Pull Request Guidelines
  • Reporting Issues
  • License

Quick Links

• Architecture Overview - High-level system design

• Module Structure - Project module organization

• Contributing Guide - How to contribute to BerryCrush

Related Documentation

• User Reference - User-facing documentation in /manual/

• KDoc API Reference - Kotlin API documentation in /kdoc/