# os-autoinst/openqa architecture

> Architecture diagram of the GitHub repository os-autoinst/openqa, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/os-autoinst/openqa
- Repository: https://github.com/os-autoinst/openqa

## Overview

openQA is the web frontend and management half of an automated system-testing framework; the separate os-autoinst engine executes tests in virtual machines. Its principal workflow is users or automation submitting and managing tests through the web/API, the scheduler assigning work to workers, and workers invoking the test engine while reporting results. README supports these broad roles and capabilities, but the supplied source excerpts contain no runtime modules, so detailed calls and data transfers are not asserted.

Main entry points: [`lib/OpenQA/WebAPI`](https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/WebAPI) (Web frontend), [`lib/OpenQA/Scheduler`](https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/Scheduler) (Test scheduler), [`lib/OpenQA/Worker`](https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/Worker) (Worker), [`lib/OpenQA/Jobs`](https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/Jobs) (Job management)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_management["Web management"]
  node_web["Web frontend"]
  node_api["High-level API"]
  node_scheduler["Test scheduler"]
  node_jobs["Job management"]
  node_results["Test results"]
  node_websockets["Live updates"]
  node_live["Live test view"]
  node_obs["OBS integration"]
end

subgraph group_execution["Test execution"]
  node_worker["Worker"]
  node_engine["Test engine"]
end

subgraph group_state["Shared state and assets"]
  node_schema[("Persistent data")]
  node_assets["Test assets"]
  node_cache["Cache service"]
end

node_user(("User or automation"))

node_user -->|"uses"| node_web
node_user -->|"submits requests"| node_api
node_scheduler -.->|"assigns work"| node_jobs
node_worker -->|"runs tests"| node_engine
node_worker -.->|"reports results"| node_results
node_web -.->|"manages records"| node_schema
node_scheduler -.->|"reads job state"| node_schema
node_jobs -.->|"uses assets"| node_assets
node_web -.->|"publishes updates"| node_websockets
node_live -.->|"streams status"| node_websockets
node_cache -.->|"caches assets"| node_assets
node_obs -.->|"extends API"| node_api

click node_web "https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/WebAPI"
click node_api "https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/WebAPI/Controller/API"
click node_scheduler "https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/Scheduler"
click node_jobs "https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/Jobs"
click node_worker "https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/Worker"
click node_results "https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/Parser/Result"
click node_schema "https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/Schema"
click node_assets "https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/Task/Asset"
click node_websockets "https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/WebSockets"
click node_live "https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/LiveHandler"
click node_cache "https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/CacheService"
click node_obs "https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/WebAPI/Plugin/ObsRsync"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_web,node_api,node_scheduler,node_jobs,node_results,node_websockets,node_live,node_obs,node_user toneBlue
class node_worker,node_engine toneAmber
class node_schema,node_assets,node_cache toneMint
```

## Components

### Web management

- [Web frontend](https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/WebAPI): `lib/OpenQA/WebAPI`
- [High-level API](https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/WebAPI/Controller/API): `lib/OpenQA/WebAPI/Controller/API`
- [Test scheduler](https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/Scheduler): `lib/OpenQA/Scheduler`
- [Job management](https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/Jobs): `lib/OpenQA/Jobs`
- [Test results](https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/Parser/Result): `lib/OpenQA/Parser/Result`
- [Live updates](https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/WebSockets): `lib/OpenQA/WebSockets`
- [Live test view](https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/LiveHandler): `lib/OpenQA/LiveHandler`
- [OBS integration](https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/WebAPI/Plugin/ObsRsync): `lib/OpenQA/WebAPI/Plugin/ObsRsync`

### Test execution

- [Worker](https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/Worker): `lib/OpenQA/Worker`
- **Test engine**

### Shared state and assets

- [Persistent data](https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/Schema): `lib/OpenQA/Schema`
- [Test assets](https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/Task/Asset): `lib/OpenQA/Task/Asset`
- [Cache service](https://github.com/os-autoinst/openqa/tree/master/lib/OpenQA/CacheService): `lib/OpenQA/CacheService`

### Other components

- **User or automation**

## Connections

- User or automation → Web frontend: uses (evidence: `README.md`)
- User or automation → High-level API: submits requests (evidence: `README.md`)
- Test scheduler → Job management: assigns work
- Worker → Test engine: runs tests (evidence: `README.md`)
- Worker → Test results: reports results
- Web frontend → Persistent data: manages records
- Test scheduler → Persistent data: reads job state
- Job management → Test assets: uses assets
- Web frontend → Live updates: publishes updates
- Live test view → Live updates: streams status
- Cache service → Test assets: caches assets
- OBS integration → High-level API: extends API
