# gsanchezm/test-oriented-microkernel-architecture architecture

> Architecture diagram of the GitHub repository gsanchezm/test-oriented-microkernel-architecture, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-23). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gsanchezm/test-oriented-microkernel-architecture
- Repository: https://github.com/gsanchezm/test-oriented-microkernel-architecture

## Overview

##### Project Type and Purpose
- This is an open-source, extensible Test Automation Framework built in Java (with a parallel JavaScript version) using a Microkernel (plugin-based) architecture.
- The “core” module implements the microkernel—loading plugins, providing execution context, dispatching tasks/validations.
- Additional modules (“common,” “frameworks,” “plugins”) provide support libraries, platform-specific initialization handlers, and concrete test-automation plugins (Web, Mobile, API, Performance).

##### File Structure Analysis
- Top-level Maven reactor (pom.xml) defines sub-modules:
- common – shared utilities, config, factories, interfaces, resolvers, listeners.
- core – microkernel engine, plugin manager, exception handling, test runners.
- frameworks – platform initialization handlers/write-your-own-framework (api, web-ui, mobile-ui, performance).
- plugins – concrete plugins for various domains: selenium, rest-assured, appium, JMeter.
- ci-cd – GitHub Actions workflow for build/test.
- Each framework/plugin module has its own POM and src/main/java hierarchy.
- Common patterns: Factory, Service Locator (AutoDiscoveryPlugin), Interface-based plugins (IPlugin, ITaskFactory, IValidationFactory).

##### README Insights
- Emphasizes “Microkernel Architecture” with “modular test plugin” approach.
- Core execution engine loads/invokes plugins.
- CI/CD integration via Maven and Node.js scripts.

a. Main Components
- Core Microkernel
- Common Library
- Framework Modules (API, Web-UI, Mobile-UI, Performance)
- Plugin Modules (Selenium, RestAssured, Appium, JMeter)
- CI/CD Pipeline (GitHub Actions)
- External Tools/Services: Appium Server, Selenium Grid/Browser Drivers, JMeter Engine, REST endpoints
b. Relationships & Interactions
- Core depends on Common for configuration, factories, listeners.
- Core’s PluginManager dynamically loads Frameworks and Plugins at startup.
- Framework modules implement initialization handlers (e.g., IWebInitialize, IMobileInitialize) invoked by Core.
- Plugin modules implement ITask and IValidation interfaces, discovered via Common’s AutoDiscoveryPlugin.
- During test execution: Core → Framework Init → Plugin tasks/validations → External tools (Appium/JMeter/Selenium).
- CI/CD triggers Maven (and npm) builds, runs Core tests against assembled modules.
c. Architectural Patterns & Principles
- Microkernel with Plugin Manager (Inversion of Control for extensibility)
- Factory Method & Service Locator for object creation and discovery
- Interface-driven design for tasks, validations, initialization
- Modularization via Maven multi-module project
d. Key Technologies & Frameworks
- Java 17, Maven multi-module
- Interfaces: IPlugin, ITask, IValidation, IInitializeBase
- Framework-specific InitHandlers: ApiInitializerHandler, AndroidCapabilitiesLoader, PerformanceInitializerHandler, etc.
- Plugins: SeleniumPlugin, RestAssuredPlugin, AppiumPlugin, JMeterPlugin

##### Essential Elements to Capture
- Core/PluginManager as central orchestrator
- Common services (Configuration, AutoDiscovery)
- Framework InitHandlers for each domain
- Plugin modules as drop-in extensions
- External dependencies (Appium, Selenium Grid, JMeter)
- CI/CD flow connecting code → build → test → report

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Maven Multi-Module Project"
        subgraph "Common Module"
            Common["Common Library"]:::common
            ADP["AutoDiscoveryPlugin"]:::common
        end
        subgraph "Core Module"
            PM["PluginManager"]:::core
            GE["GlobalExceptionHandler"]:::core
        end
        subgraph "Framework Modules"
            API["ApiInitializerHandler"]:::frameworks
            WebInit["IWebInitialize"]:::frameworks
            MobileInit["IMobileInitialize"]:::frameworks
            PerfInit["PerformanceInitializerHandler"]:::frameworks
        end
        subgraph "Plugin Modules"
            Selenium["SeleniumPlugin"]:::plugins
            RestAssured["RestAssuredPlugin"]:::plugins
            AppiumPlugin["AppiumPlugin"]:::plugins
            JMeterPlugin["JMeterPlugin"]:::plugins
        end
    end

    %% Dependencies and Invocations
    PM -->|"depends on"| Common
    PM -->|"AutoDiscovery"| ADP
    PM -->|"PluginManager.load()"| API
    PM -->|"PluginManager.load()"| WebInit
    PM -->|"PluginManager.load()"| MobileInit
    PM -->|"PluginManager.load()"| PerfInit
    PM -->|"PluginManager.load()"| Selenium
    PM -->|"PluginManager.load()"| RestAssured
    PM -->|"PluginManager.load()"| AppiumPlugin
    PM -->|"PluginManager.load()"| JMeterPlugin

    %% Plugins to External
    Selenium ==>|"ITask.execute()"| SeleniumGrid
    RestAssured ==>|"ITask.execute()"| RestService
    AppiumPlugin ==>|"ITask.execute()"| AppiumServer
    JMeterPlugin ==>|"ITask.execute()"| JMeterEngine

    %% CI/CD Flow
    CICD -->|"build/test"| PM
    CICD -->|"build/test"| Common
    CICD -->|"build/test"| API
    CICD -->|"build/test"| Selenium

    %% External Tools
    subgraph "External Tools/Services"
        SeleniumGrid["Selenium Grid/Browser Drivers"]:::external
        RestService["REST Endpoints"]:::external
        AppiumServer["Appium Server"]:::external
        JMeterEngine["JMeter Engine"]:::external
    end

    CICD["CI/CD Pipeline"]:::cicd

    %% Click Events
    click PM "https://github.com/gsanchezm/test-oriented-microkernel-architecture/blob/main/core/src/main/java/tom/plugin_manager/PluginManager.java"
    click GE "https://github.com/gsanchezm/test-oriented-microkernel-architecture/blob/main/core/src/main/java/tom/exceptions/GlobalExceptionHandler.java"
    click ADP "https://github.com/gsanchezm/test-oriented-microkernel-architecture/blob/main/common/src/main/java/utils/AutoDiscoveryPlugin.java"
    click API "https://github.com/gsanchezm/test-oriented-microkernel-architecture/blob/main/frameworks/api/src/main/java/framework/core/ApiInitializerHandler.java"
    click WebInit "https://github.com/gsanchezm/test-oriented-microkernel-architecture/blob/main/frameworks/web-ui/src/main/java/framework/core/interfaces/IWebInitialize.java"
    click MobileInit "https://github.com/gsanchezm/test-oriented-microkernel-architecture/blob/main/frameworks/mobile-ui/src/main/java/framework/core/interfaces/IMobileInitialize.java"
    click PerfInit "https://github.com/gsanchezm/test-oriented-microkernel-architecture/blob/main/frameworks/performance/src/main/java/framework/core/PerformanceInitializerHandler.java"
    click Selenium "https://github.com/gsanchezm/test-oriented-microkernel-architecture/blob/main/plugins/selenium-plugin/src/main/java/plugin/SeleniumPlugin.java"
    click RestAssured "https://github.com/gsanchezm/test-oriented-microkernel-architecture/blob/main/plugins/restassured-plugin/src/main/java/plugin/RestAssuredPlugin.java"
    click AppiumPlugin "https://github.com/gsanchezm/test-oriented-microkernel-architecture/blob/main/plugins/appium-plugin/src/main/java/plugin/AppiumPlugin.java"
    click JMeterPlugin "https://github.com/gsanchezm/test-oriented-microkernel-architecture/blob/main/plugins/jmeter-plugin/src/main/java/plugin/JMeterPlugin.java"
    click CICD "https://github.com/gsanchezm/test-oriented-microkernel-architecture/blob/main/ci-cd/.github/workflows/ci.yml"

    %% Styles
    classDef core fill:#08427b,color:#fff,stroke:#000;
    classDef common fill:#a9a9a9,color:#000,stroke:#000;
    classDef frameworks fill:#7dcbe6,color:#000,stroke:#000;
    classDef plugins fill:#8bc34a,color:#000,stroke:#000;
    classDef external fill:#f9a825,color:#000,stroke:#000;
    classDef cicd fill:#8e24aa,color:#fff,stroke:#000;
```
