Skip to content

Testing

Run checks that match the area you changed.

Docs

bash
cd docs
npm ci
npm run build

Frontend

bash
cd frontend
npm install
npm run typecheck
npm run lint
npm run format:check
npm test
npm run build

Backend

bash
ruff check app tests
ruff format --check app tests
pytest

Smoke Tests

Smoke tests need a running Borg UI instance.

bash
docker compose up -d --build
python3 tests/smoke/run_core_smoke.py --url http://localhost:8081

Run broader suites when touching backup, restore, repository, archive, SSH, or scheduling behavior.

Some smoke tests require host capabilities or external setup:

  • FUSE archive mounting tests require FUSE support.
  • Remote SSH tests require SSH test configuration.
  • OIDC tests require an OIDC test setup.

What To Run

ChangeMinimum check
Docs onlycd docs && npm run build
Frontend UIfrontend typecheck, lint, tests
Backend APIbackend lint and relevant pytest
Backup/restore corerelevant unit tests plus smoke tests
Docker/runtimebuild image and run smoke tests

Distributed under the AGPL-3.0 License.