תיעוד

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

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

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

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

קריאת ריצה

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

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

ממצאים

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

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

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

הועלו

  • שער מייעץ
  • סוכן הבודק
  • סורק מחובר

נתיבו

ניתנים לתיקון

חזרה אל המפתח כעבודה מחדש

כל השאר

מצורף ל־pull request

נפתרו

  • תוקנו

    השינוי מתקן את הבעיה

  • נקבעו כתקינים

    נכון, אין צורך לפעול כאן. נא לציין את הסיבה.

  • דוכאו

    תוצאה חיובית שגויה או כלל שאינו רלוונטי. נא לציין את הסיבה.

תגליות שניתן לתקן מטופלות בתוך הריצה. השאר מגיעות ל־pull request, וכל תגלית מסתיימת בתיקון, בקבלה או בהתעלמות, עם סיבה לשתי האפשרויות האחרונות.

מיון ממצאים

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

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

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

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

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

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

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

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

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