PVS-Studio ושילוב מתמשך: TeamCity. ניתוח פרויקט Open RollerCoaster Tycoon 2

אחד התרחישים העדכניים ביותר לשימוש בנתח PVS-Studio הוא השילוב שלו עם מערכות CI. ולמרות שניתן לבנות את הניתוח של פרויקט PVS-Studio כמעט מכל מערכת אינטגרציה רציפה בכמה פקודות בלבד, אנו ממשיכים להפוך את התהליך הזה לנוח עוד יותר. ל-PVS-Studio יש כעת תמיכה בהמרת פלט מנתח לפורמט עבור TeamCity - TeamCity Inspections Type. בוא נראה איך זה עובד.

מידע על התוכנה שבה נעשה שימוש

סטודיו PVS - מנתח סטטי של קוד C, C++, C# ו-Java, שנועד להקל על המשימה של מציאת ותיקון סוגים שונים של שגיאות. ניתן להשתמש בנתח ב-Windows, Linux ו-macOS. במאמר זה נשתמש באופן פעיל לא רק בנתח עצמו, אלא גם בכמה כלי עזר מהפצתו.

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

PlogConverter - כלי עזר להמרת דוחות מנתח לפורמטים שונים.

מידע על הפרויקט הנבדק

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

OpenRCT2 - יישום פתוח של המשחק RollerCoaster Tycoon 2 (RCT2), מרחיב אותו עם פונקציות חדשות ותיקון באגים. המשחק סובב סביב בנייה ותחזוקה של פארק שעשועים המכיל מתקנים, חנויות ומתקנים. השחקן חייב לנסות להרוויח ולשמור על המוניטין הטוב של הפארק תוך שמירה על האורחים מרוצים. OpenRCT2 מאפשר לך לשחק גם בתרחיש וגם בארגז חול. תרחישים דורשים מהשחקן להשלים משימה ספציפית תוך זמן מוגדר, בעוד ש-Sandbox מאפשר לשחקן לבנות פארק גמיש יותר ללא הגבלות או כספים.

התאמה

כדי לחסוך זמן, אני כנראה אוותר על תהליך ההתקנה ואתחיל מהרגע שבו שרת TeamCity פועל במחשב שלי. עלינו לעבור אל: localhost:{port שצוין במהלך תהליך ההתקנה} (במקרה שלי, localhost:9090) ולהזין נתוני הרשאה. לאחר הכניסה יקבלו את פנינו:

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

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

בוא נקליק צור תצורת בנייה.

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

לבסוף, נעבור להגדרות הפרויקט.

בואו נוסיף שלבי הרכבה, כדי לעשות זאת לחץ: שלבי בנייה -> הוסף שלב בנייה.

כאן אנו בוחרים:

• סוג רץ -> שורת פקודה
• הפעלה -> סקריפט מותאם אישית

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

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

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

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

תסריט ישיר

ראשית, עלינו להוריד את ההפצה העדכנית ביותר של PVS-Studio. לשם כך אנו משתמשים במנהל חבילות השוקולד. למי שרוצה לדעת יותר על זה, יש הודעה מקבילה מאמר:

choco install pvs-studio -y

לאחר מכן, הבה נשיק את כלי המעקב לבניית פרויקט CLMonitor.

%CLmon% monitor –-attach

לאחר מכן נבנה את הפרויקט כמשתנה סביבתי MSB הוא הנתיב לגרסה של MSBuild שאני צריך לבנות

%MSB% %ProjPath% /t:clean
%MSB% %ProjPath% /t:rebuild /p:configuration=release
%MSB% %ProjPath% /t:g2
%MSB% %ProjPath% /t:PublishPortable

הבה נזין את הכניסה ומפתח הרישיון עבור PVS-Studio:

%PVS-Studio_cmd% credentials --username %PVS_Name% --serialNumber %PVS_Key%

לאחר השלמת הבנייה, הפעל שוב את CLMonitor כדי ליצור קבצים מעובדים מראש וניתוח סטטי:

%CLmon% analyze -l "c:ptest.plog"

אז נשתמש בכלי שירות אחר מההפצה שלנו. PlogConverter ממיר דוח מפורמט סטנדרטי לפורמט ספציפי ל-TeamCity. הודות לכך, נוכל לצפות בו ישירות בחלון הבנייה.

%PlogConverter% "c:ptest.plog" --renderTypes=TeamCity -o "C:temp"

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

type "C:tempptest.plog_TeamCity.txt"

קוד סקריפט מלא:

choco install pvs-studio -y
%CLmon% monitor --attach
set platform=x64
%MSB% %ProjPath% /t:clean
%MSB% %ProjPath% /t:rebuild /p:configuration=release
%MSB% %ProjPath% /t:g2
%MSB% %ProjPath% /t:PublishPortable
%PVS-Studio_cmd% credentials --username %PVS_Name% --serialNumber %PVS_Key%
%CLmon% analyze -l "c:ptest.plog"
%PlogConverter% "c:ptest.plog" --renderTypes=TeamCity -o "C:temp"
type "C:tempptest.plog_TeamCity.txt"

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

עכשיו בואו נלחץ על בדיקות סך הכלכדי לעבור לצפייה בדוח הנתח:

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

צפייה בתוצאות הנתח

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

אזהרה N1

V773 [CWE-401] החריג נזרק מבלי לשחרר את מצביע ה'תוצאה'. תיתכן דליפת זיכרון. libopenrct2 ObjectFactory.cpp 443

Object* CreateObjectFromJson(....)
{
  Object* result = nullptr;
  ....
  result = CreateObject(entry);
  ....
  if (readContext.WasError())
  {
    throw std::runtime_error("Object has errors");
  }
  ....
}

Object* CreateObject(const rct_object_entry& entry)
{
  Object* result;
  switch (entry.GetType())
  {
    case OBJECT_TYPE_RIDE:
      result = new RideObject(entry);
      break;
    case OBJECT_TYPE_SMALL_SCENERY:
      result = new SmallSceneryObject(entry);
      break;
    case OBJECT_TYPE_LARGE_SCENERY:
      result = new LargeSceneryObject(entry);
      break;
    ....
    default:
      throw std::runtime_error("Invalid object type");
  }
  return result;
}

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

אזהרה N2

V501 יש תתי-ביטויים זהים '(1ULL << WIDX_MONTH_BOX)' משמאל ומימין ל-'|' מַפעִיל. libopenrct2ui Cheats.cpp 487

static uint64_t window_cheats_page_enabled_widgets[] = 
{
  MAIN_CHEAT_ENABLED_WIDGETS |
  (1ULL << WIDX_NO_MONEY) |
  (1ULL << WIDX_ADD_SET_MONEY_GROUP) |
  (1ULL << WIDX_MONEY_SPINNER) |
  (1ULL << WIDX_MONEY_SPINNER_INCREMENT) |
  (1ULL << WIDX_MONEY_SPINNER_DECREMENT) |
  (1ULL << WIDX_ADD_MONEY) |
  (1ULL << WIDX_SET_MONEY) |
  (1ULL << WIDX_CLEAR_LOAN) |
  (1ULL << WIDX_DATE_SET) |
  (1ULL << WIDX_MONTH_BOX) |  // <=
  (1ULL << WIDX_MONTH_UP) |
  (1ULL << WIDX_MONTH_DOWN) |
  (1ULL << WIDX_YEAR_BOX) |
  (1ULL << WIDX_YEAR_UP) |
  (1ULL << WIDX_YEAR_DOWN) |
  (1ULL << WIDX_DAY_BOX) |
  (1ULL << WIDX_DAY_UP) |
  (1ULL << WIDX_DAY_DOWN) |
  (1ULL << WIDX_MONTH_BOX) |  // <=
  (1ULL << WIDX_DATE_GROUP) |
  (1ULL << WIDX_DATE_RESET),
  ....
};

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

אזהרות N3

V703 זה מוזר ששדה 'דגלים' במחלקה הנגזרת 'RCT12BannerElement' מחליף את השדה במחלקה הבסיסית 'RCT12TileElementBase'. קווי בדיקה: RCT12.h:570, RCT12.h:259. libopenrct2 RCT12.h 570

struct RCT12SpriteBase
{
  ....
  uint8_t flags;
  ....
};
struct rct1_peep : RCT12SpriteBase
{
  ....
  uint8_t flags;
  ....
};

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

אזהרה N4

V793 זה מוזר שהתוצאה של ההצהרה 'imageDirection / 8' היא חלק מהתנאי. אולי צריך היה להשוות את ההצהרה הזו למשהו אחר. libopenrct2 ObservationTower.cpp 38

void vehicle_visual_observation_tower(...., int32_t imageDirection, ....)
{
  if ((imageDirection / 8) && (imageDirection / 8) != 3)
  {
    ....
  }
  ....
}

בואו נסתכל מקרוב. ביטוי imageDirection/8 יהיה שקר אם imageDirection הוא בטווח שבין -7 ל-7. חלק שני: (imageDirection / 8) != 3 צ'קים imageDirection להיות מחוץ לטווח: מ-31 עד -24 ומ-24 עד 31, בהתאמה. זה נראה לי די מוזר לבדוק מספרים להכללה בטווח מסוים בדרך זו, וגם אם אין שגיאה בקטע הקוד הזה, הייתי ממליץ לשכתב את התנאים האלה כדי להיות מפורשים יותר. זה יעשה את החיים הרבה יותר קלים עבור האנשים שיקראו ותחזקו את הקוד הזה.

אזהרה N5

V587 רצף מוזר של מטלות מסוג זה: A = B; B = A;. קווי בדיקה: 1115, 1118. libopenrct2ui MouseInput.cpp 1118

void process_mouse_over(....)
{
  ....
  switch (window->widgets[widgetId].type)
  {
    case WWT_VIEWPORT:
      ebx = 0;
      edi = cursorId;                                 // <=
      // Window event WE_UNKNOWN_0E was called here,
      // but no windows actually implemented a handler and
      // it's not known what it was for
      cursorId = edi;                                 // <=
      if ((ebx & 0xFF) != 0)
      {
        set_cursor(cursorId);
        return;
      }
      break;
      ....
  }
  ....
}

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

אזהרה N6

V1004 [CWE-476] המצביע 'שחקן' היה בשימוש לא בטוח לאחר שהוא אומת כנגד nullptr. קווי בדיקה: 2085, 2094. libopenrct2 Network.cpp 2094

void Network::ProcessPlayerList()
{
  ....
  auto* player = GetPlayerByID(pendingPlayer.Id);
  if (player == nullptr)
  {
    // Add new player.
    player = AddPlayer("", "");
    if (player)                                          // <=
    {
      *player = pendingPlayer;
       if (player->Flags & NETWORK_PLAYER_FLAG_ISSERVER)
       {
         _serverConnection->Player = player;
       }
    }
    newPlayers.push_back(player->Id);                    // <=
  }
  ....
}

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

void Network::ProcessPlayerList()
{
  ....
  auto* player = GetPlayerByID(pendingPlayer.Id);
  if (player == nullptr)
  {
    // Add new player.
    player = AddPlayer("", "");
    if (player)
    {
      *player = pendingPlayer;
      if (player->Flags & NETWORK_PLAYER_FLAG_ISSERVER)
      {
        _serverConnection->Player = player;
      }
      newPlayers.push_back(player->Id);
    }
  }
  ....
}

אזהרה N7

V547 [CWE-570] הביטוי 'name == nullptr' הוא תמיד שקר. libopenrct2 ServerList.cpp 102

std::optional<ServerListEntry> ServerListEntry::FromJson(...)
{
  auto name = json_object_get(server, "name");
  .....
  if (name == nullptr || version == nullptr)
  {
    ....
  }
  else
  {
    ....
    entry.name = (name == nullptr ? "" : json_string_value(name));
    ....
  }
  ....
}

אתה יכול להיפטר משורת קוד קשה לקריאה במכה אחת ולפתור את הבעיה בבדיקת nullptr. אני מציע לשנות את הקוד באופן הבא:

std::optional<ServerListEntry> ServerListEntry::FromJson(...)
{
  auto name = json_object_get(server, "name");
  .....
  if (name == nullptr || version == nullptr)
  {
    name = ""
    ....
  }
  else
  {
    ....
    entry.name = json_string_value(name);
    ....
  }
  ....
}

אזהרה N8

V1048 [CWE-1164] למשתנה 'ColumnHeaderPressedCurrentState' הוקצה אותו ערך. libopenrct2ui CustomListView.cpp 510

void CustomListView::MouseUp(....)
{
  ....
  if (!ColumnHeaderPressedCurrentState)
  {
    ColumnHeaderPressed = std::nullopt;
    ColumnHeaderPressedCurrentState = false;
    Invalidate();
  }
}

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

פלט

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

אם ברצונך לשתף מאמר זה עם קהל דובר אנגלית, אנא השתמש בקישור התרגום: ולדיסלב סטוליארוב. PVS-Studio ושילוב מתמשך: TeamCity. ניתוח פרויקט Open RollerCoaster Tycoon 2.

מקור: www.habr.com