acceptbox 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- acceptbox-0.1.0/.gitignore +8 -0
- acceptbox-0.1.0/LICENSE +21 -0
- acceptbox-0.1.0/PKG-INFO +198 -0
- acceptbox-0.1.0/README.md +181 -0
- acceptbox-0.1.0/pyproject.toml +31 -0
- acceptbox-0.1.0/src/acceptbox/__init__.py +8 -0
- acceptbox-0.1.0/src/acceptbox/cli.py +1008 -0
- acceptbox-0.1.0/src/acceptbox/command.py +92 -0
- acceptbox-0.1.0/src/acceptbox/config.py +244 -0
- acceptbox-0.1.0/src/acceptbox/git.py +252 -0
- acceptbox-0.1.0/src/acceptbox/inputs.py +173 -0
- acceptbox-0.1.0/src/acceptbox/pin.py +76 -0
- acceptbox-0.1.0/src/acceptbox/report.py +112 -0
- acceptbox-0.1.0/src/acceptbox/verdict.py +148 -0
- acceptbox-0.1.0/src/acceptbox/witnessbox.py +265 -0
acceptbox-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 kaufd
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
acceptbox-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: acceptbox
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Независимая приёмка коммитов base → repro → head в режимах command и WitnessBox
|
|
5
|
+
License-Expression: MIT
|
|
6
|
+
License-File: LICENSE
|
|
7
|
+
Classifier: Development Status :: 4 - Beta
|
|
8
|
+
Classifier: Environment :: Console
|
|
9
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
10
|
+
Classifier: Programming Language :: Python :: 3
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
14
|
+
Classifier: Topic :: Software Development :: Testing
|
|
15
|
+
Requires-Python: >=3.11
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
|
|
18
|
+
# AcceptBox
|
|
19
|
+
|
|
20
|
+
Инструмент независимой приёмки цепочки коммитов `base → repro → head` в изолированных Git worktree с атомарным машиночитаемым отчётом `accept.json` (формат 1). Runtime использует только стандартную библиотеку Python (`>=3.11`).
|
|
21
|
+
|
|
22
|
+
AcceptBox поддерживает два режима приёмки:
|
|
23
|
+
- **`--mode command`** (по умолчанию, L19, L22) — приёмка по обычной тестовой команде без `witnessbox`: `repro` меняет только пути внутри `--tests`, `head` не имеет права менять/переименовывать/удалять файлы репро-теста, `repro` должен завершиться кодом `1` (`red`), `head` — кодом `0` (`green`);
|
|
24
|
+
- **`--mode witnessbox`** — приёмка через внешний CLI [WitnessBox](https://github.com/kaufd/witnessbox) (`>=0.10.0`, без верхней границы, правила L9, L10, L17, L21): проверка доверенного дерева `ebt/`, красная `base` и красный `repro` по целевому инварианту `--inv` (`FALSE_PROOF` / `CONFIRMED_VIOLATION`), зелёный `head`.
|
|
25
|
+
|
|
26
|
+
## Область применимости (L24)
|
|
27
|
+
|
|
28
|
+
Цепочка `base → repro → head` с красным репро-коммитом предназначена для **багфиксов** (а также для инвариантов, утверждённых человеком до реализации в `--mode witnessbox`).
|
|
29
|
+
Для **новых фич** красный репро-тест, написанный той же моделью, не даёт полезной гарантии, так как модель может подогнать тест и реализацию друг под друга — приёмка фич строится на утверждённой человеком спецификации (D4/L10) и/или независимом ревью и проверке поведения. Политика для **рефакторингов** (`base` зелёный → `head` зелёный без `repro`) ортогональна `--mode` и остаётся отдельной задачей.
|
|
30
|
+
|
|
31
|
+
## Установка
|
|
32
|
+
|
|
33
|
+
```sh
|
|
34
|
+
uv tool install acceptbox==0.1.0
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Для режима `--mode witnessbox` дополнительно установите WitnessBox (опционально):
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
uv tool install 'witnessbox>=0.10.0'
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Проверка установки (`--installation`)
|
|
44
|
+
|
|
45
|
+
```sh
|
|
46
|
+
acceptbox --installation
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Выводит JSON формата `1` (`format`, `report_format`, `distribution`, `version`, блоки `git` и `witnessbox` с `supported: ">=0.10.0"`). Возвращает код `0`, если доступны `git` и `acceptbox`, независимо от того, установлен ли `witnessbox`; код `2` — только при отсутствии/сбое `git` или ошибке диагностики `acceptbox`.
|
|
50
|
+
|
|
51
|
+
## Проектный конфиг (`.acceptbox.toml`, L23, L25, L26)
|
|
52
|
+
|
|
53
|
+
Чтобы не повторять параметры проекта при каждом запуске, добавьте в корень репозитория `.acceptbox.toml`:
|
|
54
|
+
|
|
55
|
+
```toml
|
|
56
|
+
format = 1
|
|
57
|
+
mode = "command" # опционально: "command" | "witnessbox" (по умолчанию "command")
|
|
58
|
+
timeout = 600 # опционально: положительное число секунд
|
|
59
|
+
protect = ["pyproject.toml"] # опционально: объединяется с --protect из CLI
|
|
60
|
+
env = ["PYTHONPATH=src"] # опционально: KEY или KEY=VAL (BASE, EBT_* и git local-env-vars запрещены)
|
|
61
|
+
|
|
62
|
+
[command]
|
|
63
|
+
tests = ["tests/"]
|
|
64
|
+
argv = ["python3", "-m", "unittest", "discover", "-s", "tests"]
|
|
65
|
+
|
|
66
|
+
[witnessbox]
|
|
67
|
+
ebt_ref = "main"
|
|
68
|
+
# ebt_repo указывать не нужно, если ebt/ живёт в том же репозитории (по умолчанию --repo);
|
|
69
|
+
# если указан — только URL или абсолютный путь (L27)
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
**Правила доверия (fail-closed):**
|
|
73
|
+
- `.acceptbox.toml` читается строго из объектов Git базового коммита `base` (в `calibrate` — только при переданном `--base`), а не из рабочего дерева или веток `repro`/`head`;
|
|
74
|
+
- `.acceptbox.toml` автоматически защищается от изменений, удаления и переименования в `base..repro` и `base..head` (как `--protect`);
|
|
75
|
+
- **граница доверия `--base` (L26):** конфигу можно доверять ровно настолько, насколько можно доверять `--base`. AcceptBox не проверяет принадлежность `--base` основной ветке — `--base` должна задавать принимающая сторона (человек, CI или внешний оркестратор, например через `git merge-base main HEAD`), а не проверяемый агент;
|
|
76
|
+
- все присутствующие секции валидируются строго: неизвестные ключи, пер-задачные поля (`inv`, `ebt_sha`, `approved_tree`, `base`, `repro`, `head`, `repo`, `out`), относительный локальный путь `[witnessbox].ebt_repo`, симлинки и ошибки TOML завершаются с `ERROR` (`config-invalid`, код `2`); блок `inputs.config` такого отчёта содержит `commit` и `sha256` отклонённого файла;
|
|
77
|
+
- `env` допускает обычные переменные (включая `GIT_SSH_COMMAND` или `GIT_AUTHOR_NAME`), но запрещает `BASE`, любые `EBT_*` и переменные git-изоляции из `git rev-parse --local-env-vars`;
|
|
78
|
+
- `protect` из конфига и CLI суммируются (CLI не может ослабить защиту из `base`), `env` сливается с приоритетом CLI по ключу (`--env KEY` без значения при отсутствии `KEY` в окружении снимает значение из конфига), остальные параметры переопределяются явными флагами CLI.
|
|
79
|
+
|
|
80
|
+
## Фиксация дерева проверок (`pin`)
|
|
81
|
+
|
|
82
|
+
```sh
|
|
83
|
+
acceptbox pin --ebt-repo /path/to/project --ebt-sha "$(git -C /path/to/project rev-parse HEAD)"
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
Читает дерево `ebt/` напрямую из объектов Git (без незакоммиченных правок) и печатает 64-символьный SHA-256. Флаг `--ebt-repo` в `pin` обязателен.
|
|
87
|
+
|
|
88
|
+
## Приёмка коммитов (`accept`)
|
|
89
|
+
|
|
90
|
+
Эргономичные значения по умолчанию (L22):
|
|
91
|
+
- `--mode` по умолчанию берётся из `.acceptbox.toml` или равен `command`;
|
|
92
|
+
- `--repo` по умолчанию `.`;
|
|
93
|
+
- `--head` по умолчанию `HEAD` из `--repo`; резолв в полный SHA выполняется сразу после проверки `git`, его сбой даёт `gate-error` с отчётом (явно переданный `--head` по-прежнему принимается только как полный 40/64-hex SHA). **Важно:** незакоммиченные правки рабочего дерева не проверяются, а если `--repo` указан как URL, через `git ls-remote` берётся удалённый `HEAD` (обычно ветка по умолчанию, а не ветка с фиксом — для URL передавайте `--head` явно);
|
|
94
|
+
- `--ebt-repo` в `witnessbox` по умолчанию берётся из `.acceptbox.toml` или равен `--repo`. Если это локальный checkout, проверка «`--ebt-sha` — предок `--ebt-ref`» идёт по локальной ветке, которую может сдвинуть любой, кто пишет в этот checkout: опорой доверия остаётся только `--approved-tree`. Для полной проверки L10 передайте в `--ebt-repo` URL основного репозитория (L27);
|
|
95
|
+
- `--out` по умолчанию атомарно создаётся как новый пустой каталог в системном `TMPDIR`, а путь к `accept.json` выводится в итоговое сообщение.
|
|
96
|
+
|
|
97
|
+
### Режим `command`
|
|
98
|
+
|
|
99
|
+
Минимальный запуск (при наличии `.acceptbox.toml` в `base`, из корня репозитория):
|
|
100
|
+
|
|
101
|
+
```sh
|
|
102
|
+
acceptbox accept --base "$(git merge-base main HEAD)" --repro <40-hex-sha>
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Полный запуск с явными флагами (без `.acceptbox.toml`):
|
|
106
|
+
|
|
107
|
+
```sh
|
|
108
|
+
acceptbox accept \
|
|
109
|
+
--mode command \
|
|
110
|
+
--repo /path/to/project \
|
|
111
|
+
--base <40-hex-sha> \
|
|
112
|
+
--repro <40-hex-sha> \
|
|
113
|
+
--head <40-hex-sha> \
|
|
114
|
+
--tests tests/ \
|
|
115
|
+
[--protect path/to/protect ...] \
|
|
116
|
+
[--timeout 600] \
|
|
117
|
+
[--env KEY[=VAL] ...] \
|
|
118
|
+
[--out /tmp/accept-run] \
|
|
119
|
+
-- python3 -m unittest discover -s tests
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
Команда после `--` (или `[command].argv` в `.acceptbox.toml`) запускается без shell (`shell=False`) с очищенным окружением. Автоопределение тестовой команды не выполняется. Код `0` трактуется как `green`, код `1` — как `red`, любой другой код (`>= 2`), сигнал или таймаут — как `gate-error` (код `2`).
|
|
123
|
+
|
|
124
|
+
### Режим `witnessbox`
|
|
125
|
+
|
|
126
|
+
```sh
|
|
127
|
+
acceptbox accept \
|
|
128
|
+
--mode witnessbox \
|
|
129
|
+
--base <40-hex-sha> \
|
|
130
|
+
--repro <40-hex-sha> \
|
|
131
|
+
--inv INV-1,INV-2 \
|
|
132
|
+
--ebt-ref main \
|
|
133
|
+
--ebt-sha <40-hex-sha> \
|
|
134
|
+
--approved-tree <64-hex-sha256> \
|
|
135
|
+
[--repo /path/to/project] \
|
|
136
|
+
[--head <40-hex-sha>] \
|
|
137
|
+
[--ebt-repo /path/to/ebt-repo] \
|
|
138
|
+
[--protect path/to/protect ...] \
|
|
139
|
+
[--timeout 600] \
|
|
140
|
+
[--env KEY[=VAL] ...] \
|
|
141
|
+
[--out /tmp/accept-ebt-run]
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
## Калибровка чувствительности (`calibrate`)
|
|
145
|
+
|
|
146
|
+
Режим `command`:
|
|
147
|
+
|
|
148
|
+
```sh
|
|
149
|
+
acceptbox calibrate \
|
|
150
|
+
--green <sha> \
|
|
151
|
+
--red <sha> \
|
|
152
|
+
[--repo /path/to/project] \
|
|
153
|
+
[--base <base_sha>] \
|
|
154
|
+
[--timeout 600] \
|
|
155
|
+
[--env KEY[=VAL] ...] \
|
|
156
|
+
[--out /tmp/calibrate-run] \
|
|
157
|
+
-- python3 -m unittest discover -s tests
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
Режим `witnessbox`:
|
|
161
|
+
|
|
162
|
+
```sh
|
|
163
|
+
acceptbox calibrate \
|
|
164
|
+
--mode witnessbox \
|
|
165
|
+
--green <sha> \
|
|
166
|
+
--red <sha> \
|
|
167
|
+
--inv INV-1 \
|
|
168
|
+
--ebt-ref main \
|
|
169
|
+
--ebt-sha <40-hex-sha> \
|
|
170
|
+
--approved-tree <64-hex-sha256> \
|
|
171
|
+
[--repo /path/to/project] \
|
|
172
|
+
[--ebt-repo /path/to/ebt-repo] \
|
|
173
|
+
[--base <base_sha>] \
|
|
174
|
+
[--timeout 600] \
|
|
175
|
+
[--env KEY[=VAL] ...] \
|
|
176
|
+
[--out /tmp/calibrate-ebt-run]
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
Калибровка проверяет набор `--green` / `--red` коммитов и записывает `<out>/calibrate.json` (`accept.json` не создаётся). Проверки `ancestry`, `--protect` и диффа `base..repro` / `repro..head` в калибровке **не применяются**. Если передан `--base`, настройки могут подгружаться из `.acceptbox.toml` этого коммита (и в `witnessbox` передаётся `BASE`).
|
|
180
|
+
|
|
181
|
+
## Коды выхода и отчёты
|
|
182
|
+
|
|
183
|
+
- `0` — `ACCEPTED` (для `accept`) / `CALIBRATED` (для `calibrate`);
|
|
184
|
+
- `1` — `REJECTED` / `FAILED` (отказ по правилам приёмки или калибровки);
|
|
185
|
+
- `2` — `ERROR` (ошибка аргументов CLI, непустой `--out`, некорректный `.acceptbox.toml` `config-invalid`, сбой `git`, отсутствующий/несовместимый `witnessbox`, нарушение схемы отчёта, ошибка прогона `gate-error`).
|
|
186
|
+
|
|
187
|
+
**Правило записи отчёта при коде `2` (L26):**
|
|
188
|
+
- `accept.json` / `calibrate.json` **не создаётся** при ошибках синтаксиса CLI, при `out-not-empty`, а также при нехватке обязательных аргументов (`--tests`, команды после `--`, `--inv`, `--ebt-ref`, `--ebt-sha`, `--approved-tree`) или смешивании флагов режимов, обнаруженных после чтения `base:.acceptbox.toml`; если пустой каталог `--out` был создан текущим запуском, он удаляется;
|
|
189
|
+
- во всех остальных случаях кода `2` после захвата `--out` (включая `config-invalid`, `witnessbox-missing`, `witnessbox-incompatible`, `gate-error`) отчёт записывается атомарно, а путь к нему печатается в `stderr`.
|
|
190
|
+
|
|
191
|
+
Подробнее о подключении проекта см. [docs/onboarding.md](docs/onboarding.md) и журнал решений [docs/decisions.md](docs/decisions.md).
|
|
192
|
+
|
|
193
|
+
## Разработка и сборка
|
|
194
|
+
|
|
195
|
+
```sh
|
|
196
|
+
python3 -m unittest discover -s tests
|
|
197
|
+
uv build
|
|
198
|
+
```
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
# AcceptBox
|
|
2
|
+
|
|
3
|
+
Инструмент независимой приёмки цепочки коммитов `base → repro → head` в изолированных Git worktree с атомарным машиночитаемым отчётом `accept.json` (формат 1). Runtime использует только стандартную библиотеку Python (`>=3.11`).
|
|
4
|
+
|
|
5
|
+
AcceptBox поддерживает два режима приёмки:
|
|
6
|
+
- **`--mode command`** (по умолчанию, L19, L22) — приёмка по обычной тестовой команде без `witnessbox`: `repro` меняет только пути внутри `--tests`, `head` не имеет права менять/переименовывать/удалять файлы репро-теста, `repro` должен завершиться кодом `1` (`red`), `head` — кодом `0` (`green`);
|
|
7
|
+
- **`--mode witnessbox`** — приёмка через внешний CLI [WitnessBox](https://github.com/kaufd/witnessbox) (`>=0.10.0`, без верхней границы, правила L9, L10, L17, L21): проверка доверенного дерева `ebt/`, красная `base` и красный `repro` по целевому инварианту `--inv` (`FALSE_PROOF` / `CONFIRMED_VIOLATION`), зелёный `head`.
|
|
8
|
+
|
|
9
|
+
## Область применимости (L24)
|
|
10
|
+
|
|
11
|
+
Цепочка `base → repro → head` с красным репро-коммитом предназначена для **багфиксов** (а также для инвариантов, утверждённых человеком до реализации в `--mode witnessbox`).
|
|
12
|
+
Для **новых фич** красный репро-тест, написанный той же моделью, не даёт полезной гарантии, так как модель может подогнать тест и реализацию друг под друга — приёмка фич строится на утверждённой человеком спецификации (D4/L10) и/или независимом ревью и проверке поведения. Политика для **рефакторингов** (`base` зелёный → `head` зелёный без `repro`) ортогональна `--mode` и остаётся отдельной задачей.
|
|
13
|
+
|
|
14
|
+
## Установка
|
|
15
|
+
|
|
16
|
+
```sh
|
|
17
|
+
uv tool install acceptbox==0.1.0
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Для режима `--mode witnessbox` дополнительно установите WitnessBox (опционально):
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
uv tool install 'witnessbox>=0.10.0'
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Проверка установки (`--installation`)
|
|
27
|
+
|
|
28
|
+
```sh
|
|
29
|
+
acceptbox --installation
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Выводит JSON формата `1` (`format`, `report_format`, `distribution`, `version`, блоки `git` и `witnessbox` с `supported: ">=0.10.0"`). Возвращает код `0`, если доступны `git` и `acceptbox`, независимо от того, установлен ли `witnessbox`; код `2` — только при отсутствии/сбое `git` или ошибке диагностики `acceptbox`.
|
|
33
|
+
|
|
34
|
+
## Проектный конфиг (`.acceptbox.toml`, L23, L25, L26)
|
|
35
|
+
|
|
36
|
+
Чтобы не повторять параметры проекта при каждом запуске, добавьте в корень репозитория `.acceptbox.toml`:
|
|
37
|
+
|
|
38
|
+
```toml
|
|
39
|
+
format = 1
|
|
40
|
+
mode = "command" # опционально: "command" | "witnessbox" (по умолчанию "command")
|
|
41
|
+
timeout = 600 # опционально: положительное число секунд
|
|
42
|
+
protect = ["pyproject.toml"] # опционально: объединяется с --protect из CLI
|
|
43
|
+
env = ["PYTHONPATH=src"] # опционально: KEY или KEY=VAL (BASE, EBT_* и git local-env-vars запрещены)
|
|
44
|
+
|
|
45
|
+
[command]
|
|
46
|
+
tests = ["tests/"]
|
|
47
|
+
argv = ["python3", "-m", "unittest", "discover", "-s", "tests"]
|
|
48
|
+
|
|
49
|
+
[witnessbox]
|
|
50
|
+
ebt_ref = "main"
|
|
51
|
+
# ebt_repo указывать не нужно, если ebt/ живёт в том же репозитории (по умолчанию --repo);
|
|
52
|
+
# если указан — только URL или абсолютный путь (L27)
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
**Правила доверия (fail-closed):**
|
|
56
|
+
- `.acceptbox.toml` читается строго из объектов Git базового коммита `base` (в `calibrate` — только при переданном `--base`), а не из рабочего дерева или веток `repro`/`head`;
|
|
57
|
+
- `.acceptbox.toml` автоматически защищается от изменений, удаления и переименования в `base..repro` и `base..head` (как `--protect`);
|
|
58
|
+
- **граница доверия `--base` (L26):** конфигу можно доверять ровно настолько, насколько можно доверять `--base`. AcceptBox не проверяет принадлежность `--base` основной ветке — `--base` должна задавать принимающая сторона (человек, CI или внешний оркестратор, например через `git merge-base main HEAD`), а не проверяемый агент;
|
|
59
|
+
- все присутствующие секции валидируются строго: неизвестные ключи, пер-задачные поля (`inv`, `ebt_sha`, `approved_tree`, `base`, `repro`, `head`, `repo`, `out`), относительный локальный путь `[witnessbox].ebt_repo`, симлинки и ошибки TOML завершаются с `ERROR` (`config-invalid`, код `2`); блок `inputs.config` такого отчёта содержит `commit` и `sha256` отклонённого файла;
|
|
60
|
+
- `env` допускает обычные переменные (включая `GIT_SSH_COMMAND` или `GIT_AUTHOR_NAME`), но запрещает `BASE`, любые `EBT_*` и переменные git-изоляции из `git rev-parse --local-env-vars`;
|
|
61
|
+
- `protect` из конфига и CLI суммируются (CLI не может ослабить защиту из `base`), `env` сливается с приоритетом CLI по ключу (`--env KEY` без значения при отсутствии `KEY` в окружении снимает значение из конфига), остальные параметры переопределяются явными флагами CLI.
|
|
62
|
+
|
|
63
|
+
## Фиксация дерева проверок (`pin`)
|
|
64
|
+
|
|
65
|
+
```sh
|
|
66
|
+
acceptbox pin --ebt-repo /path/to/project --ebt-sha "$(git -C /path/to/project rev-parse HEAD)"
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Читает дерево `ebt/` напрямую из объектов Git (без незакоммиченных правок) и печатает 64-символьный SHA-256. Флаг `--ebt-repo` в `pin` обязателен.
|
|
70
|
+
|
|
71
|
+
## Приёмка коммитов (`accept`)
|
|
72
|
+
|
|
73
|
+
Эргономичные значения по умолчанию (L22):
|
|
74
|
+
- `--mode` по умолчанию берётся из `.acceptbox.toml` или равен `command`;
|
|
75
|
+
- `--repo` по умолчанию `.`;
|
|
76
|
+
- `--head` по умолчанию `HEAD` из `--repo`; резолв в полный SHA выполняется сразу после проверки `git`, его сбой даёт `gate-error` с отчётом (явно переданный `--head` по-прежнему принимается только как полный 40/64-hex SHA). **Важно:** незакоммиченные правки рабочего дерева не проверяются, а если `--repo` указан как URL, через `git ls-remote` берётся удалённый `HEAD` (обычно ветка по умолчанию, а не ветка с фиксом — для URL передавайте `--head` явно);
|
|
77
|
+
- `--ebt-repo` в `witnessbox` по умолчанию берётся из `.acceptbox.toml` или равен `--repo`. Если это локальный checkout, проверка «`--ebt-sha` — предок `--ebt-ref`» идёт по локальной ветке, которую может сдвинуть любой, кто пишет в этот checkout: опорой доверия остаётся только `--approved-tree`. Для полной проверки L10 передайте в `--ebt-repo` URL основного репозитория (L27);
|
|
78
|
+
- `--out` по умолчанию атомарно создаётся как новый пустой каталог в системном `TMPDIR`, а путь к `accept.json` выводится в итоговое сообщение.
|
|
79
|
+
|
|
80
|
+
### Режим `command`
|
|
81
|
+
|
|
82
|
+
Минимальный запуск (при наличии `.acceptbox.toml` в `base`, из корня репозитория):
|
|
83
|
+
|
|
84
|
+
```sh
|
|
85
|
+
acceptbox accept --base "$(git merge-base main HEAD)" --repro <40-hex-sha>
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Полный запуск с явными флагами (без `.acceptbox.toml`):
|
|
89
|
+
|
|
90
|
+
```sh
|
|
91
|
+
acceptbox accept \
|
|
92
|
+
--mode command \
|
|
93
|
+
--repo /path/to/project \
|
|
94
|
+
--base <40-hex-sha> \
|
|
95
|
+
--repro <40-hex-sha> \
|
|
96
|
+
--head <40-hex-sha> \
|
|
97
|
+
--tests tests/ \
|
|
98
|
+
[--protect path/to/protect ...] \
|
|
99
|
+
[--timeout 600] \
|
|
100
|
+
[--env KEY[=VAL] ...] \
|
|
101
|
+
[--out /tmp/accept-run] \
|
|
102
|
+
-- python3 -m unittest discover -s tests
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Команда после `--` (или `[command].argv` в `.acceptbox.toml`) запускается без shell (`shell=False`) с очищенным окружением. Автоопределение тестовой команды не выполняется. Код `0` трактуется как `green`, код `1` — как `red`, любой другой код (`>= 2`), сигнал или таймаут — как `gate-error` (код `2`).
|
|
106
|
+
|
|
107
|
+
### Режим `witnessbox`
|
|
108
|
+
|
|
109
|
+
```sh
|
|
110
|
+
acceptbox accept \
|
|
111
|
+
--mode witnessbox \
|
|
112
|
+
--base <40-hex-sha> \
|
|
113
|
+
--repro <40-hex-sha> \
|
|
114
|
+
--inv INV-1,INV-2 \
|
|
115
|
+
--ebt-ref main \
|
|
116
|
+
--ebt-sha <40-hex-sha> \
|
|
117
|
+
--approved-tree <64-hex-sha256> \
|
|
118
|
+
[--repo /path/to/project] \
|
|
119
|
+
[--head <40-hex-sha>] \
|
|
120
|
+
[--ebt-repo /path/to/ebt-repo] \
|
|
121
|
+
[--protect path/to/protect ...] \
|
|
122
|
+
[--timeout 600] \
|
|
123
|
+
[--env KEY[=VAL] ...] \
|
|
124
|
+
[--out /tmp/accept-ebt-run]
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## Калибровка чувствительности (`calibrate`)
|
|
128
|
+
|
|
129
|
+
Режим `command`:
|
|
130
|
+
|
|
131
|
+
```sh
|
|
132
|
+
acceptbox calibrate \
|
|
133
|
+
--green <sha> \
|
|
134
|
+
--red <sha> \
|
|
135
|
+
[--repo /path/to/project] \
|
|
136
|
+
[--base <base_sha>] \
|
|
137
|
+
[--timeout 600] \
|
|
138
|
+
[--env KEY[=VAL] ...] \
|
|
139
|
+
[--out /tmp/calibrate-run] \
|
|
140
|
+
-- python3 -m unittest discover -s tests
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
Режим `witnessbox`:
|
|
144
|
+
|
|
145
|
+
```sh
|
|
146
|
+
acceptbox calibrate \
|
|
147
|
+
--mode witnessbox \
|
|
148
|
+
--green <sha> \
|
|
149
|
+
--red <sha> \
|
|
150
|
+
--inv INV-1 \
|
|
151
|
+
--ebt-ref main \
|
|
152
|
+
--ebt-sha <40-hex-sha> \
|
|
153
|
+
--approved-tree <64-hex-sha256> \
|
|
154
|
+
[--repo /path/to/project] \
|
|
155
|
+
[--ebt-repo /path/to/ebt-repo] \
|
|
156
|
+
[--base <base_sha>] \
|
|
157
|
+
[--timeout 600] \
|
|
158
|
+
[--env KEY[=VAL] ...] \
|
|
159
|
+
[--out /tmp/calibrate-ebt-run]
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
Калибровка проверяет набор `--green` / `--red` коммитов и записывает `<out>/calibrate.json` (`accept.json` не создаётся). Проверки `ancestry`, `--protect` и диффа `base..repro` / `repro..head` в калибровке **не применяются**. Если передан `--base`, настройки могут подгружаться из `.acceptbox.toml` этого коммита (и в `witnessbox` передаётся `BASE`).
|
|
163
|
+
|
|
164
|
+
## Коды выхода и отчёты
|
|
165
|
+
|
|
166
|
+
- `0` — `ACCEPTED` (для `accept`) / `CALIBRATED` (для `calibrate`);
|
|
167
|
+
- `1` — `REJECTED` / `FAILED` (отказ по правилам приёмки или калибровки);
|
|
168
|
+
- `2` — `ERROR` (ошибка аргументов CLI, непустой `--out`, некорректный `.acceptbox.toml` `config-invalid`, сбой `git`, отсутствующий/несовместимый `witnessbox`, нарушение схемы отчёта, ошибка прогона `gate-error`).
|
|
169
|
+
|
|
170
|
+
**Правило записи отчёта при коде `2` (L26):**
|
|
171
|
+
- `accept.json` / `calibrate.json` **не создаётся** при ошибках синтаксиса CLI, при `out-not-empty`, а также при нехватке обязательных аргументов (`--tests`, команды после `--`, `--inv`, `--ebt-ref`, `--ebt-sha`, `--approved-tree`) или смешивании флагов режимов, обнаруженных после чтения `base:.acceptbox.toml`; если пустой каталог `--out` был создан текущим запуском, он удаляется;
|
|
172
|
+
- во всех остальных случаях кода `2` после захвата `--out` (включая `config-invalid`, `witnessbox-missing`, `witnessbox-incompatible`, `gate-error`) отчёт записывается атомарно, а путь к нему печатается в `stderr`.
|
|
173
|
+
|
|
174
|
+
Подробнее о подключении проекта см. [docs/onboarding.md](docs/onboarding.md) и журнал решений [docs/decisions.md](docs/decisions.md).
|
|
175
|
+
|
|
176
|
+
## Разработка и сборка
|
|
177
|
+
|
|
178
|
+
```sh
|
|
179
|
+
python3 -m unittest discover -s tests
|
|
180
|
+
uv build
|
|
181
|
+
```
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling>=1.27"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "acceptbox"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Независимая приёмка коммитов base → repro → head в режимах command и WitnessBox"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = "MIT"
|
|
11
|
+
requires-python = ">=3.11"
|
|
12
|
+
dependencies = []
|
|
13
|
+
classifiers = [
|
|
14
|
+
"Development Status :: 4 - Beta",
|
|
15
|
+
"Environment :: Console",
|
|
16
|
+
"License :: OSI Approved :: MIT License",
|
|
17
|
+
"Programming Language :: Python :: 3",
|
|
18
|
+
"Programming Language :: Python :: 3.11",
|
|
19
|
+
"Programming Language :: Python :: 3.12",
|
|
20
|
+
"Programming Language :: Python :: 3.13",
|
|
21
|
+
"Topic :: Software Development :: Testing",
|
|
22
|
+
]
|
|
23
|
+
|
|
24
|
+
[project.scripts]
|
|
25
|
+
acceptbox = "acceptbox.cli:main"
|
|
26
|
+
|
|
27
|
+
[tool.hatch.build.targets.wheel]
|
|
28
|
+
packages = ["src/acceptbox"]
|
|
29
|
+
|
|
30
|
+
[tool.hatch.build.targets.sdist]
|
|
31
|
+
include = ["/src/acceptbox", "/README.md", "/LICENSE", "/pyproject.toml"]
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"""AcceptBox: независимая приёмка коммитов base → repro → head."""
|
|
2
|
+
|
|
3
|
+
from importlib.metadata import PackageNotFoundError, version
|
|
4
|
+
|
|
5
|
+
try:
|
|
6
|
+
__version__ = version("acceptbox")
|
|
7
|
+
except PackageNotFoundError: # запуск из исходников (PYTHONPATH=src) без установленного пакета
|
|
8
|
+
__version__ = "0.1.0"
|