পিভিএস-স্টুডিও এবং ক্রমাগত ইন্টিগ্রেশন: টিমসিটি। ওপেন রোলারকোস্টার টাইকুন 2 প্রকল্পের বিশ্লেষণ

পিভিএস-স্টুডিও বিশ্লেষক ব্যবহারের জন্য সবচেয়ে বর্তমান পরিস্থিতিগুলির মধ্যে একটি হল এটি সিআই সিস্টেমের সাথে একীকরণ। এবং যদিও প্রায় যেকোনো একটানা ইন্টিগ্রেশন সিস্টেম থেকে PVS-Studio প্রোজেক্টের বিশ্লেষণ শুধুমাত্র কয়েকটি কমান্ডে তৈরি করা যেতে পারে, আমরা এই প্রক্রিয়াটিকে আরও বেশি সুবিধাজনক করে চলেছি। পিভিএস-স্টুডিওতে এখন বিশ্লেষক আউটপুটকে টিমসিটি - টিমসিটি পরিদর্শন প্রকারের ফর্ম্যাটে রূপান্তর করার জন্য সমর্থন রয়েছে। দেখা যাক এটা কিভাবে কাজ করে।

ব্যবহৃত সফ্টওয়্যার সম্পর্কে তথ্য

পিভিএস-স্টুডিও — C, C++, C# এবং জাভা কোডের একটি স্ট্যাটিক বিশ্লেষক, বিভিন্ন ধরনের ত্রুটি খুঁজে বের করা এবং সংশোধন করার কাজ সহজতর করার জন্য ডিজাইন করা হয়েছে। বিশ্লেষকটি উইন্ডোজ, লিনাক্স এবং ম্যাকোসে ব্যবহার করা যেতে পারে। এই নিবন্ধে আমরা সক্রিয়ভাবে শুধুমাত্র বিশ্লেষক নিজেই নয়, এর বিতরণ থেকে কিছু ইউটিলিটিও ব্যবহার করব।

সিএল মনিটর — হল একটি মনিটরিং সার্ভার যা কম্পাইলার লঞ্চ মনিটর করে। এটি আপনার প্রকল্প নির্মাণ শুরু করার আগে অবিলম্বে চালানো আবশ্যক. স্নুপিং মোডে, সার্ভার সমস্ত সমর্থিত কম্পাইলারের রান আটকাবে। এটি লক্ষণীয় যে এই ইউটিলিটি শুধুমাত্র C/C++ প্রকল্পগুলি বিশ্লেষণ করতে ব্যবহার করা যেতে পারে।

প্লাগ কনভার্টার - বিশ্লেষক প্রতিবেদনগুলিকে বিভিন্ন ফর্ম্যাটে রূপান্তর করার জন্য একটি ইউটিলিটি।

গবেষণা অধীন প্রকল্প সম্পর্কে তথ্য

একটি ব্যবহারিক উদাহরণে এই কার্যকারিতাটি চেষ্টা করা যাক - আসুন OpenRCT2 প্রকল্পটি বিশ্লেষণ করি।

ওপেনআরসিটি 2 - RollerCoaster Tycoon 2 (RCT2) গেমটির একটি উন্মুক্ত বাস্তবায়ন, এটিকে নতুন ফাংশন এবং বাগ সংশোধন করে প্রসারিত করা। গেমপ্লে রাইড, দোকান এবং সুবিধা সম্বলিত একটি বিনোদন পার্ক তৈরি এবং রক্ষণাবেক্ষণের চারপাশে ঘোরে। খেলোয়াড়কে অবশ্যই লাভ করার চেষ্টা করতে হবে এবং অতিথিদের খুশি রেখে পার্কের সুনাম বজায় রাখতে হবে। OpenRCT2 আপনাকে দৃশ্যকল্প এবং স্যান্ডবক্স উভয় ক্ষেত্রেই খেলতে দেয়। পরিস্থিতির জন্য খেলোয়াড়কে একটি নির্দিষ্ট সময়ের মধ্যে একটি নির্দিষ্ট কাজ সম্পূর্ণ করতে হবে, যখন স্যান্ডবক্স খেলোয়াড়কে কোনো সীমাবদ্ধতা বা অর্থ ছাড়াই আরও নমনীয় পার্ক তৈরি করতে দেয়।

সমন্বয়

সময় বাঁচানোর জন্য, আমি সম্ভবত ইনস্টলেশন প্রক্রিয়াটি এড়িয়ে যাব এবং আমার কম্পিউটারে টিমসিটি সার্ভার চালু হওয়ার মুহূর্ত থেকে শুরু করব। আমাদের যেতে হবে: localhost:{port specified while installation process} (আমার ক্ষেত্রে, localhost:9090) এবং অনুমোদনের ডেটা লিখতে হবে। প্রবেশ করার পরে আমাদের অভ্যর্থনা জানানো হবে:

Create Project বাটনে ক্লিক করুন। এর পরে, ম্যানুয়ালি নির্বাচন করুন এবং ক্ষেত্রগুলি পূরণ করুন।

বোতাম টিপানোর পর সৃষ্টি, আমরা সেটিংস সহ একটি উইন্ডো দ্বারা স্বাগত জানানো হয়।

এর ক্লিক করা যাক বিল্ড কনফিগারেশন তৈরি করুন.

ক্ষেত্রগুলি পূরণ করুন এবং ক্লিক করুন সৃষ্টি. আমরা একটি উইন্ডো দেখতে পাই যা আপনাকে একটি সংস্করণ নিয়ন্ত্রণ ব্যবস্থা নির্বাচন করতে বলছে। যেহেতু উত্স ইতিমধ্যে স্থানীয়ভাবে অবস্থিত, ক্লিক করুন লাফালাফি করা.

অবশেষে, আমরা প্রকল্প সেটিংসে চলে যাই।

আসুন সমাবেশের পদক্ষেপগুলি যোগ করি, এটি করতে ক্লিক করুন: বিল্ড স্টেপ -> বিল্ড স্টেপ যোগ করুন.

এখানে আমরা নির্বাচন করি:

• রানার টাইপ -> কমান্ড লাইন
• চালান -> কাস্টম স্ক্রিপ্ট

যেহেতু আমরা প্রকল্প সংকলনের সময় বিশ্লেষণ করব, সমাবেশ এবং বিশ্লেষণ এক ধাপ হওয়া উচিত, তাই ক্ষেত্রটি পূরণ করুন কাস্টম স্ক্রিপ্ট:

আমরা পরে পৃথক পদক্ষেপগুলি দেখব। এটি গুরুত্বপূর্ণ যে বিশ্লেষক লোড করা, প্রকল্পটি একত্রিত করা, এটি বিশ্লেষণ করা, প্রতিবেদনটি আউটপুট করা এবং ফর্ম্যাট করার জন্য কোডের মাত্র এগারো লাইন লাগে।

শেষ জিনিসটি আমাদের করতে হবে পরিবেশের ভেরিয়েবলগুলি সেট করুন, যা আমি তাদের পঠনযোগ্যতা উন্নত করার কিছু উপায় বর্ণনা করেছি। এটি করতে, আসুন এগিয়ে যাই: পরামিতি -> নতুন প্যারামিটার যোগ করুন এবং তিনটি ভেরিয়েবল যোগ করুন:

আপনাকে যা করতে হবে তা হল বোতাম টিপুন চালান উপরের ডান কোণায়। যখন প্রকল্পটি একত্রিত এবং বিশ্লেষণ করা হচ্ছে, আমি আপনাকে স্ক্রিপ্ট সম্পর্কে বলব।

সরাসরি স্ক্রিপ্ট

প্রথমত, আমাদের সর্বশেষ PVS-Studio বিতরণ ডাউনলোড করতে হবে। এর জন্য আমরা 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_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"

ইতিমধ্যে, প্রকল্পের সমাবেশ এবং বিশ্লেষণ সফলভাবে সম্পন্ন হয়েছে, আমরা ট্যাবে যেতে পারি প্রকল্প এবং এটা নিশ্চিত করুন।

এখন ক্লিক করা যাক পরিদর্শন মোটবিশ্লেষক রিপোর্ট দেখতে যেতে:

সতর্কতাগুলি ডায়াগনস্টিক নিয়ম সংখ্যা দ্বারা গোষ্ঠীবদ্ধ করা হয়৷ কোডটি নেভিগেট করতে, আপনাকে সতর্কতা সহ লাইন নম্বরে ক্লিক করতে হবে। উপরের ডানদিকে কোণায় প্রশ্ন চিহ্নে ক্লিক করলে ডকুমেন্টেশন সহ একটি নতুন ট্যাব খুলবে। আপনি বিশ্লেষক সতর্কতা সহ লাইন নম্বরে ক্লিক করে কোডটি নেভিগেট করতে পারেন। ব্যবহার করার সময় দূরবর্তী কম্পিউটার থেকে নেভিগেশন সম্ভব 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 মিথ্যা হবে যদি ইমেজ ডিরেকশন -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;
      ....
  }
  ....
}

এই কোড খণ্ডটি সম্ভবত 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 অর্থ মিথ্যা.

উপসংহার

আমরা দেখতে পাচ্ছি, আপনার টিমসিটি প্রকল্পে পিভিএস-স্টুডিও স্ট্যাটিক বিশ্লেষককে একীভূত করা বেশ সহজ। এটি করার জন্য, শুধুমাত্র একটি ছোট কনফিগারেশন ফাইল লিখতে যথেষ্ট। কোড চেক করা আপনাকে সমাবেশের পরে অবিলম্বে সমস্যাগুলি সনাক্ত করার অনুমতি দেবে, যা জটিলতা এবং পরিবর্তনের খরচ এখনও কম হলে সেগুলি দূর করতে সাহায্য করবে।

আপনি যদি এই নিবন্ধটি ইংরেজি ভাষাভাষী দর্শকদের সাথে ভাগ করতে চান তবে অনুগ্রহ করে অনুবাদ লিঙ্কটি ব্যবহার করুন: ভ্লাদিস্লাভ স্টোলিয়ারভ। পিভিএস-স্টুডিও এবং ক্রমাগত ইন্টিগ্রেশন: টিমসিটি। ওপেন রোলারকোস্টার টাইকুন 2 প্রকল্পের বিশ্লেষণ.

উত্স: www.habr.com