PVS-Studio と継続的インテグレーション: TeamCity。 Open RollerCoaster Tycoon 2 プロジェクトの分析

PVS-Studio アナライザーを使用するための最新のシナリオの XNUMX つは、CI システムとの統合です。 また、ほとんどすべての継続的統合システムからの PVS-Studio プロジェクトの分析は、わずか数個のコマンドに組み込むことができますが、私たちはこのプロセスをさらに便利にするために継続的に取り組んでいます。 PVS-Studio は、アナライザー出力を TeamCity (TeamCity Inspections Type) の形式に変換する機能をサポートするようになりました。 どのように機能するかを見てみましょう。

使用されているソフトウェアに関する情報

PVSスタジオ — C、C++、C#、および Java コードの静的アナライザー。さまざまなタイプのエラーを見つけて修正するタスクを容易にするように設計されています。 アナライザーは Windows、Linux、macOS で使用できます。 この記事では、アナライザー自体だけでなく、そのディストリビューションのいくつかのユーティリティも積極的に使用します。

CLモニター — コンパイラの起動を監視する監視サーバーです。 プロジェクトのビルドを開始する直前に実行する必要があります。 スヌーピング モードでは、サーバーはサポートされているすべてのコンパイラの実行をインターセプトします。 このユーティリティは C/C++ プロジェクトの分析にのみ使用できることに注意してください。

プログコンバーター – アナライザー レポートをさまざまな形式に変換するユーティリティ。

研究中のプロジェクトに関する情報

実際の例でこの機能を試してみましょう。OpenRCT2 プロジェクトを分析してみましょう。

OpenRCT2 - ゲーム RollerCoaster Tycoon 2 (RCT2) のオープン実装。新しい機能で拡張し、バグを修正します。 ゲームプレイは、乗り物、ショップ、施設を含む遊園地の建設と維持を中心に展開します。 プレイヤーはゲストを満足させながら、利益を上げて公園の良い評判を維持しようと努めなければなりません。 OpenRCT2 では、シナリオとサンドボックスの両方でプレイできます。 シナリオでは、プレイヤーは設定時間内に特定のタスクを完了する必要がありますが、サンドボックスを使用すると、プレイヤーは制限や資金なしでより柔軟なパークを構築できます。

調整

時間を節約するために、おそらくインストールプロセスをスキップし、コンピューター上で TeamCity サーバーを実行している時点から開始するでしょう。 localhost:{インストールプロセス中に指定されたポート} (私の場合、localhost:9090) に移動し、認証データを入力する必要があります。 入ると次のような歓迎を受けます。

「プロジェクトの作成」ボタンをクリックします。 次に、「手動」を選択してフィールドに入力します。

ボタンを押した後 創造する, 設定を含むウィンドウが表示されます。

クリックしましょう ビルド構成の作成.

フィールドに入力してクリックします 創造する。 バージョン管理システムの選択を求めるウィンドウが表示されます。 ソースはすでにローカルに配置されているため、 スキップ.

最後に、プロジェクトの設定に進みます。

組み立て手順を追加しましょう。これを行うには、次をクリックします。 ビルドステップ -> ビルドステップの追加.

ここでは次のことを選択します。

• ランナータイプ -> コマンドライン
• 実行 -> カスタムスクリプト

プロジェクトのコンパイル中に分析を実行するため、組み立てと分析は XNUMX つのステップである必要があるため、フィールドに記入します。 カスタムスクリプト:

個々のステップについては後で見ていきます。 アナライザーのロード、プロジェクトの組み立て、分析、レポートの出力、およびフォーマット設定に必要なコードはわずか XNUMX 行であることが重要です。

最後に行う必要があるのは、環境変数を設定することです。これについては、読みやすさを向上させるいくつかの方法を概説しました。 これを行うには、次に進みましょう。 パラメータ -> 新しいパラメータを追加 そして XNUMX つの変数を追加します。

ボタンを押すだけです ラン 右上隅にあります。 プロジェクトが組み立てられ、分析されている間に、スクリプトについて説明します。

直接スクリプトを作成する

まず、最新の 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 固有の形式に変換します。 このおかげで、ビルド ウィンドウで直接確認できるようになります。

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

最後のステップでは、フォーマットされたレポートを表示します。 (Linuxで言うところの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"

それまでの間、プロジェクトの組み立てと分析は正常に完了し、タブに移動できます。 プロジェクト そしてそれを確かめてください。

さあ、クリックしてみましょう 検査合計アナライザー レポートの表示に移動するには、次のようにします。

警告は診断ルール番号ごとにグループ化されています。 コード内を移動するには、警告のある行番号をクリックする必要があります。 右上隅にある疑問符をクリックすると、ドキュメントを含む新しいタブが開きます。 アナライザーの警告のある行番号をクリックして、コード内を移動することもできます。 を使用すると、リモート コンピュータからのナビゲーションが可能になります ソースツリールート マーカー。 アナライザーのこの動作モードに興味がある人は、対応するセクションをよく理解してください。 ドキュメンテーション.

アナライザーの結果の表示

ビルドのデプロイと構成が完了したので、注目しているプロジェクトで見つかったいくつかの興味深い警告を見てみましょう。

警告N1

V６０ [CWE-401] 「結果」ポインタを解放せずに例外がスローされました。 メモリリークの可能性があります。 libopenrct2 オブジェクトファクトリー.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

V６０ '|' の左側と右側に同一の部分式 '(1ULL << WIDX_MONTH_BOX)' があります。 オペレーター。 libopenrct2ui 攻略.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

V６０ 派生クラス「RCT12BannerElement」の「flags」フィールドが基本クラス「RCT12TileElementBase」のフィールドを上書きするのは奇妙です。 行を確認してください: RCT12.h:570、RCT12.h:259。 libopenrct2 RCT12.h 570

struct RCT12SpriteBase
{
  ....
  uint8_t flags;
  ....
};
struct rct1_peep : RCT12SpriteBase
{
  ....
  uint8_t flags;
  ....
};

もちろん、基本クラスと子孫で同じ名前の変数を使用することが常にエラーになるわけではありません。 ただし、継承テクノロジ自体は、親クラスのすべてのフィールドが子クラスに存在することを前提としています。 継承内で同じ名前のフィールドを宣言すると、混乱が生じます。

警告N4

V６０ 「imageDirection / 8」ステートメントの結果が条件の一部であるのは奇妙です。 おそらく、この発言は他の何かと比較されるべきでした。 libopenrct2 観測タワー.cpp 38

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

詳しく見てみましょう。 表現 画像方向/8 の場合は false になります 画像方向 範囲は -7 ～ 7 です。 XNUMX 番目の部分: (imageDirection / 8) != 3 小切手 画像方向 範囲外の場合: それぞれ -31 ～ -24 と 24 ～ 31。 この方法で特定の範囲に含まれる数値をチェックするのは非常に奇妙に思えます。たとえこのコードにエラーがないとしても、これらの条件をより明示的に書き直すことをお勧めします。 これにより、このコードを読んで保守する人にとって作業がはるかに簡単になります。

警告N5

V６０ この種の代入の奇妙なシーケンス: 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

V６０ [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);                    // <=
  }
  ....
}

このコードは修正が非常に簡単で、XNUMX 回確認するだけで済みます。 プレイヤー null ポインターに追加するか、条件文の本体に追加します。 私は XNUMX 番目のオプションをお勧めします。

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

V６０ [CWE-570] 式 'name == nullptr' は常に false です。 libopenrct2 サーバーリスト.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

V６０ [CWE-1164] 「ColumnHeaderPressedCurrentState」変数に同じ値が割り当てられていました。 libopenrct2uiカスタムリストビュー.cpp 510

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

コードはかなり奇妙に見えます。 条件または変数の再代入時にタイプミスがあったように思えます ColumnHeaderPressedCurrentState 意味 false.

出力

ご覧のとおり、PVS-Studio 静的アナライザーを TeamCity プロジェクトに統合するのは非常に簡単です。 これを行うには、小さな構成ファイルを XNUMX つ作成するだけで十分です。 コードをチェックすると、アセンブリ直後に問題を特定できるため、変更の複雑さとコストがまだ低いうちに問題を解決できます。

この記事を英語圏の読者と共有したい場合は、翻訳リンクを使用してください: Vladislav Stolyarov。 PVS-Studio と継続的インテグレーション: TeamCity。 Open RollerCoaster Tycoon 2 プロジェクトの分析.

出所： habr.com