BerryCrush Documentation
========================

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

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   quickstart
   tutorial

.. toctree::
   :maxdepth: 2
   :caption: Features

   features/scenario-syntax
   features/auto-test
   features/kotlin-dsl
   features/standalone-runner
   features/parameters
   features/plugins
   features/custom-steps
   features/reporting
   features/multi-spec
   features/fragments
   features/spring-boot
   features/logging

.. toctree::
   :maxdepth: 2
   :caption: Guides

   migration
   troubleshooting

.. toctree::
   :maxdepth: 1
   :caption: Reference

   API Documentation (KDoc) <../kdoc/index.html>

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 6 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
-------------

.. code-block:: kotlin

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

Scenario file (``pet-api.scenario``):

.. code-block:: berrycrush

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

Installation
------------

.. tabs::

   .. tab:: Gradle (Kotlin DSL)

      Add to your ``build.gradle.kts``:

      .. code-block:: kotlin

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

   .. tab:: Gradle (Groovy)

      Add to your ``build.gradle``:

      .. code-block:: groovy

          dependencies {
              testImplementation 'org.berrycrush.berrycrush:core:1.0.0'
              testImplementation 'org.berrycrush.berrycrush:junit:1.0.0'
              // For Spring Boot projects
              testImplementation 'org.berrycrush.berrycrush:spring:1.0.0'
          }

   .. tab:: Maven

      Add to your ``pom.xml``:

      .. code-block:: xml

          <dependencies>
              <dependency>
                  <groupId>org.berrycrush.berrycrush</groupId>
                  <artifactId>core</artifactId>
                  <version>1.0.0</version>
                  <scope>test</scope>
              </dependency>
              <dependency>
                  <groupId>org.berrycrush.berrycrush</groupId>
                  <artifactId>junit</artifactId>
                  <version>1.0.0</version>
                  <scope>test</scope>
              </dependency>
              <!-- For Spring Boot projects -->
              <dependency>
                  <groupId>org.berrycrush.berrycrush</groupId>
                  <artifactId>spring</artifactId>
                  <version>1.0.0</version>
                  <scope>test</scope>
              </dependency>
          </dependencies>

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`