# i-cell-mobilsoft-open-source/roaster architecture

> Architecture diagram of the GitHub repository i-cell-mobilsoft-open-source/roaster, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/i-cell-mobilsoft-open-source/roaster
- Repository: https://github.com/i-cell-mobilsoft-open-source/roaster

## Overview

Based on your project files and README, the roaster project is clearly a Java-based, multi-module testing and integration framework. Its purpose is to collect and provide reusable testing algorithms and integration routines (using CDI, REST-assured, and more) so that developers can streamline how they write tests. The project is built with Maven and is organized into multiple modules that cover different testing or integration aspects (e.g., API support, database/ORM integration, REST services, UI testing with Selenide, and several test result reporting modules).

##### Main Components
- Core Modules and BOM: Include the roaster-bom (which acts as the dependency management layer) and the core modules such as roaster-api and roaster-common. These modules define the fundamental interfaces, common utilities, and configuration management.
- Integration Modules: Highlight all modules that integrate third-party technologies or offer extended functionality. Examples include:
– roaster-hibernate (integration with Hibernate and JPA)
– roaster-jaxrs (for RESTful API support)
– roaster-oracle (database connectivity)
– roaster-mongodb and roaster-redis (NoSQL and caching or message integration)
– roaster-restassured (integration with the REST-assured testing framework)
– roaster-selenide (for UI/Angular/Selenide support)
- Test and Reporting Modules: Modules such as roaster-testdoc, roaster-testsuite, roaster-tm4j, roaster-zephyr, and roaster-weldunit support specialized testing, documentation generation, and validation strategies.
- Documentation and CI/CD: Incorporate the docs folder and GitHub workflows from the .github directory as a “supporting” infrastructure component that ensures proper build and deployment, as well as documentation publishing.

##### Relationships and Interactions
- Core Layer: Connect the roaster-api and roaster-common modules as the building blocks which are then used by all specialized modules.
- Testing/Reporting Modules: Show that modules like roaster-testsuite, roaster-tm4j, and roaster-zephyr consume the core framework and integration features to provide reporting and test execution capabilities.

##### Architectural Patterns and Design Principles
- Modularity: Emphasize that the system is designed as a multi-module Maven project. Each module is isolated by purpose but integrated through the BOM and dependency management.
- Extensibility: Show extension points such as configurable response processors, integration with various external systems, and plugin-style mechanisms (the existence of modules like roaster-common-config and configuration files in META-INF) that allow custom behavior.
- Integration Testing Focus: Since the framework is focused on testing algorithms and integration, highlighting the relationships between the testing modules and core modules is essential.

##### Relevant Technologies, Frameworks, or Libraries
- Java (11+)
- Maven (with the BOM concept to manage modules)
- CDI (Context and Dependency Injection)
- REST-assured (for REST API testing)
- Hibernate, Oracle JDBC, MongoDB, Redis, Selenide, etc. (as applicable to the respective modules)
- The CI/CD and documentation components such as GitHub workflows and Asciidoctor for documentation

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Dependency Management
    subgraph "Dependency Management"
        BOM["roaster-bom"]:::bom
    end

    %% Core Modules
    subgraph "Core Modules"
        API["roaster-api"]:::core
        CommonConfig["roaster-common-config"]:::core
        CommonUtil["roaster-common-util"]:::core
    end

    %% Integration Modules
    subgraph "Integration Modules"
        Hibernate["roaster-hibernate"]:::integration
        JAXRS["roaster-jaxrs"]:::integration
        Oracle["roaster-oracle"]:::integration
        MongoDB["roaster-mongodb"]:::integration
        Redis["roaster-redis"]:::integration
        RestAssured["roaster-restassured"]:::integration
        SelenideAngular["roaster-selenide-angular"]:::integration
        SelenideAPI["roaster-selenide-api"]:::integration
    end

    %% Test & Reporting Modules
    subgraph "Test & Reporting Modules"
        TestDoc["roaster-testdoc"]:::test
        TestSuite["roaster-testsuite"]:::test
        TM4J["roaster-tm4j"]:::test
        WeldUnit["roaster-weldunit"]:::test
        Zephyr["roaster-zephyr"]:::test
    end

    %% CI/CD & Documentation Support
    subgraph "CI/CD & Documentation"
        Docs["docs"]:::ci
        GitHub[".github/workflows"]:::ci
    end

    %% External Technologies
    subgraph "External Technologies"
        Java["Java 11+"]:::external
        Maven["Maven"]:::external
        CDI["CDI 2.0+"]:::external
        ExtRESTassured["REST-assured"]:::external
    end

    %% Connections
    Maven -->|"manages"| BOM
    BOM -->|"manages"| API
    BOM -->|"manages"| CommonConfig
    BOM -->|"manages"| CommonUtil

    API -->|"extends"| Hibernate
    API -->|"extends"| JAXRS
    API -->|"extends"| Oracle
    API -->|"extends"| MongoDB
    API -->|"extends"| Redis
    API -->|"extends"| RestAssured
    API -->|"extends"| SelenideAngular
    API -->|"extends"| SelenideAPI

    API -->|"supports"| TestDoc
    API -->|"supports"| TestSuite
    API -->|"supports"| TM4J
    API -->|"supports"| WeldUnit
    API -->|"supports"| Zephyr

    RestAssured -->|"integrates"| TestSuite

    Java -->|"powers"| API
    CDI -->|"injects"| API
    ExtRESTassured -->|"supports"| RestAssured

    GitHub -->|"triggers"| Docs

    %% Click Events
    click BOM "https://github.com/i-cell-mobilsoft-open-source/roaster/blob/master/roaster-bom/pom.xml"
    click API "https://github.com/i-cell-mobilsoft-open-source/roaster/blob/master/roaster-api/pom.xml"
    click CommonConfig "https://github.com/i-cell-mobilsoft-open-source/roaster/tree/master/roaster-common/roaster-common-config/"
    click CommonUtil "https://github.com/i-cell-mobilsoft-open-source/roaster/tree/master/roaster-common/roaster-common-util/"
    click Hibernate "https://github.com/i-cell-mobilsoft-open-source/roaster/tree/master/roaster-hibernate/"
    click JAXRS "https://github.com/i-cell-mobilsoft-open-source/roaster/tree/master/roaster-jaxrs/"
    click Oracle "https://github.com/i-cell-mobilsoft-open-source/roaster/tree/master/roaster-oracle/"
    click MongoDB "https://github.com/i-cell-mobilsoft-open-source/roaster/blob/master/roaster-mongodb/pom.xml"
    click Redis "https://github.com/i-cell-mobilsoft-open-source/roaster/tree/master/roaster-redis/"
    click RestAssured "https://github.com/i-cell-mobilsoft-open-source/roaster/tree/master/roaster-restassured/"
    click SelenideAngular "https://github.com/i-cell-mobilsoft-open-source/roaster/tree/master/roaster-selenide/roaster-selenide-angular/"
    click SelenideAPI "https://github.com/i-cell-mobilsoft-open-source/roaster/tree/master/roaster-selenide/roaster-selenide-api/"
    click TestDoc "https://github.com/i-cell-mobilsoft-open-source/roaster/tree/master/roaster-testdoc/"
    click TestSuite "https://github.com/i-cell-mobilsoft-open-source/roaster/tree/master/roaster-testsuite/"
    click TM4J "https://github.com/i-cell-mobilsoft-open-source/roaster/tree/master/roaster-tm4j/"
    click WeldUnit "https://github.com/i-cell-mobilsoft-open-source/roaster/tree/master/roaster-weldunit/"
    click Zephyr "https://github.com/i-cell-mobilsoft-open-source/roaster/tree/master/roaster-zephyr/"
    click Docs "https://github.com/i-cell-mobilsoft-open-source/roaster/tree/master/docs/"
    click GitHub "https://github.com/i-cell-mobilsoft-open-source/roaster/tree/master/.github/workflows/"

    %% Class Definitions for styling
    classDef bom fill:#E3F2FD,stroke:#0288D1,stroke-width:2px;
    classDef core fill:#BBDEFB,stroke:#1976D2,stroke-width:2px;
    classDef integration fill:#C8E6C9,stroke:#388E3C,stroke-width:2px;
    classDef test fill:#FFCCBC,stroke:#D84315,stroke-width:2px;
    classDef ci fill:#E1BEE7,stroke:#8E24AA,stroke-width:2px;
    classDef external fill:#F8BBD0,stroke:#C2185B,stroke-width:2px;
```
