🥇정적 분석 - 도입부터 통합까지

끝없는 코드 검토나 디버깅에 지쳐서 때로는 삶을 단순화하는 방법에 대해 생각합니다. 그리고 조금 검색하거나 우연히 우연히 발견하면 "정적 분석"이라는 마법의 문구를 볼 수 있습니다. 이것이 무엇인지, 그리고 프로젝트와 어떻게 상호 작용할 수 있는지 살펴보겠습니다.

사실 현대 언어로 작성하면 자신도 모르게 정적 분석기를 통해 실행하게 됩니다. 사실 모든 최신 컴파일러는 코드의 잠재적인 문제에 대해 아주 작은 경고 집합을 제공합니다. 예를 들어 Visual Studio에서 C++ 코드를 컴파일할 때 다음이 표시될 수 있습니다.

이 출력에서 우리는 변수를 볼 수 있습니다 였다 함수의 어느 곳에서도 사용되지 않았습니다. 따라서 실제로는 거의 항상 간단한 정적 코드 분석기를 사용했습니다. 그러나 Coverity, Klocwork 또는 PVS-Studio와 같은 전문 분석기와 달리 컴파일러에서 제공하는 경고는 작은 범위의 문제만을 나타낼 수 있습니다.

정적 분석이 무엇인지, 어떻게 구현하는지 확실히 모르겠다면, 이 기사를 읽어보세요이 방법론에 대해 자세히 알아보세요.

정적 분석이 필요한 이유는 무엇입니까?

간단히 말해서 가속과 단순화입니다.

정적 분석을 사용하면 언어 구성의 잘못된 사용부터 오타까지 코드에서 다양한 문제를 찾을 수 있습니다. 예를 들어, 대신

auto x = obj.x;
auto y = obj.y;
auto z = obj.z;

다음 코드를 작성했습니다.

auto x = obj.x;
auto y = obj.y;
auto z = obj.x;

보시다시피 마지막 줄에 오타가 있습니다. 예를 들어 PVS-Studio는 다음 경고를 발행합니다.

V537 'y' 항목의 사용법이 올바른지 검토해 보세요.

이 오류를 직접 확인하고 싶다면 컴파일러 탐색기에서 미리 만들어진 예제를 시도해 보세요. *클릭*.

아시다시피 이러한 코드 섹션에 즉시주의를 기울이는 것이 항상 가능한 것은 아니며 이로 인해 모든 것이 왜 그렇게 이상하게 작동하는지 궁금해하면서 한 시간 동안 디버깅에 앉아있을 수 있습니다.

그러나 이는 분명히 실수이다. 개발자가 언어의 미묘함을 잊어버렸기 때문에 최적이 아닌 코드를 작성했다면 어떻게 될까요? 아니면 코드에서 허용했을 수도 있습니다. 정의되지 않은 동작? 안타깝게도 이러한 경우는 매우 흔한 일이며 오타, 일반적인 오류 또는 정의되지 않은 동작이 포함된 작업 코드를 구체적으로 디버깅하는 데 가장 많은 시간이 소비됩니다.

이러한 상황을 위해 정적 분석이 나타났습니다. 이는 코드의 다양한 문제를 지적하고 문서에서 왜 이런 방식으로 작성할 필요가 없는지, 이로 인해 발생할 수 있는 문제와 해결 방법을 설명하는 개발자를 위한 보조자입니다. 다음은 그 예입니다. *클릭*.

기사에서 분석기가 감지할 수 있는 더 흥미로운 오류를 찾을 수 있습니다.

이제 이 자료를 읽고 정적 분석의 이점을 확신했으므로 사용해 볼 수 있습니다. 하지만 어디서부터 시작해야 할까요? 현재 프로젝트에 새로운 도구를 통합하는 방법은 무엇입니까? 그리고 그에게 팀을 소개하는 방법은 무엇입니까? 아래에서 이러한 질문에 대한 답을 찾을 수 있습니다.

있습니다. 정적 분석은 코드 검토와 같은 유용한 기능을 대체하거나 취소하지 않습니다. 이는 이 프로세스를 보완하여 오타, 부정확성 및 위험한 디자인을 미리 발견하고 수정하는 데 도움이 됩니다. 잘못 배치된 괄호나 코드를 찾는 것보다 알고리즘 및 코드 명확성에 대한 코드 검토에 집중하는 것이 훨씬 더 생산적입니다. 지루한 비교 기능 읽기.

0. 도구 알아보기

모든 것은 평가판으로 시작됩니다. 실제로, 이전에 실제 도구를 본 적이 없다면 개발 프로세스에 무언가를 구현하기로 결정하기가 어렵습니다. 그러므로 가장 먼저 해야 할 일은 다운로드입니다. 평가판.

이 단계에서 배울 내용은 다음과 같습니다.

분석기와 상호 작용하는 방법은 무엇입니까?
분석기가 개발 환경과 호환됩니까?
현재 귀하의 프로젝트에는 어떤 문제가 있습니까?

필요한 모든 것을 설치한 후 가장 먼저 해야 할 일은 전체 프로젝트에 대한 분석을 실행하는 것입니다(Windows, Linux, macOS). Visual Studio의 PVS-Studio의 경우 비슷한 그림이 표시됩니다(클릭 가능).

사실 정적 분석기는 일반적으로 코드 기반이 큰 프로젝트에 대해 엄청난 수의 경고를 발행합니다. 프로젝트가 이미 작동 중이므로 모든 문제를 해결할 필요는 없습니다. 즉, 이러한 문제는 심각하지 않습니다. 그러나 당신은 가장 흥미로운 경고를 볼 수 있습니다 필요한 경우 수정하세요. 이렇게 하려면 출력을 필터링하고 가장 신뢰할 수 있는 메시지만 남겨야 합니다. Visual Studio용 PVS-Studio 플러그인에서는 오류 수준 및 범주별로 필터링하여 이 작업을 수행합니다. 가장 정확한 출력을 위해 높은 и 일반 (클릭 가능):

실제로 수천 개의 경고보다 178개의 경고를 보는 것이 훨씬 쉽습니다.

탭에서 중급 и 낮은 좋은 경고가 있는 경우가 많지만 이러한 범주에는 정확도(신뢰도)가 낮은 진단이 포함됩니다. Windows 작업 시 경고 수준 및 옵션에 대한 자세한 내용은 여기에서 확인할 수 있습니다. *클릭*.

가장 흥미로운 오류를 성공적으로 검토하고 성공적으로 수정한 것은 가치 있는 일입니다. 남은 경고 억제. 이는 새로운 경고가 이전 경고 사이에서 사라지지 않도록 하기 위해 필요합니다. 또한 정적 분석기는 프로그래머를 위한 보조 도구이지 버그 목록이 아닙니다. 🙂

1. 자동화

익숙해진 후에는 플러그인을 구성하고 CI에 통합할 차례입니다. 프로그래머가 정적 분석기를 사용하기 전에 이 작업을 수행해야 합니다. 사실 프로그래머는 분석을 활성화하는 것을 잊거나 분석을 전혀 원하지 않을 수도 있습니다. 이렇게 하려면 테스트되지 않은 코드가 일반 개발 분기에 들어갈 수 없도록 모든 것을 최종적으로 확인해야 합니다.

이 단계에서 배울 내용은 다음과 같습니다.

도구는 어떤 자동화 옵션을 제공합니까?
분석기가 귀하의 조립 시스템과 호환됩니까?

완벽한 문서가 존재하지 않기 때문에 때로는 작성해야 할 때도 있습니다. 지지. 이는 정상적인 현상이며 기꺼이 도와드리겠습니다. 🙂

이제 CI(지속적 통합) 서비스로 넘어가겠습니다. 어떤 분석기도 심각한 문제 없이 구현할 수 있습니다. 이렇게 하려면 일반적으로 빌드 및 단위 테스트 뒤에 위치하는 파이프라인에 별도의 단계를 만들어야 합니다. 이는 다양한 콘솔 유틸리티를 사용하여 수행됩니다. 예를 들어 PVS-Studio는 다음 유틸리티를 제공합니다.

PVS-Studio_Cmd.exe (Windows에서의 솔루션, C#, C++ 프로젝트 분석)
CLMonitor.exe (컴파일 모니터링)
pvs-스튜디오-분석기 (Linux/macOS에서의 C++ 프로젝트 분석)
pvs-스튜디오-dotnet (솔루션 분석, Linux/macOS의 C# 프로젝트)
pvs-studio.jar (Java 프로젝트 분석)
PlogConverter (보고서 파일 변환기)

분석을 CI에 통합하려면 다음 세 가지 작업을 수행해야 합니다.

분석기를 설치하십시오.
분석을 실행합니다.
결과를 제공합니다.

예를 들어 Linux(Debian 기반)에 PVS-Studio를 설치하려면 다음 명령을 실행해야 합니다.

wget -q -O - https://files.viva64.com/etc/pubkey.txt 
    | sudo apt-key add -
sudo wget -O /etc/apt/sources.list.d/viva64.list 
  https://files.viva64.com/etc/viva64.list
  
sudo apt-get update -qq
sudo apt-get install -qq pvs-studio

Windows를 실행하는 시스템에서는 패키지 관리자에서 분석기를 설치할 수 없지만 명령줄에서 분석기를 배포하는 것은 가능합니다.

PVS-Studio_setup.exe /verysilent /suppressmsgboxes 
/norestart /nocloseapplications

Windows*를 실행하는 시스템에 PVS-Studio를 배포하는 방법에 대해 자세히 알아볼 수 있습니다.여기에*.

설치 후에는 분석을 직접 실행해야 합니다. 그러나 컴파일과 테스트를 통과한 후에만 이 작업을 수행하는 것이 좋습니다. 이는 정적 분석이 일반적으로 컴파일보다 두 배의 시간이 걸리기 때문입니다.

시작 방법은 플랫폼과 프로젝트 기능에 따라 다르므로 C++(Linux)에 대한 옵션을 예로 표시하겠습니다.

pvs-studio-analyzer analyze -j8 
                            -o PVS-Studio.log
plog-converter -t errorfile PVS-Studio.log --cerr -w

첫 번째 명령은 분석을 수행하고 두 번째 명령은 봉투보고서를 텍스트 형식으로 변환하여 화면에 표시하고 경고가 있는 경우 0이 아닌 반환 코드를 반환합니다. 이와 같은 메커니즘은 오류 메시지가 있을 때 빌드를 차단하는 데 편리하게 사용할 수 있습니다. 그러나 언제든지 플래그를 제거할 수 있습니다. -w 경고가 포함된 어셈블리를 차단하지 마세요.

있습니다. 텍스트 형식이 불편합니다. 간단히 예시로 제공됩니다. 좀 더 흥미로운 보고서 형식인 FullHtml에 주목하세요. 이를 통해 코드를 탐색할 수 있습니다.

"에서 CI 분석 설정에 대한 자세한 내용을 읽을 수 있습니다.PVS-Studio 및 지속적인 통합"(Windows) 또는 "Travis CI에서 PVS-Studio를 설정하는 방법"(리눅스).

좋습니다. 빌드 서버에서 분석기를 구성했습니다. 이제 누군가가 테스트되지 않은 코드를 업로드하면 검증 단계가 실패하고 문제를 감지할 수 있지만 이는 완전히 편리하지는 않습니다. 브랜치를 병합한 후가 아니라 프로젝트를 확인하는 것이 더 효율적이기 때문입니다. 그 전에 풀 리퀘스트 단계에서 A.

일반적으로 풀 요청 분석을 설정하는 것은 일반적인 CI 분석 시작과 크게 다르지 않습니다. 변경된 파일 목록을 가져와야 하는 경우는 제외됩니다. 이는 일반적으로 git을 사용하여 브랜치 간의 차이점을 쿼리하여 얻을 수 있습니다.

git diff --name-only HEAD origin/$MERGE_BASE > .pvs-pr.list

이제 이 파일 목록을 분석기에 입력으로 전달해야 합니다. 예를 들어 PVS-Studio에서는 플래그를 사용하여 구현됩니다. -S:

pvs-studio-analyzer analyze -j8 
                            -o PVS-Studio.log 
                            -S .pvs-pr.list

풀 요청 분석에 대해 자세히 알아볼 수 있습니다 *여기에*. 귀하의 CI가 기사에 언급된 서비스 목록에 없더라도 이러한 유형의 분석 이론을 다루는 일반 섹션이 유용할 것입니다.

풀 요청 분석을 설정하면 경고가 포함된 커밋을 차단하여 테스트되지 않은 코드가 넘을 수 없는 경계를 만들 수 있습니다.

확실히 다 좋은데, 모든 경고를 한 곳에서 볼 수 있었으면 좋겠어요. 정적 분석기뿐만 아니라 단위 테스트나 동적 분석기에서도 마찬가지입니다. 이를 위한 다양한 서비스와 플러그인이 있습니다. 예를 들어 PVS-Studio에는 SonarQube에 통합하기 위한 플러그인.

2. 개발자 컴퓨터에 통합

이제 일상적인 개발 사용을 위해 분석기를 설치하고 구성할 차례입니다. 이 시점에서는 이미 대부분의 작업 방식에 익숙해졌으므로 이것이 가장 쉬운 부분이라고 할 수 있습니다.

가장 간단한 옵션으로 개발자는 필요한 분석기를 직접 설치할 수 있습니다. 그러나 이 작업은 시간이 많이 걸리고 개발에 방해가 되므로 설치 프로그램과 필요한 플래그를 사용하여 이 프로세스를 자동화할 수 있습니다. PVS-Studio에는 다양한 자동 설치를 위한 플래그. 그러나 Chocolatey(Windows), Homebrew(macOS) 또는 Linux용 수십 가지 옵션과 같은 패키지 관리자는 항상 있습니다.

그런 다음 필요한 플러그인을 설치해야 합니다. 예를 들어 비주얼 스튜디오, IDEA, 타는 사람 등

3. 매일 사용

이 단계에서는 일상적인 사용 중에 분석기의 속도를 높이는 방법에 대해 몇 마디 말할 시간입니다. 전체 프로젝트를 완벽하게 분석하는 데는 많은 시간이 소요됩니다. 그런데 전체 프로젝트 전반에 걸쳐 코드를 한 번에 변경하는 경우가 얼마나 자주 있습니까? 전체 코드 베이스에 즉시 영향을 미칠 정도로 큰 리팩토링은 거의 없습니다. 한 번에 변경되는 파일 수는 12개를 초과하는 경우가 거의 없으므로 해당 파일을 분석하는 것이 좋습니다. 그런 상황에는 증분 분석 모드. 놀라지 마십시오. 이것은 또 다른 도구가 아닙니다. 이는 변경된 파일과 해당 종속성만 분석할 수 있는 특수 모드이며, 플러그인이 설치된 IDE에서 작업하는 경우 빌드 후 자동으로 발생합니다.

분석기가 최근 변경된 코드에서 문제를 발견하면 이를 독립적으로 보고합니다. 예를 들어 PVS-Studio는 경고를 사용하여 이에 대해 알려줍니다.

물론 개발자에게 도구를 사용하라고 말하는 것만으로는 충분하지 않습니다. 우리는 그것이 무엇인지, 그것이 어떤 것인지 어떻게든 그들에게 말해야 합니다. 예를 들어 다음은 PVS-Studio의 빠른 시작에 대한 기사이지만 원하는 도구에 대한 유사한 튜토리얼을 찾을 수 있습니다.

이러한 기사는 일상적인 사용에 필요한 모든 정보를 제공하며 시간이 많이 걸리지 않습니다. 🙂

도구를 알아가는 단계에서도 첫 번째 출시 중 많은 경고를 표시하지 않았습니다. 불행하게도 정적 분석기는 완벽하지 않기 때문에 때때로 거짓 긍정을 제공합니다. 일반적으로 이를 억제하는 것은 쉽습니다. 예를 들어 Visual Studio용 PVS-Studio 플러그인에서는 버튼 하나만 클릭하면 됩니다.

그러나 단순히 억제하는 것 이상의 작업을 수행할 수 있습니다. 예를 들어 지원팀에 문제를 보고할 수 있습니다. 거짓 긍정을 수정할 수 있다면 향후 업데이트에서 코드베이스와 관련된 거짓 긍정이 점점 더 적어지는 것을 확인할 수 있습니다.

통합 후

그래서 우리는 정적 분석을 개발 프로세스에 통합하는 모든 단계를 거쳤습니다. CI에서 이러한 도구를 설정하는 것이 중요함에도 불구하고 이를 실행하는 가장 중요한 장소는 개발자의 컴퓨터입니다. 결국, 정적 분석기는 코드가 좋지 않다고 멀리 떨어진 곳에서 말하는 판사가 아닙니다. 반대로, 피곤하면 알려주고, 잊어버린 것이 있으면 상기시켜주는 도우미입니다.

사실, 정기적으로 사용하지 않으면 정적 분석이 개발을 크게 단순화할 가능성이 없습니다. 결국, 개발자가 얻을 수 있는 주요 이점은 복잡하고 논쟁의 여지가 있는 코드 섹션을 검색하는 것보다 조기에 발견할 수 있다는 것입니다. 테스트를 위해 편집 내용을 보낸 후 문제를 발견하는 것은 불쾌할 뿐만 아니라 시간도 많이 소모된다는 점에 동의합니다. 정적 분석을 정기적으로 사용하면 컴퓨터의 모든 변경 사항을 직접 살펴보고 코드 작업 중에 의심스러운 부분을 보고합니다.

귀하 또는 귀하의 동료가 분석기를 구현할 가치가 있는지 여전히 확신하지 못한다면 이제 "기사를 읽기 시작하는 것이 좋습니다.개발 프로세스에 정적 코드 분석기 PVS-Studio를 도입하는 이유". 정적 분석에 시간이 많이 걸린다는 개발자의 일반적인 우려 사항을 해결합니다.

이 기사를 영어권 청중과 공유하려면 번역 링크인 Maxim Zvyagintsev를 사용하십시오. 정적 분석: 시작부터 통합까지.

출처 : habr.com

정적 분석 - 도입부터 통합까지