بتل کد Battle Codeدارد باز می‌شود…

جلسه‌ی 30: تست کردن سرور Testing Your Server

هر بار که کد سرور را عوض می‌کنی، ممکن است چیزی که دیروز کار می‌کرد خراب شود. به‌جای اینکه همه‌چیز را هر بار با دست امتحان کنی، تست می‌نویسی: کدی که خودش درخواست می‌فرستد و با assert جواب را بررسی می‌کند. راه خوب و راه بد هر مسیر را تست می‌کنی، برای هر کار یک تابع تست می‌نویسی و تست‌های قبول‌شده را می‌شماری.

در این جلسه یاد می‌گیری

درس

🔐 قانون طلایی این دوره: سرور امانت‌دار است. هر سروری که می‌سازی داده‌ی آدم‌ها را نگه می‌دارد: اسم، امتیاز، یادداشت، رمز. پس به هر چه از بیرون می‌آید شک کن، رمز را هیچ‌وقت خام نگه ندار و داده‌ی کسی را به دیگری نشان نده. فقط سرورهای خودت را امتحان کن. سرور این دوره ساختگی است و داخل همین صفحه کار می‌کند: هر بار که برنامه را اجرا می‌کنی از صفر ساخته می‌شود، پس هر چه می‌خواهی امتحان کن.

یادت هست؟ در جلسه‌ی ۲۹ با @app.after به همه‌ی جواب‌ها یک هدر اضافه کردیم و با r.headers[...] خواندیمش. ask(..., quiet=True) هم از جلسه‌ی ۱ آشناست: درخواست را می‌فرستد ولی چیزی چاپ نمی‌کند و جواب را برمی‌گرداند تا خودت r.status و r.json را بخوانی. امروز همین دو را برای تست به کار می‌بریم.

from server import app, ask

@app.get("/api/v1/ping")
def ping():
    return "pong"

@app.after
def version(response):
    response.headers["X-Version"] = "1"

r = ask("GET /api/v1/ping", quiet=True)
print(r.status, r.text, r.headers["X-Version"])

🧪 چرا تست؟ فرض کن سرور کوییز ۱۵ مسیر دارد. هر بار که یک خط را عوض می‌کنی، باید هر ۱۵ مسیر را دوباره امتحان کنی، با جواب‌های خوب و بد. با دست خسته‌کننده است و چیزی جا می‌ماند. تست (test) کدی است که همین کار را خودش می‌کند: درخواست می‌فرستد، جواب را می‌گیرد و بررسی می‌کند که همان است که نقشه گفته. هر بار که کد را عوض کردی، تست‌ها را اجرا کن؛ در یک چشم به‌هم‌زدن معلوم می‌شود چیزی خراب شده یا نه.

from server import app, ask

@app.get("/api/v1/books/<int:book_id>")
def one_book(book_id):
    if book_id == 1:
        return {"id": 1, "title": "Wonder"}
    return {"error": "no such book"}, 404

r = ask("GET /api/v1/books/1", quiet=True)
print(r.status, r.json["title"])
r = ask("GET /api/v1/books/5", quiet=True)
print(r.status, r.json)

✋ assert: «این باید درست باشد». assert یک دستور پایتون است. بعدش یک شرط می‌آید و اگر بخواهی، بعد از , یک پیام: assert score > 5, "score is too low". اگر شرط درست باشد هیچ اتفاقی نمی‌افتد و برنامه ادامه می‌دهد. اگر غلط باشد، برنامه همان‌جا با خطای AssertionError و پیامت می‌ایستد:

``
AssertionError: score is too low
`

این خطا را هم مثل بقیه‌ی خطاها می‌شود با
try/except AssertionError گرفت (جلسه‌ی ۶). با except AssertionError as err: خود خطا در err می‌آید و print(err)` پیامش را چاپ می‌کند.

score = 7
assert score > 5, "score is too low"
print("first check passed")
try:
    assert score > 10, "score is too low"
    print("second check passed")
except AssertionError as err:
    print("a check failed:", err)

🛣️ راه خوب و راه بد. یک تست خوب فقط راه خوب (happy path) را امتحان نمی‌کند: «کتاب ۱ هست و 200 می‌دهد». راه بد هم مهم است: «کتاب ۹ نیست و باید 404 بدهد»، «بدون عنوان باید 400 بدهد». خیلی از باگ‌ها و حفره‌های امنیتی دقیقاً در راه‌های بدی‌اند که کسی امتحانشان نکرده. با quiet=True بپرس و با assert هم r.status و هم r.json را بررسی کن.

from server import app, ask, abort

BOOKS = {1: "Wonder", 2: "Matilda"}

@app.get("/api/v1/books/<int:book_id>")
def one_book(book_id):
    if book_id not in BOOKS:
        abort(404, "no such book")
    return {"id": book_id, "title": BOOKS[book_id]}

r = ask("GET /api/v1/books/1", quiet=True)
assert r.status == 200, "book 1 should be there"
assert r.json["title"] == "Wonder"
r = ask("GET /api/v1/books/9", quiet=True)
assert r.status == 404, "book 9 should be missing"
assert r.json == {"error": "no such book"}
print("all checks passed")

🗂️ یک تابع برای هر تست. تست‌ها را در تابع‌هایی بگذار که اسمشان با test_ شروع می‌شود و می‌گوید چه چیزی را بررسی می‌کنند: test_book_found، test_book_missing. این‌طوری وقتی یکی خراب شد، از اسمش می‌فهمی کجا را نگاه کنی. هر تابع یک کار کوچک را تست می‌کند. اگر تابع بدون خطا تمام شد، یعنی تست قبول شد.

from server import app, ask, abort

BOOKS = {1: "Wonder", 2: "Matilda"}

@app.get("/api/v1/books/<int:book_id>")
def one_book(book_id):
    if book_id not in BOOKS:
        abort(404, "no such book")
    return {"id": book_id, "title": BOOKS[book_id]}

def test_book_found():
    r = ask("GET /api/v1/books/1", quiet=True)
    assert r.status == 200
    assert r.json["title"] == "Wonder"

def test_book_missing():
    r = ask("GET /api/v1/books/9", quiet=True)
    assert r.status == 404

test_book_found()
print("ok: test_book_found")
test_book_missing()
print("ok: test_book_missing")

🔢 شمردن تست‌های قبول‌شده. اسم یک تابع بدون () خود تابع است، نه جوابش؛ پس می‌شود تابع‌ها را در یک لیست گذاشت: tests = [test_book_found, test_book_missing] و بعد در یک حلقه test() صدایشان زد. test.__name__ اسم تابع را به شکل متن می‌دهد. هر تست را در try اجرا کن: اگر AssertionError نداد، PASS، وگرنه FAIL با پیامش. آخر هم بگو چند تا از چند تا قبول شد. این‌جا یک تست عمداً غلط نوشته شده تا FAIL را ببینی.

from server import app, ask, abort

BOOKS = {1: "Wonder", 2: "Matilda"}

@app.get("/api/v1/books/<int:book_id>")
def one_book(book_id):
    if book_id not in BOOKS:
        abort(404, "no such book")
    return {"id": book_id, "title": BOOKS[book_id]}

def test_book_found():
    assert ask("GET /api/v1/books/1", quiet=True).status == 200, "book 1 should be there"

def test_book_missing():
    assert ask("GET /api/v1/books/9", quiet=True).status == 404, "book 9 should be missing"

def test_title():
    assert ask("GET /api/v1/books/1", quiet=True).json["title"] == "Matilda", "book 1 should be Matilda"

tests = [test_book_found, test_book_missing, test_title]
passed = 0
for test in tests:
    try:
        test()
        print("PASS", test.__name__)
        passed += 1
    except AssertionError as err:
        print("FAIL", test.__name__, "-", err)
print(passed, "of", len(tests), "tests passed")

⚠️ اشتباه‌های رایج:
- assert (r.status == 200, "msg") با پرانتز: این یک تاپل است و تاپلِ پر همیشه «درست» حساب می‌شود، پس این تست هیچ‌وقت شکست نمی‌خورد. پرانتز نگذار: assert r.status == 200, "msg".
- تستی که assert ندارد چیزی را بررسی نمی‌کند؛ فقط درخواست می‌فرستد.
- یادت برود quiet=True بگذاری و خروجی تست‌ها پر از جواب‌های چاپ‌شده شود.
- تست‌هایی که به هم وابسته‌اند: یک تست کتاب اضافه می‌کند و تست بعدی تعداد کتاب‌ها را با عدد قدیمی مقایسه می‌کند. ترتیب تست‌ها را بدان.
- وقتی تست شکست خورد، تست را عوض نکن تا قبول شود؛ اگر نقشه درست است، سرور را درست کن.

مثال‌های این جلسه

چالش‌ها

  1. A Label on a 404 (آسان)
  2. How Many Passed? (آسان)
  3. Three Checks (متوسط)
  4. Test Functions for POST (متوسط)
  5. The Test Runner (سخت)
  6. Catch the Bug, Then Fix It (سخت)

بیشتر بخوان

← جلسه‌ی 29: نقشه‌ی API: قبل از کد جلسه‌ی 31: سرور کوییز، بخش ۱ →