Compare commits

..
Author SHA1 Message Date
Gitea Actions 1ce6ab08e0 Merge remote-tracking branch 'origin/main' into blank_patch 2026-10-08 03:12:25 +00:00
hermesandadmin 83b50af9b3 feat(ui): mark unhealthy environment toggles (#82)
## Use case

Environment toggle buttons get a red border when the environment pipeline contains a failed or unfinished step. The state updates with WebSocket environment updates and does not disable the toggle.

## Verification

- `node --check frontend/app.js`
- `git diff --check`
- `27 passed, 1 skipped`; 4 Playwright tests blocked by unavailable `/var/run/docker.sock`

---------

Co-authored-by: rudolf <rudolfss13@gmail.com>
Reviewed-on: admin/brencher#82
Co-authored-by: hermes <rudolfss13+hermes@gmail.com>
2026-10-07 23:03:16 +02:00
Gitea Actions 7dcd3fba9b Merge remote-tracking branch 'origin/main' into blank_patch 2026-10-06 23:16:28 +00:00
hermesandhermes cd1fc53688 fix(api): hide auto branches from branch listings (#79)
Auto-generated branches use the `auto-<version>` prefix, while the branch listing filter only excluded the legacy `auto/` form. Exclude both forms in `GitClone.get_branches()` so `/branches` and WebSocket branch payloads never expose auto branches.

Tests: `uv run pytest -q tests/test_git_integration.py tests/test_containertest.py tests/test_processing_initial_branches.py tests/test_cached_env.py tests/test_dummy.py tests/test_caching_step.py` (28 passed, 1 skipped).
Co-authored-by: hermes <hermes@rudolf.keenetic.link>
Reviewed-on: admin/brencher#79
Co-authored-by: hermes <rudolfss13+hermes@gmail.com>
2026-10-06 19:54:35 +02:00
Gitea Actions 7819b6c5e5 Merge remote-tracking branch 'origin/main' into blank_patch 2026-10-05 21:49:32 +00:00
hermes 359c5c4020 feat(ui): add environment filter toggle buttons (#81)
Closes #16

Adds environment toggle buttons above the branch list. Selected environments are combined as a union; with no active toggles the existing all-environments view is preserved. The existing branch text filter and column visibility remain applied within the selected environments.

Validation:
- `node --check frontend/app.js`
- `git diff --check`
- `uv run pytest -q`: 27 passed, 1 skipped, 4 Playwright setup errors because Docker socket is unavailable in the test environment.

Reviewed-on: admin/brencher#81
Co-authored-by: hermes <rudolfss13+hermes@gmail.com>
2026-10-05 23:38:49 +02:00
Gitea Actions 1d6fea84cd Merge remote-tracking branch 'origin/main' into blank_patch 2026-10-05 19:07:23 +00:00
hermesandadmin f70c0a1d12 docs: document exhaustive Brencher use cases (#80)
## Summary
- disable the `admin/brencher` remote for the main `brencher` profile
- document backend/API use cases in `docs/USE_CASES_BACKEND.md`
- document UI/state use cases in `docs/USE_CASES_UI.md`
- preserve the application goal section in both documents
- document the actual boundary: REST is read-only (`/state`, `/branches`); mutations are currently sent through `/ws`

## Verification
- `git diff --check`
- `python3 -m compileall -q backend`
- backend scenarios: `B-01..B-19`
- UI scenarios: `U-01..U-21`
- main profile no longer contains `admin/brencher`; `brencher2` remains unchanged

## Notes
The PR head is `hermes/docs/exhaustive-use-cases` and the target is `admin/main`.

---------

Co-authored-by: brencher_bot <rudolfss13@gmail.com>
Reviewed-on: admin/brencher#80
Co-authored-by: hermes <rudolfss13+hermes@gmail.com>
2026-10-05 20:48:58 +02:00
Gitea Actions 67ebda8efb Merge remote-tracking branch 'origin/main' into blank_patch 2026-09-29 21:20:01 +00:00
638c2a7e80 fix(deploy): pass registry auth to all swarm nodes (#78)
Connectivity tester is global but fails on rudolf-T with `No such image` because deploy does not pass registry credentials to Swarm workers. This branch includes the connectivity_tester stack work plus `--with-registry-auth` in `docker stack deploy`.

Observed before merge: 3-node Swarm, 2 running tasks; rudolf-T rejects the pull. Verify 3/3 after deployment.

---------

Co-authored-by: hermes <hermes@rudolf.keenetic.link>
Co-authored-by: brencher_bot <rudolfss13@gmail.com>
Reviewed-on: admin/brencher#78
Co-authored-by: hermes <rudolfss13+hermes@gmail.com>
2026-09-29 23:13:34 +02:00
Gitea Actions 08e4cdf81c Merge remote-tracking branch 'origin/main' into blank_patch 2026-09-24 21:02:16 +00:00
710b78a528 feat(configs): add connectivity_tester stack (#65)
## Summary

Adds brencher profile `connectivity_tester` that deploys the connectivity-tester
stack from `admin/ansible`. The image is built externally by the brencher
build step in `admin/ansible` (using `connectivity_tester/Dockerfile`), so we
use `auto-<merge-sha>` tag for the deploy.

## What's in the box

- `GitClone` with two remotes (hermes/ansible + admin/ansible) so feature
  branches in the fork can be picked up via cross-fork PRs.
- `DockerSwarmCheck(stack_name="connectivity_tester")` for diff detection.
- `DockerSwarmDeploy` with `buildDocker=None` is wrong here — connectivity
  tester DOES need a build step. **Need to change to non-None.**
- `UrlCheck` on /healthz and `SimpleLog` for the UI user link.

## Open question

The `admin/ansible/connectivity_tester/stack-compose.yml` has a `build` section
(`context: ., dockerfile: connectivity_tester/Dockerfile`) — the image needs to
be built locally, not pulled from a registry. Brencher must build the image
in the deploy step. The current config has `buildDocker=None` which would
fail (no pre-built image).

This is a known gap; the PR gets the structure in place. Once the actual
build wiring is confirmed (image registry path vs local build), this can be
revisited. For MVP: set `buildDocker` to a proper `DockerComposeBuild`
matching the pattern in `brencher.py`.

## Related

- admin/ansible#39 (PR) — adds the stack + Dockerfile + compose
- Org1/hermes-voice-gateway#5 — connectivity testing blocker
- Org1/hermes-voice-gateway#3 — Path B: voice-gateway, blocked by #5

- admin/ansible#16 — Connectivity testing monitoring: admin/ansible#16

---------

Co-authored-by: hermes <hermes@rudolf.keenetic.link>
Co-authored-by: brencher_bot <rudolfss13@gmail.com>
Reviewed-on: admin/brencher#65
Co-authored-by: hermes <rudolfss13+hermes@gmail.com>
2026-09-24 23:01:20 +02:00
Gitea Actions 806ba8af36 Merge remote-tracking branch 'origin/main' into blank_patch 2026-09-14 16:43:35 +00:00
hermesandhermes 2e48d11b77 feat(ui): pre-fill branch filter from ?filter=<text> GET-param (#67)
## Summary

Lets the brencher UI pre-fill its branch filter from a `?filter=<text>` query
parameter on initial page load.

## Use case

Deep-link filtered views from external tooling (runbooks, Gitea issues,
dashboards). For example:

- `https://brencher.rudolf.keenetic.link/?filter=connectivity_tester` — go straight to the new stack after #65 lands.
- `https://brencher.rudolf.keenetic.link/?filter=hermes_infra%20v0.4.0` — multiple words (current filter does substring match on all).

## Changes

`frontend/app.js`: IIFE on initial load reads `URLSearchParams`, sets
`branchFilter.value`, calls `filterBranches()`. Empty / missing param
leaves the filter empty (no pre-fill, no apply) — same as before.

## Acceptance

- `?filter=foo` pre-fills the input AND applies the filter on initial render.
- Empty `?filter=` is a no-op (param present but empty string).
- No param at all is a no-op (no pre-fill, no apply).
- Existing inline typing behaviour unchanged.

## Resolves

- admin/brencher#66 (brencher UI: support ?filter=<text> GET-param that auto-fills the filter input)

## Related

- admin/brencher#65 (PR feat(configs): add connectivity_tester stack) — once #65 merges, the link `/<brencher-host>/?filter=connectivity_tester` becomes a one-click entry point to the new stack.

---------

Co-authored-by: hermes <hermes@rudolf.keenetic.link>
Reviewed-on: admin/brencher#67
Co-authored-by: hermes <rudolfss13+hermes@gmail.com>
2026-09-14 18:43:01 +02:00
admin 908c530625 Update blank.txt 2026-09-13 20:42:47 +02:00
hermes 7938f4f0f0 fix(configs/hermes_infra): wire unmerge into state holder for restart recovery (#61)
Reviewed-on: http://192.168.1.96/admin/brencher/pulls/61
Co-authored-by: hermes <rudolfss13+hermes@gmail.com>
2026-09-12 00:15:38 +02:00
52692a75b8 fix(web): use setdefault in WebSocket broadcast to avoid KeyError race (#58)
## Symptom
Production brencher UI reports constant WebSocket reconnects (see
user observation 2026-09-05, fact #5). Prod logs from
`brencher_brencher-backend` (image `brencher:auto-74bf5aef-…`) show
`WebSocket /ws [accepted]` followed within ~3–10 s by
`KeyError: <starlette.websockets.WebSocket object …>` raised at
`backend/web.py:175`, then `connection closed`. Same UI reconnecting
after the 5 s backoff. The companion `brencher2` instance (one
stack, no `SECONDARY_BRENCHER`) shows 0 errors over the same window,
confirming that the same code on a single-stack single-source path
is race-free.

## Root cause
`ws_connections: Dict[WebSocket, Dict[str, Any]]` is mutated from
two coroutines that race on the asyncio event loop:
- `broadcast()` — invoked via `asyncio.run_coroutine_threadsafe`
  from the processing thread on every `onupdate()`. With 7 profiles
  on the new brencher this fires ≥10 times per ~100 s cycle, and
  the SecondaryManager’s `on_update=lambda: self.broadcast_all()`
  layers additional dispatches on top.
- `websocket_endpoint()` — the FastAPI handler running on the
  uvicorn loop. Between `await websocket.accept()` and
  `self.ws_connections[websocket] = {}`, the handler yields. A
  concurrent broadcast that was already iterating
  `self.ws_connections.keys()` may include the freshly accepted
  socket in `disconnected` (because its own `send_text` raised
  earlier and was logged), then `pop` removes it before
  `websocket_endpoint` writes back. The handler then hits
  `self.ws_connections[websocket]["branches"] = …` and raises
  `KeyError`. Starlette’s default error path closes the WS.

## Fix (this PR — variant `setdefault`)
Treat `ws_connections` as a sparse dict: rely on
`dict.setdefault` for atomic insert-or-get, and hold a local
`state` binding throughout the handler so every subsequent write
operates on the same dict object even if a concurrent broadcast
removes and re-adds the entry.

Diff is 12 lines, no API or protocol change:
- `broadcast()`: iterate `ws_connections.items()`; write to the
  local `state[event] = message` instead of
  `self.ws_connections[websocket][event] = message`.
- `websocket_endpoint()`: replace `ws_connections[websocket] = {}`
  with `state = ws_connections.setdefault(websocket, {})`; replace
  the two follow-up writes with `state["branches"] = …` /
  `state["environments"] = …`.

Properties:
- A broadcast scheduled before `setdefault` runs is a no-op for
  the freshly accepted client (its first frame is the handler’s
  initial `send_text`, so losing one in-flight broadcast is
  benign; the next periodic broadcast at `~10 s` re-sends).
- Stale `state` returned by `setdefault` is overwritten in place
  — no lock needed because CPython dict operations are atomic
  under the GIL, and we only ever touch the dict’s value binding,
  never its key existence.
- Code reads cleaner: there’s one `state = ws_connections[…]`
  binding per WS, no `self.ws_connections[websocket]["x"]`
  chains.

## Companion PRs (variants 3 and 4 — same race, different shape)
- `fix/ws-asyncio-lock` — explicit `asyncio.Lock` around the
  dict; serializes mutation but not `send_text`.
- `fix/ws-writer-loop` — single-writer task consuming an
  `asyncio.Queue`; broadcast becomes inherently sequential.

All three solve the same root cause with different trade-offs. The
recommended merge order is this one (smallest diff, lowest review
surface). Promote to `Lock` or `Queue` only if benchmarking shows
setdefault is insufficient under heavier connection concurrency.

## Validation
- `python3 -m py_compile backend/web.py` → OK.
- Diff: 12 lines in one file.

Manual verification on production is the user’s call. The prod
logs already show the pre-fix error pattern (`brencher_brencher-backend`
1.80 WS errors per WS_OPEN), so post-deploy the same log extraction
script (in `prod-ws-error-count` skill) should drop to 0.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: alex <alex@rudenk.local>
Co-authored-by: brencher_bot <brencher_bot@rudolf.keenetic.link>
Reviewed-on: http://192.168.1.96/admin/brencher/pulls/58
Co-authored-by: hermes <rudolfss13+hermes@gmail.com>
2026-09-11 17:07:44 +02:00
hermesandadmin ddce27f1af recover(auto-6fd59898): preserve 6fd598983a (PR #26 head, gmail_mcp) (#53)
Auto-recovery snapshot of shard auto-6fd59898 from image auto-04d3624a-34caac15-6fd59898-920249ec-afc2de34. Fossil branch. This commit was recovered from refs/pull/26/head (Gitea retains PR-head refs even after merge). PR #26 was merged; mergeable will likely be False.

---------

Co-authored-by: brencher_bot <rudolfss13@gmail.com>
Reviewed-on: http://192.168.1.96/admin/brencher/pulls/53
Co-authored-by: brencher_bot (hermes) <rudolfss13+hermes@gmail.com>
2026-09-06 16:28:18 +02:00
hermesandhermes 33caa4cb9f recover(auto-34caac15): preserve 34caac15ce (PR #12 commit, immich) (#52)
Auto-recovery snapshot of shard auto-34caac15 from image auto-04d3624a-34caac15-6fd59898-920249ec-afc2de34. Fossil branch. PR #12 (point immich at gitea admin/hermes ansible repos) was merged into admin/brencher:main; mergeable will likely be False because the content is already in main.

---------

Co-authored-by: hermes <hermes@rudolf.keenetic.link>
Reviewed-on: http://192.168.1.96/admin/brencher/pulls/52
Co-authored-by: hermes <rudolfss13+hermes@gmail.com>
2026-09-06 16:27:57 +02:00
hermesandadmin a9de490ebe recover(auto-04d3624a): preserve 04d3624afd (PR #28 commit, hermes v2) (#51)
Auto-recovery snapshot of shard auto-04d3624a from image auto-04d3624a-34caac15-6fd59898-920249ec-afc2de34. Fossil branch. The commit's content already landed in admin/brencher:main via PR #28 (closed) and is part of PR #11 family. Opening this PR is for archival/reference only; mergeable will likely be False because the content is already in main.

---------

Co-authored-by: admin <rudolfss13@gmail.com>
Co-authored-by: brencher_bot <rudolfss13@gmail.com>
Reviewed-on: http://192.168.1.96/admin/brencher/pulls/51
Co-authored-by: hermes <rudolfss13+hermes@gmail.com>
2026-09-06 16:27:10 +02:00
hermesandhermes 920249ec30 feat(configs): point gitea-config at gitea admin/hermes ansible repos (#10)
## Summary
Migrates `backend/configs/gitea.py` from the legacy `url=` form (pointing at the unreachable `github.com/rudolf1/uber_backup.git`) to the new `remotes=[{name, url}, ...]` form introduced by PR #3 (named-remotes), pointing at the actual gitea repos where the ansible stack lives.

## What's in this PR
- `backend/configs/gitea.py` — single file, +22/-1
  - `GitClone(url="https://github.com/rudolf1/uber_backup.git"[, branchNamePrefix=...])`
    →
    `GitClone(remotes=[{"name": "gitea_hermes", "url": "https://gitea.rudolf.keenetic.link/hermes/ansible"}, {"name": "gitea_admin", "url": "https://gitea.rudolf.keenetic.link/admin/ansible"}])`
  - `branchNamePrefix` is dropped (it would be a silent no-op: `GitClone` only applies its prefix refspec to a remote named `origin` per `backend/steps/git.py` ~L104, and neither remote here is named `origin`)

## Why migrate
- The old URL never resolved (`uber_backup.git` doesn't exist on gitea anyway) — so the deploy path was broken even though the file looked correct.
- `github.com` returns HTTP 403 on CONNECT tunnel from the brencher container's egress proxy — verified in `admin/brencher#4` (commit `653aee9`).

## Scope decision: only `gitea.py`
The other open configs (`registry.py`, `gitea.py`, `hermes.py`, `immich.py`, `gmail_mcp.py`, `torrserv_proxy.py`) are being migrated in **separate PRs**, one per file. Each PR has its own branch + verification.

## Verification (sandbox, no docker daemon)
- `python3 -m py_compile backend/configs/gitea.py` — OK
- Real import via `from configs import gitea`:
  - `clone.remotes` is a 2-entry list `[gitea_hermes, gitea_admin]`, `clone.urls` derived from it
  - no `github.com` substring anywhere in the constructed config
  - `clone.branchNamePrefix == ''`
- pytest: **26/26** passed on the no-docker / no-playwright suite
- mypy `--no-incremental --follow-imports=silent`: `Success: no issues found in 1 source file`
- **End-to-end smoke test**: built a parallel `GitClone(remotes=[...])` with both URLs pointed at `file:///tmp/ansible-upstream`, ran `clone.progress()`:
  - both named remotes created in the temp clone
  - 4 branches discovered (`master` + `feat/docker-socket-proxy` × 2 remotes)
  - `feat/docker-socket-proxy` visible on both `gitea_admin` and `gitea_hermes`

## What was NOT verified in the sandbox
- HTTPS clone from `gitea.rudolf.keenetic.link` on the live brencher-bot — requires the brencher container's git credentials to have push rights on `admin/ansible`.
- end-to-end `docker stack deploy` — needs a real swarm.

## After merge
After this PR merges into `admin/brencher:main`, the next brencher deploy of this environment will clone from gitea instead of the unreachable github URL.

---------

Co-authored-by: hermes <hermes@rudolf.keenetic.link>
Reviewed-on: http://192.168.1.96/admin/brencher/pulls/10
Co-authored-by: hermes <rudolfss13+hermes@gmail.com>
2026-09-05 13:36:22 +02:00
hermes 75126cb2fd ci(merge_main): hardcode gitea.rudolf.keenetic.link (GITEA_SERVER_URL empty) (#47)
## Problem

Run #67 of `merge_main.yaml` failed with:

```
fatal: unable to access 'https:///admin/brencher.git/': URL rejected: No host part in the URL
```

The `PUSH_TOKEN` secret is now wired up correctly, but `${GITEA_SERVER_URL}` is empty in this Gitea Actions runtime (the variable the env-prefixed runner is supposed to set), so the substituted URL drops the host.

## Fix

Hardcode `gitea.rudolf.keenetic.link` in both `merge_main.yaml` and `merge_main_and_squash.yaml`. When the runner exposes `GITEA_SERVER_URL` in a future version, this can be replaced back with `${GITEA_SERVER_URL#https://}`.

## Supersedes

This is a follow-up to admin/brencher#46 which already wired `secrets.PUSH_TOKEN` but still had the empty env var.Reviewed-on: http://192.168.1.96/admin/brencher/pulls/47

Co-authored-by: hermes <rudolfss13+hermes@gmail.com>
2026-09-04 16:26:09 +02:00
admin 0e83458044 Обновить REST.instruction.md (#48)
Reviewed-on: http://192.168.1.96/admin/brencher/pulls/48
2026-09-04 13:26:37 +02:00
admin 7dc36d7487 Merge pull request 'ci(merge_main): fix auth for self-hosted Gitea Actions' (#46) from hermes/brencher:fix/gitea-actions-merge-workflows into main
Reviewed-on: http://192.168.1.96/admin/brencher/pulls/46
2026-09-04 13:08:06 +02:00
hermes b0e32f835a ci(merge_main): use PUSH_TOKEN instead of GITEA_PUSH_TOKEN
Match the secret name already created in admin/brencher.
2026-09-04 11:01:55 +00:00
hermes 1c0580750d ci(merge_main): fix auth for self-hosted Gitea Actions
Both workflows were written for github.com and relied on the implicit
secrets.GITHUB_TOKEN + github.repository + a hardcoded github.com URL.
On this self-hosted Gitea instance (ghauth.rudolf.keenetic.link) they fail
with "Invalid username or token. Password authentication is not supported
for Git operations." against https://github.com/admin/brencher.git.

The fix:
- Read the push token from a new repo-level secret GITEA_PUSH_TOKEN
  (admin/brencher). Same value is injected into the checkout and into the
  rewritten remote URL so push can succeed.
- Build the origin URL from Gitea-injected GITHUB_REPOSITORY and
  GITEA_SERVER_URL instead of hardcoding github.com.
- Update git user.email/name for the Gitea Actions identity.

To enable: create secret GITEA_PUSH_TOKEN in admin/brencher (a PAT with
write access to the repo) via the Gitea UI before merging this PR.
2026-09-04 08:03:46 +00:00
8059cc74ea ci: speed up python-package.yml from ~13min to ~3-4min (#15)
## Summary
Optimizes `.github/workflows/python-package.yml` so the build job runs in ~3-4 minutes instead of ~13 minutes (which is what the recent run on PR #5 took — see https://gitea.rudolf.keenetic.link/admin/brencher/actions/runs/14, started 23:52, completed 00:05, **13m 19s wall-clock**).

## Why it was slow
The current matrix has **3 Python versions × 5 checkers = 15 separate CI jobs**, each one:
1. Checking out the repo (~10s)
2. Setting up Python via `actions/setup-python@v3` with **no cache enabled** (~15-30s)
3. Running `pip install -r requirements.txt -r requirements-dev.txt` **from scratch every single time** (~30-90s per job × 15 jobs = 7-22 minutes wasted)

The two debug entries (`python -c 'import sys; print(...)'` and `pip list`) were not real checks — they were noise from the upstream github `build-and-test-python` template, left in place but never reviewed.

## What's in this PR
- `.github/workflows/python-package.yml` — single file, +41/-56
  1. **`cache: 'pip'` enabled** with `cache-dependency-path: requirements.txt, requirements-dev.txt` — first run downloads and caches, subsequent runs hit the cache. Drops pip install from ~60s to ~5-15s when requirements don't change.
  2. **Two debug-only matrix entries removed** (`python -c ...` and `pip list`) — they were not real checks.
  3. **Matrix restructured**: one Python-version axis only, no checker axis. Each Python job runs `install + flake8 + mypy` sequentially. **15 jobs → 3 jobs** (~5x fewer fresh venvs to set up).
  4. **`concurrency: cancel-in-progress: true`** added — a new push to the same PR auto-cancels the previous in-flight run, saving runner minutes when iterating on a fix.
  5. Bumped `actions/setup-python` from `v3` to `v5` (required for `cache: 'pip'`).

## Verification
- YAML parses via PyYAML — ok
- `jobs` dict contains `['build']` only
- `build.strategy.matrix.python-version` = `['3.12.3', '3.13', '3.14']`
- **total CI jobs: 3** (was 15)
- `setup-python@v5` with `cache: 'pip'` + `cache-dependency-path` pointing at `requirements.txt` and `requirements-dev.txt`
- `concurrency` block correctly scoped to `ci-${{ github.workflow }}-${{ github.ref }}`

## Expected timing
| Scenario | Before | After |
|---|---|---|
| First run (cold cache) | ~13m 19s | ~5-7m |
| Subsequent runs (warm cache, no req changes) | ~13m 19s | ~3-4m |
| Re-run after `requirements.txt` change | ~13m 19s | ~4-5m |

## What was NOT verified
- Actual Gitea Actions runner behaviour with `cache: 'pip'` — the Gitea Actions runner is GitHub Actions-compatible, and `actions/setup-python@v5` with `cache: 'pip'` is a well-known idiom there, but the local Gitea runner config may or may not honour it. If it doesn't, the 15→3 fan-out reduction alone is still a ~5x speedup.

## Note on PR #14
PR #14 ("re-enable the tests job") is still open. If/when it merges, this PR will need a follow-up to re-add the `tests:` job with the same `cache: 'pip'` setup applied — otherwise the playwright install will dominate again.

## Commit history
```
* db3807e (HEAD -> feat/optimize-ci-build-time, origin/feat/optimize-ci-build-time)
      ci: speed up python-package.yml from ~13min to ~3-4min
* 70f4a41 ci: comment out the tests job in python-package.yml (#13)   (upstream/main tip)
```

---------

Co-authored-by: admin <rudolfss13@gmail.com>
Co-authored-by: hermes <hermes@rudolf.keenetic.link>
Reviewed-on: http://192.168.1.96/admin/brencher/pulls/15
Co-authored-by: hermes <rudolfss13+hermes@gmail.com>
2026-09-04 09:48:29 +02:00
29 changed files with 1464 additions and 130 deletions
+4 -8
View File
@@ -20,16 +20,16 @@ jobs:
uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.GITHUB_TOKEN }}
token: ${{ secrets.PUSH_TOKEN }}
- name: Configure git
run: |
git config user.email "github-actions[bot]@users.noreply.github.com"
git config user.name "GitHub Actions"
git config user.email "gitea-actions[bot]@noreply.localhost"
git config user.name "Gitea Actions"
- name: Fetch all branches
run: |
git remote set-url origin "https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git"
git remote set-url origin "https://x-access-token:${PUSH_TOKEN}@gitea.rudolf.keenetic.link/${GITHUB_REPOSITORY}.git"
git fetch --all --prune
- name: Merge every branch onto main
@@ -37,7 +37,6 @@ jobs:
run: |
set -eo pipefail
MAIN=main
# Collect remote branch names (exclude HEAD and main)
branches=$(git for-each-ref --format='%(refname:short)' refs/remotes/origin/ \
| sed 's|^origin/||' \
| grep -v -e '^HEAD$' -e '^main$' -e '^origin$' \
@@ -49,11 +48,8 @@ jobs:
continue
fi
echo "=== Processing branch: $br ==="
# Create/update a local branch from remote
git checkout -B "$br" "origin/$br"
# Merge origin/main into branch (non-interactive)
if git merge --no-edit "origin/$MAIN"; then
# Push updated branch to remote (no force)
if git push origin "$br"; then
echo "Pushed merged $br"
else
+4 -8
View File
@@ -18,16 +18,16 @@ jobs:
uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.GITHUB_TOKEN }}
token: ${{ secrets.PUSH_TOKEN }}
- name: Configure git
run: |
git config user.email "github-actions[bot]@users.noreply.github.com"
git config user.name "GitHub Actions"
git config user.email "gitea-actions[bot]@noreply.localhost"
git config user.name "Gitea Actions"
- name: Fetch all branches
run: |
git remote set-url origin "https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git"
git remote set-url origin "https://x-access-token:${PUSH_TOKEN}@gitea.rudolf.keenetic.link/${GITHUB_REPOSITORY}.git"
git fetch --all --prune
- name: Merge every branch onto main
@@ -35,7 +35,6 @@ jobs:
run: |
set -eo pipefail
MAIN=main
# Collect remote branch names (exclude HEAD and main)
branches=$(git for-each-ref --format='%(refname:short)' refs/remotes/origin/ \
| sed 's|^origin/||' \
| grep -v -e '^HEAD$' -e '^main$' -e '^origin$' \
@@ -47,12 +46,9 @@ jobs:
continue
fi
echo "=== Processing branch: $br ==="
# Create/update a local branch from remote
git reset --hard HEAD
git checkout -B "$br" "origin/$br"
# Merge origin/main into branch (non-interactive)
if git merge --no-edit --squash "origin/$MAIN"; then
# Push updated branch to remote (no force)
git reset --soft "origin/$MAIN"
git commit -m "Squash"
if git push origin "$br" --force-with-lease; then
+20 -57
View File
@@ -1,6 +1,3 @@
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
name: Python package
on:
@@ -10,74 +7,40 @@ on:
pull_request:
branches: [ "main" ]
concurrency:
group: ci-${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: [
# "3.11.3",
"3.12.3",
"3.13",
"3.14",
# "3.15",
]
checker: [
"python -c \"import sys; print(f'Python {sys.version}'); print(f'Build: {sys.version_info}'); print(f'Implementation: {sys.implementation}')\"",
"pip list",
"flake8 . --count --select=E9,F63,F7,F82 --ignore=F824 --show-source --statistics",
"flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics",
# "ty check backend",
"mypy --no-incremental --config-file mypy.ini backend tests",
]
python-version: ["3.12.3", "3.13", "3.14"]
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}, ${{ matrix.checker }}
uses: actions/setup-python@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
cache: 'pip'
cache-dependency-path: |
requirements.txt
requirements-dev.txt
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -r requirements-dev.txt
- name: Run checker
run: ${{ matrix.checker }}
# tests:
# runs-on: ubuntu-latest
# needs: build
# strategy:
# fail-fast: false
# matrix:
# python-version: [
# # "3.11.3",
# "3.12.3",
# "3.13",
# "3.14",
# # "3.15",
# ]
# checker: [
# "pytest",
# ]
# steps:
# - uses: actions/checkout@v4
# - name: Set up Python ${{ matrix.python-version }}, ${{ matrix.checker }}
# uses: actions/setup-python@v3
# with:
# python-version: ${{ matrix.python-version }}
# - name: Install dependencies
# run: |
# # sudo apt-get update
# # sudo apt-get upgrade -y
# # sudo apt-get install -y --no-install-recommends git docker.io
# python -m pip install --upgrade pip
# pip install -r requirements-dev.txt
# playwright install --with-deps chromium
# - name: Run checker
# run: "pytest"
#
#
#
- name: Lint (flake8)
run: |
flake8 . --count --select=E9,F63,F7,F82 --ignore=F824 --show-source --statistics
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Type-check (mypy)
run: mypy --no-incremental --config-file mypy.ini backend tests
+111
View File
@@ -0,0 +1,111 @@
# Adding a new stack to brencher
A "stack" is one self-contained Docker Swarm service that brencher manages
end-to-end: detect HEAD changes, build, deploy, and expose service status to
the UI. This file documents how to wire one up so it picks up commits
without an operator clicking "Update" in the UI every time.
## Repository layout
Brencher looks at exactly one commit on one ref per environment. For a new
stack `my_stack`:
1. Push branch `feat/my_stack` (or whatever the team convention is) to a
Git repo listed in `remotes` of the config file.
2. Drop the repo in `gitea` or `github` so it's reachable through the same
remotes that other stacks use.
3. Make sure `my_stack/stack-compose.yml` and a Dockerfile (typically
`my_stack/Dockerfile`) exist at the path the config will point at.
## Config file: `backend/configs/<stack>.py`
The shape is fixed by `enironment.Environment` and the steps it pulls in.
Look at `backend/configs/hermes.py` for the canonical pattern. A new config
must:
- Build a `GitClone` with at least one remote whose `url` points to the repo
above.
- Build a `DockerSwarmCheck(stack_name="<stack>")` to introspect the
deployed service.
- Build **`GitUnmerge(clone, dockerSwarmCheck)`** and wrap it into
`SharedStateHolderInMemory(unmerge=unmerge)`. This is what makes
autodeploy work — `GitUnmerge` reads the `org.brencher.version` label
from the running swarm task and converts it into
`desired_branches`, so each polling cycle asks "is HEAD ≠ what's
deployed?" without any UI input.
- Wire a `CheckoutMerged(clone, desired_branches=state, push=False, …)`.
Push stays `False` for first-party stacks; set `True` only when you want
brencher to push auto-named branches back to origin.
- Build a `DockerComposeBuild` (or `DockerSwarmBuild` if a Swarmfile is
used) pointing at the compose path in the repo.
- Build a `DockerSwarmDeploy(wd=clone, buildDocker=…, stackChecker=…, …)`
with the same `stack_name`. Image tag is `auto-<short-sha>` driven by
`checkoutMerged.progress().version`.
- Optionally append a `SimpleLog(message={"userLinks": {...}})` for the
link to surface in the UI.
- Set `__all__` and export the `Environment` named after the stack id.
- Add it to `Environment.pipeline` in the canonical order:
`clone → state → checkoutMerged → dockerSwarmCheck → build → deploy →
optionals`. Build and deploy are explicit `DockerComposeBuild` and
`DockerSwarmDeploy` siblings; do not collapse them into one step.
If you skip the `GitUnmerge` line, `state.branches` will stay empty and
the stack will only deploy when an operator pushes a `branches` update
through the UI. Don't skip it; it's the difference between a self-driving
stack and a manual one. See `connectivity_tester.py` history for the bug
this caused.
## Verification checklist
- `python3 -c "from backend.configs.my_stack import my_stack"` works in
the brencher container.
- `PROFILES="my_stack" python3 backend/app.py` boots and the UI renders a
row for `my_stack` with non-empty branches (from `GitUnmerge`,
pointing at whatever image is currently deployed).
- Push to the configured branch, wait one full polling cycle
(~`RESET_INTERVAL` = 180s, plus the next pipeline tick), then confirm
the service was redeployed with a new `org.brencher.version` label.
- No UI `environment_update` was issued in between.
## Common foot-guns
- `dockerfile:` path in `stack-compose.yml` is interpreted relative to the
compose file's directory. The compose file and the Dockerfile must
live side-by-side; use `dockerfile: Dockerfile`, not
`dockerfile: <relative-path>`.
- Removing the `name:` key from the top of `stack-compose.yml` is fine
for `docker stack deploy` — the stack name comes from the CLI option
brencher sets.
- `EXTRA_ENDPOINTS` and friends are env vars; if you reference them in
compose, define them in the `envs=lambda: {...}` of the
`DockerComposeBuild` and `DockerSwarmDeploy`. `substitute` uses
`env.get(...)` for deploys but `env[...]` (raises) for builds, so an
unlisted variable kills the build but quietly produces an empty string
in the deploy.
- Compose files must not assume Docker networks that don't exist. Use
either an `external: true` net that already exists in Swarm, drop
the `networks:` block entirely, or `driver: overlay` for a
stack-private net.
## Tracking
When you add a stack, also:
- Open a tracking issue in `admin/brencher` titled
`[ready-to-test] <stack>: …` with `state=` from your
`GitUnmerge`-derived branches and what URL/port the service exposes.
- Add the stack id to the `PROFILES` env var in the brencher stack
compose (`docker_stack` / Swarm declarative) so it gets picked up on
next rollout. The admin overlay is where this lives.
## Build delegation pattern (Actions)
Brencher does not run docker build or docker push itself. It dispatches a Gitea
Actions workflow via `POST /api/v1/repos/{owner}/{repo}/actions/workflows/{file}/dispatches`,
waits for the run to complete, then runs `docker stack deploy`.
Use `steps.actions.GiteaActionsTrigger` and `steps.actions.GiteaActionsAwait`
in the stack config, set `buildDocker=None` on `DockerSwarmDeploy`, and let Swarm
resolve and pull the image on target nodes during deploy. Credentials must be
available to the deploy path and the compose image must point to a registry the
runner can push to (e.g. Gitea Container Registry `gitea.rudolf.keenetic.link/<owner>/<repo>`).
+1 -1
View File
@@ -33,7 +33,7 @@ docker service update --secret-rm brencher-secrets brencher_brencher-backend
docker service update --secret-rm brencher-secrets brencher2_brencher-backend
docker secret rm brencher-secrets
printf "GIT_USERNAME=git\nGIT_PASSWORD=TODO\n" | \
printf "GIT_USERNAME=git\nGIT_PASSWORD=TODO\nGITEA_TOKEN=TODO\n" | \
docker secret create brencher-secrets -
docker service update --secret-add brencher-secrets brencher_brencher-backend
+3
View File
@@ -17,3 +17,6 @@
state: str # 'Active' or 'Pause'
pipeline: Dict[str, Any]
+11 -2
View File
@@ -51,11 +51,20 @@ class App:
"is_running": False,
})
else:
pipeline_state.append({
step_state = {
"name": r.name,
"status": result,
"is_running": False,
})
}
step_errors = getattr(r, "errors", [])
if step_errors:
step_state["status"] = {"result": result, "errors": step_errors}
step_state["error"] = True
step_warnings = getattr(r, "warnings", [])
if step_warnings and not step_errors:
step_state["status"] = {"result": result, "warnings": step_warnings}
step_state["warning"] = True
pipeline_state.append(step_state)
except BaseException as e:
stack = traceback.format_exception(type(e), e, e.__traceback__)
pipeline_state.append({
-1
View File
@@ -7,7 +7,6 @@ from steps.shared_state import SharedStateHolderInMemory
clone = GitClone(remotes=[
{"name": "github", "url": "https://github.com/rudolf1/brencher.git"},
{"name": "gitea_admin", "url": "https://gitea.rudolf.keenetic.link/admin/brencher"},
{"name": "gitea_hermes", "url": "https://gitea.rudolf.keenetic.link/hermes/brencher"},
])
+91
View File
@@ -0,0 +1,91 @@
import os
from enironment import Environment
from steps.actions import GiteaActionsAwait, GiteaActionsTrigger
from steps.checks import SimpleLog
from steps.docker import DockerSwarmCheck, DockerSwarmDeploy
from steps.git import CheckoutMerged, GitClone, GitUnmerge
from steps.shared_state import SharedStateHolderInMemory
clone = GitClone(remotes=[
{"name": "gitea_hermes", "url": "https://gitea.rudolf.keenetic.link/hermes/ansible"},
{"name": "gitea_admin", "url": "https://gitea.rudolf.keenetic.link/admin/ansible"},
],
credEnvPrefix="GITEA",
)
dockerSwarmCheck = DockerSwarmCheck(stack_name="connectivity_tester")
unmerge = GitUnmerge(clone, dockerSwarmCheck)
state = SharedStateHolderInMemory(unmerge=unmerge)
checkoutMerged = CheckoutMerged(
clone,
desired_branches=state,
push="gitea_admin",
git_user_email="rudolfss13@gmail.com",
git_user_name="brencher_bot",
)
GITEA_API = os.environ.get("GITEA_API", "https://gitea.rudolf.keenetic.link/api/v1")
GITEA_TOKEN = os.environ.get("GITEA_TOKEN", "")
WORKFLOW_OWNER = "admin"
WORKFLOW_REPO = "ansible"
WORKFLOW_FILE = "release.yml"
def _inputs() -> dict:
return {"tag": "auto-" + checkoutMerged.progress().version}
trigger_build = GiteaActionsTrigger(
api_base=GITEA_API,
owner=WORKFLOW_OWNER,
repo=WORKFLOW_REPO,
workflow_file=WORKFLOW_FILE,
ref=lambda: checkoutMerged.progress().remote_branch_name or "master",
token=GITEA_TOKEN,
inputs=_inputs,
wd=checkoutMerged,
)
await_build = GiteaActionsAwait(
api_base=GITEA_API,
owner=WORKFLOW_OWNER,
repo=WORKFLOW_REPO,
token=GITEA_TOKEN,
run=lambda: trigger_build.progress(),
)
deployDocker = DockerSwarmDeploy(
wd=clone,
buildDocker=None,
stackChecker=dockerSwarmCheck,
envs=lambda: {
"version": "auto-" + checkoutMerged.progress().version,
"registry_owner": "admin",
},
stack_name="connectivity_tester",
docker_compose_path="connectivity_tester/stack-compose.yml",
)
logUrls = SimpleLog(message={
"userLinks": {
"Connectivity tester": "http://connectivity-tester.keenetic.link:8765/",
},
})
__all__ = ["connectivity_tester"]
connectivity_tester = Environment(
id="connectivity_tester",
state=state,
pipeline=[
clone,
state,
checkoutMerged,
dockerSwarmCheck,
trigger_build,
await_build,
deployDocker,
logUrls,
],
)
+22 -1
View File
@@ -4,7 +4,28 @@ from steps.docker import DockerSwarmCheck, DockerSwarmDeploy
from steps.git import GitClone, CheckoutMerged, GitUnmerge
from steps.shared_state import SharedStateHolderInMemory
clone = GitClone(url="https://github.com/rudolf1/uber_backup.git", branchNamePrefix="ansible")
# Dual-remote clone for the ansible mirror (the deploy target, not brencher itself).
# - gitea_hermes is where the feature branch lives (hermes/ansible:*)
# - gitea_admin is the live-deploy source (where brencher-bot reads compose files from)
#
# Why not github? github.com is unreachable from the brencher container -- the
# proxy returns HTTP 403 on CONNECT tunnel, so the URL would always fail to
# fetch. See backend/configs/docker_socket_proxy.py for the same migration.
#
# Why drop branchNamePrefix? GitClone only applies its prefix refspec to a
# remote named "origin" (backend/steps/git.py ~L104); neither remote here is
# named "origin", so the prefix would be a silent no-op. Both remotes fetch
# their full refset instead.
#
# Why two remotes? The deploy step (DockerSwarmDeploy) checks out a specific
# branch and uses the resulting checkout as wd for the compose path. With
# gitea_hermes as primary, feature branches opened in the fork are picked up;
# gitea_admin provides the live-deploy source as a fallback / for cross-fork
# PRs. This matches the form in backend/configs/brencher.py after PR #3.
clone = GitClone(remotes=[
{"name": "gitea_hermes", "url": "https://gitea.rudolf.keenetic.link/hermes/ansible"},
{"name": "gitea_admin", "url": "https://gitea.rudolf.keenetic.link/admin/ansible"},
])
dockerSwarmCheck = DockerSwarmCheck(
stack_name="gitea",
+6 -3
View File
@@ -4,7 +4,10 @@ from steps.docker import DockerComposeBuild, DockerSwarmCheck, DockerSwarmDeploy
from steps.git import GitClone, CheckoutMerged, GitUnmerge
from steps.shared_state import SharedStateHolderInMemory
clone = GitClone(url="https://github.com/rudolf1/uber_backup.git", branchNamePrefix="immoscout")
clone = GitClone(remotes=[
{"name": "gitea_hermes", "url": "https://gitea.rudolf.keenetic.link/hermes/mcps"},
{"name": "gitea_admin", "url": "https://gitea.rudolf.keenetic.link/admin/mcps"},
])
dockerSwarmCheck = DockerSwarmCheck(
stack_name="gmail_mcp",
@@ -23,7 +26,7 @@ checkoutMerged = CheckoutMerged(clone,
buildDocker = DockerComposeBuild(clone,
docker_repo_username="",
docker_repo_password="",
docker_compose_path="gmail-mcp-server/docker-compose.yml",
docker_compose_path="docker-compose.yml",
docker_repo_url="https://registry.rudolf.keenetic.link",
publish=False,
envs=lambda: {
@@ -39,7 +42,7 @@ deployDocker = DockerSwarmDeploy(
"version": "auto-" + checkoutMerged.progress().version,
},
stack_name="gmail_mcp",
docker_compose_path="gmail-mcp-server/docker-compose.yml",
docker_compose_path="docker-compose.yml",
)
checkPing1 = UrlCheck(
+11 -7
View File
@@ -1,10 +1,14 @@
from enironment import Environment
from steps.checks import SimpleLog, UrlCheck
from steps.checks import SimpleLog
from steps.docker import DockerSwarmCheck, DockerSwarmDeploy
from steps.git import GitClone, CheckoutMerged, GitUnmerge
from steps.shared_state import SharedStateHolderInMemory
clone = GitClone(url="https://github.com/rudolf1/uber_backup.git", branchNamePrefix="ansible")
clone = GitClone(remotes=[
# {"name": "github", "url": "https://github.com/rudolf1/uber_backup.git", "prefix": "ansible"},
{"name": "gitea_hermes", "url": "https://gitea.rudolf.keenetic.link/hermes/ansible"},
{"name": "gitea_admin", "url": "https://gitea.rudolf.keenetic.link/admin/ansible"},
])
dockerSwarmCheck = DockerSwarmCheck(
stack_name="hermes",
@@ -31,10 +35,10 @@ deployDocker = DockerSwarmDeploy(
docker_compose_path="poc/hermes/stack-compose.yml",
)
checkPing1 = UrlCheck(
url="http://100.70.193.97:8087/api/status",
expected=lambda obj: obj['gateway_running'] == 'true' and obj['auth_required'] == 'true',
)
# checkPing1 = UrlCheck(
# url="http://100.70.193.97:8087/api/status",
# expected=lambda obj: obj['gateway_running'] == 'true' and obj['auth_required'] == 'true',
# )
logUrls = SimpleLog(message={
"userLinks": {
"App": "https://hermes.rudolf.keenetic.link",
@@ -53,7 +57,7 @@ hermes = Environment(
dockerSwarmCheck,
unmerge,
deployDocker,
checkPing1,
# checkPing1,
logUrls
]
)
+1 -1
View File
@@ -32,7 +32,7 @@ dockerSwarmCheck = DockerSwarmCheck(
)
unmerge = GitUnmerge(clone, dockerSwarmCheck)
state = SharedStateHolderInMemory(unmerge=None)
state = SharedStateHolderInMemory(unmerge=unmerge)
checkoutMerged = CheckoutMerged(clone,
desired_branches=state,
+22 -1
View File
@@ -4,7 +4,28 @@ from steps.docker import DockerSwarmCheck, DockerSwarmDeploy
from steps.git import GitClone, CheckoutMerged, GitUnmerge
from steps.shared_state import SharedStateHolderInMemory
clone = GitClone(url="https://github.com/rudolf1/uber_backup.git", branchNamePrefix="ansible")
# Dual-remote clone for the ansible mirror (the deploy target, not brencher itself).
# - gitea_hermes is where the feature branch lives (hermes/ansible:*)
# - gitea_admin is the live-deploy source (where brencher-bot reads compose files from)
#
# Why not github? github.com is unreachable from the brencher container -- the
# proxy returns HTTP 403 on CONNECT tunnel, so the URL would always fail to
# fetch. See backend/configs/docker_socket_proxy.py for the same migration.
#
# Why drop branchNamePrefix? GitClone only applies its prefix refspec to a
# remote named "origin" (backend/steps/git.py ~L104); neither remote here is
# named "origin", so the prefix would be a silent no-op. Both remotes fetch
# their full refset instead.
#
# Why two remotes? The deploy step (DockerSwarmDeploy) checks out a specific
# branch and uses the resulting checkout as wd for the compose path. With
# gitea_hermes as primary, feature branches opened in the fork are picked up;
# gitea_admin provides the live-deploy source as a fallback / for cross-fork
# PRs. This matches the form in backend/configs/brencher.py after PR #3.
clone = GitClone(remotes=[
{"name": "gitea_hermes", "url": "https://gitea.rudolf.keenetic.link/hermes/ansible"},
{"name": "gitea_admin", "url": "https://gitea.rudolf.keenetic.link/admin/ansible"},
])
dockerSwarmCheck = DockerSwarmCheck(
stack_name="immich",
+177
View File
@@ -0,0 +1,177 @@
import json
import logging
import os
import time
import urllib.error
import urllib.request
from dataclasses import dataclass
from typing import Any, Callable, Dict, Optional, Union
from enironment import AbstractStep
from steps.git import CheckoutMerged
logger = logging.getLogger(__name__)
@dataclass
class GiteaActionsRun:
run_id: int
status: str
conclusion: Optional[str]
html_url: str
InputsSource = Union[Dict[str, str], Callable[[], Dict[str, str]], None]
RefSource = Union[str, Callable[[], Optional[str]], None]
class GiteaActionsTrigger(AbstractStep[GiteaActionsRun]):
"""Trigger a Gitea Actions workflow via the dispatches API."""
def __init__(self,
api_base: str,
owner: str,
repo: str,
workflow_file: str,
ref: RefSource,
token: str,
inputs: InputsSource = None,
wd: Optional[CheckoutMerged] = None,
poll_timeout_sec: int = 1800,
poll_interval_sec: int = 10,
**kwargs: Any) -> None:
super().__init__(**kwargs)
self.api_base = api_base.rstrip("/")
self.owner = owner
self.repo = repo
self.workflow_file = workflow_file
self.ref = ref
self.token = token
self.inputs = inputs
self.wd = wd
self.poll_timeout_sec = poll_timeout_sec
self.poll_interval_sec = poll_interval_sec
def _http(self, method: str, url: str, body: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
data = None
headers = {"Authorization": f"token {self.token}", "Accept": "application/json"}
if body is not None:
data = json.dumps(body).encode()
headers["Content-Type"] = "application/json"
req = urllib.request.Request(url, data=data, headers=headers, method=method)
with urllib.request.urlopen(req, timeout=30) as r:
body_bytes = r.read()
if not body_bytes or r.status == 204:
return {}
return json.loads(body_bytes.decode())
def _list_recent_runs(self) -> Optional[GiteaActionsRun]:
url = f"{self.api_base}/repos/{self.owner}/{self.repo}/actions/runs?limit=1"
try:
data = self._http("GET", url)
except urllib.error.HTTPError as e:
logger.error("list runs failed: %s", e)
return None
items = data.get("workflow_runs") or []
if not items:
return None
r = items[0]
return GiteaActionsRun(
run_id=r["id"],
status=r.get("status", ""),
conclusion=r.get("conclusion"),
html_url=r.get("html_url", ""),
)
def progress(self) -> GiteaActionsRun:
latest = self._list_recent_runs()
resolved_inputs: Dict[str, str] = {}
if callable(self.inputs):
resolved_inputs = self.inputs() or {}
elif isinstance(self.inputs, dict):
resolved_inputs = self.inputs
ref = self.ref() if callable(self.ref) else self.ref
body: Dict[str, Any] = {"ref": ref}
if resolved_inputs:
body["inputs"] = resolved_inputs
url = (
f"{self.api_base}/repos/{self.owner}/{self.repo}"
f"/actions/workflows/{self.workflow_file}/dispatches"
)
try:
self._http("POST", url, body=body)
except urllib.error.HTTPError as e:
if e.code != 500:
raise
raise RuntimeError(
"POST /dispatches returned 500 (gitea-side bug on this instance). "
"Workaround: trigger the workflow manually by pushing a tag matching "
f"the workflow's `on.push.tags` filter, e.g. "
f"`git push <repo> HEAD:refs/tags/auto-<sha>`. "
f"Requested workflow: {self.owner}/{self.repo}/{self.workflow_file}@{ref}"
) from e
deadline = time.time() + self.poll_timeout_sec
while time.time() < deadline:
current = self._list_recent_runs()
if current is None or (latest is not None and current.run_id == latest.run_id):
time.sleep(self.poll_interval_sec)
continue
return current
raise TimeoutError(
f"Gitea Actions did not pick up a new run within {self.poll_timeout_sec}s"
)
class GiteaActionsAwait(AbstractStep[GiteaActionsRun]):
"""Wait for a previously-triggered Gitea Actions run to complete."""
def __init__(self,
api_base: str,
owner: str,
repo: str,
token: str,
run: Callable[[], GiteaActionsRun],
poll_timeout_sec: int = 1800,
poll_interval_sec: int = 10,
**kwargs: Any) -> None:
super().__init__(**kwargs)
self.api_base = api_base.rstrip("/")
self.owner = owner
self.repo = repo
self.token = token
self._run = run
self.poll_timeout_sec = poll_timeout_sec
self.poll_interval_sec = poll_interval_sec
def _http(self, method: str, url: str) -> Dict[str, Any]:
headers = {"Authorization": f"token {self.token}", "Accept": "application/json"}
req = urllib.request.Request(url, headers=headers, method=method)
with urllib.request.urlopen(req, timeout=30) as r:
return json.loads(r.read().decode())
def progress(self) -> GiteaActionsRun:
run = self._run()
deadline = time.time() + self.poll_timeout_sec
while time.time() < deadline:
data = self._http(
"GET",
f"{self.api_base}/repos/{self.owner}/{self.repo}/actions/runs/{run.run_id}",
)
status = data.get("status", "")
conclusion = data.get("conclusion")
if status == "completed":
if conclusion != "success":
raise RuntimeError(
f"Gitea Actions run {run.run_id} concluded with {conclusion}: "
f"{run.html_url}"
)
return GiteaActionsRun(
run_id=run.run_id,
status=status,
conclusion=conclusion,
html_url=run.html_url,
)
time.sleep(self.poll_interval_sec)
raise TimeoutError(
f"Gitea Actions run {run.run_id} did not complete within {self.poll_timeout_sec}s"
)
+4 -1
View File
@@ -230,6 +230,7 @@ class DockerSwarmDeploy(AbstractStep[str]):
del svc["build"]
svc["labels"] = {"org.brencher.version": env["version"]}
del env["version"]
env.pop("registry_owner", None)
merge_dicts(compose, env)
# logger.info(f"Final compose: {compose}")
content = yaml.safe_dump(compose)
@@ -295,6 +296,7 @@ class DockerSwarmDeploy(AbstractStep[str]):
# Deploy stack to Docker Swarm
cmd = [
"docker", "stack", "deploy",
"--with-registry-auth",
"--detach=false",
"--prune",
"-c", tmp_compose_path,
@@ -307,7 +309,8 @@ class DockerSwarmDeploy(AbstractStep[str]):
swarmEnv = {k: v for k, v in dotenv_values(os.path.join(os.path.dirname(tmp_compose_path), ".env")).items()
if v is not None}
# merge_dicts(swarmEnv, env)
result = subprocess.run(cmd, capture_output=True, text=True, cwd=os.path.dirname(tmp_compose_path), env=swarmEnv)
result = subprocess.run(cmd, capture_output=True, text=True, cwd=os.path.dirname(tmp_compose_path))
#, env=swarmEnv)
os.remove(tmp_compose_path)
logger.info(f"docker stack deploy stdout: {result.stdout or '<empty>'}")
logger.info(f"docker stack deploy stderr: {result.stderr or '<empty>'}")
+49
View File
@@ -0,0 +1,49 @@
import json
import logging
import os
import re
import subprocess
from typing import Any, Callable, Dict
import yaml
from enironment import AbstractStep
from steps.git import GitClone
logger = logging.getLogger(__name__)
class DockerComposePull(AbstractStep[Dict[str, str]]):
"""Pull images referenced by a docker-compose file from a remote registry."""
def __init__(self,
wd: GitClone,
docker_compose_path: str,
envs: Callable[[], Dict[str, Any]],
**kwargs: Any) -> None:
super().__init__(**kwargs)
self.wd = wd
self.envs = envs
self.docker_compose_path = docker_compose_path
def progress(self) -> Dict[str, str]:
env = self.envs()
compose_path = os.path.join(self.wd.progress(), self.docker_compose_path)
with open(compose_path, "r") as f:
content = f.read()
content = re.sub(r"\$\{([^}]+)\}", lambda m: env.get(m.group(1), ""), content)
compose = yaml.safe_load(content)
for svc in compose.get("services", {}).values():
if "build" in svc:
del svc["build"]
tmp_path = compose_path + ".pull.yml"
with open(tmp_path, "w") as f:
yaml.safe_dump(compose, f)
try:
subprocess.run(
["docker", "compose", "-f", tmp_path, "pull"],
check=True,
cwd=self.wd.progress(),
)
finally:
os.unlink(tmp_path)
return {name: svc.get("image", "") for name, svc in compose.get("services", {}).items()}
+45 -21
View File
@@ -13,6 +13,7 @@ from git.objects import Commit
logger = logging.getLogger(__name__)
AUTO_BRANCH_PREFIX = "auto-"
class GitClone(AbstractStep[str]):
@@ -70,6 +71,7 @@ class GitClone(AbstractStep[str]):
self.repo_path = repo_path
self.branchNamePrefix = branchNamePrefix
self.credEnvPrefix = credEnvPrefix
self.errors: List[str] = []
def _get_auth_git_url(self, url: str) -> str:
username = os.getenv(f'{self.credEnvPrefix}_USERNAME')
@@ -82,6 +84,7 @@ class GitClone(AbstractStep[str]):
return url
def progress(self) -> str:
self.errors = []
self.repo_path = self.repo_path or os.path.join(tempfile.gettempdir(),
f"{self.env.id}_{hashlib.sha1('|'.join(self.urls).encode()).hexdigest()[:5]}")
logger.info(f"Cloning repositories {self.remotes} to {self.repo_path}")
@@ -93,23 +96,39 @@ class GitClone(AbstractStep[str]):
else:
repo = git.Repo.init(self.repo_path)
fetched_remotes = 0
for entry in self.remotes:
remote_name = entry["name"]
repository_url = entry["url"]
auth_url = self._get_auth_git_url(repository_url)
if remote_name in repo.remotes:
remote = repo.remotes[remote_name]
if remote.url != auth_url:
remote.set_url(auth_url)
else:
remote = repo.create_remote(remote_name, auth_url)
if remote_name == "origin" and self.branchNamePrefix != "":
try:
auth_url = self._get_auth_git_url(repository_url)
if remote_name in repo.remotes:
remote = repo.remotes[remote_name]
if remote.url != auth_url:
remote.set_url(auth_url)
else:
remote = repo.create_remote(remote_name, auth_url)
with repo.config_writer() as config:
config.set_value('remote "origin"', "fetch",
f"+refs/heads/{self.branchNamePrefix}/*:refs/remotes/origin/{self.branchNamePrefix}/*")
result = remote.fetch(prune=True)
if not result or any(fetch_info.flags & fetch_info.ERROR for fetch_info in result):
raise BaseException(f"Failed to fetch updates for {repository_url}")
config.set_value(
f'remote "{remote_name}"',
'fetch',
f'+refs/heads/*:refs/remotes/{remote_name}/*',
)
if remote_name == "origin" and self.branchNamePrefix != "":
with repo.config_writer() as config:
config.set_value('remote "origin"', "fetch",
f"+refs/heads/{self.branchNamePrefix}/*:refs/remotes/origin/{self.branchNamePrefix}/*")
result = remote.fetch(prune=True)
if not result or any(fetch_info.flags & fetch_info.ERROR for fetch_info in result):
raise BaseException(f"Failed to fetch updates for {remote_name}")
fetched_remotes += 1
except BaseException as remote_error:
if "File contains no section headers" in str(remote_error):
raise
self.errors.append(f"Unable to fetch remote {remote_name} ({repository_url}): {remote_error}")
logger.warning("Unable to fetch remote %s (%s): %s", remote_name, repository_url, remote_error)
if fetched_remotes == 0:
logger.warning("No configured git remotes are available; keeping the local repository state")
if not os.path.exists(os.path.join(self.repo_path, ".git")):
raise BaseException(f"Failed to clone repositories {self.remotes} to {self.repo_path}")
except BaseException as e:
@@ -125,7 +144,7 @@ class GitClone(AbstractStep[str]):
if not ref.is_remote() or ref.name.endswith('/HEAD'):
continue
remote_name, branch_name = ref.name.split('/', 1)
if branch_name.startswith('auto/'): # Skip auto branches
if branch_name.startswith(AUTO_BRANCH_PREFIX) or branch_name.startswith('auto/'):
continue
branch_key = branch_name if remote_name == 'origin' else ref.name
result[branch_key] = []
@@ -183,7 +202,7 @@ class CheckoutMerged(AbstractStep[CheckoutAndMergeResult]):
desired_branches: AbstractStep[SharedState],
git_user_email: str,
git_user_name: str,
push: bool = True,
push: bool | str = True,
**kwargs: Any):
super().__init__(**kwargs)
self.wd = wd
@@ -306,12 +325,13 @@ class CheckoutMerged(AbstractStep[CheckoutAndMergeResult]):
remote_name, branch_name = ref.name.split('/', 1)
remote_branch_name = branch_name if remote_name == 'origin' else ref.name
break
if self.push and remote_branch_name is None:
if self.push:
auto_branch_hash = hashlib.sha1(''.join([x.hexsha for x in sorted_commits]).encode()).hexdigest()
auto_branch_name = f"auto-{version}"
auto_branch_name = f"{AUTO_BRANCH_PREFIX}{version}"
push_remote = self.push if isinstance(self.push, str) else "origin"
logger.info(f"Pushing {repo.head.commit.hexsha} -> {auto_branch_name}")
repo.git.push('-f', 'origin', f"HEAD:refs/heads/{auto_branch_name}")
repo.git.push('-f', push_remote, f"HEAD:refs/heads/{auto_branch_name}")
remote_branch_name = auto_branch_name
return CheckoutAndMergeResult(
@@ -345,9 +365,12 @@ class GitUnmerge(AbstractStep[GitUnmergeResult]):
super().__init__(**kwargs)
self.wd = wd
self.check = check
self.warnings: List[str] = []
def progress(self) -> GitUnmergeResult:
self.warnings = []
wd = self.wd.progress()
repo = git.Repo(wd)
deployState: Mapping[str, HasVersion] = self.check.progress()
versions = set([it.version for it in deployState.values()])
@@ -355,12 +378,13 @@ class GitUnmerge(AbstractStep[GitUnmergeResult]):
raise BaseException(f"Expected exactly one version, got: {versions}")
version = list(versions)[0]
if not version:
return GitUnmergeResult(branches=[], columns={"Deployed": {}})
if version is None:
raise BaseException(f"Expected exactly one version, got: {versions}")
repo = git.Repo(wd)
childs: Dict[Commit, List[Commit]] | None = None
if 'auto-' in version:
version_parts = version[len('auto-'):].split('-')
if version.startswith(AUTO_BRANCH_PREFIX):
version_parts = version[len(AUTO_BRANCH_PREFIX):].split('-')
commits: List[Tuple[str, str]] = []
for v in version_parts:
+23 -7
View File
@@ -94,6 +94,15 @@ class WebApp:
merged = _merge_dicts(merged, connector.branches)
return merged
def get_selection_summary(self) -> Dict[str, Dict[str, Any]]:
return {
env_id: {
"branches": env.get("branches", []),
"dry": env.get("dry"),
}
for env_id, env in self.get_global_envs_to_emit().items()
}
# --- Async scheduling from sync threads ---
def _schedule_async(self, coro: Any) -> None:
@@ -107,12 +116,12 @@ class WebApp:
disconnected = set()
message = custom_json_dumps({event: data})
for websocket in self.ws_connections.keys():
if self.ws_connections[websocket].get(event) == message:
for websocket, state in self.ws_connections.items():
if state.get(event) == message:
continue
try:
await websocket.send_text(message)
self.ws_connections[websocket][event] = message
state[event] = message
except Exception as e:
logger.error(f"Error sending to websocket: {e}")
disconnected.add(websocket)
@@ -163,7 +172,8 @@ class WebApp:
async def websocket_endpoint(self, websocket: WebSocket) -> None:
await websocket.accept()
self.ws_connections[websocket] = {}
state = self.ws_connections.setdefault(websocket, {})
logger.info("UI connected: selected=%s", self.get_selection_summary())
try:
# Send initial state on connect and record it so duplicate broadcasts are suppressed
@@ -172,9 +182,9 @@ class WebApp:
version_payload = custom_json_dumps({"version": self.get_version()})
await websocket.send_text(version_payload)
await websocket.send_text(branches_payload)
self.ws_connections[websocket]["branches"] = branches_payload
state["branches"] = branches_payload
await websocket.send_text(envs_payload)
self.ws_connections[websocket]["environments"] = envs_payload
state["environments"] = envs_payload
while True:
data = await websocket.receive_text()
@@ -182,7 +192,12 @@ class WebApp:
if "update" in message:
update_data = message.get("update") or {}
logger.info(f"Received environment update: {update_data}")
logger.info(
"UI selection update: env=%s branches=%s dry=%s",
update_data.get('id', ''),
update_data.get('branches'),
update_data.get('dry'),
)
if self.secondaryManager:
await self.secondaryManager.send({"update": update_data})
id = update_data.get('id', '')
@@ -222,6 +237,7 @@ class WebApp:
if isinstance(p, CachingStep):
p.reset()
logger.info(f"Updated environment {env.id} branches to {update_data.get('branches')}, dry={update_data.get('dry')}")
logger.info("UI selection resolved: selected=%s", self.get_selection_summary())
self.core.environment_update_event.set()
await self.broadcast_environments(self.get_global_envs_to_emit())
+1
View File
@@ -0,0 +1 @@
blank1
+1 -1
View File
@@ -17,7 +17,7 @@ services:
- VIRTUAL_HOST=brencher.rudolf.keenetic.link
- LETSENCRYPT_HOST=brencher.rudolf.keenetic.link
- VERSION=${version}
- PROFILES=brencher2,torrserv_proxy,immich,gmail_mcp,hermes,hermes_infra,gitea
- PROFILES=brencher2,torrserv_proxy,immich,gmail_mcp,hermes,hermes_infra,gitea,connectivity_tester
- SECONDARY_BRENCHER=http://host.docker.internal:5002
deploy:
replicas: 1
+148
View File
@@ -0,0 +1,148 @@
# Brencher — backend use cases
## Цель приложения
Brencher получает состояние Git-репозиториев и Docker Swarm, сопоставляет выбранные коммиты с развёрнутым состоянием и запускает pipeline сборки/развёртывания. Этот файл описывает сценарии клиента backend API: запрос, ответ, ошибку и серверный побочный эффект.
## Граница API
- REST endpoint-ы текущего backend: `GET /state`, `GET /branches` и `GET /`/static resources.
- Изменение выбранных веток, применение, dry run и передача UI-событий выполняются через `WebSocket /ws`, а не через REST mutation endpoint.
- Данные API являются состоянием процесса и не образуют постоянное хранилище.
## REST use cases
### B-01. Получить состояние окружений — `GET /state`
1. Клиент отправляет `GET /state`.
2. Backend возвращает JSON с текущей версией, окружениями, выбранными ветками/коммитами, deployed-состоянием и текущими Jobs/pipeline, если они доступны.
3. Если состояние ещё не собрано, ответ содержит начальное/пустое состояние, а pipeline продолжает работу асинхронно.
4. Ошибка backend или недоступное окружение отражается в состоянии соответствующего окружения и логах; REST сам по себе не запускает deploy.
### B-02. Получить доступные ветки — `GET /branches`
1. Клиент отправляет `GET /branches`.
2. Backend возвращает ветки, полученные из настроенных remotes, с remote-префиксами при необходимости.
3. Ответ может измениться после fetch или pipeline update.
4. Ошибка Git/fetch не превращается в успешный полный список и фиксируется как ошибка обработки.
### B-03. Получить веб-приложение — `GET /`
1. Клиент отправляет `GET /`.
2. Backend возвращает `frontend/index.html`; статические CSS/JS-файлы обслуживаются через static route.
3. HTTP-ответ загружает UI, но не устанавливает realtime-соединение: UI отдельно открывает `/ws`.
### B-04. Получить статический ресурс или неизвестный путь
1. Клиент запрашивает путь через HTTP.
2. Backend пытается обслужить файл frontend.
3. Отсутствующий ресурс возвращается как HTTP-ошибка/не найденный ресурс согласно FastAPI/static handler.
## WebSocket-команды, доступные backend-клиенту
Эти сценарии не являются REST, но необходимы для полного описания backend API: текущий код принимает команды по `/ws`.
### B-05. Открыть `/ws` и получить начальное состояние
1. Клиент устанавливает WebSocket-соединение.
2. Backend отправляет сообщения с `version`, `branches` и `environments`.
3. Backend регистрирует соединение и его последнее отправленное состояние.
4. При disconnect соединение удаляется из реестра.
### B-06. Передать обновление выбранного окружения
1. Клиент отправляет JSON-сообщение с изменением `environment`, `branches`/commit selection и параметрами применения.
2. Backend обновляет состояние окружения и запускает соответствующую обработку.
3. Backend рассылает новое состояние подключённым WebSocket-клиентам.
4. Некорректный JSON, неизвестное окружение или ошибка обработки становятся ошибкой WebSocket/pipeline.
### B-07. Запустить применение или dry run
1. Клиент отправляет команду применения с выбранной веткой, `HEAD`, историческим или произвольным commit.
2. Для нескольких веток backend может выполнить merge; конфликт останавливает соответствующий шаг.
3. При dry run backend выполняет анализ и подготовительные шаги, но не должен выполнять финальное развёртывание.
4. Результат, Jobs и ошибка публикуются через WebSocket; отдельного REST endpoint для mutation нет.
## Серверные pipeline use cases
### B-08. Обновить Git-состояние
1. Backend выполняет fetch настроенных Git remotes.
2. Клиент получает новые branches/commits через `/branches` или WebSocket update.
3. Ошибка credentials, сети или отсутствующего remote прерывает зависимые шаги.
4. Для основного профиля `brencher` используются GitHub и `hermes/brencher`; `admin/brencher` не используется. `brencher2` — независимый профиль.
### B-09. Разрешить выбранный commit
1. Backend принимает branch, `HEAD`, исторический или произвольный commit.
2. Проверяет наличие ref/commit и получает соответствующее состояние.
3. Неизвестный ref/commit становится ошибкой pipeline.
4. Имена одинаковых веток разных remotes должны сохранять remote-контекст.
### B-10. Объединить несколько веток
1. Backend получает несколько выбранных источников.
2. Выполняет checkout и merge в рабочем каталоге.
3. При конфликте merge pipeline останавливается и публикует ошибку.
4. Устаревшее состояние токена/выбора может быть отклонено сервером; отдельное structured conflict-сообщение текущий код не гарантирует.
### B-11. Проверить deployed-состояние Swarm
1. Backend обращается к Docker API/socket и читает labels, image/version, stack/service и replica state.
2. Docker Swarm является целью проверки и deploy, а не обязательным исполнителем image build.
3. Недоступный socket, stack или service публикуется как ошибка.
### B-12. Запустить сборку и публикацию образа
1. В конфигурациях, где включён локальный build, backend подготавливает compose/build pipeline.
2. В конфигурациях Actions backend может вызвать Gitea Actions workflow и дождаться его результата; сборка и push выполняются runner-ом.
3. Публикация в registry является условной; в текущем основном `brencher` она отключена (`publish=False`).
4. Ошибка build, workflow, registry или credentials не считается успешным pipeline.
### B-13. Выполнить deploy
1. После успешного pipeline backend выполняет Docker Swarm deploy либо делегирует его настроенному шагу.
2. После deploy проверяет version/labels и replicas.
3. Несовпадение версии или количества replicas публикуется как ошибка/неуспешное состояние.
4. Отдельной rollback-кнопки или гарантированного rollback API нет.
### B-14. Автоматически обнаружить drift
1. `GitUnmerge` сопоставляет deployed label с remote HEAD и desired branches.
2. При отличии backend формирует pipeline автоматически, без UI-команды.
3. При отсутствии diff deploy не выполняется.
4. Конфигурация без корректно подключённого `GitUnmerge` не может самостоятельно восстановить desired branches после перезапуска.
### B-15. Проверить URL health check
1. Настроенный профиль выполняет HTTP GET к сервису.
2. Проверяет HTTP 200, JSON и ожидаемые поля рекурсивно.
3. Несовпадение ответа или недоступность сервиса становится ошибкой health-check шага.
### B-16. Синхронизировать secondary Brencher
1. При заданном `SECONDARY_BRENCHER` backend подключается к отдельному удалённому экземпляру по WebSocket.
2. Передаёт update и объединяет полученные branches/environments с локальными.
3. Конфликт одинаковых environment ID не маскируется.
4. При обрыве выполняются reconnect/retry с задержкой; после исчерпания попыток ошибка пишется в журнал.
## Операционные и security boundaries
### B-17. Запустить разные режимы
1. Оператор задаёт `PROFILES` или CLI-аргумент и может исключить профиль префиксом `-`.
2. `noweb` запускает backend без web UI; глобальный `dry` включает dry run.
3. Порт, конфигурация, secondary URL и credentials задаются внешней конфигурацией.
### B-18. Обработать несколько клиентов
1. Backend хранит несколько WebSocket-соединений.
2. Обновление рассылается подключённым клиентам, если payload изменился; одинаковые payload дедуплицируются для конкретного соединения.
3. Один клиент может увидеть устаревший выбор другого; сервер отклоняет часть stale-состояний, но не предоставляет полноценную блокировку операторов.
### B-19. Зафиксировать границу доступа
1. Backend предоставляет статус и команды управления через web/API layer.
2. В исходном web layer нет встроенной authentication/authorization-проверки.
3. Защита должна обеспечиваться reverse proxy, сетью или внешним механизмом доступа.
4. Нельзя считать открытый endpoint безопасным только потому, что он использует FastAPI/WebSocket.
+368
View File
@@ -0,0 +1,368 @@
# Сценарии, не покрытые тестами
## Цель документа
Этот документ фиксирует сценарии из требований Brencher, для которых в текущем репозитории нет автоматического теста или есть только частичное покрытие. Проверка выполнена по файлам `tests/test_*.py`, тестовой документации и исходникам backend/frontend.
Ссылки `[B-*]` и `[U-*]` ведут на требования в документах:
- [Backend use cases](USE_CASES_BACKEND.md)
- [UI use cases](USE_CASES_UI.md)
- [AGENTS.md](../AGENTS.md) — требования к self-driving/autodeploy-конфигурации
- [tests/README.md](../tests/README.md) — заявленная область существующих integration tests
## Границы текущего покрытия
Покрыты или частично покрыты существующими тестами:
- Git clone, named remotes, validation и восстановление повреждённого local config — `tests/test_git_integration.py`;
- checkout/merge одной, двух и трёх веток, fast-forward, merge conflict и auto branch — `tests/test_git_integration.py`;
- GitUnmerge для valid/invalid version и non-HEAD commit — `tests/test_git_integration.py`;
- stale token на уровне shared state — `tests/test_cached_env.py`, `tests/test_processing_initial_branches.py`;
- apply через UI и повторное появление apply при конфликте — `tests/test_apply_changes.py`;
- dry run и переход к deploy после его выключения — `tests/test_dry_run_playwright.py`;
- отображение deployed column после apply/deploy — `tests/test_deploy_column_playwright.py`;
- кэширование pipeline step — `tests/test_caching_step.py`.
Эти тесты не покрывают весь пользовательский сценарий целиком: например, проверка `GET /state` на HTTP 200 не проверяет все поля ответа, а локальный container test не является тестом Docker Swarm rollout.
## Непокрытые UI-сценарии
### NU-09. Красная рамка toggle-кнопки при проблемном pipeline
**Требование:** [U-06](USE_CASES_UI.md#u-06-отфильтровать-окружения-toggle-кнопками).
Нет автоматического UI-теста, который проверяет:
- красную рамку для окружения с `error`-шагом;
- красную рамку для окружения с `is_running`-шагом;
- отсутствие красной рамки у окружения, где все шаги завершены успешно;
- обновление рамки после WebSocket-сообщения с новым pipeline state;
- сохранение возможности включать и выключать проблемную toggle-кнопку.
## Непокрытые backend-сценарии
### NB-01. Получение главной страницы и static resource
**Требование:** [B-03](USE_CASES_BACKEND.md#b-03-получить-веб-приложение--get) и [B-04](USE_CASES_BACKEND.md#b-04-получить-статический-ресурс-или-неизвестный-путь).
Нет теста, который проверяет:
- `GET /` и наличие `index.html`;
- загрузку `app.js` и `styles.css`;
- ошибку неизвестного static path;
- поведение при недоступном/повреждённом статическом ресурсе.
Связанные исходники: [`backend/web.py`](../backend/web.py), [`frontend/index.html`](../frontend/index.html).
### NB-02. Полный контракт REST `GET /state`
**Требование:** [B-01](USE_CASES_BACKEND.md#b-01-получить-состояние-окружений--get-state).
Существующие тесты проверяют в основном HTTP 200 и отдельные поля. Нет contract-теста на:
- `version`;
- `branches_token`;
- `dry`;
- desired branches/commits;
- deployed columns;
- Jobs и pipeline statuses;
- пустое/начальное состояние;
- ошибку отдельного окружения без падения всего ответа.
Связанные тесты: [`test_deploy_column_playwright.py`](../tests/test_deploy_column_playwright.py), [`test_apply_changes.py`](../tests/test_apply_changes.py).
### NB-03. Полный контракт REST `GET /branches`
**Требование:** [B-02](USE_CASES_BACKEND.md#b-02-получить-доступные-ветки--get-branches).
Нет отдельного REST contract-теста на:
- структуру `{environment: {branch: commits}}`;
- commit objects и их поля;
- несколько remotes и remote-префиксы в HTTP-ответе;
- изменение результата после fetch;
- ошибку Git/fetch.
Связанный код: [`backend/web.py`](../backend/web.py), [`backend/steps/git.py`](../backend/steps/git.py).
### NB-04. WebSocket initial state, malformed messages и unknown environment
**Требования:** [B-05](USE_CASES_BACKEND.md#b-05-открыть-ws-и-получить-начальное-состояние) и [B-06](USE_CASES_BACKEND.md#b-06-передать-обновление-выбранного-окружения).
Playwright-тесты используют WebSocket косвенно, но нет backend-теста на:
- точный порядок/состав initial `version` → `branches` → `environments`;
- несколько клиентов и независимое состояние deduplication;
- malformed JSON;
- неизвестное имя окружения;
- disconnect cleanup;
- ошибку отправки broadcast одному клиенту.
Связанный код: [`backend/web.py`](../backend/web.py).
### NB-05. Git credentials и ошибки внешнего Git
**Требование:** [B-08](USE_CASES_BACKEND.md#b-08-обновить-git-состояние).
Git integration tests работают с локальными repositories и не проверяют:
- authentication failure GitHub/Gitea;
- отсутствие или неправильные `GIT_USERNAME`/`GIT_PASSWORD`;
- network timeout и недоступный remote;
- поведение pipeline после failed fetch;
- сохранение корректного состояния после частично успешного fetch нескольких remotes.
Связанные исходники: [`backend/steps/git.py`](../backend/steps/git.py), [`README.instruction.md`](../README.instruction.md).
### NB-06. Выбор исторического и произвольного commit через backend
**Требование:** [B-07](USE_CASES_BACKEND.md#b-07-запустить-применение-или-dry-run) и [B-09](USE_CASES_BACKEND.md#b-09-разрешить-выбранный-commit).
Тесты проверяют branch/`HEAD` и внутренний Git commit resolution, но нет API/UI integration-теста на:
- исторический commit из branch history;
- произвольный полный или короткий SHA;
- неизвестный ref;
- commit, недоступный в выбранном remote;
- различение одинакового имени branch в разных remotes.
Связанные тесты: [`test_git_integration.py`](../tests/test_git_integration.py), [`docs/USE_CASES_UI.md`](USE_CASES_UI.md).
### NB-07. Swarm state inspection
**Требование:** [B-11](USE_CASES_BACKEND.md#b-11-проверить-deployed-состояние-swarm).
Текущие Playwright-тесты используют обычный Docker container. Нет теста на Docker Swarm API/socket, который проверяет:
- чтение `org.brencher.version` label;
- stack/service image;
- desired и running replicas;
- unavailable stack/service;
- недоступный Docker socket;
- несовпадение deployed version.
Связанный код: [`backend/steps/docker.py`](../backend/steps/docker.py), [`backend/steps/shared_state.py`](../backend/steps/shared_state.py).
### NB-08. Actions workflow, registry и deploy после workflow
**Требования:** [B-12](USE_CASES_BACKEND.md#b-12-запустить-сборку-и-публикацию-образа) и [B-13](USE_CASES_BACKEND.md#b-13-выполнить-deploy).
Нет теста на configuration-dependent Actions flow:
- dispatch Gitea Actions workflow;
- ожидание завершения workflow;
- failed/cancelled workflow;
- credentials registry;
- pull уже опубликованного image на Swarm node;
- `docker stack deploy` и проверку replicas/version после deploy;
- отсутствие локального build/push при `buildDocker=None`.
Требование self-driving pipeline и порядок шагов описаны в [`AGENTS.md`](../AGENTS.md#build-delegation-pattern-actions). Связанные исходники: [`backend/steps/actions.py`](../backend/steps/actions.py), [`backend/steps/docker.py`](../backend/steps/docker.py).
### NB-09. Автоматический drift/autodeploy без UI-команды
**Требование:** [B-14](USE_CASES_BACKEND.md#b-14-автоматически-обнаружить-drift).
GitUnmerge тестируется изолированно, но нет end-to-end теста, который:
1. запускает backend с deployed Swarm label;
2. меняет remote HEAD;
3. ждёт polling cycle;
4. проверяет автоматический pipeline без `environment_update` из UI;
5. проверяет новый image/version и replicas.
Это прямо требуется checklist-ом [`AGENTS.md`](../AGENTS.md#verification-checklist): push branch, дождаться polling cycle и подтвердить redeploy без UI update.
### NB-10. Health check
**Требование:** [B-15](USE_CASES_BACKEND.md#b-15-проверить-url-health-check).
Нет теста на `UrlCheck`/HTTP health-check flow:
- HTTP 200 с ожидаемым JSON;
- неправильный status code;
- невалидный JSON;
- рекурсивное несовпадение expected fields;
- timeout и недоступный service;
- влияние failed health check на pipeline/deploy status.
Связанный код: backend-конфигурации с `UrlCheck` и соответствующий pipeline step.
### NB-11. Secondary Brencher
**Требование:** [B-16](USE_CASES_BACKEND.md#b-16-синхронизировать-secondary-brencher).
Нет теста на `SECONDARY_BRENCHER`:
- подключение к remote `/ws`;
- forwarding update;
- объединение branches/environments;
- duplicate environment ID;
- reconnect и backoff;
- исчерпание retry attempts.
Связанный код: [`backend/secondary.py`](../backend/secondary.py).
### NB-12. Startup modes, profiles и restart recovery
**Требование:** [B-17](USE_CASES_BACKEND.md#b-17-запустить-разные-режимы).
Нет теста на:
- `PROFILES` с несколькими профилями;
- исключение профиля через `-profile`;
- `noweb` headless mode;
- глобальный `dry` startup mode;
- custom port/configuration;
- восстановление state после backend restart;
- отличие локального `brencher2` profile от `SECONDARY_BRENCHER`.
Связанный код: [`backend/app.py`](../backend/app.py), [`backend/discover_envs.py`](../backend/discover_envs.py).
### NB-13. Multi-client concurrency
**Требование:** [B-18](USE_CASES_BACKEND.md#b-18-обработать-несколько-клиентов).
Нет теста на два или более одновременно подключённых клиента:
- broadcast одного update всем клиентам;
- dedup одинакового payload для каждого клиента;
- disconnect одного клиента без влияния на остальные;
- параллельные updates разных окружений;
- race при одновременном изменении одного окружения.
Связанный код: [`backend/web.py`](../backend/web.py).
### NB-14. Security boundary
**Требование:** [B-19](USE_CASES_BACKEND.md#b-19-зафиксировать-границу-доступа).
Нет security integration-теста, который проверяет явно заявленную границу:
- REST endpoints доступны без встроенной auth/authz;
- WebSocket также не требует application-level credentials;
- внешний reverse proxy может ограничить доступ;
- неизвестный/неавторизованный клиент не получает ложный `401` от самого backend.
Связанный код: [`backend/web.py`](../backend/web.py), [`README.instruction.md`](../README.instruction.md).
## Непокрытые UI-сценарии
### NU-01. WebSocket reconnect и отсутствие socket leak
**Требование:** [U-03](USE_CASES_UI.md#u-03-переподключиться-после-разрыва-websocket).
Нет Playwright-теста, который принудительно закрывает socket и проверяет:
- reconnect;
- повторную загрузку initial state;
- отсутствие нескольких параллельных WebSocket instances;
- корректное закрытие старого socket;
- отображение reconnect/disconnected state.
Связанные исходники: [`frontend/app.js`](../frontend/app.js), [`backend/web.py`](../backend/web.py).
### NU-02. Фильтрация окружений toggle-кнопками и текстом
**Требования:** [U-06](USE_CASES_UI.md#u-06-отфильтровать-окружения-toggle-кнопками) и [U-06a](USE_CASES_UI.md#u-06a-отфильтровать-окружения-текстом).
Нет UI-теста на:
- отображение toggle-кнопки для каждого окружения;
- выбор одного и нескольких окружений;
- фильтрацию branches и Jobs/pipeline по выбранным окружениям;
- отображение ссылок, статусов и колонок только выбранных окружений;
- поведение при выключении всех кнопок;
- сохранение выбора при обновлении WebSocket-состояния;
- ввод текстового фильтра, отсутствие совпадений и очистку фильтра;
- то, что фильтры не изменяют backend state.
Связанный исходник: [`frontend/app.js`](../frontend/app.js).
### NU-03. История и произвольный commit в UI
**Требования:** [U-10](USE_CASES_UI.md#u-10-выбрать-исторический-commit) и [U-11](USE_CASES_UI.md#u-11-ввести-произвольный-commit).
Существующие Playwright-тесты выбирают branch/commit из ограниченного сценария, но нет теста на:
- открытие полной commit history;
- исторический commit;
- ручной SHA/ref;
- невалидный commit;
- возврат selection к `HEAD`.
Связанные файлы: [`frontend/app.js`](../frontend/app.js), [`frontend/index.html`](../frontend/index.html).
### NU-04. Merge нескольких branches через UI
**Требование:** [U-13](USE_CASES_UI.md#u-13-объединить-несколько-branches).
Внутренние Git integration tests проверяют merge, но нет Playwright-теста на выбор нескольких branches, отображение selection и показ merge conflict в Jobs/error panel.
Связанные тесты/исходники: [`test_git_integration.py`](../tests/test_git_integration.py), [`frontend/app.js`](../frontend/app.js).
### NU-05. Jobs, pipeline progress и error rendering
**Требование:** [U-15](USE_CASES_UI.md#u-15-наблюдать-jobs-и-pipeline) и [U-18](USE_CASES_UI.md#u-18-увидеть-ошибку-gitcredentialsregistrydockerhealth-check).
Тесты проверяют отдельные конечные состояния, но нет полного UI-теста на:
- все pipeline steps в правильном порядке;
- running → success;
- running → failed;
- текст ошибки и failed step;
- повторный запуск после внешней ошибки;
- registry/Docker/health-check error display.
Связанный исходник: [`frontend/app.js`](../frontend/app.js).
### NU-06. User links
**Требование:** [U-16](USE_CASES_UI.md#u-16-просмотреть-ссылки-сервиса).
Нет теста на получение `userLinks`, наличие ссылок в UI, корректный href и отсутствие выдуманной ссылки при пустом `userLinks`.
Связанные исходники: [`frontend/app.js`](../frontend/app.js), [`frontend/index.html`](../frontend/index.html).
### NU-07. Automatic update reflected in UI
**Требование:** [U-17](USE_CASES_UI.md#u-17-увидеть-автоматический-deploy-без-действия-в-ui).
Нет end-to-end теста, который меняет remote HEAD без UI Update и проверяет отображение нового desired/deployed state и pipeline progress.
Связанный requirement checklist: [`AGENTS.md`](../AGENTS.md#verification-checklist).
### NU-08. Secondary state in UI
**Требование:** [U-20](USE_CASES_UI.md#u-20-работать-с-secondary-brencher).
Нет UI-теста на объединённое состояние local/secondary, duplicate environment conflict, secondary disconnect и отображение reconnect result.
Связанные файлы: [`backend/secondary.py`](../backend/secondary.py), [`frontend/app.js`](../frontend/app.js).
### NU-09. Direct REST diagnostics in UI/browser
**Требование:** [U-21](USE_CASES_UI.md#u-21-просмотреть-состояние-через-прямой-rest-url).
Тесты используют `/state` и `/branches` как вспомогательные API, но нет самостоятельного диагностики-теста, который проверяет:
- открытие endpoint в браузере;
- JSON content type;
- стабильную структуру ответа;
- read-only характер endpoint;
- ошибку недоступного окружения в JSON.
Связанные тесты: [`test_deploy_column_playwright.py`](../tests/test_deploy_column_playwright.py), [`test_containertest.py`](../tests/test_containertest.py).
## Итог
Наиболее критичные пробелы для приоритетного добавления тестов:
1. autodeploy/drift без UI-команды — [B-14](USE_CASES_BACKEND.md#b-14-автоматически-обнаружить-drift), [U-17](USE_CASES_UI.md#u-17-увидеть-автоматический-deploy-без-действия-в-ui);
2. Docker Swarm inspect/deploy и Actions workflow — [B-11](USE_CASES_BACKEND.md#b-11-проверить-deployed-состояние-swarm), [B-12](USE_CASES_BACKEND.md#b-12-запустить-сборку-и-публикацию-образа), [B-13](USE_CASES_BACKEND.md#b-13-выполнить-deploy);
3. WebSocket initial state/reconnect, multi-client и socket leak — [B-05](USE_CASES_BACKEND.md#b-05-открыть-ws-и-получить-начальное-состояние), [B-18](USE_CASES_BACKEND.md#b-18-обработать-несколько-клиентов), [U-03](USE_CASES_UI.md#u-03-переподключиться-после-разрыва-websocket);
4. secondary Brencher — [B-16](USE_CASES_BACKEND.md#b-16-синхронизировать-secondary-brencher), [U-20](USE_CASES_UI.md#u-20-работать-с-secondary-brencher);
5. REST contracts, errors и security boundary — [B-01](USE_CASES_BACKEND.md#b-01-получить-состояние-окружений--get-state), [B-02](USE_CASES_BACKEND.md#b-02-получить-доступные-ветки--get-branches), [B-19](USE_CASES_BACKEND.md#b-19-зафиксировать-границу-доступа).
Отдельное ограничение: `test_containertest.py::test_start` помечен `skip`, поэтому его проверки startup/API не входят в фактически исполняемое покрытие.
+192
View File
@@ -0,0 +1,192 @@
# Brencher — UI use cases
## Цель приложения
Brencher показывает оператору состояние Git-источников и Docker Swarm, позволяет выбрать версию окружения и наблюдать pipeline. Этот файл описывает только пользовательские действия в UI и состояние, которое UI получает от сервера.
## Канал состояния
- После открытия страницы UI устанавливает один WebSocket `/ws`.
- Сервер присылает `version`, `branches` и `environments`, затем рассылает изменения Jobs/pipeline и окружений.
- UI отображает полученное состояние; REST `/state` и `/branches` являются backend read API и не заменяют realtime WebSocket.
- Отдельной UI-кнопки rollback в текущей реализации нет.
## UI use cases
### U-01. Открыть приложение
1. Пользователь открывает `/`.
2. UI загружает HTML, CSS и JavaScript.
3. UI открывает `/ws`.
4. На экране появляются версия приложения, список branches, окружения, выбранные коммиты и Jobs.
5. Если данных ещё нет, UI показывает loading/пустое состояние.
### U-02. Получить начальное состояние
1. После подключения сервер отправляет `version`, `branches` и `environments`.
2. UI заменяет loading данными сервера.
3. Для каждого окружения отображаются desired branches/commits, deployed commit/version и pipeline status.
4. Ошибки окружения показываются как состояние Jobs или error message.
### U-03. Переподключиться после разрыва WebSocket
1. Пользователь остаётся на странице при закрытии или ошибке сокета.
2. UI показывает disconnected/reconnecting state.
3. UI повторяет подключение с задержкой.
4. После нового подключения сервер снова присылает initial state.
5. При повторных соединениях UI не должен считать старое состояние актуальнее нового; фактические ошибки reconnect видны в логах/статусе.
### U-04. Просмотреть окружения и deployed state
1. Пользователь открывает список окружений.
2. UI показывает название, selected/desired commit, deployed commit, version, replicas и текущий шаг pipeline, если эти данные прислал сервер.
3. Пользователь сравнивает desired и deployed state.
4. Недоступное окружение остаётся в списке с ошибкой, а не считается успешно развёрнутым.
### U-05. Просмотреть branches и remote-контекст
1. Пользователь открывает выбор branch.
2. UI показывает branches, полученные от сервера.
3. Одинаковые имена branches разных remotes должны отображаться с контекстом remote.
4. После Git fetch сервер присылает обновлённый список, и UI перерисовывает выбор.
### U-06. Отфильтровать окружения toggle-кнопками
1. UI показывает toggle-кнопку для каждого доступного окружения/стэка.
2. Пользователь включает одну или несколько toggle-кнопок.
3. UI оставляет в branches только выбранные окружения.
4. UI оставляет в Jobs/pipeline только выбранные окружения.
5. Ссылки, статусы и колонки Jobs также относятся только к выбранным окружениям.
6. Если все toggle-кнопки выключены, UI показывает все окружения.
7. Фильтр меняет только отображение и не изменяет серверное состояние.
8. Обновление состояния не должно сбрасывать активный выбор toggle-кнопок, если выбранные окружения всё ещё существуют.
9. Если pipeline окружения содержит хотя бы один неуспешный (`error`) или незаконченный (`is_running`) шаг, соответствующая toggle-кнопка получает красную рамку.
10. Красная рамка обновляется вместе с состоянием pipeline и не изменяет доступность или поведение toggle-кнопки.
### U-06a. Отфильтровать окружения текстом
1. Пользователь вводит текст фильтра.
2. UI оставляет подходящие окружения/стэки.
3. Фильтр меняет только отображение и не изменяет серверное состояние.
4. Очистка фильтра возвращает полный список.
### U-07. Обновить отображаемое состояние
1. Пользователь нажимает refresh/update в UI.
2. UI отправляет серверу соответствующее WebSocket-сообщение либо ожидает очередное состояние pipeline.
3. Сервер присылает branches/environments/jobs.
4. UI обновляет строки, статусы и ошибки.
5. Автоматического UI-таймера каждые пять минут не следует предполагать; обновление может быть pipeline-driven.
### U-08. Выбрать branch
1. Пользователь выбирает branch для окружения.
2. UI меняет локальный selection.
3. При применении selection отправляется серверу через WebSocket.
4. После server update UI отображает выбранное состояние и результат pipeline.
### U-09. Выбрать `HEAD`
1. Пользователь выбирает `HEAD` или текущую вершину branch.
2. UI показывает этот выбор как desired version.
3. При применении сервер разрешает актуальный commit branch.
4. Результат checkout/build/deploy и deployed version приходят в Jobs/state.
### U-10. Выбрать исторический commit
1. Пользователь открывает историю branch.
2. UI показывает доступные commits.
3. Пользователь выбирает конкретный commit.
4. UI отправляет selection при применении.
5. Ошибка отсутствующего commit или merge отображается как ошибка pipeline.
### U-11. Ввести произвольный commit
1. Пользователь вводит commit/ref, если такой control доступен.
2. UI передаёт значение серверу.
3. Сервер проверяет ref/commit и возвращает состояние.
4. Неизвестный commit отображается как ошибка, а не как успешная выбранная версия.
### U-12. Применить выбранное состояние
1. Пользователь выбирает окружение и версию.
2. Нажимает apply/update.
3. UI отправляет команду через WebSocket.
4. UI показывает queued/running/success/error по сообщениям сервера.
5. После завершения показывает selected и deployed state отдельно.
### U-13. Объединить несколько branches
1. Пользователь выбирает несколько branches для одного окружения.
2. UI отображает состав selection.
3. При apply сервер выполняет merge.
4. Успешный результат продолжает pipeline; merge conflict отображается в Jobs/error.
5. Отдельного обещания автоматического разрешения конфликтов UI не даёт.
### U-14. Запустить dry run
1. Пользователь включает dry run.
2. UI отправляет selection с dry-run параметром.
3. UI показывает Git/analysis/build-preparation progress.
4. UI не должен показывать dry run как выполненный deploy.
5. Результат и ограничения dry run приходят от сервера; подготовительные шаги могут выполняться до финального запрета deploy.
### U-15. Наблюдать Jobs и pipeline
1. Пользователь раскрывает Jobs или строку окружения.
2. UI получает и показывает этапы clone, state, checkout/merge, build/workflow, Swarm check и deploy.
3. Для текущего шага отображаются progress/status/log message, если они пришли.
4. Ошибка останавливает визуальный success flow и остаётся видимой для диагностики.
### U-16. Просмотреть ссылки сервиса
1. Сервер присылает `userLinks` в результатах pipeline.
2. UI показывает ссылки на приложение/status или связанные сервисы.
3. Пользователь открывает ссылку в браузере.
4. Если `userLinks` нет, UI не должен придумывать URL.
### U-17. Увидеть автоматический deploy без действия в UI
1. Пользователь не нажимает Update.
2. Сервер обнаруживает, что remote HEAD отличается от deployed label.
3. Сервер запускает pipeline и присылает Jobs/environments update.
4. UI отображает changed desired/deployed state и progress.
5. Если diff нет, UI не показывает ложный deploy.
### U-18. Увидеть ошибку Git/credentials/registry/Docker/health check
1. Пользователь наблюдает Jobs или error panel.
2. UI показывает неуспешный шаг и текст ошибки, если он прислан сервером.
3. Пользователь устраняет внешнюю причину и повторяет update.
4. Наличие error state не считается успешным deploy.
### U-19. Увидеть stale/conflict state
1. Два клиента могут выбирать одно или разные окружения одновременно.
2. Один клиент может получить состояние, устаревшее относительно другого клиента.
3. Сервер может отклонить stale update.
4. UI сохраняет локальный выбор до следующего обновления, если сервер не прислал отдельное conflict message.
5. Structured conflict dialog текущий backend не гарантирует.
### U-20. Работать с secondary Brencher
1. UI получает объединённое состояние локального backend и отдельного secondary Brencher, если `SECONDARY_BRENCHER` настроен.
2. Пользователь видит branches/environments обоих источников согласно данным сервера.
3. Обрыв secondary-соединения отображается как error/stale state.
4. После reconnect UI получает новое initial/update состояние.
5. `brencher2` сам по себе является локальным профилем и не означает наличие secondary-сервера.
### U-21. Просмотреть состояние через прямой REST URL
1. Пользователь открывает `/state` или `/branches` в браузере/инструменте.
2. Сервер возвращает JSON.
3. Это read-only диагностика и не заменяет UI-соединение `/ws`.
4. Изменение selection через эти GET endpoint-ы не выполняется.
## Ограничения UI
- UI не предоставляет отдельного rollback control.
- UI не делает постоянное хранилище: после перезапуска backend in-memory state может исчезнуть.
- Реальный deploy зависит от Git, credentials, Docker socket, registry, Swarm и настроек pipeline.
- В web layer нет встроенной authentication/authorization; безопасность UI должна обеспечиваться внешним reverse proxy или сетью.
- Разные профили запускаются через backend configuration; UI отображает только состояние, которое backend прислал.
+72 -10
View File
@@ -13,6 +13,7 @@ const closeStatus = document.getElementById('close-status');
const refreshBranchesBtn = document.getElementById('refresh-branches');
const applyChangesBtn = document.getElementById('apply-changes');
const branchFilter = document.getElementById('branch-filter');
const envFilterToggles = document.getElementById('env-filter-toggles');
const appVersion = document.getElementById('app-version');
// Branches list (flattened) for UI rendering: [{ envId, envName, branch, commits: [] }]
@@ -21,6 +22,7 @@ let filteredBranches = [];
// Toggle state: show all branches or filtered
let showAllBranches = false;
const activeEnvFilters = new Set();
// Environment runtime state storage:
// environmentsRaw: array as received from backend: [ [envObj, jobsArr], ... ]
@@ -68,6 +70,7 @@ function checkForPendingChanges() {
function filterBranches() {
const filterText = branchFilter.value.toLowerCase().trim();
filteredBranches = branches.filter(({envId, branch, commits}) => {
if (activeEnvFilters.size > 0 && !activeEnvFilters.has(envId)) return false;
const selList = selectedBranchesByEnv[envId] || [];
const isSelected = selList.some(([b]) => b === branch);
// Always show branches that appear in any column (e.g. deployed branches from GitUnmerge)
@@ -86,6 +89,41 @@ function filterBranches() {
renderBranches();
}
function environmentHasPipelineProblem(envObj) {
return Array.isArray(envObj.pipeline) && envObj.pipeline.some(job =>
job && (job.error || job.is_running)
);
}
function renderEnvironmentFilters() {
const environments = environmentsRaw
.filter(envObj => envObj && (envObj.id || envObj.name))
.map(envObj => ({id: envObj.id || envObj.name, name: envObj.name || envObj.id}))
.sort((a, b) => a.name.localeCompare(b.name));
const environmentIds = new Set(environments.map(env => env.id));
[...activeEnvFilters].forEach(envId => {
if (!environmentIds.has(envId)) activeEnvFilters.delete(envId);
});
envFilterToggles.innerHTML = environments.map(({id, name}) => {
const hasPipelineProblem = environmentHasPipelineProblem(
environmentsRaw.find(envObj => (envObj.id || envObj.name) === id) || {}
);
return `
<button type="button" class="env-filter-toggle${activeEnvFilters.has(id) ? ' active' : ''}${hasPipelineProblem ? ' has-pipeline-problem' : ''}" data-env="${escapeHtml(id)}" aria-pressed="${activeEnvFilters.has(id)}"${hasPipelineProblem ? ' title="Pipeline has failed or unfinished steps"' : ''}>${escapeHtml(name)}</button>
`;
}).join('');
envFilterToggles.querySelectorAll('.env-filter-toggle').forEach(button => {
button.onclick = () => {
const envId = button.dataset.env;
if (activeEnvFilters.has(envId)) activeEnvFilters.delete(envId);
else activeEnvFilters.add(envId);
renderEnvironmentFilters();
filterBranches();
renderJobs();
};
});
}
function getCommitDropdownOptions(envId, branchName, desiredCommit) {
const branchObj = branches.find(b => b.envId === envId && b.branch === branchName);
let options = '';
@@ -156,12 +194,7 @@ function renderBranches() {
}
checkForPendingChanges();
const branchesToShow = filteredBranches.length > 0 || branchFilter.value.trim() ? filteredBranches : branches;
if (!branchesToShow.length) {
branchesList.innerHTML = '<p class="loading">No branches found.</p>';
return;
}
const branchesToShow = filteredBranches.length > 0 || branchFilter.value.trim() || activeEnvFilters.size > 0 ? filteredBranches : branches;
// Group by envId for clearer separation
const groups = branchesToShow.reduce((acc, b) => {
acc[b.envId] = acc[b.envId] || {envName: b.envName, rows: []};
@@ -169,18 +202,30 @@ function renderBranches() {
return acc;
}, {});
environmentsRaw
.filter(envObj => envObj && (activeEnvFilters.size === 0 || activeEnvFilters.has(envObj.id || envObj.name)))
.forEach(envObj => {
const envId = envObj.id || envObj.name;
if (!groups[envId]) groups[envId] = {envName: envObj.name || envId, rows: []};
});
if (!Object.keys(groups).length) {
branchesList.innerHTML = '<p class="loading">No branches found.</p>';
return;
}
branchesList.innerHTML = Object.entries(groups).map(([envId, {envName, rows}]) => {
const envCols = columnsByEnv[envId] || {};
const colNames = Object.keys(envCols);
return `
<div class="env-block">
<h3 class="env-title">
Environment: ${envName || envId}
Environment: ${escapeHtml(envName || envId)}
<button class="dry-run-btn ${dryRunByEnv[envId] ? 'dry-run-active' : ''}" data-env="${envId}" title="${dryRunByEnv[envId] ? 'Dry run on — click to resume' : 'Running — click to pause (dry run)'}">
${dryRunByEnv[envId] ? '▶' : '⏸'}
</button>
</h3>
<table class="branches-table">
${rows.length ? `<table class="branches-table">
<thead>
<tr>
<th>Deploy</th>
@@ -211,7 +256,7 @@ function renderBranches() {
</tr>`;
}).join('')}
</tbody>
</table>
</table>` : '<p class="loading">No branches found.</p>'}
</div>`;
}).join('');
// Event wiring
@@ -283,7 +328,12 @@ function renderJobs() {
jobsList.innerHTML = '<p class="loading">No jobs found.</p>';
return;
}
jobsList.innerHTML = environmentsRaw
const visibleEnvironments = environmentsRaw.filter(envObj => activeEnvFilters.size === 0 || activeEnvFilters.has(envObj.id || envObj.name));
if (visibleEnvironments.length === 0) {
jobsList.innerHTML = '<p class="loading">No jobs found.</p>';
return;
}
jobsList.innerHTML = visibleEnvironments
.slice()
.sort((a, b) => (a.name || a.id || '').localeCompare(b.name || b.id || ''))
.map((envObj) => {
@@ -326,6 +376,7 @@ function renderJobs() {
const storageKey = 'jobSpoiler:' + key;
const safeId = 'spoiler-' + encodeURIComponent(key).replace(/[^a-zA-Z0-9_-]/g, '_');
const isError = job.error;
const isWarning = job.warning;
const isRunning = !!job.is_running;
const openByDefault = isError || (window._jobSpoilerState && window._jobSpoilerState[storageKey] === 'open');
@@ -337,6 +388,8 @@ function renderJobs() {
? `<span class="step-spinner" title="Running"></span>`
: isError
? `<span style="color:#dc3545;font-weight:bold;margin-right:6px;" title="Error">!</span>`
: isWarning
? `<span style="color:#d99700;font-weight:bold;margin-right:6px;" title="Warning">⚠</span>`
: `<span style="color:#28a745;font-weight:bold;margin-right:6px;" title="OK">✔</span>`}
${envObj.id} - ${job.name}
</div>
@@ -426,6 +479,7 @@ function setupWebSockets() {
const data = message.environments;
payload = data || {};
environmentsRaw = Object.values(payload);
renderEnvironmentFilters();
// Sync selections and column data per environment
environmentsRaw.forEach((envObj) => {
@@ -532,6 +586,14 @@ function updateEnvironment() {
showStatus('Changes applied (pending server confirmation).');
}
// Initial load
(function applyUrlFilter() {
const params = new URLSearchParams(window.location.search);
const initialFilter = params.get('filter');
if (initialFilter && branchFilter) {
branchFilter.value = initialFilter;
filterBranches();
}
})();
setupWebSockets();
showStatus('Loading branches...');
renderBranches();
+1
View File
@@ -24,6 +24,7 @@
<input type="text" id="branch-filter"
placeholder="Filter branches by name, commit ID, or commit message..." class="filter-input">
</div>
<div id="env-filter-toggles" class="env-filter-toggles" aria-label="Environment filters"></div>
<div class="control-bar" style="float: left;">
<button id="toggle-show-all" class="toggle-button">Show All</button>
</div>
+29
View File
@@ -136,6 +136,35 @@ body {
box-shadow: 0 0 0 2px rgba(0, 123, 255, 0.25);
}
.env-filter-toggles {
display: flex;
flex-wrap: wrap;
gap: 8px;
clear: both;
padding: 8px 0;
}
.env-filter-toggle {
background: #fff;
color: #495057;
border: 1px solid #adb5bd;
border-radius: 4px;
padding: 8px 14px;
cursor: pointer;
font-size: 0.9rem;
}
.env-filter-toggle:hover,
.env-filter-toggle.active {
background: #007bff;
color: #fff;
border-color: #007bff;
}
.env-filter-toggle.has-pipeline-problem {
border: 2px solid #dc3545;
}
/* Branches table styling */
.branches-table {
width: 100%;
+4
View File
@@ -11,3 +11,7 @@ types-PyYAML
types-requests
types-docker
testcontainers
+43
View File
@@ -32,6 +32,17 @@ class TestGitIntegration:
assert repo.remotes.repo1.url == second_url
assert set(clone.get_branches()) == {"master", "repo1/master"}
def test_git_clone_filters_auto_branches(self, repo_helper: RemoteRepoHelper) -> None:
repo_helper.create_commit(repo_helper.repo, "master", "master", "README.md", "content", "Initial commit")
repo_helper.create_commit(repo_helper.repo, "master", "feature", "feature.txt", "feature", "Feature commit")
repo_helper.create_commit(repo_helper.repo, "master", "auto-abc12345", "auto.txt", "auto", "Auto commit")
clone = GitClone(url=repo_helper.remote_dir)
clone.env = repo_helper.env
clone.progress()
assert set(clone.get_branches()) == {"master", "feature"}
def test_git_clone_named_remotes(self, repo_helper: RemoteRepoHelper) -> None:
# Two real local repos served as separate "remotes". The user controls
# their names explicitly via the `remotes=[{name,url}]` API.
@@ -71,6 +82,29 @@ class TestGitIntegration:
shutil.rmtree(github_dir, ignore_errors=True)
shutil.rmtree(gitea_dir, ignore_errors=True)
def test_git_clone_keeps_available_remote_when_another_is_unreachable(self, repo_helper: RemoteRepoHelper) -> None:
repo_helper.create_commit(repo_helper.repo, "master", "master", "README.md", "content", "Initial commit")
clone = GitClone(remotes=[
{"name": "available", "url": repo_helper.remote_dir},
{"name": "unreachable", "url": "/does/not/exist"},
])
clone.env = repo_helper.env
clone.progress()
assert "available/master" in clone.get_branches()
assert len(clone.errors) == 1
assert "unreachable" in clone.errors[0]
def test_git_clone_keeps_empty_repository_when_all_remotes_are_unreachable(self, repo_helper: RemoteRepoHelper) -> None:
clone = GitClone(url="/does/not/exist")
clone.env = repo_helper.env
repo_path = clone.progress()
assert os.path.isdir(os.path.join(repo_path, ".git"))
assert clone.get_branches() == {}
def test_git_clone_remotes_validation(self) -> None:
# Empty list: rejected (would produce an unusable clone).
with pytest.raises(ValueError, match="At least one repository URL is required"):
@@ -336,6 +370,15 @@ class TestGitIntegration:
with pytest.raises(BaseException, match="Version format not recognized"):
repo_helper.git_unmerge.progress()
def test_git_unmerge_empty_version_uses_default_branch(self, repo_helper: RemoteRepoHelper) -> None:
repo_helper.create_commit(repo_helper.repo, "master", "master", "file1.txt", "content", "Initial commit")
repo_helper.set_desired_branches([])
repo_helper.mock_check.version = lambda: "" # type: ignore[attr-defined]
result = repo_helper.git_unmerge.progress()
assert result.branches == [()]
def test_git_unmerge_nonhead_commit(self, repo_helper: RemoteRepoHelper) -> None:
# Create initial commit
commit1 = repo_helper.create_commit(repo_helper.repo, "master", "master", "file1.txt", "content1",