# areso/oblache architecture

> Architecture diagram of the GitHub repository areso/oblache, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/areso/oblache
- Repository: https://github.com/areso/oblache

## Overview

##### Project type and purpose
- From the file tree and README, “Oblache” is not a full-stack repo but a dedicated automated test suite (API + UI) for a separate issue/feature-tracker application. Key indicators:
- tests_api/ and tests_ui/ directories containing pytest fixtures, page objects, HTTP utils, etc.
- .github/workflows definitions for api.yml, ui.yml, full_report.yml, etc.
- Dockerfile and docker-compose.yml to containerize the tests.

##### File structure
- Top-level files and folders:
- .github/workflows/ – CI jobs that build Docker images and launch tests.
- Dockerfile & docker-compose.yml – the environment in which tests run.
- requirements.txt – Python dependencies (pytest, requests, selenium, etc.).
- conftest.py – shared fixtures for all pytest runs.
- tests_api/ – API test suite using HTTP-based utils, data sources, logger, HTML report generators.
- tests_ui/ – UI test suite using the Page Object Model (base_page.py, login_page.py, etc.), Selenium locators, and browser drivers.
- manual tests ui/ – markdown test cases for manual verification.

##### README for additional insights
- README.md describes this as a “public issue and feature tracker” test project with links to design_doc.md and API references.
- README_TESTS.md likely outlines how to run and structure tests.

##### Callouts and details
- That conftest.py provides shared fixtures (base URLs, browser sessions) used by both suites.
- That tests_api/data drives data-driven testing.
- That manual tests UI live outside the automated pipeline but feed into the same page object abstractions if later automated.
- Optionally, note capacity.yml for load/performance tests as a separate CI job calling tests_api/try_performance.py.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "CI/CD Layer"
        API_YAML["API Workflow"]:::ci
        UI_YAML["UI Workflow"]:::ci
        FULL_YAML["Full Report Workflow"]:::ci
        CAP_YAML["Capacity Workflow"]:::ci
    end

    subgraph "Build Layer"
        DOCKERFILE["Dockerfile"]:::build
        DOCKERCOMPOSE["docker-compose.yml"]:::build
    end

    subgraph "Test Runner / Fixtures"
        ROOT_CONFT["conftest.py"]:::runnerFile
        UI_CONFT["tests_ui/conftest.py"]:::runnerFile
    end

    subgraph "API Test Suite"
        CONFIG["config.py"]:::api
        ASSERT["assertion.py"]:::api
        HTTPM["http_methods.py"]:::api
        REQUEST["request.py"]:::api
        LOGGER["logger.py"]:::api
        DATA["data.py"]:::api
        LOADREP["loading_report_path.py"]:::api
        LOGPATH["logger_path.py"]:::api
        TESTGET["test_get.py"]:::api
        TESTDB["test_db.py"]:::api
        TESTBD["test_bd.py"]:::api
        PERF["try_perfomance.py"]:::api
    end

    subgraph "UI Test Suite"
        BASEPAGE["base_page.py"]:::ui
        LOGINPAGE["login_page.py"]:::ui
        LOGINLOC["login_page_locators.py"]:::ui
        MAINPAGE["main_page.py"]:::ui
        PROFILEPAGE["profile_page.py"]:::ui
        LINKS["links.py"]:::ui
        TESTUI["test_ui.py"]:::ui
    end

    subgraph "Reporting & Artifacts"
        REP1["my_report1.html"]:::report
        REP2["loading_report_dir/my_report1.html"]:::report
        LOGSFOLDER["logs/"]:::report
    end

    subgraph "Manual UI Test Cases"
        MANUAL["test_cases.md"]:::doc
    end

    subgraph "API & Design Documentation"
        APIREF["api_references.md"]:::doc
        DESIGN["design_doc.md"]:::doc
        README_TESTS["README_TESTS.md"]:::doc
    end

    SUT["Oblache Application (SUT)"]:::external

    %% Connections
    API_YAML --> DOCKERFILE
    UI_YAML --> DOCKERFILE
    FULL_YAML --> DOCKERFILE
    CAP_YAML --> DOCKERFILE

    DOCKERFILE --> ROOT_CONFT
    DOCKERCOMPOSE --> ROOT_CONFT

    ROOT_CONFT --> CONFIG
    ROOT_CONFT --> ASSERT
    ROOT_CONFT --> HTTPM
    ROOT_CONFT --> REQUEST
    ROOT_CONFT --> LOGGER
    ROOT_CONFT --> DATA
    ROOT_CONFT --> LOADREP
    ROOT_CONFT --> LOGPATH
    ROOT_CONFT --> TESTGET
    ROOT_CONFT --> TESTDB
    ROOT_CONFT --> TESTBD
    ROOT_CONFT --> PERF

    UI_CONFT --> BASEPAGE
    UI_CONFT --> LOGINPAGE
    UI_CONFT --> LOGINLOC
    UI_CONFT --> MAINPAGE
    UI_CONFT --> PROFILEPAGE
    UI_CONFT --> LINKS
    UI_CONFT --> TESTUI

    CONFIG --> SUT
    ASSERT --> SUT
    HTTPM --> SUT
    REQUEST --> SUT
    LOGGER --> SUT
    DATA --> SUT
    LOADREP --> SUT
    LOGPATH --> SUT
    TESTGET --> SUT
    TESTDB --> SUT
    TESTBD --> SUT
    PERF --> SUT

    BASEPAGE --> SUT
    LOGINPAGE --> SUT
    LOGINLOC --> SUT
    MAINPAGE --> SUT
    PROFILEPAGE --> SUT
    LINKS --> SUT
    TESTUI --> SUT

    CONFIG --> REP1
    TESTGET --> REP1
    PERF --> REP1
    BASEPAGE --> REP1

    CONFIG --> REP2
    PERF --> REP2

    CONFIG --> LOGSFOLDER
    PERF --> LOGSFOLDER
    TESTGET --> LOGSFOLDER

    MANUAL --> BASEPAGE
    APIREF --> ROOT_CONFT
    DESIGN --> ROOT_CONFT
    README_TESTS --> ROOT_CONFT

    %% Click Events
    click API_YAML "https://github.com/areso/oblache/blob/master/.github/workflows/api.yml"
    click UI_YAML "https://github.com/areso/oblache/blob/master/.github/workflows/ui.yml"
    click FULL_YAML "https://github.com/areso/oblache/blob/master/.github/workflows/full_report.yml"
    click CAP_YAML "https://github.com/areso/oblache/blob/master/.github/workflows/capacity.yml"
    click DOCKERFILE "https://github.com/areso/oblache/tree/master/Dockerfile"
    click DOCKERCOMPOSE "https://github.com/areso/oblache/blob/master/docker-compose.yml"
    click ROOT_CONFT "https://github.com/areso/oblache/blob/master/conftest.py"
    click UI_CONFT "https://github.com/areso/oblache/blob/master/tests_ui/conftest.py"
    click CONFIG "https://github.com/areso/oblache/blob/master/tests_api/config.py"
    click ASSERT "https://github.com/areso/oblache/blob/master/tests_api/assertion.py"
    click HTTPM "https://github.com/areso/oblache/blob/master/tests_api/utils/http_methods.py"
    click REQUEST "https://github.com/areso/oblache/blob/master/tests_api/utils/request.py"
    click LOGGER "https://github.com/areso/oblache/blob/master/tests_api/utils/logger.py"
    click DATA "https://github.com/areso/oblache/blob/master/tests_api/data/data.py"
    click LOADREP "https://github.com/areso/oblache/blob/master/tests_api/loading_report_dir/loading_report_path.py"
    click LOGPATH "https://github.com/areso/oblache/blob/master/tests_api/logs/logger_path.py"
    click TESTGET "https://github.com/areso/oblache/blob/master/tests_api/test_get.py"
    click TESTDB "https://github.com/areso/oblache/blob/master/tests_api/test_db.py"
    click TESTBD "https://github.com/areso/oblache/blob/master/tests_api/test_bd.py"
    click PERF "https://github.com/areso/oblache/blob/master/tests_api/try_perfomance.py"
    click BASEPAGE "https://github.com/areso/oblache/blob/master/tests_ui/base_page.py"
    click LOGINPAGE "https://github.com/areso/oblache/blob/master/tests_ui/login_page.py"
    click LOGINLOC "https://github.com/areso/oblache/blob/master/tests_ui/login_page_locators.py"
    click MAINPAGE "https://github.com/areso/oblache/blob/master/tests_ui/main_page.py"
    click PROFILEPAGE "https://github.com/areso/oblache/blob/master/tests_ui/profile_page.py"
    click LINKS "https://github.com/areso/oblache/blob/master/tests_ui/links.py"
    click TESTUI "https://github.com/areso/oblache/blob/master/tests_ui/test_ui.py"
    click REP1 "https://github.com/areso/oblache/blob/master/tests_api/my_report1.html"
    click REP2 "https://github.com/areso/oblache/blob/master/tests_api/loading_report_dir/my_report1.html"
    click LOGSFOLDER "https://github.com/areso/oblache/tree/master/tests_api/logs/"
    click MANUAL "https://github.com/areso/oblache/blob/master/manual tests ui/test_cases.md"
    click APIREF "https://github.com/areso/oblache/blob/master/api_references.md"
    click DESIGN "https://github.com/areso/oblache/blob/master/design_doc.md"
    click README_TESTS "https://github.com/areso/oblache/blob/master/README_TESTS.md"

    %% Styles
    classDef ci fill:#0d6efd,stroke:#000,color:#fff
    classDef build fill:#20c997,stroke:#000,color:#fff
    classDef runnerFile fill:#6f42c1,stroke:#000,color:#fff
    classDef api fill:#198754,stroke:#000,color:#fff
    classDef ui fill:#0dcaf0,stroke:#000,color:#fff
    classDef report fill:#adb5bd,stroke:#000,color:#000
    classDef doc fill:#ffc107,stroke:#000,color:#000
    classDef external fill:#fd7e14,stroke:#000,color:#000
```
