Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ jobs:
run: pip install ".[test]"

- name: Run tests
run: sg libvirt -c "pytest tests/ -v --tb=short"
run: sg libvirt -c "pytest tests/ -v --tb=short --ignore=tests/test_vm_manager_cluster.py"

- name: Install documentation dependencies
run: pip install ".[docs]"
Expand Down
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,53 @@ sudo dnf install python3 python3-libvirt python3-rbd python3-flask-wtf
```

All theses dependencies are satisfied on a SEAPATH machine.

## Tests

The test suite uses pytest and requires libvirt/QEMU to be available on the host.

### Install test dependencies

```bash
pip install .[test]
```

### Run all tests

```bash
pytest tests/
```

### Run only standalone tests (no cluster required)

The cluster tests (`test_vm_manager_cluster.py`) require a running Pacemaker/Ceph
cluster. To run only the standalone libvirt tests, exclude that file:

```bash
pytest tests/ --ignore=tests/test_vm_manager_cluster.py
```

## Documentation

The HTML documentation is generated with Sphinx.

### Install documentation dependencies

```bash
pip install .[docs]
```

### Build the documentation

```bash
sphinx-build -b html docs docs/_build/html
```

The generated documentation is available at `docs/_build/html/index.html`.

Alternatively, using cqfd (Docker-based build wrapper):

```bash
cqfd init
cqfd -b docs
```
Loading
Loading