# testdouble/java-cucumber-example architecture

> Architecture diagram of the GitHub repository testdouble/java-cucumber-example, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-10). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/testdouble/java-cucumber-example
- Repository: https://github.com/testdouble/java-cucumber-example

## Overview

##### Project type and purpose
- This is a sample Java-based test‐automation framework that demonstrates Behavior‐Driven Development (BDD) with Cucumber and UI testing with Selenium WebDriver.
- It contains:
- Feature files under src/test/resources (Cucumber .feature scenarios)
- Glue code under src/test/java (step definitions, support classes)
- A tiny “domain” class (skeleton/Belly.java) for demo purposes
- Build scripts (Maven’s pom.xml and Ant’s build.xml)
- WebDriver executables in bin/

##### File structure
- Top‐level build files: pom.xml (Maven), build.xml (Ant), .travis.yml for CI.
- src/main/java/skeleton: contains the Belly.java domain class used in the skeleton feature.
- src/test/java:
- skeleton, bank, selenium packages with RunCukesTest & Stepdefs (glue code)
- support/Browser.java (helper to instantiate WebDriver)
- src/test/resources: three feature‐file directories (skeleton, bank, selenium).
- bin/: Windows WebDriver executables (IEDriverServer.exe, chromedriver.exe).

##### Extract insights from the README
- Tests can be driven via JUnit (`@RunWith(Cucumber.class)`) or Cucumber CLI (Ant).
- CucumberOptions annotation or `-Dcucumber.options` can override feature paths, tags, plugins.
- Maven `mvn test` and Ant `ant runcukes` are the two entry points.

##### Main components
a. Build & CI layer
- Maven (Surefire + cucumber-junit)
- Ant (cucumber.api.cli.Main)
- Continuous integration (.travis.yml)
b. Test Orchestrator
- JUnit runner with @RunWith(Cucumber.class)
- Cucumber CLI main class
c. Feature Repository
- .feature files under src/test/resources
d. Glue code
- Step definitions (skeleton.Stepdefs, bank.Stepdefs, selenium.TodoSteps)
- Support classes (support.Browser, TodoUtil)
e. Domain under test
- skeleton.Belly.java (demo business logic)
f. External tooling
- Selenium WebDriver executables (chromedriver.exe, IEDriverServer.exe)
- Actual browser instances (Chrome, IE)

##### Relationships & data flow
- Build tool invokes Test Orchestrator
- Test Orchestrator reads .feature files → for each Scenario:
- Matches steps to methods in Step definitions
- Stepdefs call Support.Browser to spin up WebDriver → launches browser
- Stepdefs and Support classes may invoke domain code (e.g., Belly) or Selenium calls on pages
- WebDriver communicates with browser via driver executables
- Results and reports are emitted via Cucumber plugins (pretty, JUnit XML, rerun)

##### Architectural patterns & design principles
- BDD / Layered separation:
- Presentation: .feature files
- Glue: step definitions + support helpers
- Domain logic: Belly and any business helpers
- Infrastructure: WebDriver, browser executables
- Test‐first mindset: features drive development of glue and domain code.
- Plug‐in architecture: Cucumber’s plugin model for reporting, rerun, pretty.

##### Technologies, frameworks, and libraries
- Java 8+
- Cucumber-JVM (cucumber-java, cucumber-junit, cucumber-api)
- Selenium WebDriver
- JUnit 4
- Maven and Ant build systems
- Browser drivers (chromedriver, IEDriverServer)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Build & CI Layer
    subgraph "Build & CI"
        Maven["Maven Surefire + cucumber-junit"]:::buildCI
        Ant["Ant Build (cucumber.api.cli.Main)"]:::buildCI
        CI["Continuous Integration (.travis.yml)"]:::buildCI
    end

    %% Test Orchestrator
    subgraph "Test Orchestrator"
        JUnit["JUnit Runner\n@RunWith(Cucumber.class)"]:::orchestrator
        CLI["Cucumber CLI"]:::orchestrator
    end

    %% Feature Repository
    Features(("Feature Files\nsrc/test/resources")):::glue
    skeletonFeature["skeleton/belly.feature"]:::glue
    bankFeature["bank/bank-ocr.feature"]:::glue
    todosFeature["selenium/todos.feature"]:::glue

    %% Glue Code
    subgraph "Glue Code"
        Stepdefs1["skeleton.Stepdefs"]:::glue
        Stepdefs2["bank.Stepdefs"]:::glue
        TodoSteps["selenium.TodoSteps"]:::glue
        BrowserHelper["support.Browser"]:::glue
        TodoUtil["selenium.TodoUtil"]:::glue
    end

    %% Domain Under Test
    Belly["skeleton.Belly.java"]:::domain

    %% External Tooling
    subgraph "External Tooling"
        WebDrivers(("WebDriver Executables")):::external
        IEDriver["IEDriverServer.exe"]:::external
        ChromeDriver["chromedriver.exe"]:::external
        Browsers(("Browser Instances\nChrome, IE")):::external
    end

    %% Connections
    CI -->|triggers| Maven
    CI -->|triggers| Ant
    Maven -->|runs tests| JUnit
    Ant -->|runs CLI| CLI

    JUnit -->|reads| Features
    CLI -->|reads| Features

    Features -->|uses| skeletonFeature
    Features -->|uses| bankFeature
    Features -->|uses| todosFeature

    skeletonFeature -->|matched by| Stepdefs1
    bankFeature -->|matched by| Stepdefs2
    todosFeature -->|matched by| TodoSteps

    Stepdefs1 -->|calls| BrowserHelper
    Stepdefs2 -->|calls| BrowserHelper
    TodoSteps -->|calls| BrowserHelper
    TodoSteps -->|uses| TodoUtil

    Stepdefs1 -->|invokes| Belly
    Stepdefs2 -->|invokes| Belly

    BrowserHelper -->|launches via| WebDrivers
    WebDrivers -->|includes| IEDriver
    WebDrivers -->|includes| ChromeDriver
    WebDrivers -->|communicates with| Browsers

    %% Click Events
    click Maven "https://github.com/testdouble/java-cucumber-example/blob/main/pom.xml"
    click Ant "https://github.com/testdouble/java-cucumber-example/blob/main/build.xml"
    click CI "https://github.com/testdouble/java-cucumber-example/blob/main/.travis.yml"
    click JUnit "https://github.com/testdouble/java-cucumber-example/blob/main/src/test/java/skeleton/RunCukesTest.java"
    click JUnit "https://github.com/testdouble/java-cucumber-example/blob/main/src/test/java/bank/RunCukesTest.java"
    click CLI "https://github.com/testdouble/java-cucumber-example/blob/main/build.xml"
    click skeletonFeature "https://github.com/testdouble/java-cucumber-example/blob/main/src/test/resources/skeleton/belly.feature"
    click bankFeature "https://github.com/testdouble/java-cucumber-example/blob/main/src/test/resources/bank/bank-ocr.feature"
    click todosFeature "https://github.com/testdouble/java-cucumber-example/blob/main/src/test/resources/selenium/todos.feature"
    click Stepdefs1 "https://github.com/testdouble/java-cucumber-example/blob/main/src/test/java/skeleton/Stepdefs.java"
    click Stepdefs2 "https://github.com/testdouble/java-cucumber-example/blob/main/src/test/java/bank/Stepdefs.java"
    click TodoSteps "https://github.com/testdouble/java-cucumber-example/blob/main/src/test/java/selenium/TodoSteps.java"
    click BrowserHelper "https://github.com/testdouble/java-cucumber-example/blob/main/src/test/java/support/Browser.java"
    click TodoUtil "https://github.com/testdouble/java-cucumber-example/blob/main/src/test/java/selenium/TodoUtil.java"
    click Belly "https://github.com/testdouble/java-cucumber-example/blob/main/src/main/java/skeleton/Belly.java"
    click IEDriver "https://github.com/testdouble/java-cucumber-example/blob/main/bin/IEDriverServer.exe"
    click ChromeDriver "https://github.com/testdouble/java-cucumber-example/blob/main/bin/chromedriver.exe"

    %% Styles
    classDef buildCI fill:#cce5ff,stroke:#004085,color:#004085;
    classDef orchestrator fill:#d4edda,stroke:#155724,color:#155724;
    classDef glue fill:#d4edda,stroke:#155724,color:#155724;
    classDef domain fill:#fff3cd,stroke:#856404,color:#856404;
    classDef external fill:#e2e3e5,stroke:#6c757d,color:#6c757d;
```
