Skip to content

armgit / peach

Public Imported from GitHub
0

Peach: Local-first video metadata scraper and media manager.

fix(test): 每次运行独占临时目录,过期测试记录随签发清退

longmeidaoa699c0a2ed37
diff --git a/docs/TESTING.md b/docs/TESTING.md
index 769b885d2..29a616bc1 100644
--- a/docs/TESTING.md
+++ b/docs/TESTING.md
@@ -96,7 +96,7 @@ Release 在媒体工具编译前核对同 SHA 主线 CI,缓存键绑定媒体
需要外部前置条件(Node、ffmpeg、Chrome 等)的用例,本机缺条件时跳过,在 CI(`GITHUB_ACTIONS=true`)里判失败,判定集中在 `tests/support/conditions.py` 的 `missing_prerequisite`。所以 `python` 矩阵里 `core` 以外的行也装 Node,Windows 行另装 ffmpeg 与 Chrome。
-本机默认并行:入口传 `--jobs auto`(Windows `-Jobs`),运行器按同一套稳定分片切成并发数四倍的片,每个子进程各领一片、先完成的接着领下一片,父进程汇总成败、用例数与逐用例耗时后按原口径签发一份记录,一片红整轮红。`-Jobs 1` 退回串行。测试之间没有共享的端口或全局目录,账本与仓库夹具都在各自的临时目录里,并行才是安全的;新增测试保持这一点。
+本机默认并行:入口传 `--jobs auto`(Windows `-Jobs`),运行器按同一套稳定分片切成并发数四倍的片,每个子进程各领一片、先完成的接着领下一片,父进程汇总成败、用例数与逐用例耗时后按原口径签发一份记录,一片红整轮红。`-Jobs 1` 退回串行。测试之间没有共享的端口或全局目录,账本与仓库夹具都在各自的临时目录里,并行才是安全的;新增测试保持这一点。运行器给每次运行建一个 `peach-test-run-<时间戳>-*` 目录,把 `TEMP`、`TMP`、`TMPDIR` 与 `tempfile.tempdir` 指向它,分片子进程沿用同一个,结束时整个删除;被强行结束的运行留下的目录,在下一次运行开始时超过一天就清扫。用例仍应回收自己的临时目录,运行目录只兜底。
Windows 的路径、挂载、托盘、证书、进程编码、更新、认证及迁移属于 `core`。构建和工作流修改选择 `packaging` 与 `tooling`;测试调度自身仍全量。仅 uv 工具版本或项目展示字段变化不算依赖图变化;无法解析时全量。
@@ -192,7 +192,7 @@ Windows Release 工作流使用 `uv sync --locked --all-extras` 准备完整依
macOS Release 使用 `macos-15`(Apple Silicon)和 `macos-15-intel`(Intel)分别构建,解释器、依赖与目标架构必须一致。独立验收任务只下载候选制品与冒烟脚本,挂载只读 DMG,核对 Applications 链接、许可证、签名与原生架构,再执行 `scripts/smoke_macos.py`。该脚本将应用移到源码树外,在移除开发工具的 PATH 下验证首次设置、迁移、单机账本、登录、前端资源与配置保存,数据全部使用临时目录。所有平台验收成功才发布;普通 push 不构建安装包,手动运行 Release 不上传公开资产。
-`auto` 从同环境、24 小时内的记录计算差异:有效全量基线保留原时间戳;有效局部基线只复用未受差异影响且本次需要的域。相同代码状态补跑缺少的域。新增、删除与修改文件均参与比较;共享设施、未知影响面和环境差异不能复用局部记录。局部记录不会变成全量,继承时间戳不延长有效期。单域失败撤销该域与全量证明,保留其他域的原成功时间;失败域必须补测,不能从旧基线恢复。全量失败撤销所有证明。`-Fresh` 与显式 `full` 始终实际执行。
+`auto` 从同环境、24 小时内的记录计算差异:有效全量基线保留原时间戳;有效局部基线只复用未受差异影响且本次需要的域。相同代码状态补跑缺少的域。新增、删除与修改文件均参与比较;共享设施、未知影响面和环境差异不能复用局部记录。局部记录不会变成全量,继承时间戳不延长有效期。单域失败撤销该域与全量证明,保留其他域的原成功时间;失败域必须补测,不能从旧基线恢复。全量失败撤销所有证明。`-Fresh` 与显式 `full` 始终实际执行。每次签发记录时清退写盘超过 24 小时的记录、持锁说明与残留的半成品文件,这些记录已没有可复用的时间戳;锁文件和非记录文件不动。
选测比较文件内容:Python 只有注释或格式变化、npm 清单只有 description/keywords 变化、TOML 只有注释或格式变化时选 `checks`。Python docstring、运行时字串和类型注释属于有效内容。Python 构建元数据变化选 `packaging`,实际依赖变化、文件模式变化、解析失败和未知影响面保留完整验证。
diff --git a/scripts/test_evidence.py b/scripts/test_evidence.py
index 08bb37100..9f56922e9 100644
--- a/scripts/test_evidence.py
+++ b/scripts/test_evidence.py
@@ -38,6 +38,7 @@ def digest(value: object) -> str:
_STATE = re.compile(r"[0-9a-f]{64}")
+VALID_SECONDS = 86400
def manifest(root: Path) -> dict:
@@ -218,6 +219,27 @@ def baselines(root: Path, current: dict, *, partial: bool = False):
yield record, changed, version_only
+def prune_expired(folder: Path, now: float | None = None) -> int:
+ """清退过期的记录、持锁说明和写到一半的临时文件,返回删掉的个数。
+
+ 判据是文件修改时间超过有效期。记录里的每个时间戳都不晚于写盘时刻,所以这样的记录已经
+ 没有可复用的域或文件结果,失败记录的 `failed_scopes` 也照样保留满一个有效期。
+ `<state>.lock` 不在此列:POSIX 加锁不刷新修改时间,删掉一把正被持有的旧锁会破坏互斥。
+ """
+ now = time.time() if now is None else now
+ removed = 0
+ for path in folder.glob("*"):
+ if path.suffix not in {".json", ".tmp"} or not _STATE.fullmatch(path.name.partition(".")[0]):
+ continue
+ try:
+ if path.is_file() and now - path.stat().st_mtime >= VALID_SECONDS:
+ path.unlink()
+ removed += 1
+ except OSError:
+ continue
+ return removed
+
+
def read(root: Path, state: str) -> dict:
try:
record = json.loads((evidence_dir(root) / f"{state}.json").read_text(encoding="utf-8"))
@@ -225,9 +247,9 @@ def read(root: Path, state: str) -> dict:
return {}
if record.get("state") == state:
record["passed"] = [scope for scope, stamp in record["validated"].items()
- if isinstance(stamp, (float, int)) and 0 <= time.time() - stamp < 86400]
+ if isinstance(stamp, (float, int)) and 0 <= time.time() - stamp < VALID_SECONDS]
record["coverage"] = {name: stamp for name, stamp in record.get("coverage", {}).items()
- if isinstance(stamp, (float, int)) and 0 <= time.time() - stamp < 86400}
+ if isinstance(stamp, (float, int)) and 0 <= time.time() - stamp < VALID_SECONDS}
return record
except (OSError, ValueError, KeyError, TypeError):
pass
@@ -267,6 +289,7 @@ def write(root: Path, state: str, scopes: tuple[str, ...], *, success: bool,
temporary = folder / f"{state}.{os.getpid()}.tmp"
temporary.write_text(json.dumps(record, ensure_ascii=False, indent=2), encoding="utf-8")
temporary.replace(folder / f"{state}.json")
+ prune_expired(folder)
def holder_path(lock_path: Path) -> Path:
diff --git a/scripts/test_runner.py b/scripts/test_runner.py
index 187d1e415..fc17fa53c 100644
--- a/scripts/test_runner.py
+++ b/scripts/test_runner.py
@@ -8,13 +8,14 @@ import json
import os
import re
import shutil
+import stat
import subprocess
import sys
import tempfile
import time
import unittest
from collections.abc import Iterable
-from contextlib import nullcontext
+from contextlib import contextmanager, nullcontext
from pathlib import Path
@@ -922,11 +923,65 @@ def retain_inflight(context, scopes, passed, previous, baseline, count):
"请运行 auto 补齐验证,本次不签发完整通过记录。", flush=True)
+RUN_TEMP = "PEACH_TEST_RUN_TEMP"
+RUN_TEMP_PREFIX = "peach-test-run-"
+TEMP_VARIABLES = ("TEMP", "TMP", "TMPDIR")
+
+
+def _force_remove(function, path, _error) -> None:
+ """Windows 上 Git 对象是只读文件,去掉只读再删一次;仍删不掉就留给下一次清扫。"""
+ try:
+ os.chmod(path, stat.S_IWRITE)
+ function(path)
+ except OSError:
+ pass
+
+
+def sweep_stale_runs(base: Path, now: float | None = None) -> None:
+ """被强行结束的运行来不及删自己的目录;目录名里记着创建时刻,超过一天的整个删掉。"""
+ now = time.time() if now is None else now
+ for path in base.glob(f"{RUN_TEMP_PREFIX}*"):
+ stamp = re.match(rf"{RUN_TEMP_PREFIX}(\d+)-", path.name)
+ if stamp and path.is_dir() and now - int(stamp.group(1)) > 86400:
+ shutil.rmtree(path, onexc=_force_remove)
+
+
+@contextmanager
+def isolated_temp(base: Path | None = None):
+ """本次运行专用的临时目录,结束时整个删掉。
+
+ TEMP、TMP、TMPDIR 与 `tempfile.tempdir` 都指向它,用例和它们起的子进程(含本机分片)
+ 建的临时文件全落在里面,个别用例漏了回收也不会堆进系统 Temp。分片子进程继承父进程的
+ 目录,不再套一层。
+ """
+ inherited = os.environ.get(RUN_TEMP)
+ if inherited and Path(inherited).is_dir():
+ yield Path(inherited)
+ return
+ base = Path(tempfile.gettempdir()) if base is None else base
+ sweep_stale_runs(base)
+ saved = {name: os.environ.get(name) for name in (RUN_TEMP, *TEMP_VARIABLES)}
+ previous = tempfile.tempdir
+ with tempfile.TemporaryDirectory(prefix=f"{RUN_TEMP_PREFIX}{int(time.time())}-", dir=base,
+ ignore_cleanup_errors=True) as folder:
+ os.environ.update(dict.fromkeys((RUN_TEMP, *TEMP_VARIABLES), folder))
+ tempfile.tempdir = folder
+ try:
+ yield Path(folder)
+ finally:
+ tempfile.tempdir = previous
+ for name, value in saved.items():
+ if value is None:
+ os.environ.pop(name, None)
+ else:
+ os.environ[name] = value
+
+
if __name__ == "__main__":
# 故障注入的默认错误日志属于当前测试进程,不能写进真实数据目录。
os.environ["PEACH_REPORTING_TEST_MODE"] = "1"
from peach import error_reporting, remote_reporting
remote_reporting.disable_for_process()
- with tempfile.TemporaryDirectory(prefix='peach-test-errors-') as error_logs:
+ with isolated_temp(), tempfile.TemporaryDirectory(prefix='peach-test-errors-') as error_logs:
error_reporting._log_dir = Path(error_logs)
raise SystemExit(main())
diff --git a/tests/test_seed_pack.py b/tests/test_seed_pack.py
index 85bdc5de7..fcf07e76d 100644
--- a/tests/test_seed_pack.py
+++ b/tests/test_seed_pack.py
@@ -81,7 +81,9 @@ PROFILE = {"kana": "あまかわそら", "birth_date": "1998-10-10", "height_cm"
class SeedPackCase(unittest.TestCase):
def setUp(self):
- self.root = Path(tempfile.mkdtemp(prefix="peach-seed-"))
+ # 目录先登记回收:清理按后进先出执行,两个连接关掉之后才删目录。
+ self.root = Path(self.enterContext(
+ tempfile.TemporaryDirectory(prefix="peach-seed-", ignore_cleanup_errors=True)))
self.source = connect(fresh_ledger(self.root, "source.db"))
self.target = connect(fresh_ledger(self.root, "target.db"))
self.addCleanup(self.source.close)
diff --git a/tests/test_test_evidence.py b/tests/test_test_evidence.py
index dda8939d6..0fa8e4d0d 100644
--- a/tests/test_test_evidence.py
+++ b/tests/test_test_evidence.py
@@ -3,10 +3,12 @@ from __future__ import annotations
import json
import io
import os
+import stat
import subprocess
import sys
import tempfile
import threading
+import time
import unittest
from concurrent.futures import ThreadPoolExecutor
from contextlib import redirect_stderr, redirect_stdout
@@ -770,6 +772,97 @@ class VerificationTests(unittest.TestCase):
test_focus.selection(self.repo, [selector])
+class EvidenceExpiryTests(unittest.TestCase):
+ def setUp(self):
+ temporary = tempfile.TemporaryDirectory()
+ self.addCleanup(temporary.cleanup)
+ self.folder = Path(temporary.name)
+ self.old, self.live = "a" * 64, "b" * 64
+ self.stale = time.time() - evidence.VALID_SECONDS - 60
+
+ def place(self, name: str, *, stale: bool) -> Path:
+ path = self.folder / name
+ path.write_text("{}", encoding="utf-8")
+ if stale:
+ os.utime(path, (self.stale, self.stale))
+ return path
+
+ def test_expired_records_notes_and_partial_writes_go_while_live_records_and_locks_stay(self):
+ gone = [self.place(name, stale=True) for name in
+ (f"{self.old}.json", f"{self.old}.lock.holder.json", f"{self.old}.4242.tmp")]
+ kept = [self.place(f"{self.live}.json", stale=False),
+ self.place(f"{self.old}.lock", stale=True),
+ self.place(f"{self.old}.lock.holder.lock", stale=True),
+ self.place("full-suite.lock", stale=True),
+ self.place("release-notes.json", stale=True)]
+ task_folder = self.folder / f"{'c' * 64}.json"
+ task_folder.mkdir()
+ os.utime(task_folder, (self.stale, self.stale))
+
+ self.assertEqual(evidence.prune_expired(self.folder), 3)
+
+ self.assertEqual([path for path in gone if path.exists()], [])
+ self.assertEqual([path for path in kept if not path.exists()], [])
+ self.assertTrue(task_folder.is_dir())
+
+ def test_signing_a_record_prunes_expired_ones_and_keeps_a_fresh_failure(self):
+ expired = self.place(f"{self.old}.json", stale=True)
+ context = {"manifest": {}, "environment": "fixture"}
+ with mock.patch.object(evidence, "evidence_dir", return_value=self.folder):
+ evidence.write(self.folder, self.live, ("checks",), success=False, elapsed=0,
+ slowest=[], count=0, previous={}, context=context)
+ record = evidence.read(self.folder, self.live)
+
+ self.assertFalse(expired.exists())
+ self.assertEqual(record["failed_scopes"], ["checks"])
+
+
+class RunTemporaryFolderTests(unittest.TestCase):
+ def setUp(self):
+ temporary = tempfile.TemporaryDirectory()
+ self.addCleanup(temporary.cleanup)
+ self.base = Path(temporary.name).resolve()
+ # 运行本文件的测试进程自己就在一个运行目录里;这里要验证的是新开一个。
+ self.enterContext(mock.patch.dict(os.environ))
+ os.environ.pop(runner.RUN_TEMP, None)
+
+ def test_temporary_files_of_the_run_and_its_children_are_removed_with_it(self):
+ previous = tempfile.tempdir
+ with runner.isolated_temp(self.base) as folder:
+ leaked = Path(tempfile.mkdtemp(prefix="peach-seed-"))
+ (leaked / "ledger.db").write_bytes(b"x")
+ (leaked / "ledger.db").chmod(stat.S_IREAD)
+ child = subprocess.run([sys.executable, "-c", "import tempfile; print(tempfile.gettempdir())"],
+ capture_output=True, text=True, encoding="utf-8", check=True)
+ self.assertEqual(leaked.parent, folder)
+ self.assertEqual(Path(child.stdout.strip()).resolve(), folder.resolve())
+
+ self.assertEqual(list(self.base.iterdir()), [])
+ self.assertEqual(tempfile.tempdir, previous)
+ self.assertNotIn(runner.RUN_TEMP, os.environ)
+
+ def test_shard_children_share_the_parent_folder(self):
+ with runner.isolated_temp(self.base) as folder, runner.isolated_temp(self.base) as nested:
+ self.assertEqual(nested, folder)
+ self.assertEqual(len(list(self.base.iterdir())), 1)
+ self.assertEqual(list(self.base.iterdir()), [])
+
+ def test_folders_left_by_killed_runs_are_swept_after_a_day(self):
+ now = time.time()
+ stale = self.base / f"{runner.RUN_TEMP_PREFIX}{int(now) - 2 * 86400}-abc"
+ recent = self.base / f"{runner.RUN_TEMP_PREFIX}{int(now) - 3600}-def"
+ unrelated = self.base / "peach-seed-old"
+ for folder in (stale / "repo", recent, unrelated):
+ folder.mkdir(parents=True)
+ (stale / "repo" / "object").write_bytes(b"x")
+ (stale / "repo" / "object").chmod(stat.S_IREAD)
+
+ runner.sweep_stale_runs(self.base, now)
+
+ self.assertFalse(stale.exists())
+ self.assertTrue(recent.is_dir())
+ self.assertTrue(unrelated.is_dir())
+
if __name__ == "__main__":
unittest.main()