رفتن به محتوا
وبلاگ

تست سندباکس API سفر: آنچه سندباکس نشان نمی‌دهد

تحریریه Tekravel
نوشته‌شده با کمک هوش مصنوعی

یکپارچه‌سازی از هر چیزی که تست سندباکس API سفر می‌توانست جلویش بگذارد سربلند بیرون آمد. جست‌وجو پرواز برگرداند، درخواست موجودی هتل با اتاق برگشت، درخواست رزرو هر بار شماره تأیید داد و تیم QA روز پنجشنبه آن را تأیید کرد. سه‌شنبه‌ی بعد، مشتری‌ای هتلی را با یک قیمت پرداخت کرد و تأمین‌کننده آن را با قیمت دیگری تأیید کرد، یک رزرو پرواز تایم‌اوت شد و هیچ‌کس نمی‌توانست بگوید صندلی نگه داشته شده یا نه، و یک کارشناس پشتیبانی یک بعدازظهر کامل صرف تطبیق دو رکوردی کرد که یک سفر واحد را توصیف می‌کردند. هیچ‌کدام از این‌ها باگی نبود که مجموعه‌ی تست از دستش داده باشد. سناریویی بود که مجموعه‌ی تست اصلاً راهی برای دیدنش نداشت. سندباکس (sandbox) لازم است، اما به‌هیچ‌وجه کافی نیست، و فاصله‌ی میان این دو همان جایی است که بیشتر حادثه‌های پرهزینه‌ی یک یکپارچه‌سازی سفر در آن رخ می‌دهند.

این یک برنامه‌ی تست برای توسعه‌دهنده‌ای است که مسئول آن یکپارچه‌سازی است: سندباکس چه چیزی را می‌تواند ثابت کند، چه چیزی را از نظر ساختاری نمی‌تواند، و چطور این فاصله را بدون خرید صندلی واقعی با کارت شرکت پوشش دهید.

چرا تست سندباکس API سفر کدی را قبول می‌کند که در محیط عملیاتی می‌شکند

سندباکس قولی درباره‌ی شکل پاسخ‌هاست، نه درباره‌ی رفتار آن‌ها. اسکیما با محیط عملیاتی (production) یکی است. رفتار تقریباً هیچ‌وقت یکی نیست، به دلایلی که تقصیر هیچ‌کس نیست: یک محیط تست توان اجرای موجودی زنده را ندارد، پس مجموعه‌ای ثابت از نرخ‌ها و اتاق‌ها ارائه می‌دهد که هرگز تمام نمی‌شوند، هرگز قیمتشان عوض نمی‌شود و هرگز برنامه‌ی زمانی‌شان تغییر نمی‌کند. سریع جواب می‌دهد چون کس دیگری از آن استفاده نمی‌کند. به‌ندرت وسط کار شکست می‌خورد.

محیط عملیاتی همه‌ی این کارها را هر روز انجام می‌دهد. موجودی با همه‌ی فروشنده‌های دیگر مشترک است؛ نرخ‌ها جایی بالادست کش می‌شوند و کهنه می‌شوند؛ سیستم تأمین‌کننده زیر بار کند جواب می‌دهد یا اصلاً جواب نمی‌دهد. کدی که فقط سندباکس را دیده، در عمل فقط در برابر تأمین‌کننده‌ای تست شده که روز بی‌نقصی را می‌گذراند.

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

سناریوهایی که سندباکس معمولاً نمی‌تواند در اختیارتان بگذارد

پیش از نوشتن حتی یک تست، این‌ها را یادداشت کنید. ممکن است سندباکس یکی دو مورد از آن‌ها را با یک مقدار تست خاص شبیه‌سازی کند؛ بیشترشان را اصلاً ندارد.

سناریومحیط عملیاتی چه می‌کندچطور پوششش دهیم
تغییر قیمت میان جست‌وجو و رزرودرخواست رزرو با مبلغ کل متفاوتی موفق می‌شود، یا با خطای تغییر قیمت شکست می‌خورد که باید آن را نمایش دهیدیک جفت فیکسچر: پاسخ جست‌وجو و پاسخ رزرو با مبلغ کل متفاوت؛ بررسی کنید که دوباره از مسافر پرسیده شود و هرگز بی‌صدا از او پول کسر نشود
تمام‌شدن ظرفیت میان موجودی و رزرواتاق یا کلاس نرخی که پیشنهاد شده بود، وقتی می‌خواهید نگهش دارید دیگر وجود نداردفیکسچری از خطای واقعی تمام‌شدن ظرفیت تأمین‌کننده؛ بررسی کنید که مسافر به نتایج برگردد، نه به صفحه‌ی خطا
تایم‌اوت در درخواست رزروتأمین‌کننده ممکن است رزرو را ساخته باشد یا نساخته باشدپس از ارسال درخواست، تایم‌اوت تزریق کنید؛ بررسی کنید که پیش از هر تلاش مجدد، وضعیت رزرو استعلام شود
ارسال تکرارییک دوبار-کلیک یا تلاش مجدد کلاینت دو رزرو می‌سازدهمان رزرو را دو بار با همان idempotency key بفرستید؛ بررسی کنید که دقیقاً یک رزرو وجود داشته باشد
تغییر برنامه‌ی پرواز پس از صدور بلیتپروازی که فروخته‌اید حالا در ساعت دیگری یا با شماره‌ی پرواز دیگری حرکت می‌کندفیکسچری از برنامه‌ی سفر اصلاح‌شده؛ بررسی کنید که تغییر به کسی برسد که مسئول مشتری است
موفقیت ناقص در رزرو چندبخشیپرواز تأیید می‌شود و هتل نهفیکسچر ترکیبی؛ بررسی کنید که سیستم دقیقاً همان چیزی را که تأیید شده ثبت کند و به یک انسان هشدار دهد
محدودسازی نرخ (throttling) زیر بارپاسخ‌های محدودیت نرخ، و بعد پاسخ‌های کندیک پاسخ throttling ضبط‌شده را دوباره پخش کنید؛ backoff را بررسی کنید، و این‌که جست‌وجو به‌جای خطا دادن، با کیفیت کمتر ادامه دهد

شاید با ستون آخر برای استک خودتان موافق نباشید. اشکالی ندارد. مهم این است که هر ردیف یک مسئول و یک assertion داشته باشد، چون هرکدام از این‌ها دیر یا زود برای شما هم پیش می‌آید.

فیکسچرها را از پاسخ‌های واقعی بسازید، نه ساختگی

مفیدترین عادت در یک یکپارچه‌سازی سفر نگه داشتن پاسخ‌هایی است که غافلگیرتان کرده‌اند. داده‌ی ماک دست‌نویس بازتاب چیزی است که فکر می‌کنید تأمین‌کننده می‌فرستد؛ پاسخ ضبط‌شده بازتاب چیزی است که واقعاً فرستاده، از جمله فیلدهایی که خالی‌اند در حالی که مستندات می‌گوید هرگز خالی نیستند، قیمتی به ارزی که درخواستش نکرده بودید، و خطایی که با وضعیت موفقیت از راه می‌رسد.

روالی که جواب می‌دهد:

  • در مرز ضبط کنید. بدنه‌ی خام درخواست و پاسخ فراخوانی‌های تأمین‌کننده را در یک محیط غیرعملیاتی لاگ کنید، و اگر قواعد حریم خصوصی‌تان اجازه می‌دهد، در محیط عملیاتی هم برای سهمی نمونه‌گیری‌شده از ترافیک.
  • پیش از نگه داشتن، پاک‌سازی کنید. نام مسافران، شماره‌ی گذرنامه، ایمیل، شماره‌ی تلفن و شناسه‌های پرداخت پیش از ورود فیکسچر به مخزن حذف می‌شوند. آن‌ها را با مقادیری آشکارا جعلی جایگزین کنید تا هیچ‌کس فیکسچر را با یک رزرو واقعی اشتباه نگیرد.
  • فیکسچرها را بر اساس رفتار نام‌گذاری کنید. hotel-book-price-increased.json به توسعه‌دهنده‌ی بعدی می‌گوید چرا وجود دارد؛ response-17.json نمی‌گوید.
  • زشت‌ها را برای همیشه نگه دارید. پاسخ معیوبی که یک یکشنبه جست‌وجو را از کار انداخت، باارزش‌ترین فایلی است که دارید. جایش در تستی است که با هر کامیت اجرا می‌شود.

سپس روی همین فیکسچرها تست قرارداد (contract test) بنویسید: پارسرتان، نگاشتتان به مدل‌های داخلی، و دسته‌بندی خطاهایتان. اگر تأمین‌کننده نام یک فیلد را عوض کند و تست قرارداد شکست بخورد، آن را در CI می‌فهمید نه از زبان مشتری. بخش دسته‌بندی خطا با جزئیات بیشتر در مقاله‌ی ما درباره‌ی مدیریت خطای API موتور رزرو آمده است.

تست مسیرهای پولی بدون خرج کردن پول

اینجا سندباکس کمترین کمک را می‌کند، چون مسیرهای پولی دقیقاً همان جایی‌اند که محیط تست با محیط واقعی فرق دارد. صدور واقعی بلیت، برداشت واقعی از کارت و صورت‌حساب واقعی تأمین‌کننده همان چیزهایی‌اند که بیش از همه باید درست از آب درآیند و کمتر از همه می‌شود به‌صورت زنده تمرینشان کرد.

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

نیمه‌ی دوم، گذارهای وضعیت پیرامون پرداخت است. آن‌ها را صریح مدل کنید — قیمت‌داده‌شده، نگه‌داشته‌شده، پرداخت‌شده، تأییدشده، بلیت‌صادرشده، لغوشده، بازپرداخت‌شده — و تست کنید که هر گذار دقیقاً یک علت داشته باشد. تستی که پرهزینه‌ترین باگ را می‌گیرد همانی است که بررسی می‌کند برای رزروی که تأمین‌کننده تأییدش نکرده نمی‌توان پرداخت را برداشت کرد، و رزرو تأییدشده بدون رکورد پرداخت نمی‌تواند وجود داشته باشد.

در نهایت، رسیدن یک اجرای تست به صدور زنده‌ی بلیت را غیرممکن کنید. نه بعید؛ غیرممکن. یک بررسی هنگام راه‌اندازی که وقتی اعتبارنامه‌های محیط عملیاتی بارگذاری شده‌اند از اجرای مجموعه‌ی تست خودداری کند، یک خط کد هزینه دارد و جلوی بدترین صبحی را که یک تیم یکپارچه‌سازی ممکن است تجربه کند می‌گیرد.

اگر اشتباه کنید چه هزینه‌ای دارد

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

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

پس از هر تغییر تأمین‌کننده چه چیزی را smoke test کنیم

تأمین‌کننده‌ها چیزها را تغییر می‌دهند: نسخه‌ی جدید API، اندپوینت جدید، اعتبارنامه‌ی چرخش‌یافته، نگاشت محتوای متفاوت. ممکن است کد خودتان اصلاً تغییری نکرده باشد. با این حال این فهرست را در محیطی که با تأمین‌کننده‌ی تغییریافته حرف می‌زند اجرا کنید:

  1. برای هر محصولی که از آن تأمین‌کننده می‌فروشید یک جست‌وجو، روی مسیر یا شهری که می‌دانید نتیجه برمی‌گرداند.
  2. همه‌ی نتایج را بدون حذف بی‌صدای هیچ‌کدام پارس کنید؛ تعدادتان را با آنچه در پاسخ خام هست مقایسه کنید.
  3. قیمت یک نتیجه را از ابتدا تا انتها محاسبه کنید و مبلغ نمایش‌داده‌شده را با محاسبه‌ی خودتان از نرخ خام مقایسه کنید.
  4. در محیط تست یک رزرو بسازید، وضعیتش را دوباره بخوانید و تک‌تک فیلدهایی را که ذخیره می‌کنید مقایسه کنید.
  5. آن را لغو کنید و مطمئن شوید لغو هم در رکوردهای شما و هم در سمت تأمین‌کننده دیده می‌شود.
  6. فیکسچرهای زشتی را که نگه داشته‌اید دوباره از پارسر جدید عبور دهید.
  7. بررسی کنید که تایم‌اوت‌ها و محدودیت‌های نرخ همچنان به رفتاری که تصمیم گرفته‌اید نگاشت می‌شوند، چون نسخه‌ی جدید ممکن است به آن‌ها طور دیگری پاسخ دهد. اگر زمان پاسخ جابه‌جا شده، مقاله‌ی تأخیر توضیح می‌دهد کدام بخش از آن را خودتان باید اصلاح کنید.

آن‌قدر کوتاه است که بشود هر بار اجرایش کرد، و نکته همین است. smoke testی که هیچ‌کس اجرایش نمی‌کند چون یک روز طول می‌کشد، smoke test نیست.

جایگاه سندباکس کجاست

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

تحریریه Tekravel

میز فناوری سفر

میز فناوری سفر Tekravel برای اهل صنعت می‌نویسد: صاحبان آژانس‌ها، کنسولیدیتورها و توسعه‌دهندگانی که آن‌ها را یکپارچه می‌کنند. هر مقاله پیش از انتشار با همان پلتفرمی که توصیفش می‌کند بررسی می‌شود.