Spy — یہ کیا ہے، Mockito.spy() اور کال کی تصدیق

Spy کیا ہے اور یہ Mock سے کیسے مختلف ہے؟

Spy — ایک حقیقی آبجیکٹ کے گرد ایک لپیٹنے والا ہے جو تمام میتھڈ کالز کو روکتا ہے اور انہیں ریکارڈ کرتا ہے۔ آبجیکٹ کی حقیقی منطق عمل میں آتی ہے: اگر میتھڈ ڈیٹا محفوظ کرتا ہے، قدر کا حساب لگاتا ہے، یا درخواست کرتا ہے — سب کچھ معمول کے مطابق ہوتا ہے۔ اضافی طور پر، spy میٹا ڈیٹا ریکارڈ کرتا ہے: میتھڈ کا نام، آرگیومینٹس، کال کی تعداد، عمل کا وقت۔ یہ اصطلاح Meszaros (2007) کی درجہ‌بندی کا حصہ ہے اور Martin Fowler کے مضمون “Mocks Aren’t Stubs” میں تفصیل سے بیان کی گئی ہے۔

Mock سے بنیادی فرق — mock آبجیکٹ کو مکمل طور پر ٹیسٹ stub سے بدل دیتا ہے؛ تمام میتھڈ ڈیفالٹ طور پر کچھ نہیں کرتے۔ spy موجودہ آبجیکٹ کو لپیٹتا ہے: تمام میتھڈ ڈیفالٹ طور پر معمول کے مطابق کام کرتے ہیں، لیکن ریکارڈ بھی ہوتے ہیں۔ یہ فرق بنیادی ہے: mock ٹیسٹ شدہ کوڈ کو حقیقت سے الگ کرتا ہے، جبکہ spy حقیقت کو محفوظ رکھتا ہے اور اسے مشاہدہ کرنے کی اجازت دیتا ہے۔ ان کے درمیان انتخاب اس بات پر منحصر ہے کہ کیا ٹیسٹ کیا جا رہا ہے۔

Spy کب صحیح انتخاب ہے

Spy صحیح انتخاب ہے — اگر ٹیسٹ شدہ کوڈ کسی حقیقی آبجیکٹ کی حالت تبدیل کرتا ہے، اور ٹیسٹ کو نتیجہ (حالت) کی تصدیق کرنی ہو اور یہ یقینی بنانا ہو کہ کالیں صحیح ترتیب میں کی گئی تھیں۔ mock مناسب نہیں ہے کیونکہ یہ حقیقی عمل‌درآمد نہیں کرتا۔ stub مناسب نہیں ہے کیونکہ یہ کالز ریکارڈ نہیں کرتا۔ Spy واحد ٹیسٹ ڈبل ہے جو بیک وقت حقیقی منطق کو محفوظ رکھتا ہے اور کالز کے بارے میں معلومات فراہم کرتا ہے۔

Spy vs Mock: جاسوس کب استعمال کریں

Mock — مکمل علیحدگی۔ اگر ٹیسٹ کو حقیقی آبجیکٹ کے عمل‌درآمد پر منحصر نہیں ہونا چاہیے (مثال کے طور پر، ڈیٹابیس یا نیٹ ورک کلائنٹ)، mock استعمال کریں۔ mock اس بات کی ضمانت دیتا ہے کہ کوئی کال حقیقی جزو تک نہیں پہنچتی۔ یہ محفوظ اور پیش‌قابل ہے۔ نقصان: mock حقیقی منطق نہیں چلاتا، لہذا اگر ٹیسٹ شدہ کوڈ کسی واپسی قدر پر منحصر ہے، تو اسے when/stub کے ذریعے واضح طور پر ترتیب دینا ہوگا۔

Spy — حقیقی منطق + مشاہدہ۔ اگر ٹیسٹ شدہ کوڈ کسی ایسے آبجیکٹ کے ساتھ تعامل کرتا ہے جس کی منطق ٹیسٹ کے لیے اہم ہے، نہ کہ صرف ڈیٹا — spy استعمال کریں۔ مثال کے طور پر، AnalyticsTracker جو ایونٹس جمع کرتا ہے اور وقتاً فوقتاً بھیجتا ہے۔ ٹیسٹ تصدیق کرتا ہے کہ ایونٹس بفر میں شامل کیے گئے، اور بھیجنے کے بعد بفر صاف ہو گیا۔ mock اس کی تصدیق نہیں کر سکتا کیونکہ یہ ٹریکر کی حقیقی منطق نہیں چلاتا۔

اینٹی پیٹرن: ہر چیز کے لیے spy

ہر چیز کے لیے spy — تمام ٹیسٹوں میں mock کے بجائے spy استعمال کرنا ایک غلطی ہے۔ spy حقیقی کوڈ چلاتا ہے جس کے ضمنی اثرات ہو سکتے ہیں: فائل میں لکھنا، HTTP بھیجنا، عالمی حالت تبدیل کرنا۔ اگر ٹیسٹ شدہ ماڈیول کسی spy آبجیکٹ کے میتھڈ کو کال کرتا ہے جو HTTP درخواست کرتا ہے، تو ٹیسٹ یونٹ ٹیسٹ نہیں بلکہ انٹیگریشن ٹیسٹ بن جاتا ہے۔ اصول: اگر spy I/O آپریشنز والے آبجیکٹ کو لپیٹتا ہے — تو یہ اب یونٹ ٹیسٹ نہیں رہا۔ I/O کو الگ کرنے کے لیے mock استعمال کریں، اور spy صرف میموری میں موجود آبجیکٹس کے لیے استعمال کریں جن کے بیرونی اثرات نہ ہوں۔

Android پر Mockito.spy() اور MockK میں spy

Mockito.spy() — Java/Kotlin پروجیکٹس میں جاسوس بنانے کا کلاسک طریقہ۔ spy() ایک حقیقی آبجیکٹ لیتا ہے اور ایک لپیٹنے والا لوٹاتا ہے۔ تمام کالیں ڈیفالٹ طور پر حقیقی آبجیکٹ کو سونپی جاتی ہیں اور نتائج ریکارڈ کیے جاتے ہیں۔ ٹیسٹ کے بعد، آپ کال کی تعداد اور آرگیومینٹس چیک کرنے کے لیے verify() استعمال کر سکتے ہیں۔ ان میتھڈز کے لیے جو ٹیسٹ ڈیٹا واپس کرنی چاہیے، doReturn/when استعمال کیا جاتا ہے — اسے “جزوی mocking” کہا جاتا ہے۔

class AnalyticsReporterTest {

    private val realTracker = AnalyticsTracker()
    private val spyTracker = Mockito.spy(realTracker)

    fun test_event_tracked() {
        val event = AnalyticsEvent("login")
        spyTracker.track(event)

        Mockito.verify(spyTracker).track(event)
        assertEquals(1, spyTracker.getBufferedCount())
    }

    fun test_track_with_exception() {
        Mockito.doThrow(RuntimeException("network"))
            .when(spyTracker).flush()

        spyTracker.track(AnalyticsEvent("login"))
        assertTrue(spyTracker.hasPendingEvents())
    }
}

MockK.spyk() — coroutine اور sealed کلاسز کے لیے بہتر سپورٹ کے ساتھ Kotlin پروجیکٹس کا ایک متبادل۔ MockK.spyk() ایک جاسوس بناتا ہے، جو Mockito.spy() کے مشابہ ہے۔ یہ suspend فنکشنز کے لیے coVerify اور جزوی stubbing کے لیے every کو سپورٹ کرتا ہے۔ Mockito کے برعکس، MockK final کلاسز کے لیے spy کو سپورٹ نہیں کرتا (Kotlin میں تمام کلاسز ڈیفالٹ طور پر final ہوتی ہیں) — آپ کو کلاس کھولنی (open) یا انٹرفیس استعمال کرنا ہوگا۔

class LoginUseCaseTest {

    private val realRepo = UserRepository()
    private val spyRepo = spyk(realRepo)

    private val useCase = LoginUseCase(spyRepo)

    fun test_login_calls_save() = runTest {
        every { spyRepo.getUser(any()) } returns User("test")

        val result = useCase.login("test", "pass")

        coVerify { spyRepo.saveLoginTime(any()) }
        assertTrue(result.isSuccess)
    }
}

Spy کے ذریعے جزوی stubbing

جزوی stubbing — ایک طاقتور لیکن خطرناک تکنیک۔ آپ کسی آبجیکٹ کا spy بنا سکتے ہیں اور صرف کچھ میتھڈز کو اوور رائڈ (stub) کر سکتے ہیں، باقی کو حقیقی چھوڑ سکتے ہیں۔ مثال: ایک spy ریپوزٹری جہاں getUser() ٹیسٹ ڈیٹا واپس کرتا ہے، جبکہ saveUser() حقیقت میں میموری میں موجود فہرست میں محفوظ کرتا ہے۔ یہ stub (کنٹرول شدہ ڈیٹا) اور spy (حقیقی منطق) دونوں کے فوائد کو یکجا کرنے کی اجازت دیتا ہے۔ نقصان: ٹیسٹ کی پڑھنے کی اہلیت متاثر ہوتی ہے — یہ واضح نہیں ہوتا کہ کون سے میتھڈ حقیقی ہیں اور کون سے stub۔

OCMock اور پروٹوکول کے ساتھ iOS پر Spy کا نفاذ

Objective-C کے لیے OCMock — ایک لائبریری جو niceMock کے ذریعے spy آبجیکٹس بنانے کی حمایت کرتی ہے۔ OCMock Objective-C رن ٹائم استعمال کرکے میتھڈ کالز کو روکتا ہے اور انہیں ریکارڈ کرتا ہے۔ ٹیسٹ کے بعد verify کہا جاتا ہے۔ OCMock کسی بھی آبجیکٹ کے لیے spy کو سپورٹ کرتا ہے (Objective-C میں تمام میتھڈ ڈائنامک ہوتے ہیں)، جو اسے Swift پر برتری دیتا ہے، جہاں spy صرف پروٹوکول کے ذریعے ممکن ہوتے ہیں۔

// حقیقی آبجیکٹ کے لیے spy بنانا
AnalyticsTracker *realTracker = [[AnalyticsTracker alloc] init];
AnalyticsTracker *spy = [OCMockObject partialMockForObject:realTracker];

// ٹیسٹ چلانا
[spy trackEvent:@"login"];

// تصدیق
[[spy verify] trackEvent:@"login"];
XCTAssertEqual([realTracker eventCount], 1);

Swift پروٹوکول پر مبنی spy — Swift میں Objective-C جیسا رن ٹائم ریفلیکشن نہیں ہے، لہذا spy دستی طور پر بنائے جاتے ہیں۔ ایک ٹیسٹ ڈھانچہ ایک پروٹوکول کو نافذ کرتا ہے اور اندرونی طور پر حقیقی آبجیکٹ کو کال کرتا ہے جبکہ بیک وقت کالز ریکارڈ کرتا ہے۔ اس کے لیے زیادہ کوڈ درکار ہے، لیکن یہ مکمل طور پر کنٹرول قابل اور ٹائپ محفوظ ہے۔ دستی جاسوسوں کو بیرونی لائبریریوں کی ضرورت نہیں ہوتی اور وہ رن ٹائم استعمال نہیں کرتے — سب کچھ کمپائل ٹائم پر چیک کیا جاتا ہے۔

protocol AnalyticsProtocol {
    func trackEvent(name: String)
}

final class SpyAnalytics: AnalyticsProtocol {
    private let real: AnalyticsProtocol
    private var events: [String] = []

    init(real: AnalyticsProtocol) {
        self.real = real
    }

    func trackEvent(name: String) {
        events.append(name)
        real.trackEvent(name: name)
    }

    func verifyTracked(name: String) -> Bool {
        return events.contains(name)
    }
}

OCMock بمقابلہ دستی spy کب استعمال کریں — Objective-C کوڈ کے لیے OCMock استعمال کریں (کم بوائلرپلیٹ)۔ Swift کے لیے پروٹوکول کے ذریعے دستی جاسوس ترجیح دیتے ہیں۔ ایک دستی spy کال ریکارڈنگ پر مکمل کنٹرول دیتا ہے، ریفلیکشن کی ضرورت نہیں ہوتی اور ویلیو ٹائپس (struct) کے ساتھ کام کرتا ہے۔ واحد نقصان یہ ہے کہ آپ کو نئے میتھڈ شامل کرتے وقت spy کلاس کوڈ کو پروٹوکول کے ساتھ ہم آہنگ رکھنا ہوگا۔

Spy کے استعمال کے عام منظرنامے

تجزیہ کی تصدیق — جاسوسوں کا سب سے عام استعمال۔ پروڈکشن کوڈ میں، تجزیہ کالز پوری ایپلیکیشن میں پھیلی ہوتی ہیں: لاگ ان، لاگ آؤٹ، خریداری، خرابی۔ ٹیسٹ AnalyticsTracker کے لیے ایک spy لپیٹنے والا بناتا ہے، ایک منظرنامہ انجام دیتا ہے (لاگ ان، پروڈکٹ دیکھنا، کارٹ میں شامل کرنا، خریدنا) اور چیک کرتا ہے کہ تمام ضروری ایونٹس صحیح ترتیب میں بھیجے گئے۔ mock مناسب نہیں ہے کیونکہ AnalyticsTracker میں بفرنگ اور بھیجنے کی منطق ہے۔

ٹائمر اور شیڈیولر — Handler (Android) یا Timer (iOS) استعمال کرنے والے کوڈ کی جانچ حقیقی وقت کی وجہ سے مشکل ہے۔ Scheduler کے لیے ایک spy لپیٹنے والا ریکارڈ کرتا ہے کہ کون سے کام کس تاخیر سے طے کیے گئے۔ ٹیسٹ حقیقی Handler کا spy بناتا ہے، ایک عمل کرتا ہے، اور چیک کرتا ہے کہ Handler.postDelayed(runnable, delay) صحیح تاخیر سے کال ہوا۔ حقیقی کام انجام نہیں دیا جاتا — spy کال کو روکتا اور ریکارڈ کرتا ہے۔

لاگنگ اور ڈیبگ معلومات — پروڈکشن میں، لاگ غیر فعال یا فائل میں لکھے جا سکتے ہیں۔ Logger کے لیے ایک spy لپیٹنے والا تمام پیغامات کو میموری میں موجود فہرست میں ریکارڈ کرتا ہے جسے ٹیسٹ عمل کے بعد چیک کرتا ہے۔ یہ کنسول کو بے ترتیب کیے بغیر خرابی کی صورت میں صحیح پیغام لکھے جانے کی تصدیق کرنے کی اجازت دیتا ہے۔ Logger کے لیے دستی جاسوس iOS پر خاص طور پر مفید ہیں، جہاں OSLog کے پاس ٹیسٹ API نہیں ہے۔

کال ترتیب کی تصدیق — کچھ منظرناموں کو آپریشنز کی سخت ترتیب درکار ہوتی ہے: کنکشن کھولیں، ڈیٹا بھیجیں، کنکشن بند کریں۔ Mockito InOrder.verify() کے ذریعے ترتیب چیک کرنے کی اجازت دیتا ہے۔ spy بھی ایسا ہی کرتا ہے لیکن حقیقی عمل کو محفوظ رکھتا ہے۔ اگر ترتیب اور ہر مرحلے کا نتیجہ (کنکشن واقعی کھلا) دونوں اہم ہوں — mock نہیں، spy استعمال کریں۔