ohos-devloop 0.1.2__py3-none-any.whl
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.
- ohos_devloop/__init__.py +2 -0
- ohos_devloop/_version.py +24 -0
- ohos_devloop/agents/skills/collab-delegate/SKILL.md +79 -0
- ohos_devloop/agents/skills/loop-iterate/SKILL.md +54 -0
- ohos_devloop/agents/skills/openharmony-ci/SKILL.md +71 -0
- ohos_devloop/agents/skills/openharmony-ci/agents/openai.yaml +4 -0
- ohos_devloop/agents/skills/openharmony-ci/scripts/openharmony_ci.py +520 -0
- ohos_devloop/agents/skills/pool-status/SKILL.md +47 -0
- ohos_devloop/config/e2e-cases.yaml +31 -0
- ohos_devloop/config/e2e-hap.yaml +54 -0
- ohos_devloop/config/inventory-template.yaml +35 -0
- ohos_devloop/config/inventory.yaml +68 -0
- ohos_devloop/config/report-templates/analysis-report.md +48 -0
- ohos_devloop/config/report-templates/impl-report.md +47 -0
- ohos_devloop/config/task-template.md +21 -0
- ohos_devloop/config/tdd-board.yaml +31 -0
- ohos_devloop/config/tdd-coverage.yaml +47 -0
- ohos_devloop/config/tdd-emulator.yaml +36 -0
- ohos_devloop/config/tdd-host.yaml +26 -0
- ohos_devloop/config/tdd-suites.yaml +34 -0
- ohos_devloop/config/templates/agents-user.md +11 -0
- ohos_devloop/config/templates/quickstart.md +82 -0
- ohos_devloop/config/verify.yaml +45 -0
- ohos_devloop/examples/anchor-e2e.yaml +55 -0
- ohos_devloop/examples/assert-smoke.yaml +33 -0
- ohos_devloop/examples/diffcov-fixture/cov.json +6688 -0
- ohos_devloop/examples/diffcov-fixture/diff.txt +24 -0
- ohos_devloop/examples/diffcov-smoke.yaml +32 -0
- ohos_devloop/examples/e2e-emu-smoke.yaml +45 -0
- ohos_devloop/examples/layout-fixture.norm.json +1 -0
- ohos_devloop/examples/smoke.yaml +27 -0
- ohos_devloop/ohos_cli.py +131 -0
- ohos_devloop/scripts/agent-run-v3.sh +149 -0
- ohos_devloop/scripts/apply.py +1448 -0
- ohos_devloop/scripts/check_env.py +284 -0
- ohos_devloop/scripts/collab.py +303 -0
- ohos_devloop/scripts/diffcov.py +211 -0
- ohos_devloop/scripts/flash.py +511 -0
- ohos_devloop/scripts/mount_ws.py +192 -0
- ohos_devloop/scripts/release.py +2645 -0
- ohos_devloop/scripts/release_audit.py +260 -0
- ohos_devloop/scripts/release_metadata.py +397 -0
- ohos_devloop/scripts/release_smoke.py +287 -0
- ohos_devloop/scripts/report_draft.py +234 -0
- ohos_devloop/scripts/server_init.py +310 -0
- ohos_devloop/scripts/sgrep.py +82 -0
- ohos_devloop/scripts/sign_hap.py +256 -0
- ohos_devloop/scripts/telemetry.py +260 -0
- ohos_devloop/scripts/ui_probe.py +396 -0
- ohos_devloop/scripts/verify_frame_diff.py +138 -0
- ohos_devloop/scripts/ws_init.py +131 -0
- ohos_devloop/scripts/wsroot.py +192 -0
- ohos_devloop-0.1.2.dist-info/METADATA +177 -0
- ohos_devloop-0.1.2.dist-info/RECORD +58 -0
- ohos_devloop-0.1.2.dist-info/WHEEL +5 -0
- ohos_devloop-0.1.2.dist-info/entry_points.txt +2 -0
- ohos_devloop-0.1.2.dist-info/licenses/LICENSE +202 -0
- ohos_devloop-0.1.2.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,287 @@
|
|
|
1
|
+
#!/usr/bin/env python3
|
|
2
|
+
# -*- coding: utf-8 -*-
|
|
3
|
+
"""release_smoke.py —— 给定 wheel 的真实安装态 smoke 公共 runner(Phase 5,库 + CLI)。
|
|
4
|
+
|
|
5
|
+
语义(05-01 D-02/T-5-03,Pitfall 8 收口):
|
|
6
|
+
- 输入是明确的归档 wheel:安装前后都校验 SHA256(与调用方预期一致),runner 绝不调用任何
|
|
7
|
+
构建函数(build 只允许存在于测试 fixture 的自备输入层)。
|
|
8
|
+
- 真实链:干净 venv → pip install → 无关 cwd version → init(带空格工作区 + 假 home)→
|
|
9
|
+
check-env --offline 核心集 → site-packages 零用户数据 → 维护者 inventory 注入 + SSH
|
|
10
|
+
BatchMode 预检 → 真实 examples/smoke.yaml run(三步 results.json + outcome=ok)。
|
|
11
|
+
- 返回结构化 {ok, executed, skipped, failures, evidence, ...}:
|
|
12
|
+
- 普通测试环境(strict=False):环境缺项映射为 skipped(G-11 语义由调用方决定 skipTest);
|
|
13
|
+
- 发布硬门(strict=True,release.py 调用):任何 skipped 非空或 failures 非空 → ok=False
|
|
14
|
+
——绝不把 skip 当发布绿。
|
|
15
|
+
- 证据落 evidence 目录(smoke-report.json),只记步骤/结果/哈希,不记凭据。
|
|
16
|
+
|
|
17
|
+
CLI:
|
|
18
|
+
python ohos_devloop/scripts/release_smoke.py --wheel <wheel> --evidence <dir> \
|
|
19
|
+
[--expected-sha256 <hex>] [--strict]
|
|
20
|
+
退出码:0=全绿 1=smoke 失败(strict 下环境缺项同此) 2=用法错误
|
|
21
|
+
"""
|
|
22
|
+
from __future__ import annotations
|
|
23
|
+
|
|
24
|
+
import argparse
|
|
25
|
+
import hashlib
|
|
26
|
+
import json
|
|
27
|
+
import os
|
|
28
|
+
import subprocess
|
|
29
|
+
import sys
|
|
30
|
+
import tempfile
|
|
31
|
+
import zipfile
|
|
32
|
+
from datetime import datetime
|
|
33
|
+
from pathlib import Path
|
|
34
|
+
|
|
35
|
+
import yaml
|
|
36
|
+
|
|
37
|
+
REPO = Path(__file__).resolve().parents[2] # 实际执行脚本所在仓根(与 release.REPO 同源锚定)
|
|
38
|
+
MAINTAINER_INVENTORY = Path("config") / "inventory.yaml" # 相对 REPO:gitignored 维护者覆写位
|
|
39
|
+
# check-env 核心必绿集(D-09;test_installed_smoke 同款字面)
|
|
40
|
+
CORE_CHECK_ENV_ITEMS = ("Python + PyYAML", "inventory.yaml 可解析",
|
|
41
|
+
"config/e2e-cases.yaml", "config/tdd-suites.yaml")
|
|
42
|
+
SMOKE_STEPS = ("local-echo", "write-marker", "server-echo") # examples/smoke.yaml 按 spec 序
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
class SmokeError(Exception):
|
|
46
|
+
"""用法/编程错误(可预期失败走 failures 列表,不以此异常表达)。"""
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
def _now_iso() -> str:
|
|
50
|
+
return datetime.now().astimezone().isoformat(timespec="seconds")
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
def sha256_file(p: Path) -> str:
|
|
54
|
+
h = hashlib.sha256()
|
|
55
|
+
with p.open("rb") as f:
|
|
56
|
+
for chunk in iter(lambda: f.read(1 << 16), b""):
|
|
57
|
+
h.update(chunk)
|
|
58
|
+
return h.hexdigest()
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
def wheel_metadata_version(wheel: Path) -> str:
|
|
62
|
+
"""读 wheel .dist-info/METADATA 的 Version 行(test_installed_smoke 同款,不引 packaging)。"""
|
|
63
|
+
with zipfile.ZipFile(wheel) as z:
|
|
64
|
+
meta = next((n for n in z.namelist() if n.endswith(".dist-info/METADATA")), None)
|
|
65
|
+
if meta is None:
|
|
66
|
+
raise SmokeError(f"wheel 缺 .dist-info/METADATA 条目: {wheel.name}")
|
|
67
|
+
text = z.read(meta).decode("utf-8", errors="replace")
|
|
68
|
+
for line in text.splitlines():
|
|
69
|
+
if line.lower().startswith("version:"):
|
|
70
|
+
return line.split(":", 1)[1].strip()
|
|
71
|
+
raise SmokeError(f"METADATA 缺 Version 行: {wheel.name}")
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
def _run(argv: list[str], *, cwd: Path | None = None, env: dict | None = None,
|
|
75
|
+
timeout: int = 300) -> subprocess.CompletedProcess:
|
|
76
|
+
return subprocess.run([str(a) for a in argv], cwd=None if cwd is None else str(cwd),
|
|
77
|
+
env=env, capture_output=True, text=True,
|
|
78
|
+
encoding="utf-8", errors="replace", timeout=timeout)
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
def run_smoke(wheel: Path, evidence: Path, expected_sha256: str = "",
|
|
82
|
+
strict: bool = False, base_dir: Path | None = None) -> dict:
|
|
83
|
+
"""给定 wheel 的真实安装态 smoke。
|
|
84
|
+
|
|
85
|
+
返回 {ok, executed, skipped, failures, evidence, wheel, version,
|
|
86
|
+
sha256_before, sha256_after, handles};strict=True 时 skipped 非空即
|
|
87
|
+
ok=False(发布硬门:环境缺失是 FAIL,不是 skip)。
|
|
88
|
+
base_dir:调用方提供的装配基目录(不清理)——测试 fixture 借 handles 继续断言
|
|
89
|
+
venv/ws/pkg_root 等留档;None 时用内部临时目录并在返回前清理。
|
|
90
|
+
handles:装配环境句柄(venv_py/cli/ws/ws_smoke/pkg_root/unrelated/fake_home +
|
|
91
|
+
inventory_present/ssh_ok 环境判定),供普通 unittest 把环境缺项映射为 skipTest。
|
|
92
|
+
"""
|
|
93
|
+
wheel, evidence = Path(wheel), Path(evidence)
|
|
94
|
+
executed: list[str] = []
|
|
95
|
+
skipped: list[dict] = []
|
|
96
|
+
failures: list[str] = []
|
|
97
|
+
handles: dict = {}
|
|
98
|
+
version = ""
|
|
99
|
+
sha_before = sha_after = ""
|
|
100
|
+
started = _now_iso()
|
|
101
|
+
|
|
102
|
+
def _finish(ok: bool) -> dict:
|
|
103
|
+
report = {
|
|
104
|
+
"wheel": str(wheel), "version": version, "strict": strict,
|
|
105
|
+
"started": started, "ended": _now_iso(),
|
|
106
|
+
"executed": executed, "skipped": skipped, "failures": failures,
|
|
107
|
+
"sha256_before": sha_before, "sha256_after": sha_after,
|
|
108
|
+
"handles": handles,
|
|
109
|
+
"outcome": "ok" if ok else "fail",
|
|
110
|
+
}
|
|
111
|
+
try:
|
|
112
|
+
evidence.mkdir(parents=True, exist_ok=True)
|
|
113
|
+
(evidence / "smoke-report.json").write_text(
|
|
114
|
+
json.dumps(report, ensure_ascii=False, indent=2), encoding="utf-8")
|
|
115
|
+
except OSError as e:
|
|
116
|
+
failures.append(f"证据写盘失败(不影响判定): {e}")
|
|
117
|
+
report["evidence"] = str(evidence)
|
|
118
|
+
report["ok"] = ok
|
|
119
|
+
return report
|
|
120
|
+
|
|
121
|
+
if not wheel.is_file():
|
|
122
|
+
failures.append(f"wheel 文件不存在: {wheel}")
|
|
123
|
+
return _finish(False)
|
|
124
|
+
sha_before = sha256_file(wheel)
|
|
125
|
+
if expected_sha256 and sha_before != expected_sha256:
|
|
126
|
+
failures.append(f"输入 wheel SHA256 与预期不符(装前 {sha_before} != 预期 {expected_sha256})"
|
|
127
|
+
"——审计/安装/发布必须绑定同一字节")
|
|
128
|
+
try:
|
|
129
|
+
version = wheel_metadata_version(wheel)
|
|
130
|
+
except (SmokeError, zipfile.BadZipFile, OSError) as e:
|
|
131
|
+
failures.append(f"wheel METADATA 不可读: {e}")
|
|
132
|
+
return _finish(False)
|
|
133
|
+
|
|
134
|
+
tmp = tempfile.TemporaryDirectory(prefix="release-smoke-") if base_dir is None else None
|
|
135
|
+
try:
|
|
136
|
+
base = Path(base_dir) if base_dir is not None else Path(tmp.name)
|
|
137
|
+
# 1) 干净 venv
|
|
138
|
+
venv = base / "venv"
|
|
139
|
+
p = _run([sys.executable, "-m", "venv", str(venv)], timeout=300)
|
|
140
|
+
if p.returncode != 0:
|
|
141
|
+
failures.append(f"venv 创建失败: {p.stderr[:300]}")
|
|
142
|
+
return _finish(False)
|
|
143
|
+
executed.append("venv")
|
|
144
|
+
bindir = venv / ("Scripts" if os.name == "nt" else "bin")
|
|
145
|
+
exe = ".exe" if os.name == "nt" else ""
|
|
146
|
+
venv_py, cli = bindir / f"python{exe}", bindir / f"ohos-devloop{exe}"
|
|
147
|
+
handles.update({"venv_py": str(venv_py), "cli": str(cli)})
|
|
148
|
+
# 2) 安装归档 wheel(依赖走公开 PyPI,A3 既有约定)
|
|
149
|
+
p = _run([venv_py, "-m", "pip", "install", str(wheel),
|
|
150
|
+
"--quiet", "--disable-pip-version-check"], timeout=600)
|
|
151
|
+
if p.returncode != 0:
|
|
152
|
+
failures.append(f"pip install 失败(rc={p.returncode}): {(p.stdout + p.stderr)[:500]}")
|
|
153
|
+
return _finish(False)
|
|
154
|
+
executed.append("install")
|
|
155
|
+
unrelated = base / "unrelated-cwd"
|
|
156
|
+
unrelated.mkdir()
|
|
157
|
+
fake_home = base / "fake-home" # G-7:init 展开技能到用户级目录,须重定向
|
|
158
|
+
fake_home.mkdir()
|
|
159
|
+
handles.update({"unrelated": str(unrelated), "fake_home": str(fake_home)})
|
|
160
|
+
ws = base / "ws with spaces" # D-06:工作区目录名带空格
|
|
161
|
+
env_home = {**os.environ, "USERPROFILE": str(fake_home), "HOME": str(fake_home)}
|
|
162
|
+
# 3) 安装态 version(无关 cwd;== wheel METADATA Version)
|
|
163
|
+
p = _run([cli, "version"], cwd=unrelated, timeout=120)
|
|
164
|
+
if p.returncode != 0 or p.stdout.strip() != version:
|
|
165
|
+
failures.append(f"安装态 version 不符: {p.stdout.strip()!r} != METADATA {version!r}"
|
|
166
|
+
f"(stderr: {p.stderr[:200]})")
|
|
167
|
+
else:
|
|
168
|
+
executed.append("version")
|
|
169
|
+
# 4) init 工作区(带空格 + 假 home)
|
|
170
|
+
p = _run([cli, "init", str(ws)], env=env_home, timeout=120)
|
|
171
|
+
if p.returncode != 0:
|
|
172
|
+
failures.append(f"init 失败(rc={p.returncode}): {p.stderr[:300]}")
|
|
173
|
+
else:
|
|
174
|
+
executed.append("init")
|
|
175
|
+
handles["ws"] = str(ws)
|
|
176
|
+
# 5) check-env --offline 核心集(cwd=工作区)
|
|
177
|
+
if "init" in executed:
|
|
178
|
+
p = _run([cli, "check-env", "--offline"], cwd=ws, timeout=300)
|
|
179
|
+
missing = [i for i in CORE_CHECK_ENV_ITEMS if f"[PASS] {i}" not in p.stdout]
|
|
180
|
+
if p.returncode != 0 or missing:
|
|
181
|
+
failures.append(f"check-env 核心集未全绿(rc={p.returncode},缺 {missing})")
|
|
182
|
+
else:
|
|
183
|
+
executed.append("check-env")
|
|
184
|
+
# 6) site-packages 零用户数据(SC3)
|
|
185
|
+
pkg_root = Path(_run(
|
|
186
|
+
[venv_py, "-c",
|
|
187
|
+
"import ohos_devloop, pathlib; print(pathlib.Path(ohos_devloop.__file__).parent)"],
|
|
188
|
+
cwd=unrelated, timeout=120).stdout.strip())
|
|
189
|
+
leaked = [n for n in ("runs", "tasks", "workspace_pool.yaml") if (pkg_root / n).exists()]
|
|
190
|
+
if leaked:
|
|
191
|
+
failures.append(f"用户数据泄漏进 site-packages: {leaked}")
|
|
192
|
+
else:
|
|
193
|
+
executed.append("site-packages-clean")
|
|
194
|
+
handles["pkg_root"] = str(pkg_root)
|
|
195
|
+
# 7) 维护者 inventory 注入 + SSH 预检 + 真实 smoke run
|
|
196
|
+
if "init" in executed:
|
|
197
|
+
ws_smoke = base / "ws-smoke"
|
|
198
|
+
p = _run([cli, "init", str(ws_smoke)], env=env_home, timeout=120)
|
|
199
|
+
if p.returncode != 0:
|
|
200
|
+
failures.append(f"smoke 工作区 init 失败(rc={p.returncode}): {p.stderr[:300]}")
|
|
201
|
+
else:
|
|
202
|
+
handles["ws_smoke"] = str(ws_smoke)
|
|
203
|
+
maint = REPO / MAINTAINER_INVENTORY
|
|
204
|
+
handles["inventory_present"] = maint.is_file()
|
|
205
|
+
if maint.is_file():
|
|
206
|
+
(ws_smoke / "config").mkdir(parents=True, exist_ok=True)
|
|
207
|
+
(ws_smoke / "config" / "inventory.yaml").write_bytes(maint.read_bytes())
|
|
208
|
+
try:
|
|
209
|
+
inv = yaml.safe_load(
|
|
210
|
+
(ws_smoke / "config" / "inventory.yaml").read_text(encoding="utf-8"))
|
|
211
|
+
srv = next(iter((inv or {}).get("servers", {}).values()))
|
|
212
|
+
except (yaml.YAMLError, StopIteration, TypeError) as e:
|
|
213
|
+
failures.append(f"维护者 inventory 不可解析/无 servers 条目: {e}")
|
|
214
|
+
srv = None
|
|
215
|
+
if srv is not None:
|
|
216
|
+
probe = _run(["ssh", "-o", "BatchMode=yes", "-o", "ConnectTimeout=15",
|
|
217
|
+
"-p", str(srv.get("port", 22)),
|
|
218
|
+
f"{srv['user']}@{srv['host']}", "echo ok"], timeout=60)
|
|
219
|
+
handles["ssh_ok"] = probe.returncode == 0 and "ok" in probe.stdout
|
|
220
|
+
if not handles["ssh_ok"]:
|
|
221
|
+
skipped.append({"step": "smoke-run",
|
|
222
|
+
"reason": "服务器不可达(SSH BatchMode 预检失败)"})
|
|
223
|
+
else:
|
|
224
|
+
p = _run([cli, "apply", "examples/smoke.yaml", "run"],
|
|
225
|
+
cwd=unrelated,
|
|
226
|
+
env={**os.environ, "OHOS_WS": str(ws_smoke)}, timeout=600)
|
|
227
|
+
if p.returncode != 0:
|
|
228
|
+
failures.append(f"smoke run 失败(rc={p.returncode}): "
|
|
229
|
+
f"{(p.stdout + p.stderr)[:500]}")
|
|
230
|
+
else:
|
|
231
|
+
ok_run = all(n in p.stdout for n in SMOKE_STEPS)
|
|
232
|
+
run_dirs = [d for d in (ws_smoke / "runs").iterdir()
|
|
233
|
+
if d.is_dir()] if (ws_smoke / "runs").is_dir() else []
|
|
234
|
+
if not ok_run or not run_dirs:
|
|
235
|
+
failures.append("smoke run 输出缺步骤名或 runs/ 无 run 目录")
|
|
236
|
+
else:
|
|
237
|
+
latest = max(run_dirs, key=lambda d: d.stat().st_mtime)
|
|
238
|
+
data = json.loads(
|
|
239
|
+
(latest / "results.json").read_text(encoding="utf-8"))
|
|
240
|
+
if ([s["name"] for s in data["steps"]] != list(SMOKE_STEPS)
|
|
241
|
+
or data.get("outcome") != "ok"):
|
|
242
|
+
failures.append(
|
|
243
|
+
f"results.json 不符: 步骤 {[s['name'] for s in data['steps']]} "
|
|
244
|
+
f"outcome={data.get('outcome')}")
|
|
245
|
+
else:
|
|
246
|
+
executed.append("smoke-run")
|
|
247
|
+
else:
|
|
248
|
+
skipped.append({"step": "smoke-run",
|
|
249
|
+
"reason": f"维护者 inventory 覆写位缺席({MAINTAINER_INVENTORY})"})
|
|
250
|
+
# 8) 装后哈希(runner 绝不修改输入)
|
|
251
|
+
sha_after = sha256_file(wheel)
|
|
252
|
+
if sha_after != sha_before:
|
|
253
|
+
failures.append(f"输入 wheel 哈希在 smoke 后改变({sha_before} → {sha_after})")
|
|
254
|
+
finally:
|
|
255
|
+
if tmp is not None: # base_dir 模式:装配产物归调用方管理,不清理
|
|
256
|
+
tmp.cleanup()
|
|
257
|
+
ok = not failures and (not strict or not skipped)
|
|
258
|
+
return _finish(ok)
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
def main(argv: list[str] | None = None) -> int:
|
|
262
|
+
try:
|
|
263
|
+
sys.stdout.reconfigure(encoding="utf-8", errors="replace")
|
|
264
|
+
sys.stderr.reconfigure(encoding="utf-8", errors="replace")
|
|
265
|
+
except Exception:
|
|
266
|
+
pass
|
|
267
|
+
ap = argparse.ArgumentParser(
|
|
268
|
+
description="给定 wheel 的真实安装态 smoke(干净 venv → init → check-env 核心集 → 真实 smoke run)")
|
|
269
|
+
ap.add_argument("--wheel", required=True, help="输入 wheel 路径(归档正本;runner 不构建)")
|
|
270
|
+
ap.add_argument("--evidence", required=True, help="证据输出目录(smoke-report.json)")
|
|
271
|
+
ap.add_argument("--expected-sha256", default="", help="预期 SHA256(装前/装后都校验)")
|
|
272
|
+
ap.add_argument("--strict", action="store_true",
|
|
273
|
+
help="发布硬门:环境缺项/未执行步骤一律 FAIL(不降级为 skip)")
|
|
274
|
+
args = ap.parse_args(argv if argv is not None else None)
|
|
275
|
+
result = run_smoke(Path(args.wheel), Path(args.evidence), args.expected_sha256, args.strict)
|
|
276
|
+
for name in result["executed"]:
|
|
277
|
+
print(f"PASS {name}")
|
|
278
|
+
for s in result["skipped"]:
|
|
279
|
+
print(f"SKIP {s['step']}: {s['reason']}")
|
|
280
|
+
for f in result["failures"]:
|
|
281
|
+
print(f"FAIL {f}")
|
|
282
|
+
print(f"outcome: {result['outcome']}(evidence: {result['evidence']})")
|
|
283
|
+
return 0 if result["ok"] else 1
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
if __name__ == "__main__":
|
|
287
|
+
sys.exit(main())
|
|
@@ -0,0 +1,234 @@
|
|
|
1
|
+
#!/usr/bin/env python3
|
|
2
|
+
# -*- coding: utf-8 -*-
|
|
3
|
+
"""交付报告 draft 自动汇编(ROADMAP M3):任务契约 + 调度器 run 档案 → 报告草稿。
|
|
4
|
+
|
|
5
|
+
用法:
|
|
6
|
+
ohos-devloop report <task-id> [--type analysis|impl] [--runs id1,id2] [--out <path>]
|
|
7
|
+
# 缺省:type=impl;runs 读 tasks/<tid>/runs.txt(loop-iterate 每轮把 run-id 追加进去);
|
|
8
|
+
# 输出 tasks/<tid>/report-draft.md
|
|
9
|
+
|
|
10
|
+
数据源(有什么汇编什么,缺的留 TODO):
|
|
11
|
+
tasks/<tid>/task.md goal/现象/预期/复现(契约头 + 章节切分)
|
|
12
|
+
tasks/<tid>/status.json worker 侧 status/commits/branch/files/build/tdd/iterations
|
|
13
|
+
tasks/<tid>/report.md worker 执行报告(引用不内联)
|
|
14
|
+
tasks/<tid>/artifacts.txt 部署产物清单
|
|
15
|
+
runs/<id>/results.json 每步结果(tdd/assert/hap 关键数字展开)+ evidence/ 文件清单
|
|
16
|
+
collab.py close 成功后自动调用本脚本;也可独立运行(补汇编/重汇编)。
|
|
17
|
+
"""
|
|
18
|
+
import argparse
|
|
19
|
+
import datetime
|
|
20
|
+
import json
|
|
21
|
+
import re
|
|
22
|
+
import sys
|
|
23
|
+
from pathlib import Path
|
|
24
|
+
|
|
25
|
+
import wsroot # 工作区解析(M6):任务/run 档案归工作区,报告模板可工作区覆写
|
|
26
|
+
|
|
27
|
+
BASE = wsroot.PKG
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
def tasks_root() -> Path:
|
|
31
|
+
"""tasks 留档根(写锚点):调用点经 require_ws() 求值,绝不 import 期(02-02 惰性锚点)。"""
|
|
32
|
+
return wsroot.require_ws() / "tasks"
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
def runs_root() -> Path:
|
|
36
|
+
"""runs 档案根(写锚点):与 tasks_root 同款。"""
|
|
37
|
+
return wsroot.require_ws() / "runs"
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
def rd(p: Path) -> str:
|
|
41
|
+
return p.read_text(encoding="utf-8", errors="replace") if p.is_file() else ""
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
def parse_task_md(text: str) -> dict:
|
|
45
|
+
"""契约头(--- 前 key: value)+ 章节正文。"""
|
|
46
|
+
header: dict = {}
|
|
47
|
+
lines = text.splitlines()
|
|
48
|
+
for ln in lines:
|
|
49
|
+
if not ln.strip():
|
|
50
|
+
continue
|
|
51
|
+
if ln.startswith("#") or ln.startswith("## "):
|
|
52
|
+
break
|
|
53
|
+
m = re.match(r"^([A-Za-z_][\w]*)\s*:\s*(.*)$", ln)
|
|
54
|
+
if m:
|
|
55
|
+
header[m.group(1).lower()] = m.group(2).strip()
|
|
56
|
+
sections, cur = {}, "_head"
|
|
57
|
+
for ln in lines:
|
|
58
|
+
m = re.match(r"^##\s+(.*)$", ln)
|
|
59
|
+
if m:
|
|
60
|
+
cur = m.group(1).strip()
|
|
61
|
+
sections[cur] = []
|
|
62
|
+
elif cur in sections:
|
|
63
|
+
sections[cur].append(ln)
|
|
64
|
+
out = {k: "\n".join(v).strip() for k, v in sections.items()}
|
|
65
|
+
out["_header"] = header
|
|
66
|
+
return out
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
def section(tm: dict, key_prefix: str, fallback_todo: str) -> str:
|
|
70
|
+
for k, v in tm.items():
|
|
71
|
+
if k.startswith(key_prefix) and v:
|
|
72
|
+
return v
|
|
73
|
+
return f"<TODO:{fallback_todo}>"
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
def fmt_step(rec: dict) -> str:
|
|
77
|
+
"""results.json 单步 → 一行摘要(tdd/assert 展开关键数字)。"""
|
|
78
|
+
name, typ, st, d = rec.get("name"), rec.get("type"), rec.get("status"), rec.get("detail") or {}
|
|
79
|
+
line = f"| {name} | {typ} | {st} |"
|
|
80
|
+
if typ in ("tdd_host", "tdd_board"):
|
|
81
|
+
parts = []
|
|
82
|
+
for t in d.get("targets") or []:
|
|
83
|
+
p = f"{t['target']}:{t['passed']}过/{t['failed']}败"
|
|
84
|
+
if t.get("expected"):
|
|
85
|
+
p += f"(钉 {t['expected']})"
|
|
86
|
+
if t.get("filter"):
|
|
87
|
+
p += f" [{t['filter']}]"
|
|
88
|
+
parts.append(p)
|
|
89
|
+
return line + " " + ";".join(parts) + " |"
|
|
90
|
+
if typ == "assert":
|
|
91
|
+
a = d.get("assertions") or []
|
|
92
|
+
return line + f" {d.get('passed', 0)}/{len(a)} 断言过 |"
|
|
93
|
+
if typ == "capture":
|
|
94
|
+
return line + f" {d.get('evidence', 0)} 份证据 |"
|
|
95
|
+
if typ == "push":
|
|
96
|
+
return line + f" 推 {len(d.get('pushed') or [])} 个产物(备份 {d.get('backed_up', 0)}) |"
|
|
97
|
+
if typ == "hap_install":
|
|
98
|
+
return line + f" {d.get('bundle', '')} |"
|
|
99
|
+
if typ == "app_run":
|
|
100
|
+
return line + f" process={d.get('process')} |"
|
|
101
|
+
if typ == "board_preflight":
|
|
102
|
+
return line + f" {d.get('version', '')} |"
|
|
103
|
+
return line
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
def collect_run(rid: str) -> dict:
|
|
107
|
+
rdir = runs_root() / rid
|
|
108
|
+
rj = rdir / "results.json"
|
|
109
|
+
if not rj.is_file():
|
|
110
|
+
return {"id": rid, "missing": True}
|
|
111
|
+
d = json.loads(rd(rj))
|
|
112
|
+
steps = [fmt_step(s) for s in d.get("steps") or []]
|
|
113
|
+
ev_dir = rdir / "evidence"
|
|
114
|
+
ev = [f"evidence/{p.name}" for p in sorted(ev_dir.iterdir()) if p.is_file()] if ev_dir.is_dir() else []
|
|
115
|
+
tdd_logs = [f"tdd_board/{p.name}" for p in sorted((rdir / "tdd_board").glob("*.log"))] \
|
|
116
|
+
if (rdir / "tdd_board").is_dir() else []
|
|
117
|
+
return {"id": rid, "outcome": d.get("outcome"), "steps": steps,
|
|
118
|
+
"tool": d.get("tool_version") or "", "evidence": ev + tdd_logs, "dir": posix(rdir)}
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
def posix(p) -> str:
|
|
122
|
+
return str(p).replace("\\", "/")
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
def assemble(tid: str, rtype: str, run_ids: list[str]) -> str:
|
|
126
|
+
T = tasks_root() / tid
|
|
127
|
+
tm = parse_task_md(rd(T / "task.md"))
|
|
128
|
+
sj = json.loads(rd(T / "status.json")) if (T / "status.json").is_file() else {}
|
|
129
|
+
header = tm.get("_header") or {}
|
|
130
|
+
|
|
131
|
+
# ---- 事实字段
|
|
132
|
+
goal = header.get("goal") or "<TODO:goal>"
|
|
133
|
+
commits = sj.get("commits") or []
|
|
134
|
+
commits_s = ", ".join(commits) if isinstance(commits, list) else str(commits or "无")
|
|
135
|
+
branch = sj.get("branch") or "(无分支信息)"
|
|
136
|
+
files = sj.get("files") or []
|
|
137
|
+
files_s = "\n".join(f"- {f}" for f in files) if files else \
|
|
138
|
+
"<TODO:改动文件清单(status.json 未回收?先 collab.py fetch)>"
|
|
139
|
+
iter_n = sj.get("iterations", "?")
|
|
140
|
+
dv = "设备侧验证通过 ✔" if sj.get("device_verified") else \
|
|
141
|
+
"<TODO:尚未标记 device_verified(close 时自动标记)>"
|
|
142
|
+
refs = [x for x in [header.get("pr", ""), header.get("issue", ""), header.get("ref", "")] if x]
|
|
143
|
+
|
|
144
|
+
# worker 执行报告
|
|
145
|
+
wrep = T / "report.md"
|
|
146
|
+
wrep_s = f"`tasks/{tid}/report.md`" if wrep.is_file() else \
|
|
147
|
+
"<TODO:worker 报告未回收(collab.py fetch)>"
|
|
148
|
+
|
|
149
|
+
# 部署产物
|
|
150
|
+
art = [l for l in rd(T / "artifacts.txt").splitlines() if l.strip() and not l.startswith("#")]
|
|
151
|
+
art_s = "\n".join(f"- `{a}`" for a in art) if art else "(无部署产物;纯测试/文档改动)"
|
|
152
|
+
|
|
153
|
+
# ---- 验证(runs 档案)
|
|
154
|
+
runs = [collect_run(r) for r in run_ids]
|
|
155
|
+
vparts = []
|
|
156
|
+
for r in runs:
|
|
157
|
+
if r.get("missing"):
|
|
158
|
+
vparts.append(f"- run `{r['id']}`:results.json 缺失(目录被清?)")
|
|
159
|
+
continue
|
|
160
|
+
vparts.append(f"### run `{r['id']}` → outcome={r['outcome']}"
|
|
161
|
+
+ (f"(工具 {r['tool']})" if r.get("tool") else "")
|
|
162
|
+
+ "\n\n"
|
|
163
|
+
"| 步骤 | 类型 | 结果 | 关键数据 |\n|---|---|---|---|\n"
|
|
164
|
+
+ "\n".join(r["steps"]))
|
|
165
|
+
verif = "\n".join(vparts) if vparts else \
|
|
166
|
+
"<TODO:无 run 档案(runs.txt 未登记?或纯人工验证——写明验证方式与结果)>"
|
|
167
|
+
|
|
168
|
+
ev_files = []
|
|
169
|
+
for r in runs:
|
|
170
|
+
ev_files += [f"- `runs/{r['id']}/{e}`" for e in r.get("evidence", [])]
|
|
171
|
+
ev_s = "\n".join(ev_files) if ev_files else "<TODO:证据文件清单>"
|
|
172
|
+
|
|
173
|
+
# ---- 模板填充(工作区可覆写包缺省模板)
|
|
174
|
+
tpl = rd(wsroot.config_dir("report-templates") /
|
|
175
|
+
("analysis-report.md" if rtype == "analysis" else "impl-report.md"))
|
|
176
|
+
common = {
|
|
177
|
+
"TASK_ID": tid, "GOAL": goal, "DATE": datetime.date.today().isoformat(),
|
|
178
|
+
"COLLAB_STATUS": sj.get("status") or "(status.json 缺)",
|
|
179
|
+
"ITERATIONS": str(iter_n), "DEVICE_VERIFIED": dv,
|
|
180
|
+
"BRANCH_COMMITS": f"`{branch}` @ {commits_s}",
|
|
181
|
+
"FILES": files_s, "VERIFICATION": verif, "EVIDENCE": ev_s,
|
|
182
|
+
"REFERENCES": "\n".join(f"- {r}" for r in refs) or "<TODO:PR/issue/上游链接>",
|
|
183
|
+
"WORKER_REPORT_LINK": wrep_s, "DEPLOY_ARTIFACTS": art_s,
|
|
184
|
+
"SYMPTOM": section(tm, "现象", "现象描述(task.md 现象节缺失)"),
|
|
185
|
+
"REPRO": section(tm, "复现", "复现步骤(task.md 复现节缺失)"),
|
|
186
|
+
"REQUIREMENT": section(tm, "预期", "需求/验收标准(task.md 预期节缺失)"),
|
|
187
|
+
"TEST_ASSETS": "<TODO:测试资产(e2e 用例名 / TDD 套件别名,见 e2e-cases.yaml / tdd-suites.yaml)>",
|
|
188
|
+
}
|
|
189
|
+
out = tpl
|
|
190
|
+
for k, v in common.items():
|
|
191
|
+
out = out.replace("{{" + k + "}}", v)
|
|
192
|
+
left = re.findall(r"\{\{(\w+)\}\}", out)
|
|
193
|
+
for k in left:
|
|
194
|
+
out = out.replace("{{" + k + "}}", "<TODO:%s>" % k)
|
|
195
|
+
return out
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
def main() -> int:
|
|
199
|
+
ap = argparse.ArgumentParser(description="交付报告 draft 自动汇编")
|
|
200
|
+
ap.add_argument("tid")
|
|
201
|
+
ap.add_argument("--type", choices=["analysis", "impl"], default="impl",
|
|
202
|
+
help="问题分析报告 / 功能实现报告(缺省 impl)")
|
|
203
|
+
ap.add_argument("--runs", default="", help="关联 run-id,逗号分隔;缺省读 tasks/<tid>/runs.txt")
|
|
204
|
+
ap.add_argument("--out", default="", help="输出路径;缺省 tasks/<tid>/report-draft.md")
|
|
205
|
+
args = ap.parse_args()
|
|
206
|
+
|
|
207
|
+
t = tasks_root() / args.tid # runs.txt / report-draft.md 共用同一 tasks 锚点局部变量
|
|
208
|
+
if not (t / "task.md").is_file():
|
|
209
|
+
print(f"ERROR: 无 tasks/{args.tid}/task.md(collab new 过吗?)", file=sys.stderr)
|
|
210
|
+
return 2
|
|
211
|
+
run_ids = [x.strip() for x in args.runs.split(",") if x.strip()] if args.runs else \
|
|
212
|
+
[l.strip() for l in rd(t / "runs.txt").splitlines()
|
|
213
|
+
if l.strip() and not l.startswith("#")]
|
|
214
|
+
body = assemble(args.tid, args.type, run_ids)
|
|
215
|
+
out = Path(args.out) if args.out else t / "report-draft.md"
|
|
216
|
+
out.parent.mkdir(parents=True, exist_ok=True)
|
|
217
|
+
out.write_text(body, encoding="utf-8", newline="\n")
|
|
218
|
+
print(f"draft: {posix(out)} (type={args.type}, runs={len(run_ids)} 个"
|
|
219
|
+
+ ("(runs.txt 未登记,验证节为 TODO)" if not run_ids else "") + ")")
|
|
220
|
+
print("下一步:填 <TODO> 节 → 定稿改名 report-final.md")
|
|
221
|
+
return 0
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
if __name__ == "__main__":
|
|
225
|
+
try:
|
|
226
|
+
sys.stdout.reconfigure(encoding="utf-8", errors="replace")
|
|
227
|
+
except Exception:
|
|
228
|
+
pass
|
|
229
|
+
try:
|
|
230
|
+
rc = main()
|
|
231
|
+
except wsroot.WorkspaceRequiredError as e: # 安装态无工作区:引导 init,rc==2(02-02 错误出口契约)
|
|
232
|
+
print(f"ERROR: {e}", file=sys.stderr)
|
|
233
|
+
rc = 2
|
|
234
|
+
sys.exit(rc)
|