Files
douyin_guaji-main/tests/test_version_consistency.py
CodexandClaude Opus 4.7 e35e8a85bd 建立版本管理体系:CHANGELOG + bump 脚本 + pyproject 元数据 + 一致性测试
新增:
- CHANGELOG.md:Keep a Changelog 1.1.0 格式,回填 V3.0.0–V3.3.3 历史
- tools/dev/bump_version.py:一键 bump major/minor/patch,
  同步 version.py / pyproject.toml / CHANGELOG.md,并创建 git tag。
  支持 --dry-run / --no-tag。
- tests/test_version_consistency.py:9 个用例确保
  version.py、pyproject.toml、CHANGELOG.md 三处版本号一致

修改:
- pyproject.toml 加 [project] 元数据,version=3.3.3(PEP 440 形式,
  与 douyin/core/version.py 同步;后者带 V 前缀,是单一事实来源)

后续会给 V3.0.0 → V3.3.3 补打 git tag。

回归:353 个 pytest 用例通过;bump_version dry-run 三种模式(patch/minor/major/set)
全部输出正确。

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-21 15:17:56 +08:00

147 lines
5.5 KiB
Python
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
"""版本号一致性测试。
确保以下 3 个位置保持同步:
1. douyin/core/version.py:APP_VERSION
2. pyproject.toml [project] version(PEP 440 形式,去掉 V 前缀)
3. CHANGELOG.md 顶部最新发布版本([Unreleased] 之后的第一个版本)
新增/修改时如果忘了同步,这个测试会失败。
"""
from __future__ import annotations
import re
from pathlib import Path
import pytest
PROJECT_ROOT = Path(__file__).resolve().parents[1]
# ============================================================
# 读取三个来源
# ============================================================
def _read_version_py() -> tuple[str, str]:
"""返回 (APP_VERSION, APP_BUILD_DATE)。"""
text = (PROJECT_ROOT / "douyin" / "core" / "version.py").read_text(encoding="utf-8")
ver = re.search(r'^APP_VERSION\s*=\s*"(V?[\d.]+)"', text, re.MULTILINE)
date = re.search(r'^APP_BUILD_DATE\s*=\s*"(\d{4}-\d{2}-\d{2})"', text, re.MULTILINE)
assert ver, "version.py 中找不到 APP_VERSION"
assert date, "version.py 中找不到 APP_BUILD_DATE"
return ver.group(1), date.group(1)
def _read_pyproject_version() -> str:
text = (PROJECT_ROOT / "pyproject.toml").read_text(encoding="utf-8")
m = re.search(r'^version\s*=\s*"([^"]+)"', text, re.MULTILINE)
assert m, "pyproject.toml 中找不到 version 字段"
return m.group(1)
def _read_changelog_latest_version() -> str | None:
"""读 CHANGELOG.md 顶部第一个 ## [V...] 段的版本号;无则返回 None。"""
text = (PROJECT_ROOT / "CHANGELOG.md").read_text(encoding="utf-8")
# 跳过 [Unreleased],找下一个 ## [VX.Y.Z] 段
found_unreleased = False
for line in text.splitlines():
if re.match(r"^##\s+\[Unreleased\]\s*$", line):
found_unreleased = True
continue
m = re.match(r"^##\s+\[(V?[\d.]+)\](?:\s*[—–-].*)?$", line)
if m:
return m.group(1)
if not found_unreleased:
# 没 Unreleased 也没具名版本,CHANGELOG 还没建好
return None
return None
# ============================================================
# 一致性断言
# ============================================================
class TestVersionConsistency:
def test_version_py_format(self):
"""APP_VERSION 应是 V<major>.<minor>.<patch> 形式。"""
ver, _ = _read_version_py()
assert re.fullmatch(r"V\d+\.\d+\.\d+", ver), (
f"APP_VERSION 应为 'V<major>.<minor>.<patch>' 格式,得到 {ver!r}"
)
def test_pyproject_version_format(self):
"""pyproject.toml version 应是 PEP 440 形式(无 V 前缀)。"""
ver = _read_pyproject_version()
assert re.fullmatch(r"\d+\.\d+\.\d+", ver), (
f"pyproject.toml version 应为 '<major>.<minor>.<patch>' 形式,得到 {ver!r}"
)
def test_version_py_and_pyproject_match(self):
"""version.py 与 pyproject.toml 的版本号必须一致(去掉 V 前缀对比)。"""
py_ver, _ = _read_version_py()
pep440 = py_ver.lstrip("Vv")
pyproject_ver = _read_pyproject_version()
assert pep440 == pyproject_ver, (
f"版本号不一致:version.py={py_ver} pyproject.toml={pyproject_ver}\n"
f"运行 `python tools/dev/bump_version.py set {py_ver}` 同步。"
)
def test_version_py_and_changelog_match(self):
"""CHANGELOG.md 顶部最新发布版本必须 ≤ version.py 当前版本。
通常等于;如果 [Unreleased] 段还有未发布的改动则可以不严格相等,
但 CHANGELOG 顶部不应超出当前 version.py 声明的版本。
"""
py_ver, _ = _read_version_py()
latest = _read_changelog_latest_version()
if latest is None:
pytest.skip("CHANGELOG.md 还没有具名版本段")
# 都规范化为带 V 前缀
py_norm = py_ver if py_ver.startswith("V") else "V" + py_ver
cl_norm = latest if latest.startswith("V") else "V" + latest
assert cl_norm == py_norm, (
f"CHANGELOG 顶部 = {latest}, 但 version.py 是 {py_ver}。\n"
f"如果是 release,应让 CHANGELOG 顶部版本与 version.py 一致;"
f"用 bump_version.py 可一键同步。"
)
def test_build_date_format(self):
_, date = _read_version_py()
assert re.fullmatch(r"\d{4}-\d{2}-\d{2}", date), (
f"APP_BUILD_DATE 应为 'YYYY-MM-DD',得到 {date!r}"
)
# ============================================================
# 别名兼容(VERSION / RELEASE_DATE / get_version_string)
# ============================================================
class TestVersionAliases:
def test_version_alias_strips_v_prefix(self):
from douyin.core.version import APP_VERSION, VERSION
assert VERSION == APP_VERSION.lstrip("Vv"), (
"VERSION 应是 APP_VERSION 去掉 V 前缀的别名"
)
def test_release_date_alias(self):
from douyin.core.version import APP_BUILD_DATE, RELEASE_DATE
assert RELEASE_DATE == APP_BUILD_DATE
def test_get_version_string(self):
from douyin.core.version import (
APP_BUILD_DATE,
APP_VERSION,
get_version_string,
)
s = get_version_string()
assert APP_VERSION in s
assert APP_BUILD_DATE in s
def test_app_name_not_empty(self):
from douyin.core.version import APP_NAME
assert isinstance(APP_NAME, str) and APP_NAME.strip()