🥇PVS-स्टुडिओ आणि सतत एकत्रीकरण: टीमसिटी. ओपन रोलरकोस्टर टायकून 2 प्रकल्पाचे विश्लेषण

पीव्हीएस-स्टुडिओ विश्लेषक वापरण्यासाठी सर्वात वर्तमान परिस्थितींपैकी एक म्हणजे त्याचे सीआय सिस्टमसह एकत्रीकरण. आणि जरी PVS-स्टुडिओ प्रकल्पाचे जवळजवळ कोणत्याही सतत एकीकरण प्रणालीचे विश्लेषण फक्त काही कमांड्समध्ये तयार केले जाऊ शकते, तरीही आम्ही ही प्रक्रिया आणखी सोयीस्कर बनवणे सुरू ठेवतो. पीव्हीएस-स्टुडिओला आता विश्लेषक आउटपुट टीमसिटी - टीमसिटी इन्स्पेक्शन प्रकारासाठी फॉरमॅटमध्ये रूपांतरित करण्यासाठी समर्थन आहे. ते कसे कार्य करते ते पाहूया.

वापरलेल्या सॉफ्टवेअरची माहिती

पीव्हीएस-स्टुडिओ — C, C++, C# आणि Java कोडचे स्थिर विश्लेषक, विविध प्रकारच्या त्रुटी शोधणे आणि दुरुस्त करण्याचे कार्य सुलभ करण्यासाठी डिझाइन केलेले. विश्लेषक Windows, Linux आणि macOS वर वापरला जाऊ शकतो. या लेखात आम्ही केवळ विश्लेषकच नव्हे तर त्याच्या वितरणातील काही उपयुक्तता देखील सक्रियपणे वापरू.

सीएलमॉनिटर — एक मॉनिटरिंग सर्व्हर आहे जो कंपाइलर लाँचचे निरीक्षण करतो. तुमचा प्रकल्प तयार करणे सुरू करण्यापूर्वी ते ताबडतोब चालवणे आवश्यक आहे. स्नूपिंग मोडमध्ये, सर्व्हर सर्व समर्थित कंपाइलर्सच्या धावा रोखेल. हे लक्षात घेण्यासारखे आहे की ही उपयुक्तता केवळ C/C++ प्रकल्पांचे विश्लेषण करण्यासाठी वापरली जाऊ शकते.

PlogConverter - विश्लेषक अहवाल वेगवेगळ्या स्वरूपांमध्ये रूपांतरित करण्यासाठी उपयुक्तता.

अभ्यासाधीन प्रकल्पाची माहिती

चला ही कार्यक्षमता एका व्यावहारिक उदाहरणावर वापरून पाहू - OpenRCT2 प्रकल्पाचे विश्लेषण करूया.

ओपनआरसीटी 2 - RollerCoaster Tycoon 2 (RCT2) या गेमची खुली अंमलबजावणी, नवीन फंक्शन्ससह त्याचा विस्तार करणे आणि बगचे निराकरण करणे. गेमप्ले राइड, दुकाने आणि सुविधा असलेले मनोरंजन पार्क तयार करणे आणि त्याची देखभाल करणे याभोवती फिरते. खेळाडूने नफा कमावण्याचा प्रयत्न केला पाहिजे आणि अतिथींना आनंदी ठेवताना उद्यानाची चांगली प्रतिष्ठा राखली पाहिजे. OpenRCT2 तुम्हाला परिस्थिती आणि सँडबॉक्स दोन्हीमध्ये खेळण्याची परवानगी देते. परिस्थितींमध्ये खेळाडूने ठराविक वेळेत एक विशिष्ट कार्य पूर्ण करणे आवश्यक असते, तर सँडबॉक्स खेळाडूला कोणत्याही निर्बंध किंवा वित्तविना अधिक लवचिक पार्क तयार करण्याची परवानगी देतो.

समायोजन

वेळ वाचवण्यासाठी, मी कदाचित इंस्टॉलेशन प्रक्रिया वगळेन आणि माझ्या संगणकावर टीमसिटी सर्व्हर चालू असल्यापासून सुरू करेन. आम्हाला येथे जावे लागेल: लोकलहोस्ट:{इंस्टॉलेशन प्रक्रियेदरम्यान निर्दिष्ट केलेले पोर्ट} (माझ्या बाबतीत, लोकलहोस्ट:9090) आणि अधिकृतता डेटा प्रविष्ट करा. आत गेल्यानंतर आमचे स्वागत होईल:

प्रोजेक्ट तयार करा बटणावर क्लिक करा. पुढे, व्यक्तिचलितपणे निवडा आणि फील्ड भरा.

बटण दाबल्यानंतर तयार करा, आम्हाला सेटिंग्जसह विंडोद्वारे स्वागत केले जाते.

चला क्लिक करूया बिल्ड कॉन्फिगरेशन तयार करा.

फील्ड भरा आणि क्लिक करा तयार करा. आम्ही तुम्हाला आवृत्ती नियंत्रण प्रणाली निवडण्यास सांगणारी विंडो पाहतो. स्रोत आधीच स्थानिक पातळीवर असल्याने, क्लिक करा वगळा.

शेवटी, आम्ही प्रोजेक्ट सेटिंग्जवर जाऊ.

असेंब्ली स्टेप्स जोडूया, हे करण्यासाठी क्लिक करा: बिल्ड स्टेप्स -> बिल्ड स्टेप जोडा.

येथे आम्ही निवडतो:

रनर प्रकार -> कमांड लाइन
चालवा -> सानुकूल स्क्रिप्ट

आम्ही प्रकल्प संकलनादरम्यान विश्लेषण करणार असल्याने, असेंबली आणि विश्लेषण एक पाऊल असले पाहिजे, म्हणून फील्ड भरा सानुकूल स्क्रिप्ट:

आम्ही नंतर वैयक्तिक चरण पाहू. विश्लेषक लोड करणे, प्रकल्प एकत्र करणे, त्याचे विश्लेषण करणे, अहवाल आउटपुट करणे आणि त्याचे स्वरूपन करणे यासाठी कोडच्या फक्त अकरा ओळी लागतात हे महत्त्वाचे आहे.

शेवटची गोष्ट म्हणजे पर्यावरण व्हेरिएबल्स सेट करणे, जे मी त्यांची वाचनीयता सुधारण्याचे काही मार्ग सांगितले आहेत. हे करण्यासाठी, चला पुढे जाऊया: पॅरामीटर्स -> नवीन पॅरामीटर जोडा आणि तीन व्हेरिएबल्स जोडा:

तुम्हाला फक्त बटण दाबायचे आहे चालवा वरच्या उजव्या कोपर्यात. प्रकल्प एकत्र आणि विश्लेषण केले जात असताना, मी तुम्हाला स्क्रिप्टबद्दल सांगेन.

थेट स्क्रिप्ट

प्रथम, आम्हाला नवीनतम PVS-स्टुडिओ वितरण डाउनलोड करणे आवश्यक आहे. यासाठी आम्ही Chocolatey पॅकेज मॅनेजर वापरतो. ज्यांना याबद्दल अधिक जाणून घ्यायचे आहे त्यांच्यासाठी एक संबंधित आहे लेख:

choco install pvs-studio -y

पुढे, CLMonitor प्रोजेक्ट बिल्ड ट्रॅकिंग युटिलिटी लाँच करू.

%CLmon% monitor –-attach

मग आपण पर्यावरण परिवर्तनशील म्हणून प्रकल्प तयार करू एमएसबी 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 अहवालाला मानक स्वरूपातून टीमसिटी-विशिष्ट स्वरूपामध्ये रूपांतरित करतो. याबद्दल धन्यवाद, आम्ही ते थेट बिल्ड विंडोमध्ये पाहू शकू.

%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 मार्कर विश्लेषकाच्या ऑपरेशनच्या या पद्धतीमध्ये स्वारस्य असलेले कोणीही संबंधित विभागाशी परिचित होऊ शकतात. दस्तऐवजीकरण.

विश्लेषकाचे निकाल पहात आहे

आता आम्ही बिल्ड तैनात करणे आणि कॉन्फिगर करणे पूर्ण केले आहे, आम्ही पाहत असलेल्या प्रकल्पात सापडलेल्या काही मनोरंजक चेतावणी पाहू.

चेतावणी 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;
}

डायनॅमिकली मेमरी वाटप केल्यानंतर विश्लेषकाने एक त्रुटी लक्षात घेतली ऑब्जेक्ट तयार करा, अपवाद आढळल्यास, मेमरी साफ होत नाही आणि मेमरी लीक होते.

चेतावणी 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)
  {
    ....
  }
  ....
}

चला जवळून बघूया. अभिव्यक्ती प्रतिमादिशा/8 असत्य असेल तर प्रतिमा दिशा -7 ते 7 च्या श्रेणीत आहे. दुसरा भाग: (imageDirection / 8) != 3 चेक प्रतिमा दिशा श्रेणीबाहेर असल्याबद्दल: अनुक्रमे -31 ते -24 आणि 24 ते 31 पर्यंत. अशा प्रकारे एका विशिष्ट श्रेणीमध्ये समाविष्ट करण्यासाठी संख्या तपासणे मला खूप विचित्र वाटते आणि कोडच्या या भागामध्ये कोणतीही त्रुटी नसली तरीही, मी या अटी अधिक स्पष्ट होण्यासाठी पुन्हा लिहिण्याची शिफारस करतो. जे लोक हा कोड वाचतील आणि सांभाळतील त्यांच्यासाठी यामुळे जीवन खूप सोपे होईल.

चेतावणी N5

V587 या प्रकारच्या असाइनमेंटचा एक विचित्र क्रम: A = B; ब = अ;. ओळी तपासा: 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();
  }
}

कोड अगदी विचित्र दिसत आहे. मला असे दिसते की एकतर कंडिशनमध्ये किंवा व्हेरिएबल पुन्हा नियुक्त करताना टायपिंग झाली होती कॉलमहेडर प्रेस्ड करंट स्टेट मूल्ये खोटे.

निष्कर्ष

जसे आपण पाहू शकतो, आपल्या टीमसिटी प्रोजेक्टमध्ये PVS-Studio स्टॅटिक अॅनालायझर समाकलित करणे अगदी सोपे आहे. हे करण्यासाठी, फक्त एक लहान कॉन्फिगरेशन फाइल लिहिणे पुरेसे आहे. कोड तपासणे आपल्याला असेंब्लीनंतर लगेच समस्या ओळखण्यास अनुमती देईल, जे जटिलता आणि बदलांची किंमत अद्याप कमी असताना त्यांना दूर करण्यात मदत करेल.

आपण हा लेख इंग्रजी भाषिक प्रेक्षकांसह सामायिक करू इच्छित असल्यास, कृपया भाषांतर दुवा वापरा: व्लादिस्लाव स्टोल्यारोव्ह. पीव्हीएस-स्टुडिओ आणि सतत एकत्रीकरण: टीमसिटी. ओपन रोलरकोस्टर टायकून 2 प्रकल्पाचे विश्लेषण.

स्त्रोत: www.habr.com

पीव्हीएस-स्टुडिओ आणि सतत एकत्रीकरण: टीमसिटी. ओपन रोलरकोस्टर टायकून 2 प्रकल्पाचे विश्लेषण