پیداکردن تغییر خراب با git bisect؛ از حدس تا تست تکرارپذیر

# Replace good-release with a verified good tag or commit.
# tools/check_regression.py must exist at every tested revision,
# or be supplied from a fixed path outside the checkout.
git bisect start
git bisect bad HEAD
git bisect good good-release
git bisect run python tools/check_regression.py
git bisect log
git bisect reset

دستورها را خط‌به‌خط و فقط پس از جایگزینی نسخه سالم اجرا کنید. اسکریپت باید برای رفتار سالم exit 0، برای خطای مورد نظر exit 1 و برای نسخه غیرقابل آزمون exit 125 بدهد. این دستورها وابسته به مخزن شما هستند و نمونه مستقل قابل اجرا نیستند.

این فایل یک مخزن تازه در پوشه موقت می‌سازد و تنظیم نام نویسنده را فقط در همان مخزن ثبت می‌کند. سه commit اول درست‌اند و از commit چهارم مقدار اشتباه می‌شود. اسکریپت بررسی بیرون checkout قرار می‌گیرد تا جابه‌جایی تاریخچه آن را حذف نکند.

# make_bisect_demo.py; requires git on PATH.
from pathlib import Path
import subprocess
import tempfile

repo = Path(tempfile.mkdtemp(prefix="liyan-bisect-demo-"))
def git(*args):
    return subprocess.check_output(["git", "-C", str(repo), *args], text=True).strip()

git("init", "--quiet")
git("config", "user.name", "Bisect Demo")
git("config", "user.email", "demo@example.test")
for index in range(6):
    result = 100 if index < 3 else 99
    (repo / "calc.py").write_text(
        f"# revision {index + 1}\ndef total():\n    return {result}\n", encoding="utf-8"
    )
    git("add", "calc.py")
    git("commit", "--quiet", "-m", f"step-{index + 1}")
    if index == 0:
        git("tag", "demo-good")
    if index == 3:
        git("tag", "demo-first-bad")

check = repo.parent / (repo.name + "-check.py")
check.write_text(
    "import pathlib, runpy, sys\n"
    "if not pathlib.Path('calc.py').exists(): sys.exit(125)\n"
    "module = runpy.run_path('calc.py')\n"
    "sys.exit(0 if module['total']() == 100 else 1)\n",
    encoding="utf-8",
)
print("REPOSITORY:", repo)
print("CHECK SCRIPT:", check)
print("EXPECTED BAD:", git("rev-parse", "demo-first-bad"))

سه مسیر/شناسه چاپ‌شده را نگه دارید. کد خروج checker برای فایل موجودِ سالم صفر، برای خروجی اشتباه یک و برای نسخه فاقد فایل 125 است. این آزمایشگاه نیازی به اینترنت یا remote ندارد و در مخزن پروژه اصلی تغییری ایجاد نمی‌کند.

مسیرهای placeholder را با خروجی مرحله قبل عوض کنید و دستورها را خط‌به‌خط اجرا کنید. -C اجازه می‌دهد بدون عوض‌کردن پوشه جاری، فقط همان مخزن آزمایشگاهی هدف باشد.

# Substitute both paths printed by make_bisect_demo.py.
git -C "/path/to/liyan-bisect-demo-..." bisect start HEAD demo-good
git -C "/path/to/liyan-bisect-demo-..." bisect run python "/path/to/liyan-bisect-demo-...-check.py"
git -C "/path/to/liyan-bisect-demo-..." rev-parse refs/bisect/bad
git -C "/path/to/liyan-bisect-demo-..." bisect log
git -C "/path/to/liyan-bisect-demo-..." bisect reset

شناسه refs/bisect/bad باید با EXPECTED BAD یکسان باشد. bisect log مجموعه تصمیم‌ها را نشان می‌دهد و reset شما را به HEAD اولیه برمی‌گرداند. اگر در کار واقعی چند commit به دلیل skip باقی ماند، آن را یک نتیجه قطعی واحد گزارش نکنید.

این فایل را بیرون مخزن آزمایشگاهی ذخیره کنید و دو مسیر چاپ‌شده را به آن بدهید. پیشوند نام مخزن کنترل می‌شود تا دستورهای جابه‌جایی روی پوشه اشتباه اجرا نشوند. در تمام مسیرها، finally حالت bisect را می‌بندد.

# verify_bisect_demo.py REPOSITORY CHECK_SCRIPT
from pathlib import Path
import subprocess
import sys

repo = Path(sys.argv[1]).resolve()
check = Path(sys.argv[2]).resolve()
if not repo.name.startswith("liyan-bisect-demo-"):
    raise SystemExit("Use only the disposable repository from this article")

def git(*args):
    return subprocess.check_output(["git", "-C", str(repo), *args], text=True).strip()

expected = git("rev-parse", "demo-first-bad")
try:
    git("bisect", "start", "HEAD", "demo-good")
    git("bisect", "run", sys.executable, str(check))
    assert git("rev-parse", "refs/bisect/bad") == expected
    print("Found the expected regression:", expected)
finally:
    git("bisect", "reset")

خروجی باید Found the expected regression را همراه commit چهارم چاپ کند. پس از ثبت نتیجه، پوشه آزمایشگاهی و checker آن صرفاً artifact تمرین‌اند. در پروژه واقعی، به‌جای total() یک تست کوچک و پایدار از رفتار خراب بسازید و آن را به مجموعه رگرسیون اضافه کنید.