בדיקות API לתיירות בסביבת Sandbox: מה שהיא לא תראה לכם

האינטגרציה עברה כל מה שבדיקות API לתיירות בסביבת Sandbox יכלו לזרוק עליה. החיפוש החזיר טיסות, בדיקת הזמינות של המלונות החזירה חדרים, קריאת ההזמנה החזירה מספר אישור בכל פעם, וצוות ה-QA אישר ביום חמישי. ביום שלישי שאחרי, לקוח שילם על מלון במחיר אחד והספק אישר אותו במחיר אחר; הזמנת טיסה נפלה על timeout ואף אחד לא ידע לומר אם המושב נשמר; ונציגת תמיכה העבירה אחר צהריים שלם בהתאמת שתי רשומות שתיארו את אותה נסיעה. אף אחד מאלה לא היה באג שהבדיקות פספסו. אלה היו תרחישים שלבדיקות לא הייתה שום דרך לראות. Sandbox הוא הכרחי, הוא רחוק מאוד מלהספיק, ובפער שבין השניים מתרחשים רוב האירועים היקרים באינטגרציה עם ספקי תיירות.
זו תוכנית בדיקות למפתח שאחראי על האינטגרציה הזו: מה סביבת Sandbox יכולה להוכיח, מה היא מבנית לא יכולה, ואיך מכסים את ההפרש בלי להזמין מושבים אמיתיים על כרטיס האשראי של החברה.
למה קוד שעובר בדיקות Sandbox נשבר בייצור
Sandbox היא הבטחה לגבי צורת התשובות, לא לגבי ההתנהגות שלהן. הסכמה זהה לייצור. ההתנהגות כמעט אף פעם לא, ואין כאן אשמים: סביבת בדיקות לא יכולה להרשות לעצמה מלאי חי, ולכן היא מגישה סט קבוע של תעריפים וחדרים שלעולם לא אוזלים, לא משנים מחיר ולא משנים לוח זמנים. היא עונה מהר כי אף אחד אחר לא משתמש בה. והיא כמעט אף פעם לא נכשלת באמצע.
הייצור עושה את כל זה כל יום. המלאי משותף עם כל מוכר אחר; תעריפים נשמרים במטמון אי שם במעלה השרשרת ומתיישנים; המערכת של ספק תחת עומס עונה לאט או לא עונה בכלל. קוד שראה רק Sandbox נבדק, בפועל, רק מול ספק שעובר עליו יום מושלם.
לכן התייחסו ל-Sandbox כשכבה אחת מתוך שלוש. היא מוכיחה שהבקשות תקינות ושה-parser מבין את הסכמה. fixtures מוקלטים מוכיחים שהקוד שורד את התשובות שהייצור באמת שולח. סט קטן ומכוון של בדיקות חיות מוכיח שהחיווט תקין אחרי כל שינוי. כל שכבה תופסת את מה ששתי האחרות לא רואות.
התרחישים ש-Sandbox בדרך כלל לא נותנת לכם
כתבו אותם לפני שאתם כותבים בדיקה אחת. Sandbox אולי תדמה אחד או שניים מהם בעזרת ערך בדיקה מיוחד; את רובם פשוט אין בה.
| תרחיש | מה הייצור עושה | איך מכסים |
|---|---|---|
| המחיר משתנה בין החיפוש להזמנה | ההזמנה מצליחה בסכום אחר, או נכשלת בשגיאת שינוי מחיר שצריך להציג | זוג fixtures: תשובת חיפוש ותשובת הזמנה עם סכום שונה; לוודא שהנוסע נשאל שוב ולא מחויב בשקט |
| אזל בין בדיקת הזמינות להזמנה | החדר או מחלקת התעריף שהוצעו כבר לא קיימים ברגע השמירה | fixture של שגיאת ה"אזל" האמיתית של הספק; לוודא שהנוסע חוזר לתוצאות ולא לדף שגיאה |
| timeout בקריאת ההזמנה | ייתכן שהספק יצר את ההזמנה וייתכן שלא | להזריק timeout אחרי שליחת הבקשה; לוודא שסטטוס ההזמנה נבדק לפני כל ניסיון חוזר |
| שליחה כפולה | לחיצה כפולה או ניסיון חוזר בצד הלקוח יוצרים שתי הזמנות | לשלוח את אותה הזמנה פעמיים עם אותו idempotency key; לוודא שקיימת בדיוק אחת |
| שינוי לוח זמנים אחרי הנפקה | הטיסה שנמכרה ממריאה בשעה אחרת או במספר טיסה אחר | fixture של מסלול ששונה; לוודא שהשינוי מגיע למי שמנהל את הלקוח |
| הצלחה חלקית בהזמנה משולבת | הטיסה מאושרת, המלון לא | fixture מעורב; לוודא שהמערכת רושמת בדיוק מה אושר ומתריעה לאדם |
| הגבלת קצב תחת עומס | תשובות rate limit ואחריהן תשובות איטיות | להריץ מחדש תשובת throttling מוקלטת; לוודא backoff ושהחיפוש מאט במקום לקרוס |
ייתכן שתחלקו על העמודה האחרונה בהתאם לסטאק שלכם. בסדר גמור. מה שחשוב הוא שלכל שורה יהיו בעלים ובדיקה, כי כל אחת מהן תקרה לכם בסוף.
בנו fixtures מתשובות אמיתיות, לא מומצאות
ההרגל המועיל ביותר באינטגרציית תיירות הוא לשמור את התשובות שהפתיעו אתכם. נתוני mock שנכתבו ביד משקפים את מה שאתם חושבים שהספק שולח; תשובה מוקלטת משקפת את מה שהוא שלח באמת — כולל שדות ריקים שלפי התיעוד לעולם לא ריקים, מחיר במטבע שלא ביקשתם, ושגיאה שמגיעה עם סטטוס הצלחה.
שגרה שעובדת:
- הקליטו בגבול. שמרו את גופי הבקשות והתשובות הגולמיים של קריאות לספקים בסביבה שאינה ייצור, ובייצור עבור מדגם מהתעבורה אם כללי הפרטיות שלכם מאפשרים.
- נקו לפני ששומרים. שמות נוסעים, מספרי דרכון, אימיילים, טלפונים ואסמכתאות תשלום יוצאים לפני שה-fixture נכנס למאגר. החליפו אותם בערכים מזויפים בעליל, כדי שאף אחד לא יחשוב שמדובר בהזמנה אמיתית.
- תנו שמות לפי התנהגות.
hotel-book-price-increased.jsonמסביר למפתח הבא למה הקובץ קיים;response-17.jsonלא. - את המכוערים שמרו לנצח. התשובה המשובשת שהפילה את החיפוש ביום ראשון אחד היא הקובץ היקר ביותר שיש לכם. מקומה בבדיקה שרצה בכל commit.
אחר כך כתבו בדיקות חוזה מול ה-fixtures האלה: ה-parser, המיפוי למודלים הפנימיים וסיווג השגיאות. אם ספק משנה שם של שדה ובדיקת חוזה נכשלת, תגלו את זה ב-CI ולא מלקוח. בצד של סיווג השגיאות עסקנו בהרחבה במאמר שלנו על טיפול בשגיאות API של מנוע הזמנות.
לבדוק את מסלולי הכסף בלי להוציא כסף
כאן Sandbox עוזרת הכי פחות, כי מסלולי הכסף הם בדיוק המקום שבו סביבת בדיקות שונה מהאמיתית. הנפקה אמיתית, חיוב כרטיס אמיתי וחשבוניות ספק אמיתיות הם מה שהכי חייב להיות נכון ומה שהכי פחות אפשר לתרגל בשידור חי.
פרקו את הבעיה. חישוב המחיר הוא לוגיקה טהורה, ואפשר לבדוק אותו באופן ממצה וללא חיבור: קחו תעריפים מוקלטים, החילו את כללי ה-markup, המרת המטבע והעיגול, ובדקו את הסכום שהנוסע רואה. עשו זאת למקרים המביכים — תעריף בדולרים שנמכר בשקלים, markup שהוא אחוז במוצר אחד וסכום קבוע באחר, תעריף ילד, שלב עיגול שונה בין התצוגה לחיוב. סכום שגוי בכמה אגורות הוא עדיין שגוי, והוא שגוי בכל הזמנה.
החצי השני הוא מעברי המצב סביב התשלום. מדלו אותם במפורש — הוצעה, נשמרה, שולמה, אושרה, הונפקה, בוטלה, הוחזרה — ובדקו שלכל מעבר יש סיבה אחת בדיוק. הבדיקה שתופסת את הבאג היקר ביותר היא זו שמוודאת שאי אפשר לחייב תשלום על הזמנה שהספק לא אישר, ושלא יכולה להתקיים הזמנה מאושרת בלי רשומת תשלום.
ולבסוף, הפכו את זה לבלתי אפשרי שריצת בדיקות תגיע להנפקה אמיתית. לא לא-סביר — בלתי אפשרי. בדיקה בעת העלייה שמסרבת להריץ את הבדיקות כשנטענו פרטי גישה של ייצור עולה שורה אחת, ומונעת את הבוקר הגרוע ביותר שצוות אינטגרציה יכול לעבור.
כמה זה עולה לכם כשטועים
תרחיש שפוספס באינטגרציית תיירות כמעט אף פעם לא מופיע כשגיאה. הוא מופיע כהזמנה שנראית תקינה. כרטיס כפול שאף אחד לא ביקש ושמישהו צריך לבטל (void) לפני המועד. מלון שאושר במחיר שהסוכנות צריכה עכשיו לספוג. הזמנה שנפלה על timeout והמערכת ניסתה שוב — והספק מחזיק שני חדרים ומחייב על שניהם. בכרטיס טיסה שנמכר דרך סוכנות, פער בין מה שהונפק למה שנמכר יכול לחזור מאוחר יותר כ-ADM, הרבה אחרי שהרווח מאותה מכירה כבר הוצא.
העלויות האלה נופלות על העסק שמכר את הנסיעה, לא על המפתח שכתב את לולאת הניסיונות החוזרים. זה כל הטיעון לבדוק אותן לפני ההשקה, במקום ללמוד אותן פנייה אחר פנייה בתמיכה.
בדיקת עשן אחרי כל שינוי אצל ספק
ספקים משנים דברים: גרסת API חדשה, endpoint חדש, פרטי גישה שהוחלפו, מיפוי תוכן אחר. ייתכן שהקוד שלכם לא השתנה בכלל. הריצו את הרשימה הזו בכל זאת, בסביבה שמדברת עם הספק שהשתנה:
- חיפוש אחד לכל מוצר שאתם מוכרים מהספק הזה, במסלול או בעיר שידוע שמחזירים תוצאות, למשל תל אביב–דובאי.
- פענחו את כל התוצאות בלי להשמיט אף אחת בשקט; השוו את הספירה שלכם לתשובה הגולמית.
- תמחרו תוצאה אחת מקצה לקצה והשוו את הסכום המוצג לחישוב שלכם מהתעריף הגולמי.
- בצעו הזמנה בסביבת הבדיקות, קראו בחזרה את הסטטוס שלה והשוו כל שדה שאתם שומרים.
- בטלו אותה וודאו שהביטול נראה גם ברשומות שלכם וגם בצד של הספק.
- הריצו מחדש את ה-fixtures המכוערים ששמרתם דרך ה-parser החדש.
- בדקו ש-timeout ו-rate limit עדיין מובילים להתנהגות שהחלטתם עליה, כי גרסה חדשה עשויה להגיב אליהם אחרת. אם זמני התגובה זזו, המאמר על השהיה מסביר איזה חלק מזה בידיים שלכם.
קצרה מספיק כדי להריץ בכל פעם, וזו כל הנקודה. בדיקת עשן שאף אחד לא מריץ כי היא לוקחת יום היא לא בדיקת עשן.
המקום הנכון של ה-Sandbox
שום דבר מכל זה לא הופך את ה-Sandbox לפחות שימושית. זה הופך אותה לכנה: המקום שבו לומדים את הסכמה ומוודאים שהבקשות נכונות, לפני ש-fixtures ובדיקות חיות לוקחים את מה שהיא לא מגיעה אליו. אם אתם בוחנים את ממשקי ה-API לטיסות ולמלונות של הפלטפורמה, הגישה מתחילה בשיחה ולא במפתח בשירות עצמי — הביאו את תוכנית הבדיקות הזו לשיחה הזו ושאלו איך כל שורה בטבלה שלמעלה תכוסה. התשובות יגידו לכם על API יותר ממה שהתיעוד שלו אומר.