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:{პორტი მითითებულია ინსტალაციის პროცესში} (ჩემს შემთხვევაში localhost:9090) და შევიტანოთ ავტორიზაციის მონაცემები. შესვლის შემდეგ დაგვხვდებიან:

დააჭირეთ ღილაკს შექმენით პროექტი. შემდეგი, აირჩიეთ ხელით და შეავსეთ ველები.

ღილაკზე დაჭერის შემდეგ შექმნა, ჩვენ გვესალმება ფანჯარა პარამეტრებით.

მოდით დავაჭიროთ შექმენით build კონფიგურაცია.

შეავსეთ ველები და დააწკაპუნეთ შექმნა. ჩვენ ვხედავთ ფანჯარას, რომელიც გთხოვთ აირჩიოთ ვერსიის კონტროლის სისტემა. ვინაიდან წყაროები უკვე მდებარეობს ადგილობრივად, დააწკაპუნეთ მთავარი.

ბოლოს გადავდივართ პროექტის პარამეტრებზე.

მოდით დავამატოთ ასამბლეის ნაბიჯები, ამის გასაკეთებლად დააჭირეთ: Build ნაბიჯები -> Build Step-ის დამატება.

აქ ვირჩევთ:

• Runner ტიპი -> Command Line
• გაშვება -> მორგებული სკრიპტი

ვინაიდან ჩვენ განვახორციელებთ ანალიზს პროექტის შედგენის დროს, აწყობა და ანალიზი უნდა იყოს ერთი ნაბიჯი, ამიტომ შეავსეთ ველი საბაჟო სკრიპტი:

ცალკეულ ნაბიჯებს მოგვიანებით განვიხილავთ. მნიშვნელოვანია, რომ ანალიზატორის ჩატვირთვას, პროექტის აწყობას, მის ანალიზს, ანგარიშის გამოტანას და მის ფორმატირებას მხოლოდ თერთმეტი ხაზი სჭირდება.

ბოლო, რაც უნდა გავაკეთოთ, არის გარემოს ცვლადების დაყენება, რაც მე გამოვთქვი რამდენიმე გზა მათი წაკითხვის გასაუმჯობესებლად. ამისათვის მოდით გადავიდეთ: პარამეტრები -> ახალი პარამეტრის დამატება და დაამატეთ სამი ცვლადი:

საკმარისია დააჭიროთ ღილაკს გასაშვებად ზედა მარჯვენა კუთხეში. სანამ პროექტის აწყობა და ანალიზი მიმდინარეობს, სცენარზე მოგიყვებით.

პირდაპირ სცენარი

პირველ რიგში, ჩვენ უნდა გადმოვწეროთ უახლესი PVS-Studio დისტრიბუცია. ამისთვის ვიყენებთ Chocolatey პაკეტის მენეჯერს. მათთვის, ვისაც სურს მეტი იცოდეს ამის შესახებ, არის შესაბამისი სტატიის:

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-ის სპეციფიკურ ფორმატში. ამის წყალობით, ჩვენ შევძლებთ მისი ნახვა პირდაპირ build window-ში.

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

ბოლო ნაბიჯი არის ფორმატირებული ანგარიშის ჩვენება მკაცრი, სადაც მას აიღებს 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 მარკერი. ვისაც აინტერესებს ანალიზატორის მუშაობის ეს რეჟიმი, შეუძლია გაეცნოს შესაბამის განყოფილებას დოკუმენტაცია.

ანალიზატორის შედეგების ნახვა

ახლა, როდესაც ჩვენ დავასრულეთ კონსტრუქციის განლაგება და კონფიგურაცია, მოდით გადავხედოთ რამდენიმე საინტერესო გაფრთხილებას, რომელიც ნაპოვნია პროექტში, რომელსაც ჩვენ ვუყურებთ.

გაფრთხილება 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;
      ....
  }
  ....
}

ეს კოდის ფრაგმენტი დიდი ალბათობით იქნა მიღებული დეკომპილაციით. შემდეგ, დატოვებული კომენტარის მიხედვით თუ ვიმსჯელებთ, არასამუშაო კოდის ნაწილი ამოიღეს. თუმცა, ჯერ კიდევ რამდენიმე ოპერაცია დარჩა კურსორის ID, რომელსაც ასევე არ აქვს დიდი აზრი.

გაფრთხილება 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