PVS-स्टुडियो र निरन्तर एकीकरण: TeamCity। ओपन रोलरकोस्टर टाइकुन २ परियोजनाको विश्लेषण

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

प्रयोग गरिएको सफ्टवेयर बारे जानकारी

PVS- स्टूडियो — C, C++, C# र Java कोडको स्थिर विश्लेषक, विभिन्न प्रकारका त्रुटिहरू फेला पार्न र सुधार गर्ने कार्यलाई सहज बनाउन डिजाइन गरिएको। विश्लेषक Windows, Linux र macOS मा प्रयोग गर्न सकिन्छ। यस लेखमा हामी सक्रिय रूपमा विश्लेषक मात्र होइन, तर यसको वितरणबाट केही उपयोगिताहरू पनि प्रयोग गर्नेछौं।

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

PlogConverter - विश्लेषक रिपोर्टहरू विभिन्न ढाँचाहरूमा रूपान्तरण गर्नको लागि उपयोगिता।

अध्ययन अन्तर्गत परियोजना बारे जानकारी

यो कार्यक्षमतालाई व्यावहारिक उदाहरणमा प्रयास गरौं - OpenRCT2 परियोजनाको विश्लेषण गरौं।

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

समायोजन

समय बचत गर्नको लागि, म सम्भवतः स्थापना प्रक्रिया छोड्नेछु र मेरो कम्प्युटरमा TeamCity सर्भर चलिरहेको क्षणबाट सुरु गर्नेछु। हामीले मा जानु पर्छ: localhost:{port specified while installation process} (मेरो केसमा, localhost:9090) र प्राधिकरण डेटा प्रविष्ट गर्नुहोस्। प्रवेश गरेपछि हामीलाई स्वागत गरिनेछ:

Create Project बटनमा क्लिक गर्नुहोस्। अर्को, म्यानुअल रूपमा चयन गर्नुहोस् र क्षेत्रहरू भर्नुहोस्।

बटन थिचे पछि सिर्जना, हामीलाई सेटिङ्हरू सहितको विन्डोद्वारा स्वागत गरिन्छ।

क्लिक गरौं निर्माण कन्फिगरेसन सिर्जना गर्नुहोस्.

फिल्डहरू भर्नुहोस् र क्लिक गर्नुहोस् सिर्जना। हामी तपाईंलाई एउटा संस्करण नियन्त्रण प्रणाली चयन गर्न सोध्ने विन्डो देख्छौं। स्रोतहरू पहिले नै स्थानीय रूपमा अवस्थित भएकोले, क्लिक गर्नुहोस् छोड्नुहोस्.

अन्तमा, हामी परियोजना सेटिङहरूमा जान्छौं।

विधानसभा चरणहरू थपौं, यो गर्न क्लिक गर्नुहोस्: निर्माण चरणहरू -> निर्माण चरण थप्नुहोस्.

यहाँ हामी छनौट गर्छौं:

• धावक प्रकार -> कमाण्ड लाइन
• चलाउनुहोस् -> अनुकूलन लिपि

हामीले परियोजना संकलनको क्रममा विश्लेषण गर्ने भएकाले, विधानसभा र विश्लेषण एक चरण हुनुपर्छ, त्यसैले फिल्ड भर्नुहोस्। अनुकूल स्क्रिप्ट:

हामी व्यक्तिगत चरणहरू पछि हेर्नेछौं। यो महत्त्वपूर्ण छ कि विश्लेषक लोड गर्न, परियोजना संयोजन गर्न, यसको विश्लेषण गर्न, रिपोर्ट आउटपुट गर्न र यसलाई ढाँचामा कोडको एघार लाइनहरू मात्र लिन्छ।

हामीले गर्नुपर्ने अन्तिम कुरा भनेको वातावरण चरहरू सेट गर्नु हो, जुन मैले तिनीहरूको पठनीयता सुधार गर्ने केही तरिकाहरू रेखांकित गरेको छु। यो गर्नको लागि, अगाडि बढौं: प्यारामिटरहरू -> नयाँ प्यारामिटर थप्नुहोस् र तीन चर थप्नुहोस्:

तपाईले गर्नुपर्ने भनेको बटन थिच्नु हो चलाउनुहोस् माथिल्लो दायाँ कुनामा। जब परियोजना भेला र विश्लेषण भइरहेको छ, म तपाईंलाई स्क्रिप्टको बारेमा बताउनेछु।

प्रत्यक्ष स्क्रिप्ट

पहिले, हामीले नवीनतम PVS-स्टुडियो वितरण डाउनलोड गर्न आवश्यक छ। यसका लागि हामी 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-विशेष ढाँचामा रूपान्तरण गर्छ। यसका लागि धन्यवाद, हामी यसलाई सिधै निर्माण विन्डोमा हेर्न सक्षम हुनेछौं।

%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)
  {
    ....
  }
  ....
}

नजिकबाट हेरौं। अभिव्यक्ति imageDirection/8 यदि गलत हुनेछ छवि दिशा -७ देखि ७ सम्मको दायरामा छ। दोस्रो भाग: (छवि निर्देशन / ८) != ३ चेक छवि दिशा दायरा बाहिर भएको कारण: -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;
      ....
  }
  ....
}

यो कोड टुक्रा सम्भवतः decompilation द्वारा प्राप्त भएको थियो। त्यसपछि, टिप्पणी छोडेर न्याय गर्दै, गैर-कार्यकारी कोडको अंश हटाइयो। यद्यपि, त्यहाँ अझै दुईवटा अपरेशनहरू बाँकी छन् 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 परियोजनामा ​​एकीकृत गर्न एकदम सरल छ। यो गर्न, यो केवल एक सानो कन्फिगरेसन फाइल लेख्न पर्याप्त छ। कोड जाँच गर्नाले तपाईंलाई विधानसभा पछि तुरुन्तै समस्याहरू पहिचान गर्न अनुमति दिनेछ, जसले तिनीहरूलाई हटाउन मद्दत गर्नेछ जब परिवर्तनहरूको जटिलता र लागत अझै कम छ।

यदि तपाइँ यो लेख अंग्रेजी बोल्ने दर्शकहरूसँग साझा गर्न चाहनुहुन्छ भने, कृपया अनुवाद लिङ्क प्रयोग गर्नुहोस्: Vladislav Stolyarov। PVS-स्टुडियो र निरन्तर एकीकरण: TeamCity। ओपन रोलरकोस्टर टाइकुन २ परियोजनाको विश्लेषण.

स्रोत: www.habr.com