How i-cell-mobilsoft-open-source/roaster works
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