Axivion: ניתוח סטטי וארכיטקטורת קוד

מבוא ל-Axivion: מדריך מקיף לניתוח סטטי ולבדיקות ארכיטקטורה

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

מאמר זה נכתב בהשראת הידע שמשתף אייל גרבר מ-Novodes Embedded Software Experts, המספק הדגמה מעמיקה של יכולות Axivion בפרויקטי embedded מהעולם האמיתי. המטרה כאן היא להעניק לכם הבנה ברורה של האופן שבו Axivion יכול לשדרג את תהליכי הבטחת איכות התוכנה שלכם.

https://www.youtube.com/embed/3ex-B57Cx6o

תחילת העבודה עם Axivion: הגדרת הפרויקט שלכם

אחד המכשולים הראשונים באימוץ כלי חדש הוא ההגדרה. למרבה המזל, Axivion הופך את הקמת הפרויקט החדש לפשוטה ואינטואיטיבית. הכלי תומך במספר סביבות פיתוח (IDE), כולל פלטפורמות פופולריות כמו Keil uVision, IAR ואחרות, מה שהופך אותו לרב-תכליתי עבור מפתחי תוכנה מוטמעת.

הגדרת פרויקט שלב אחר שלב

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

• הגדרת שרת: Axivion שומר את כל תוצאות הניתוח על שרת, אשר לאחר מכן מעלה את הנתונים ללוח מחוונים מבוסס דפדפן. ניתן להגדיר שרת זה לרוץ על מחשב מקומי או ברחבי רשת, בהתאם לתשתית שלכם. עבור מפתחים בודדים או צוותים קטנים, הרצת השרת על אותו מחשב שמבצע את הניתוח היא פשוטה ויעילה.
• בחירת תיקיית הפרויקט: בחרו את התיקייה שבה נמצא קוד המקור שלכם. כך Axivion יודע בדיוק אילו קבצים לנתח.
• בחירת מערכת ה-Build: בחרו את מערכת ה-build שהפרויקט שלכם משתמש בה. לדוגמה, אם אתם משתמשים ב-Keil uVision, בחרו באפשרות זו. Axivion מזהה אוטומטית את שרשרת הכלים של המהדר (compiler toolchain), מה שמייעל את התהליך עוד יותר.
• בחירת פרויקט ו-Target: הפנו את Axivion לקובץ הפרויקט שלכם וציינו את תצורת ה-build של ה-target. הדבר כולל זיהוי הקובץ הבינארי (לדוגמה, ‎.bin‎) שנוצר עבור ה-target המוטמע שלכם.
• שורת פקודת המהדר: העתיקו את שורת פקודת המהדר מסביבת הפיתוח שלכם אל Axivion. כך הניתוח מחקה את סביבת הקומפילציה האמיתית שלכם, מה שמוביל לתוצאות מדויקות יותר.
• זיהוי בקרת גרסאות: Axivion מזהה אוטומטית את מערכת בקרת הגרסאות שלכם (לדוגמה, Git), מה שעוזר לשייך שינויי קוד לתוצאות הניתוח.
• הגדרת כתובת לוח המחוונים: הגדירו את הכתובת (URL) או הנתיב שבו לוח המחוונים יהיה נגיש, בדרך כלל localhost עם פורט מוגדר.

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

חקירת לוח המחוונים של Axivion: מרכז הבקרה שלכם לאיכות הקוד

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

תכונות לוח המחוונים

• סקירת תוצאות: הצגת המספר הכולל של השגיאות שזוהו, מסווגות לפי סוג. לדוגמה, ייתכן שתתחילו עם 60,000 שגיאות אך תצמצמו זאת ל-20,000 על ידי החרגת קבצי צד-שלישי שאינם רלוונטיים לבסיס הקוד שלכם.
• ציר זמן של הרצות ניתוח: עקבו אחר האופן שבו איכות הקוד שלכם משתנה לאורך זמן. לוח המחוונים מספק ציר זמן המראה אם הבעיות גדלו או הצטמצמו, מה שעוזר לכם למדוד את ההשפעה של התיקונים והשיפורים שלכם.
• סינון בעיות: סננו בעיות לפי רמות חומרה כגון נדרש (required), מומלץ (advisory) או מידעי (informational). הדבר עוזר לתעדף תיקונים ביעילות, במיוחד בעת עמידה בתקנים תעשייתיים מחמירים.
• פרטי בעיה: העמיקו לתוך בעיות ספציפיות עם תיאורים מפורטים, מיקום בקוד, ואפילו המפתח או מבצע ה-commit האחראי לשינויים.

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

הרצת הניתוח: כיצד לקבל את דוח הבריאות של הפרויקט שלכם

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

תהליך הניתוח מחלץ אוטומטית את שלבי ה-build מקבצי הפרויקט שלכם (לדוגמה, Keil uVision) ומריץ אותם דרך מנוע הניתוח הסטטי של Axivion. בהתאם לגודל הפרויקט, הדבר עשוי לקחת מספר דקות, אך התוצאות שוות את ההמתנה.

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

הבנת סוגי הבעיות שנמצאו על ידי Axivion

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

שכפולי קוד (Code Clones)

מקטעי קוד כפולים, או שכפולים, הם מקור נפוץ לכאבי ראש בתחזוקה. Axivion מזהה גם מקטעי קוד זהים וגם כמעט-זהים, אפילו כאשר שמות המשתנים או המחלקות שונים.

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

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

מעגלים בקוד (Cycles)

מעגלים מתרחשים כאשר מודולים או קבצים מפנים זה לזה באופן מעגלי, מה שעלול להוביל לצימוד הדוק (tight coupling) ולתלויות מורכבות. Axivion מזהה מעגלים אלה ומייצג אותם חזותית, ומראה את שרשרת קריאות הפונקציות או ההפניות היוצרת את המעגל.

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

קוד מת (Dead Code)

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

זיהוי קוד מת הוא קריטי במיוחד במערכות embedded שבהן אילוצי הזיכרון והמשאבים הדוקים.

הפרות מטריקה (Metric Violations)

מטריקות כגון מורכבות ציקלומטית (cyclomatic complexity) הן אינדיקטורים חיוניים לניתנות לתחזוקה של קוד. Axivion מנתח מטריקות אלה ומסמן פונקציות או מודולים החורגים מהספים המוגדרים.

לדוגמה, פונקציה גדולה האחראית על ‘warm start’ במנוע רישום (logging engine) עשויה להיות מסומנת בגלל מורכבות מוגזמת, מה שמסמן את הצורך לפשט או לבצע ריפקטורינג.

הפרות סגנון (Style Violations)

Axivion בודק גם עמידה בתקני קידוד, כגון MISRA או AUTOSAR C++‎. הפרות סגנון הן לרוב הרבות ביותר וכוללות בעיות כמו הגדרות מאקרו לא תקינות או מוסכמות שמות שאינן עומדות בתקן.

כל הפרה מלווה בהסברים מפורטים, הפניות לתקן ומיקומי קוד מדויקים, מה שמקל על ההבנה והתיקון.

הגדרת תקני קידוד והחרגות

ניתן להתאים אישית את Axivion לבדיקה מול תקני קידוד שונים, כגון גרסאות MISRA משנים 2012, 2019 או 2023, AUTOSAR, או תקני C++‎ ספציפיים. גמישות זו מאפשרת לכם להתאים את הניתוח לדרישות העמידה בתקנים של הפרויקט שלכם.

אם חלקים מסוימים בפרויקט שלכם צריכים להיות מוחרגים — כמו קבצי unit test או ספריות צד-שלישי — ניתן לציין החרגות גלובליות. כך הניתוח שלכם נשאר ממוקד ורלוונטי.

הגדרה ואכיפה של כללי ארכיטקטורה עם Gravis

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

כיצד Gravis עובד

לאחר הרצת ניתוח, ניתן להוריד קובץ RFG המכיל מידע מפורט על עובדות ההצהרה (declaration facts) של הקוד שלכם — בעצם, כל החיבורים בין קבצים ומודולים.

Gravis מאפשר לכם ליצור שכבות המייצגות חלקים שונים של המערכת שלכם, כגון:

• שכבת אפליקציה (Application Layer)
• שכבת דרייברים (Drivers Layer)
• שכבת אתחול חומרת ה-CPU (CPU Hardware Initialization Layer)
• Middleware
• RTOS

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

הגדרת יחסים בין שכבות

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

ניתוח הפרות ארכיטקטורה

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

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

מעקב אחר התקדמות לאורך זמן

שמירה על איכות הקוד היא מאמץ מתמשך, ו-Axivion תומך בכך על ידי מתן מגמות והשוואות בין הרצות ניתוח שונות.

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

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

מדוע לבחור ב-Axivion לפרויקטי התוכנה המוטמעת שלכם?

Axivion בולט ככלי מקיף לניתוח סטטי ולבדיקת ארכיטקטורה המותאם למפתחי תוכנה מוטמעת. הנה מדוע כדאי לשקול אותו:

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

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

סיכום

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

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

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