תיעוד

בדיקות, הפעלות וממצאים

קריאת תוצאות אימות, מיון הממצאים שנמצאו וקבלת החלטה לגבי הפעולה הנדרשת.

בדיקה היא אימות בודד. בדיקה היא אימות בודד. ריצה היא ביצוע אחד של הבדיקות במסגרת מדיניות מסוימת כנגד שינוי נתון. ממצא הוא דבר שהבדיקה דיווחה עליו. ממצא הוא דבר שהבדיקה דיווחה עליו.

ניתן למצוא אותם תחת איכות → ריצות ו- איכות → ממצאים.

קריאת ריצה

ריצה מציגה כל בדיקה, את תוצאתה ואת הפלט שלה. כאשר משימה נכשלת באימות, הריצה היא המקום שבו תגלו מדוע.

קראו אותה מלמעלה למטה. הבדיקה הכושלת הראשונה היא בדרך כלל הבעיה האמיתית – כישלונות מאוחרים הם לרוב תוצאה שלה. כישלון בנייה שמלווה בשנים-עשר כישלונות בבדיקות מהווה בעיה אחת, ולא שלוש-עשרה.

ממצאים

הממצאים מגיעים מסוכני סקירה, סורקים ושערי ייעוץ. כל אחד מהם מכיל את מה שנמצא, היכן ומה חומרתו.

מחזור החיים שלהם:

  1. הועלו על ידי בדיקה או סוקר.
  2. נתיבוּו — ממצאים שניתן לתקן מוחזרים לסוכן המפתח כעבודה נוספת; השאר מצורפים ל-pull request.
  3. נפתר — תוקן, התקבל או דוכא.

מיון ממצאים

השאלה לגבי כל ממצא אינה "האם הוא נכון?" אלא "האם הוא משנה את מה שיקרה בהמשך?"

  • תקן עכשיו — דברים הקשורים לנכונות, אבטחה או כל דבר שבכל מקרה ייכשל בבדיקת העריכה.
  • קבל — נכון אך אין צורך לפעול בנוגע אליו כאן. יש לתעד את הסיבה.
  • דכא — תוצאה חיובית שגויה, או כלל שאינו חל על קוד זה.

יש לדכא בכוונה ועם סיבה ברורה. דיכוי ללא הסבר אינו נבדל מניסיון להשתיק אמת לא נוחה, ולאחר שישה חודשים איש לא יוכל לדעת מה היה המצב.

כאשר יש יותר מדי ממצאים

הנפח מהווה אות לגבי ההגדרות ולא לגבי איכות הקוד.

כאשר בדיקה מתריעה ברוב השינויים, היא אינה מגלה בעיות — היא מתארת את בסיס הקוד שלכם. או שהכלל אינו תואם את הנוהגים שלכם, או שהוא מתאר חוב שבחרתם לחיות איתו. בשני המקרים הבדיקה אינה מתאימה.

ממצאים ושערי איכות

ממצא משער ייעוץ הוא מידע בלבד. אותו ממצא משער חוסם עוצר את המשימה. הממצא זהה; המדיניות קובעת מה המחיר שלו.

זהו הכלי שיש להשתמש בו כאשר הבדיקה נכונה אך אגרסיבית מדי: שנו את רמת החומרה שלה במקום להסיר אותה. ראו מדיניות איכות ושערי איכות.