PVS-Studio 및 지속적인 통합: TeamCity. Open RollerCoaster Tycoon 2 프로젝트 분석

PVS-Studio 분석기를 사용하는 가장 최근의 시나리오 중 하나는 CI 시스템과의 통합입니다. 거의 모든 연속 통합 시스템의 PVS-Studio 프로젝트 분석은 단 몇 가지 명령으로 구축될 수 있지만 우리는 이 프로세스를 더욱 편리하게 만들기 위해 계속 노력하고 있습니다. PVS-Studio는 이제 분석기 출력을 TeamCity 형식(TeamCity Inspections Type)으로 변환하는 기능을 지원합니다. 그것이 어떻게 작동하는지 봅시다.

사용된 소프트웨어에 대한 정보

PVS-스튜디오 — 다양한 유형의 오류를 찾고 수정하는 작업을 용이하게 하도록 설계된 C, C++, C# 및 Java 코드의 정적 분석기입니다. 분석기는 Windows, Linux 및 macOS에서 사용할 수 있습니다. 이 기사에서는 분석기 자체뿐만 아니라 해당 배포판의 일부 유틸리티도 적극적으로 사용할 것입니다.

CL모니터 — 컴파일러 실행을 모니터링하는 모니터링 서버입니다. 프로젝트 빌드를 시작하기 직전에 실행해야 합니다. 스누핑 모드에서 서버는 지원되는 모든 컴파일러의 실행을 가로챕니다. 이 유틸리티는 C/C++ 프로젝트를 분석하는 데만 사용할 수 있다는 점은 주목할 가치가 있습니다.

PlogConverter – 분석기 보고서를 다른 형식으로 변환하는 유틸리티입니다.

연구중인 프로젝트에 대한 정보

실제 사례에서 이 기능을 시험해 보겠습니다. OpenRCT2 프로젝트를 분석해 보겠습니다.

오픈RCT2 - RollerCoaster Tycoon 2(RCT2) 게임을 공개적으로 구현하여 새로운 기능으로 확장하고 버그를 수정했습니다. 게임 플레이는 놀이기구, 상점, 시설이 포함된 놀이공원을 건설하고 유지하는 것을 중심으로 진행됩니다. 플레이어는 손님을 행복하게 하면서 이익을 얻고 공원의 좋은 평판을 유지하도록 노력해야 합니다. OpenRCT2를 사용하면 시나리오와 샌드박스 모두에서 플레이할 수 있습니다. 시나리오에서는 플레이어가 정해진 시간 내에 특정 작업을 완료해야 하는 반면, 샌드박스를 사용하면 플레이어는 제한이나 재정 없이 보다 유연한 공원을 건설할 수 있습니다.

조정

시간을 절약하기 위해 설치 과정을 건너뛰고 컴퓨터에서 TeamCity 서버가 실행되는 순간부터 시작하겠습니다. localhost:{설치 프로세스 중에 지정된 포트}(제 경우에는 localhost:9090)로 이동하여 인증 데이터를 입력해야 합니다. 입장 후 우리는 다음과 같은 인사를 받게 될 것입니다:

프로젝트 생성 버튼을 클릭하세요. 그런 다음 수동을 선택하고 필드를 채웁니다.

버튼을 누른 후 만들기, 설정 창이 나타납니다.

클릭해보자 빌드 구성 만들기.

필드를 채우고 클릭하세요. 만들기. 버전 제어 시스템을 선택하라는 창이 표시됩니다. 소스는 이미 로컬에 있으므로 건너뛰기.

마지막으로 프로젝트 설정으로 이동합니다.

조립 단계를 추가해 보겠습니다. 이를 수행하려면 다음을 클릭하세요. 빌드 단계 -> 빌드 단계 추가.

여기서는 다음을 선택합니다.

• 러너 유형 -> 명령줄
• 실행 -> 사용자 정의 스크립트

프로젝트 컴파일 과정에서 분석을 수행하기 때문에 조립과 분석이 한 단계로 이루어져야 하므로 해당 필드를 채워주세요. 사용자 정의 스크립트:

나중에 개별 단계를 살펴보겠습니다. 분석기 로드, 프로젝트 조립, 분석, 보고서 출력 및 형식 지정에 단 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"

마지막 단계는 형식이 지정된 보고서를 표시하는 것입니다. 표준 출력, 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

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

분석기는 메모리를 동적으로 할당한 후 오류를 발견했습니다. 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),
  ....
};

정적 분석가 외에는 이 주의력 테스트를 통과할 수 있는 사람이 거의 없습니다. 이 복사-붙여넣기 예제는 바로 이러한 이유로 좋습니다.

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

좀 더 자세히 살펴보겠습니다. 표현 이미지방향/8 다음과 같은 경우 거짓이 됩니다. 이미지방향 범위는 -7에서 7 사이입니다. 두 번째 부분: (이미지 방향 / 8) != 3 체크 무늬 이미지방향 범위 밖에 있는 경우: 각각 -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;
      ....
  }
  ....
}

이 코드 조각은 디컴파일을 통해 얻은 것일 가능성이 높습니다. 그런 다음 왼쪽 주석으로 판단하면 작동하지 않는 코드의 일부가 제거되었습니다. 하지만 아직 몇 가지 작업이 남았습니다. 커서ID, 그것도 별로 의미가 없습니다.

경고 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' 표현식은 항상 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);
    ....
  }
  ....
}

경고 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-Studio 및 지속적인 통합: TeamCity. Open RollerCoaster Tycoon 2 프로젝트 분석.

출처 : habr.com