BerryCrush Documentation

BerryCrush is an OpenAPI-driven BDD-style API testing library for Kotlin and Java.

Note

This library is currently in early development. APIs may change.

Getting Started

• Quick Start
  • Prerequisites
  • Installation
  • Creating Your First Test
  • Using Conditional Assertions
  • Next Steps
• Tutorial
  • Overview
  • Project Setup
  • Writing Scenarios
  • Auto-Generated Tests
  • Running Tests
  • Generating Reports
  • Spring Boot Integration
  • Conclusion

Features

• Scenario File Syntax
  • File Types
  • Basic Scenario
  • Step Keywords
  • API Calls
  • Assertions
  • Variable Extraction
  • Conditional Assertions
  • Tags
  • Features and Background
  • Parameterized Scenarios (Outline)
  • Fragment Files
  • Parameters Block
  • Auto-Generated Tests
  • Comments
  • Custom Steps
  • Custom Assertions
  • Best Practices
  • See Also
• Auto-Generated Tests
  • Overview
  • Basic Syntax
  • Example
  • Invalid Tests
  • Security Tests
  • Parameter Locations
  • Context Variables
  • Test Display Names
  • Excluding Test Types
  • Custom Providers
  • Best Practices
  • Integration with JUnit
  • Limitations
  • See Also
• Kotlin DSL
  • Overview
  • Quick Start
  • Creating a Test Suite
  • Defining Scenarios
  • API Calls
  • Variable Extraction
  • Assertions
  • Scenario Outlines
  • Fragments (Reusable Steps)
  • JUnit Integration
  • Complete Example
  • API Reference
  • JUnit 5 Integration with BerryCrushExtension
  • See Also
• Standalone Runner
  • Overview
  • Basic Usage
  • Manual Lifecycle Control
  • Cross-Scenario Variable Sharing
  • Plugin Integration
  • Fragment Support
  • Loading Scenarios from Files
  • Complete Example
  • CI/CD Integration
  • API Reference
  • See Also
• File-Level Parameters
  • Syntax
  • Supported Parameters
  • Use Cases
  • Programmatic Usage
  • JUnit Engine Integration
  • Configuration Priority
  • Notes
  • See Also
• Plugins
  • Plugin Architecture
  • Creating a Custom Plugin
  • Registering Plugins
  • Built-in Plugins
  • Best Practices
  • Example: Retry Plugin
• Custom Steps
  • Step Binding Mechanisms
  • Annotation-Based Steps
  • Registration API
  • Kotlin DSL
  • Package Scanning
  • Spring Integration
  • Step Context
  • Best Practices
  • Example: Complete Step Library
  • Custom Assertions
  • Sample Code Reference
• Reporting
  • Report Formats
  • Configuring Reports
  • Report Output Locations
  • CI/CD Integration
  • Custom Report Plugins
  • Best Practices
• Multi-Spec OpenAPI Support
  • Configuring Multiple Specs
  • Using Named Specs in Scenarios
  • Example: Separating Auth from Main API
  • Auto-Resolution
  • Multi-Host API Testing
  • Best Practices
• Fragments
  • Creating Fragments
  • Using Fragments
  • Fragment Discovery
  • Variables in Fragments
  • Multi-Spec in Fragments
  • Example: Complete Test Suite
  • Best Practices
• Spring Boot Integration
  • Setup
  • Configuration
  • Multi-Spec Support
  • Custom Steps with Spring Injection
  • How It Works
  • Best Practices
  • Troubleshooting
• HTTP Logging
  • Enabling Logging
  • Log Output Format
  • Custom Logging
  • DefaultHttpLogFormatter Options
  • Logger Types

Guides

• Migration Guide
  • From Cucumber
  • From REST Assured
  • From Karate
  • Migration Checklist
  • Getting Help
• Troubleshooting
  • Test Discovery Issues
  • Configuration Issues
  • HTTP Request Issues
  • Assertion Failures
  • Spring Integration Issues
  • Plugin Issues
  • Getting Help

Reference

• API Documentation

Key Features

• OpenAPI-driven: Automatically validate requests and responses against your OpenAPI spec

• BDD-style scenarios: Write readable tests using a Gherkin-like DSL

• Auto-generated tests: Automatically generate invalid request and security tests from OpenAPI schemas

• JUnit 5 integration: Seamless integration with your existing test infrastructure

• Spring Boot support: Auto-discover bindings and configuration from Spring context

• Plugin system: Extend functionality with custom plugins for reporting, logging, and more

• Custom steps: Define reusable step definitions with annotations, DSL, or registration API

• Multi-spec support: Work with multiple OpenAPI specifications in a single test suite

• Fragments: Create reusable scenario steps that can be included across tests

Quick Example

@IncludeEngines("berrycrush")
@BerryCrushScenarios(locations = "scenarios/pet-api.scenario")
@BerryCrushConfiguration(
    bindings = PetStoreBindings::class,
    openApiSpec = "petstore.yaml"
)
class PetApiTest

Scenario file (pet-api.scenario):

scenario: List all pets
  when: I request all pets
    call ^listPets
  then: pets are returned
    assert status 200
    assert schema

Installation

Add to your build.gradle.kts:

dependencies {
    testImplementation("org.berrycrush.berrycrush:core:0.1.0")
    testImplementation("org.berrycrush.berrycrush:junit:0.1.0")
    // For Spring Boot projects
    testImplementation("org.berrycrush.berrycrush:spring:0.1.0")
}

Indices and tables

• Index

• Search Page