إعادة بناء بثقة عبر الاختبارات

إعادة بناء بثقة عبر الاختبارات — Refactor with Tests

الاختبار ليس نشاطاً يحدث بعد الكتابة. هو أداة تُشكّل الكود منذ البداية وتمنحك الجرأة على تغييره لاحقاً دون خوف.

في هذا الدرس سنمر بدورة كاملة:

نستلم دالة تعمل لكنها مكتنزة بالشروط المتداخلة والأرقام السحرية
نكتب الاختبارات قبل أي تعديل — نثبّت السلوك الحالي
نُعيد البناء خطوة بخطوة مع تشغيل الاختبارات بعد كل خطوة
نُضيف ميزة جديدة باستخدام TDD — الاختبار أولاً ثم التنفيذ

الحالة: حاسبة الخصومات

لدينا دالة تحسب خصم طلب في متجر إلكتروني. هي تعمل، لكنها صعبة القراءة وأصعب الصيانة:

def calculate_discount(order_total, customer_type, coupon_code):
    if customer_type == "vip":
        if order_total >= 1000:
            discount = order_total * 0.30
        elif order_total >= 500:
            discount = order_total * 0.20
        else:
            discount = order_total * 0.10
    elif customer_type == "regular":
        if order_total >= 500:
            discount = order_total * 0.10
        else:
            discount = 0
    else:
        discount = 0

    if coupon_code == "SAVE50":
        discount += 50
    elif coupon_code == "PERCENT5":
        discount += order_total * 0.05

    return min(discount, order_total)

المشكلات واضحة: الأرقام السحرية 0.30, 0.20, 0.10, 500, 1000 موزّعة في الكود، الشروط متداخلة ثلاثة مستويات، وأي تغيير في سياسة الخصومات يستدعي البحث في كل فرع.

الخطوة الأولى: ثبّت السلوك بالاختبارات

قبل لمس أي سطر، نكتب اختبارات تُغطي كل الحالات الحدّية. هذا العقد الذي يجب أن يظل صحيحاً بعد التعديل.

main.go

import unittest

def calculate_discount(order_total, customer_type, coupon_code=None):
    """حاسبة الخصم الأصلية — Original discount calculator"""
    if customer_type == "vip":
        if order_total >= 1000:
            discount = order_total * 0.30
        elif order_total >= 500:
            discount = order_total * 0.20
        else:
            discount = order_total * 0.10
    elif customer_type == "regular":
        if order_total >= 500:
            discount = order_total * 0.10
        else:
            discount = 0
    else:
        discount = 0

    if coupon_code == "SAVE50":
        discount += 50
    elif coupon_code == "PERCENT5":
        discount += order_total * 0.05

    return min(discount, order_total)


class TestCalculateDiscount(unittest.TestCase):
    """اختبارات السلوك الحالي — Tests for current behavior"""

    # --- عميل VIP ---
    def test_vip_large_order(self):
        # VIP + 1000+ → 30%
        self.assertAlmostEqual(calculate_discount(1000, "vip"), 300.0)

    def test_vip_medium_order(self):
        # VIP + 500-999 → 20%
        self.assertAlmostEqual(calculate_discount(500, "vip"), 100.0)

    def test_vip_small_order(self):
        # VIP + أقل من 500 → 10%
        self.assertAlmostEqual(calculate_discount(200, "vip"), 20.0)

    # --- عميل عادي ---
    def test_regular_large_order(self):
        # Regular + 500+ → 10%
        self.assertAlmostEqual(calculate_discount(600, "regular"), 60.0)

    def test_regular_small_order(self):
        # Regular + أقل من 500 → لا خصم
        self.assertAlmostEqual(calculate_discount(300, "regular"), 0.0)

    # --- عميل ضيف ---
    def test_guest_no_discount(self):
        # Guest → لا خصم
        self.assertAlmostEqual(calculate_discount(1000, "guest"), 0.0)

    # --- الكوبونات ---
    def test_coupon_save50(self):
        # كوبون SAVE50 يُضيف 50 ثابتة
        result = calculate_discount(200, "regular", "SAVE50")
        self.assertAlmostEqual(result, 50.0)

    def test_coupon_percent5_with_vip(self):
        # VIP صغير (10%) + PERCENT5 (5%) = 15% من 400 = 60
        result = calculate_discount(400, "vip", "PERCENT5")
        self.assertAlmostEqual(result, 60.0)

    def test_discount_never_exceeds_total(self):
        # الخصم لا يتجاوز قيمة الطلب
        result = calculate_discount(30, "vip", "SAVE50")
        self.assertLessEqual(result, 30)


unittest.main(argv=['ignored'], exit=False, verbosity=2)

Output:

الاختبارات خضراء. الآن نعرف بالضبط ما يجب أن يظل صحيحاً. نبدأ التعديل.

الخطوة الثانية: استخرج الثوابت

الأرقام السحرية تجعل الكود صعب القراءة وخطير الصيانة. نُعطيها أسماء واضحة:

main.go

import unittest

# ثوابت الخصومات — Discount constants
VIP_TIER1_THRESHOLD = 1000
VIP_TIER2_THRESHOLD = 500
VIP_TIER1_RATE = 0.30   # 30% لطلبات كبيرة
VIP_TIER2_RATE = 0.20   # 20% لطلبات متوسطة
VIP_TIER3_RATE = 0.10   # 10% لطلبات صغيرة
REGULAR_THRESHOLD = 500
REGULAR_RATE = 0.10     # 10% لطلبات كبيرة
COUPON_SAVE50_AMOUNT = 50
COUPON_PERCENT5_RATE = 0.05


def calculate_discount(order_total, customer_type, coupon_code=None):
    """نفس المنطق — أسماء أوضح للثوابت"""
    if customer_type == "vip":
        if order_total >= VIP_TIER1_THRESHOLD:
            discount = order_total * VIP_TIER1_RATE
        elif order_total >= VIP_TIER2_THRESHOLD:
            discount = order_total * VIP_TIER2_RATE
        else:
            discount = order_total * VIP_TIER3_RATE
    elif customer_type == "regular":
        if order_total >= REGULAR_THRESHOLD:
            discount = order_total * REGULAR_RATE
        else:
            discount = 0
    else:
        discount = 0

    if coupon_code == "SAVE50":
        discount += COUPON_SAVE50_AMOUNT
    elif coupon_code == "PERCENT5":
        discount += order_total * COUPON_PERCENT5_RATE

    return min(discount, order_total)


# نفس الاختبارات تُثبت أن السلوك لم يتغير
class TestCalculateDiscount(unittest.TestCase):
    def test_vip_large_order(self):
        self.assertAlmostEqual(calculate_discount(1000, "vip"), 300.0)

    def test_vip_medium_order(self):
        self.assertAlmostEqual(calculate_discount(500, "vip"), 100.0)

    def test_vip_small_order(self):
        self.assertAlmostEqual(calculate_discount(200, "vip"), 20.0)

    def test_regular_large_order(self):
        self.assertAlmostEqual(calculate_discount(600, "regular"), 60.0)

    def test_regular_small_order(self):
        self.assertAlmostEqual(calculate_discount(300, "regular"), 0.0)

    def test_guest_no_discount(self):
        self.assertAlmostEqual(calculate_discount(1000, "guest"), 0.0)

    def test_coupon_save50(self):
        self.assertAlmostEqual(calculate_discount(200, "regular", "SAVE50"), 50.0)

    def test_coupon_percent5_with_vip(self):
        self.assertAlmostEqual(calculate_discount(400, "vip", "PERCENT5"), 60.0)

    def test_discount_never_exceeds_total(self):
        self.assertLessEqual(calculate_discount(30, "vip", "SAVE50"), 30)


unittest.main(argv=['ignored'], exit=False, verbosity=2)

Output:

الاختبارات لا تزال خضراء. استخراج الثوابت لم يُغيّر أي سلوك.

الخطوة الثالثة: استخرج دوال متخصصة

نُفصل منطق خصم النوع عن منطق الكوبون — كل دالة مسؤولية واحدة:

main.go

import unittest

VIP_TIER1_THRESHOLD = 1000
VIP_TIER2_THRESHOLD = 500
VIP_TIER1_RATE = 0.30
VIP_TIER2_RATE = 0.20
VIP_TIER3_RATE = 0.10
REGULAR_THRESHOLD = 500
REGULAR_RATE = 0.10
COUPON_SAVE50_AMOUNT = 50
COUPON_PERCENT5_RATE = 0.05


def _vip_discount(order_total):
    """خصم عميل VIP — VIP customer discount"""
    if order_total >= VIP_TIER1_THRESHOLD:
        return order_total * VIP_TIER1_RATE
    if order_total >= VIP_TIER2_THRESHOLD:
        return order_total * VIP_TIER2_RATE
    return order_total * VIP_TIER3_RATE


def _base_discount(order_total, customer_type):
    """الخصم الأساسي حسب نوع العميل — Base discount by customer type"""
    if customer_type == "vip":
        return _vip_discount(order_total)
    if customer_type == "regular" and order_total >= REGULAR_THRESHOLD:
        return order_total * REGULAR_RATE
    return 0.0


def _coupon_discount(order_total, coupon_code):
    """خصم الكوبون — Coupon discount"""
    if coupon_code == "SAVE50":
        return COUPON_SAVE50_AMOUNT
    if coupon_code == "PERCENT5":
        return order_total * COUPON_PERCENT5_RATE
    return 0.0


def calculate_discount(order_total, customer_type, coupon_code=None):
    """حاسبة الخصم المُعاد بناؤها — Refactored discount calculator"""
    discount = _base_discount(order_total, customer_type)
    discount += _coupon_discount(order_total, coupon_code)
    return min(discount, order_total)


# نفس الاختبارات — كل شيء يجب أن يظل أخضر
class TestCalculateDiscount(unittest.TestCase):
    def test_vip_large_order(self):
        self.assertAlmostEqual(calculate_discount(1000, "vip"), 300.0)

    def test_vip_medium_order(self):
        self.assertAlmostEqual(calculate_discount(500, "vip"), 100.0)

    def test_vip_small_order(self):
        self.assertAlmostEqual(calculate_discount(200, "vip"), 20.0)

    def test_regular_large_order(self):
        self.assertAlmostEqual(calculate_discount(600, "regular"), 60.0)

    def test_regular_small_order(self):
        self.assertAlmostEqual(calculate_discount(300, "regular"), 0.0)

    def test_guest_no_discount(self):
        self.assertAlmostEqual(calculate_discount(1000, "guest"), 0.0)

    def test_coupon_save50(self):
        self.assertAlmostEqual(calculate_discount(200, "regular", "SAVE50"), 50.0)

    def test_coupon_percent5_with_vip(self):
        self.assertAlmostEqual(calculate_discount(400, "vip", "PERCENT5"), 60.0)

    def test_discount_never_exceeds_total(self):
        self.assertLessEqual(calculate_discount(30, "vip", "SAVE50"), 30)


# اختبارات إضافية للدوال المُستخرجة
class TestHelperFunctions(unittest.TestCase):
    def test_vip_discount_tiers(self):
        # اختبر الدالة المُستخرجة مباشرة
        self.assertAlmostEqual(_vip_discount(1500), 450.0)  # 30%
        self.assertAlmostEqual(_vip_discount(700), 140.0)   # 20%
        self.assertAlmostEqual(_vip_discount(100), 10.0)    # 10%

    def test_coupon_none(self):
        # بدون كوبون → صفر
        self.assertAlmostEqual(_coupon_discount(500, None), 0.0)

    def test_coupon_unknown(self):
        # كوبون غير معروف → صفر
        self.assertAlmostEqual(_coupon_discount(500, "INVALID"), 0.0)


unittest.main(argv=['ignored'], exit=False, verbosity=2)

Output:

الكود الآن:

_vip_discount مسؤولة فقط عن منطق VIP
_base_discount تفوّض لـ_vip_discount أو تُحسب مباشرة
_coupon_discount معزولة تماماً عن منطق النوع
calculate_discount تُجمّع النتائج فقط

أي تغيير في سياسة VIP يُعدَّل في مكان واحد فقط. الاختبارات تُثبت أن الكل يعمل.

الخطوة الرابعة: TDD — اختبار أولاً

جاء طلب جديد: أضف كوبون WELCOME10 يُعطي 10% لكل الطلبات بدون حد أدنى.

في TDD نكتب الاختبار أولاً، ونتأكد أنه يفشل (لأن الكود لم يُطبّق بعد)، ثم نُنفّذ الكود حتى ينجح.

الخطوات:

اكتب الاختبار → أحمر (فشل)
اكتب أبسط كود يُنجحه → أخضر
نظّف الكود إن لزم → إعادة بناء

main.go

import unittest

VIP_TIER1_THRESHOLD = 1000
VIP_TIER2_THRESHOLD = 500
VIP_TIER1_RATE = 0.30
VIP_TIER2_RATE = 0.20
VIP_TIER3_RATE = 0.10
REGULAR_THRESHOLD = 500
REGULAR_RATE = 0.10
COUPON_SAVE50_AMOUNT = 50
COUPON_PERCENT5_RATE = 0.05
COUPON_WELCOME10_RATE = 0.10  # الثابت الجديد — New constant


def _vip_discount(order_total):
    if order_total >= VIP_TIER1_THRESHOLD:
        return order_total * VIP_TIER1_RATE
    if order_total >= VIP_TIER2_THRESHOLD:
        return order_total * VIP_TIER2_RATE
    return order_total * VIP_TIER3_RATE


def _base_discount(order_total, customer_type):
    if customer_type == "vip":
        return _vip_discount(order_total)
    if customer_type == "regular" and order_total >= REGULAR_THRESHOLD:
        return order_total * REGULAR_RATE
    return 0.0


def _coupon_discount(order_total, coupon_code):
    if coupon_code == "SAVE50":
        return COUPON_SAVE50_AMOUNT
    if coupon_code == "PERCENT5":
        return order_total * COUPON_PERCENT5_RATE
    if coupon_code == "WELCOME10":
        # الميزة الجديدة — New feature
        return order_total * COUPON_WELCOME10_RATE
    return 0.0


def calculate_discount(order_total, customer_type, coupon_code=None):
    discount = _base_discount(order_total, customer_type)
    discount += _coupon_discount(order_total, coupon_code)
    return min(discount, order_total)


class TestCalculateDiscount(unittest.TestCase):
    """الاختبارات القديمة — تبقى خضراء"""
    def test_vip_large_order(self):
        self.assertAlmostEqual(calculate_discount(1000, "vip"), 300.0)
    def test_regular_large_order(self):
        self.assertAlmostEqual(calculate_discount(600, "regular"), 60.0)
    def test_coupon_save50(self):
        self.assertAlmostEqual(calculate_discount(200, "regular", "SAVE50"), 50.0)
    def test_discount_never_exceeds_total(self):
        self.assertLessEqual(calculate_discount(30, "vip", "SAVE50"), 30)


class TestWelcomeCoupon(unittest.TestCase):
    """اختبارات الميزة الجديدة — TDD: اكتبها أولاً"""

    def test_welcome10_guest(self):
        # ضيف + WELCOME10 → 10% من 300 = 30
        result = calculate_discount(300, "guest", "WELCOME10")
        self.assertAlmostEqual(result, 30.0)

    def test_welcome10_regular_small(self):
        # Regular طلب صغير + WELCOME10 → 10% فقط (الطلب < 500)
        result = calculate_discount(200, "regular", "WELCOME10")
        self.assertAlmostEqual(result, 20.0)

    def test_welcome10_regular_large(self):
        # Regular طلب كبير + WELCOME10 → 10% base + 10% coupon = 20% من 600 = 120
        result = calculate_discount(600, "regular", "WELCOME10")
        self.assertAlmostEqual(result, 120.0)

    def test_welcome10_stacks_with_base(self):
        # WELCOME10 يُضاف فوق الخصم الأساسي — stacks with base discount
        vip_result = calculate_discount(1000, "vip", "WELCOME10")
        # 30% base + 10% coupon = 40% من 1000 = 400
        self.assertAlmostEqual(vip_result, 400.0)


unittest.main(argv=['ignored'], exit=False, verbosity=2)

Output:

كل الاختبارات — القديمة والجديدة — خضراء. هذا ما يعنيه TDD: الاختبار يُحدد العقد، الكود يُوفّيه.

مبادئ إعادة البناء الآمن

قبل أي تعديل:

اكتب اختبارات تُغطي كل الحالات الحدية (العوارض: حد التشعّب، القيم الصفرية، الطرف السفلي والعلوي)
تأكد أن الاختبارات تفشل إذا عدّلت نتيجة متوقعة — الاختبار الذي لا يستطيع الفشل لا يحميك

أثناء التعديل:

خطوة صغيرة واحدة في كل مرة — استخرج ثابتاً، ثم دالة، ثم اختبرها
شغّل الاختبارات بعد كل تغيير، لا بعد مجموعة تغييرات
إذا احمرّ اختبار، تراجع فوراً وافهم السبب قبل المتابعة

الفرق بين إعادة البناء وتغيير الميزة:

إعادة البناء: نفس السلوك، شكل أفضل — الاختبارات القديمة لا تتغير
تغيير الميزة: سلوك جديد — تحتاج اختبارات جديدة

لا تخلطهما في commit واحد.

التحدي الأول: اكتب الاختبار الفاشل أولاً

تحدي — Challenge

import unittest
import io

# الدالة غير مكتملة — Incomplete function
def format_price(amount, currency="SAR"):
    """تنسيق السعر — Format price.
    100 → "100.00 SAR"
    1500.5 → "1500.50 SAR"
    0 → "0.00 SAR"
    """
    # اكتب التنفيذ هنا — implement here
    pass


class TestFormatPrice(unittest.TestCase):
    def test_integer_amount(self):
        self.assertEqual(format_price(100), "100.00 SAR")

    def test_decimal_amount(self):
        self.assertEqual(format_price(1500.5), "1500.50 SAR")

    def test_zero(self):
        self.assertEqual(format_price(0), "0.00 SAR")

    def test_custom_currency(self):
        self.assertEqual(format_price(50, "USD"), "50.00 USD")


def run_tests():
    buf = io.StringIO()
    runner = unittest.TextTestRunner(stream=buf, verbosity=0)
    suite = unittest.TestLoader().loadTestsFromTestCase(TestFormatPrice)
    result = runner.run(suite)
    return result.wasSuccessful()


# المرحلة 1: الدالة غير مكتملة — اختبر الفشل
phase1 = run_tests()
if not phase1:
    print("TDD المرحلة 1: الاختبار يفشل لأن الكود غير مكتوب")


# المرحلة 2: اكتب التنفيذ الصحيح
def format_price(amount, currency="SAR"):
    return f"{amount:.2f} {currency}"

phase2 = run_tests()
if phase2:
    print("TDD المرحلة 2: الكود مكتوب والاختبار ينجح")


# المرحلة 3: إعادة بناء (تحسين القراءة دون تغيير السلوك)
def format_price(amount, currency="SAR"):
    # نفس المنطق — طريقة f-string أوضح
    formatted = f"{float(amount):.2f}"
    return f"{formatted} {currency}"

phase3 = run_tests()
if phase3:
    print("TDD المرحلة 3: الاختبار لا يزال ينجح بعد إعادة البناء")

التحدي الثاني: أضف ميزة بـ TDD

تحدي — Challenge

import unittest
import io

class UserRegistry:
    """سجل المستخدمين — User registry"""

    def __init__(self):
        self._users = {}

    def register(self, email, name):
        """
        سجّل مستخدم جديد — Register a new user.
        إذا البريد موجود مسبقاً: ارفع ValueError
        إذا البريد فارغ: ارفع ValueError
        وإلا: احفظ المستخدم وأرجع True
        """
        # اكتب التنفيذ — implement
        pass

    def exists(self, email):
        """هل المستخدم موجود؟ — Does user exist?"""
        return email in self._users


class TestUserRegistry(unittest.TestCase):

    def setUp(self):
        self.registry = UserRegistry()

    def test_register_new_user(self):
        # تسجيل مستخدم جديد يجب أن ينجح
        result = self.registry.register("user@test.com", "أحمد")
        self.assertTrue(result)
        self.assertTrue(self.registry.exists("user@test.com"))

    def test_register_existing_user(self):
        # تسجيل بريد مكرر يجب أن يرفع ValueError
        self.registry.register("dup@test.com", "فاطمة")
        with self.assertRaises(ValueError):
            self.registry.register("dup@test.com", "اسم آخر")

    def test_register_empty_email(self):
        # بريد فارغ يجب أن يرفع ValueError
        with self.assertRaises(ValueError):
            self.registry.register("", "اسم")


test_names = [
    ("اختبار_المستخدم_الجديد", "test_register_new_user"),
    ("اختبار_المستخدم_موجود", "test_register_existing_user"),
    ("اختبار_البريد_الفارغ", "test_register_empty_email"),
]

passed = 0
for ar_name, method_name in test_names:
    t = TestUserRegistry(method_name)
    buf = io.StringIO()
    runner = unittest.TextTestRunner(stream=buf, verbosity=0)
    res = runner.run(t)
    status = "PASS" if res.wasSuccessful() else "FAIL"
    if status == "PASS":
        passed += 1
    print(f"{ar_name}: {status}")

print(f"نجحت: {passed}/3")

خلاصة الدرس

الاختبارات ليست قيداً — هي شبكة أمان تُحرّرك من الخوف. بدونها، كل تعديل محفوف بمخاطر كسر شيء لم تُلاحظه. معها، يمكنك إعادة بناء الكود بثقة لأنك تعرف على الفور إذا كسرت شيئاً.

دورة العمل المثالية:

اكتب اختبارات تُغطي السلوك الحالي
عدّل خطوة صغيرة — ثابت، دالة، تبسيط شرط
شغّل الاختبارات — كلها خضراء؟ تابع. وجد أحمر؟ تراجع وافهم
أضف ميزة بـ TDD — اختبار أحمر أولاً، ثم اجعله أخضر، ثم نظّف

هذا ما تفعله الفرق الاحترافية يومياً.