PVS-Studioと継続的な統合：TeamCity。RollerCoaster Tycoon2プロジェクト分析を開く

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

使用したソフトウェアに関する情報

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



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



PlogConverterは、アナライザーレポートをさまざまな形式に変換するためのユーティリティです。

調査対象プロジェクトに関する情報

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



OpenRCT2は、RollerCoaster Tycoon 2（RCT2）のオープンソース実装であり、新機能とバグ修正で拡張されています。ゲームプレイは、アトラクション、ショップ、施設を収容するアミューズメントパークの建設とメンテナンスを中心に展開されます。プレイヤーは、ゲストを満足させながら、利益を上げ、公園の評判を維持するように努める必要があります。OpenRCT2を使用すると、シナリオとサンドボックスの両方でプレイできます。シナリオでは、プレーヤーは設定された時間に特定のタスクを完了する必要がありますが、サンドボックスを使用すると、プレーヤーは制限や資金をかけずに、より柔軟な公園を構築できます。

カスタマイズ

時間を節約するために、おそらくインストールプロセスをスキップして、TeamCityサーバーがコンピューターで実行されている瞬間から開始します。localhost：{インストール中に指定されたポート}（私の場合はlocalhost：9090）に移動し、認証データを入力する必要があります。入った後、私たちは次の人に会います：





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





[作成]ボタンをクリックすると、設定が表示されたウィンドウが表示されます。





[ビルド構成の作成]をクリックします。





フィールドに入力し、[作成]をクリックします。バージョン制御システムを選択するためのウィンドウが表示されます。ソースはすでにローカルにあるため、[スキップ]をクリックします。





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





[ビルドステップ]-> [ビルドステップの追加]をクリックして、ビルドステップを追加します。





ここで選択します：

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

プロジェクトのコンパイル中に分析するため、アセンブリと分析は1つのステップである必要があります。したがって、[カスタムスクリプト]フィールドに入力します。





後で個々のステップについて詳しく説明します。アナライザーのロード、プロジェクトの構築、分析、レポートの出力、およびフォーマットのすべてに、11行のコードしか必要ないことが重要です。



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





右上隅 にある[実行]ボタンをクリックするだけです。プロジェクトの組み立てと分析中に、スクリプトについて説明します。

直接スクリプト

まず、最新のPVS-Studioディストリビューションをダウンロードする必要があります。このために、hocolateyパッケージマネージャーを使用します。これについてもっと知りたい人のために、関連記事があります：

choco install pvs-studio -y

次に、CLMonitorプロジェクトアセンブリ追跡ユーティリティを起動しましょう。

%CLmon% monitor –-attach

次に、プロジェクトをビルドします。ビルドする必要のあるバージョンのMSBuildへのパスが、MSB環境変数として使用されます。

%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"

次に、配布キットのもう1つのユーティリティを使用します。PlogConverterは、レポートを標準形式からTeamCity固有の形式に変換します。これにより、組み立てウィンドウで直接確認できるようになります。

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

最後のステップは、フォーマットされたレポートをstdoutに出力することです。ここで、TeamCityパーサーによって取得されます。

type "C:\temp\ptest.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:\temp\ptest.plog_TeamCity.txt"

それまでの間、プロジェクトの組み立てと分析は正常に完了しました。[プロジェクト]タブに移動して、これを確認できます。





次に、[検査の合計]をクリックして、アナライザーレポートを表示します。





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

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

ビルドのデプロイと構成が完了したら、調査中のプロジェクトで見つかったいくつかの興味深い警告を確認することをお勧めします。



警告



N1V773 [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;
}

アナライザーは、CreateObjectでの動的メモリ割り当て後、例外がスローされたときにメモリがクリアされないというエラーに気づきました。したがって、メモリリークが発生します。



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),
  ....
};

静的アナライザー以外に、この注意力テストに合格できるものはほとんどありません。このコピー＆ペーストの例は、まさにそのために適しています。



アラート



N3V703派生クラス「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警告



V793それは「imageDirection / 8」ステートメントの結果は、条件の一部であること奇妙です。おそらく、このステートメントは他のものと比較されるべきでした。 libopenrct2ObservationTower.cpp 38

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

よく見てみましょう。imageDirectionが-7から7の範囲にある場合、imageDirection / 8式はfalseになります。2番目の部分：（imageDirection / 8）！= 3は、imageDirectionが範囲外であることを確認します：-31から-24および24から31それぞれ。この方法で特定の範囲を入力するための番号を確認するのはかなり奇妙に思えます。このコードフラグメントにエラーがない場合でも、これらの条件をより明確に書き直すことをお勧めします。これにより、このコードを読んで保守する人々の生活がはるかに楽になります。



警告



N5V587この種の割り当ての奇妙なシーケンス：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;
      ....
  }
  ....
}

このコードは、おそらく逆コンパイルによって取得されたものです。次に、残されたコメントから判断すると、機能していないコードの一部が削除されました。ただし、cursorIdに対するいくつかの操作が残っており、これもあまり意味がありません。



N6警告



V1004 [CWE-476] nullptrに対して検証された後、「player」ポインターが安全に使用されませんでした。チェックライン：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);                    // <=
  }
  ....
}

このコードの修正は非常に簡単です。プレーヤーでnullポインターを3回チェックするか、条件演算子の本体に追加する必要があります。私は2番目のオプションを提案します：

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);
    }
  }
  ....
}

警告



N7V547 [CWE-570]式 'name == nullptr'は常にfalseです。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);
    ....
  }
  ....
}

警告



N8V1048 [CWE-1164] ' ColumnHeaderPressedCurrentState '変数に同じ値が割り当てられました。libopenrct2ui CustomListView.cpp 510

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

コードはかなり奇妙に見えます。変数ColumnHeaderPressedCurrentState値をfalseに再割り当てするときに、タイプミスがあったか、影響を受ける可能性があると思います。

出力

ご覧のとおり、PVS-Studio静的アナライザーをTeamCityプロジェクトに統合するのは非常に簡単です。あなたがする必要があるのは1つの小さい構成ファイルを書くことです。コードレビューを使用すると、ビルドの直後に問題を特定できます。これにより、編集の複雑さとコストがまだ小さい場合に問題を排除できます。

この記事を英語を話す聴衆と共有したい場合は、翻訳リンクを使用してください：VladislavStolyarov。PVS-Studioと継続的な統合：TeamCity。Open RollerCoaster Tycoon2プロジェクトの分析。