पीवीएस-स्टूडियो और सतत एकीकरण: टीमसिटी। ओपन रोलरकोस्टर टाइकून 2 परियोजना का विश्लेषण

पीवीएस-स्टूडियो विश्लेषक का उपयोग करने के लिए सबसे मौजूदा परिदृश्यों में से एक सीआई सिस्टम के साथ इसका एकीकरण है। और यद्यपि लगभग किसी भी सतत एकीकरण प्रणाली से पीवीएस-स्टूडियो प्रोजेक्ट का विश्लेषण केवल कुछ कमांड में बनाया जा सकता है, हम इस प्रक्रिया को और भी सुविधाजनक बनाना जारी रखते हैं। पीवीएस-स्टूडियो के पास अब विश्लेषक आउटपुट को टीमसिटी - टीमसिटी निरीक्षण प्रकार के प्रारूप में परिवर्तित करने के लिए समर्थन है। आइए देखें कि यह कैसे काम करता है।

उपयोग किए गए सॉफ़्टवेयर के बारे में जानकारी

पीवीएस-स्टूडियो - सी, सी++, सी# और जावा कोड का एक स्थिर विश्लेषक, जिसे विभिन्न प्रकार की त्रुटियों को खोजने और ठीक करने के कार्य को सुविधाजनक बनाने के लिए डिज़ाइन किया गया है। विश्लेषक का उपयोग विंडोज़, लिनक्स और मैकओएस पर किया जा सकता है। इस लेख में हम सक्रिय रूप से न केवल विश्लेषक का उपयोग करेंगे, बल्कि इसके वितरण से कुछ उपयोगिताओं का भी उपयोग करेंगे।

सीएल मॉनिटर - एक मॉनिटरिंग सर्वर है जो कंपाइलर लॉन्च की निगरानी करता है। इसे अपना प्रोजेक्ट बनाना शुरू करने से तुरंत पहले चलाया जाना चाहिए। स्नूपिंग मोड में, सर्वर सभी समर्थित कंपाइलरों के रन को रोक देगा। यह ध्यान देने योग्य है कि इस उपयोगिता का उपयोग केवल C/C++ परियोजनाओं का विश्लेषण करने के लिए किया जा सकता है।

प्लॉग कनवर्टर - विश्लेषक रिपोर्ट को विभिन्न प्रारूपों में परिवर्तित करने के लिए एक उपयोगिता।

अध्ययनाधीन परियोजना के बारे में जानकारी

आइए इस कार्यक्षमता को एक व्यावहारिक उदाहरण पर आज़माएँ - आइए OpenRCT2 प्रोजेक्ट का विश्लेषण करें।

ओपनआरसीटी2 - गेम रोलरकोस्टर टाइकून 2 (आरसीटी2) का एक खुला कार्यान्वयन, इसे नए कार्यों के साथ विस्तारित करना और बग्स को ठीक करना। गेमप्ले एक मनोरंजन पार्क के निर्माण और रखरखाव के इर्द-गिर्द घूमता है जिसमें सवारी, दुकानें और सुविधाएं शामिल हैं। खिलाड़ी को मेहमानों को खुश रखते हुए लाभ कमाने और पार्क की अच्छी प्रतिष्ठा बनाए रखने का प्रयास करना चाहिए। OpenRCT2 आपको परिदृश्य और सैंडबॉक्स दोनों में खेलने की अनुमति देता है। परिदृश्यों में खिलाड़ी को एक निर्धारित समय के भीतर एक विशिष्ट कार्य पूरा करने की आवश्यकता होती है, जबकि सैंडबॉक्स खिलाड़ी को बिना किसी प्रतिबंध या वित्त के अधिक लचीला पार्क बनाने की अनुमति देता है।

समायोजन

समय बचाने के लिए, मैं संभवतः इंस्टॉलेशन प्रक्रिया को छोड़ दूंगा और उस क्षण से शुरू करूंगा जब मेरे कंप्यूटर पर टीमसिटी सर्वर चल रहा होगा। हमें यहां जाना होगा: लोकलहोस्ट: {इंस्टॉलेशन प्रक्रिया के दौरान निर्दिष्ट पोर्ट} (मेरे मामले में, लोकलहोस्ट:9090) और प्राधिकरण डेटा दर्ज करें। प्रवेश करने के बाद हमारा स्वागत किया जाएगा:

प्रोजेक्ट बनाएं बटन पर क्लिक करें। इसके बाद, मैन्युअल रूप से चुनें और फ़ील्ड भरें।

बटन दबाने के बाद बनाएं, हमें सेटिंग्स वाली एक विंडो द्वारा स्वागत किया जाता है।

आइए क्लिक करें बिल्ड कॉन्फ़िगरेशन बनाएं.

फ़ील्ड भरें और क्लिक करें बनाएं. हमें एक विंडो दिखाई देती है जो आपसे एक संस्करण नियंत्रण प्रणाली का चयन करने के लिए कहती है। चूँकि स्रोत पहले से ही स्थानीय रूप से स्थित हैं, क्लिक करें स्किप.

अंत में, हम प्रोजेक्ट सेटिंग्स पर आगे बढ़ते हैं।

आइए असेंबली चरण जोड़ें, ऐसा करने के लिए क्लिक करें: बिल्ड स्टेप्स -> बिल्ड स्टेप जोड़ें.

यहां हम चुनते हैं:

• धावक प्रकार -> कमांड लाइन
• चलाएँ -> कस्टम स्क्रिप्ट

चूंकि हम प्रोजेक्ट संकलन के दौरान विश्लेषण करेंगे, असेंबली और विश्लेषण एक कदम होना चाहिए, इसलिए फ़ील्ड भरें कस्टम स्क्रिप्ट:

हम बाद में अलग-अलग चरणों पर गौर करेंगे। यह महत्वपूर्ण है कि विश्लेषक को लोड करने, प्रोजेक्ट को असेंबल करने, उसका विश्लेषण करने, रिपोर्ट आउटपुट करने और उसे फ़ॉर्मेट करने में कोड की केवल ग्यारह पंक्तियाँ लगती हैं।

आखिरी चीज़ जो हमें करने की ज़रूरत है वह पर्यावरण चर सेट करना है, जिसकी पठनीयता में सुधार करने के लिए मैंने कुछ तरीकों की रूपरेखा तैयार की है। ऐसा करने के लिए, आइए आगे बढ़ें: पैरामीटर -> नया पैरामीटर जोड़ें और तीन चर जोड़ें:

आपको बस बटन दबाना है रन ऊपरी दाएँ कोने में. जबकि परियोजना को इकट्ठा और विश्लेषण किया जा रहा है, मैं आपको स्क्रिप्ट के बारे में बताऊंगा।

सीधे स्क्रिप्ट

सबसे पहले, हमें नवीनतम पीवीएस-स्टूडियो वितरण डाउनलोड करना होगा। इसके लिए हम चॉकलेटी पैकेज मैनेजर का उपयोग करते हैं। जो लोग इसके बारे में अधिक जानना चाहते हैं, उनके लिए एक अनुरूप है लेख:

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_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, जहां इसे टीमसिटी पार्सर द्वारा उठाया जाएगा।

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"

इस बीच, परियोजना का संयोजन और विश्लेषण सफलतापूर्वक पूरा हो गया है, हम टैब पर जा सकते हैं परियोजनाओं и убедиться в том.

अब क्लिक करते हैं कुल निरीक्षणविश्लेषक रिपोर्ट देखने के लिए जाएं:

चेतावनियों को नैदानिक ​​नियम संख्याओं के आधार पर समूहीकृत किया जाता है। कोड के माध्यम से नेविगेट करने के लिए, आपको चेतावनी के साथ लाइन नंबर पर क्लिक करना होगा। ऊपरी दाएं कोने में प्रश्न चिह्न पर क्लिक करने से आपके लिए दस्तावेज़ीकरण वाला एक नया टैब खुल जाएगा। आप विश्लेषक चेतावनी के साथ लाइन नंबर पर क्लिक करके भी कोड के माध्यम से नेविगेट कर सकते हैं। उपयोग करते समय दूरस्थ कंप्यूटर से नेविगेशन संभव है सोर्सट्रीरूट मार्कर. जो कोई भी विश्लेषक के संचालन के इस तरीके में रुचि रखता है वह संबंधित अनुभाग से खुद को परिचित कर सकता है प्रलेखन.

विश्लेषक के परिणाम देखना

अब जब हमने बिल्ड का परिनियोजन और कॉन्फ़िगरेशन पूरा कर लिया है, तो आइए जिस प्रोजेक्ट को हम देख रहे हैं उसमें मिली कुछ दिलचस्प चेतावनियों पर एक नज़र डालें।

चेतावनी N1

V773 [सीडब्ल्यूई-401] अपवाद को 'परिणाम' सूचक जारी किए बिना फेंक दिया गया था। स्मृति रिसाव संभव है. libopenrct2 ऑब्जेक्टफैक्टरी.सीपीपी 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 ऑब्जर्वेशनटॉवर.cpp 38

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

आओ हम इसे नज़दीक से देखें। अभिव्यक्ति छविदिशा/8 यदि गलत होगा छविदिशा -7 से 7 के बीच है। दूसरा भाग: (इमेजडायरेक्शन/8) !=3 चेकों छविदिशा सीमा से बाहर होने के लिए: क्रमशः -31 से -24 और 24 से 31 तक। इस तरह से एक निश्चित सीमा में शामिल करने के लिए संख्याओं की जांच करना मेरे लिए काफी अजीब लगता है और, भले ही कोड के इस टुकड़े में कोई त्रुटि न हो, मैं इन शर्तों को और अधिक स्पष्ट करने के लिए फिर से लिखने की सिफारिश करूंगा। इससे उन लोगों के लिए जीवन बहुत आसान हो जाएगा जो इस कोड को पढ़ेंगे और उसका रखरखाव करेंगे।

चेतावनी N5

V587 इस प्रकार के कार्यों का एक अजीब क्रम: ए = बी; बी = ए; पंक्तियाँ जाँचें: 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;
      ....
  }
  ....
}

यह कोड खंड संभवतः विसंकलन द्वारा प्राप्त किया गया था। फिर, छोड़ी गई टिप्पणी को देखते हुए, गैर-कार्यशील कोड का हिस्सा हटा दिया गया। हालाँकि, अभी भी कुछ ऑपरेशन बाकी हैं कर्सरआईडी, जिसका भी कोई खास मतलब नहीं है।

चेतावनी N6

V1004 [सीडब्ल्यूई-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 [सीडब्ल्यूई-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 [सीडब्ल्यूई-1164] 'ColumnHeaderPressedCurrentState' वेरिएबल को समान मान दिया गया था। libopenrct2ui CustomListView.cpp 510

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

कोड काफी अजीब लग रहा है. मुझे ऐसा लगता है कि या तो कंडीशन में या वेरिएबल को दोबारा असाइन करते समय कोई टाइपो त्रुटि थी कॉलमहेडरप्रेस्डकरंटस्टेट अर्थ असत्य.

उत्पादन

जैसा कि हम देख सकते हैं, पीवीएस-स्टूडियो स्टैटिक एनालाइजर को आपके टीमसिटी प्रोजेक्ट में एकीकृत करना काफी सरल है। ऐसा करने के लिए, केवल एक छोटी कॉन्फ़िगरेशन फ़ाइल लिखना पर्याप्त है। कोड की जाँच करने से आप असेंबली के तुरंत बाद समस्याओं की पहचान कर सकेंगे, जिससे परिवर्तनों की जटिलता और लागत अभी भी कम होने पर उन्हें खत्म करने में मदद मिलेगी।

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

स्रोत: www.habr.com