Jenkins에서 IntelliJ IDEA 검사 실행

IntelliJ IDEA는 오늘날 가장 진보된 정적 Java 코드 분석기를 보유하고 있습니다. 체크 스타일 и 스팟버그. 수많은 "검사"는 코딩 스타일에서 특성 버그에 이르기까지 다양한 측면에서 코드를 확인합니다.

그러나 분석 결과가 개발자의 로컬 IDE에만 표시되는 한 개발 프로세스에 거의 도움이 되지 않습니다. 정적 분석 해야 할 일 빌드 파이프라인의 첫 번째 단계로 그 결과가 품질 게이트를 결정해야 하며 품질 게이트가 실패하면 빌드가 실패해야 합니다. TeamCity CI는 IDEA와 통합되는 것으로 알려져 있습니다. 그러나 TeamCity를 사용하지 않는 경우에도 다른 CI 서버에서 IDEA 검사를 실행할 수 있습니다. IDEA Community Edition, Jenkins 및 Warnings NG 플러그인을 사용하여 이 작업을 수행할 수 있는 방법을 제안합니다.

1단계. 컨테이너에서 분석 실행 및 보고서 가져오기

처음에는 그래픽 인터페이스가 없는 CI 시스템 내에서 IDE(데스크톱 애플리케이션!)를 실행한다는 생각이 의심스럽고 매우 번거로워 보일 수 있습니다. 다행스럽게도 IDEA 개발자는 실행할 수 있는 기능을 제공했습니다. 코드 서식 и 검사 명령줄에서. 또한 이 모드에서 IDEA를 실행하기 위해 그래픽 하위 시스템이 필요하지 않으며 이러한 작업은 텍스트 셸이 있는 서버에서 수행할 수 있습니다.

검사는 스크립트를 사용하여 시작됩니다. bin/inspect.sh IDEA 설치 디렉토리에서. 필요한 매개변수는 다음과 같습니다.

• 프로젝트의 전체 경로(상대 경로는 지원되지 않음),
• 검사 설정이 있는 .xml 파일의 경로(일반적으로 .idea/inspectionProfiles/Project_Default.xml의 프로젝트 내부에 있음),
• 분석 결과 보고서가 포함된 .xml 파일이 저장될 폴더의 전체 경로입니다.

또한,

• Java SDK에 대한 경로는 IDE에서 구성되며 그렇지 않으면 분석이 작동하지 않습니다. 이러한 설정은 구성 파일에 포함되어 있습니다. jdk.table.xml IDEA 전역 구성 폴더에 있습니다. 기본 글로벌 IDEA 구성 자체는 사용자의 홈 디렉토리에 있지만 이 위치는 명시적으로 설정할 수 있음 파일에 idea.properties.
• 분석된 프로젝트는 유효한 IDEA 프로젝트여야 하며 일반적으로 무시되는 일부 파일은 버전 제어에 커밋되어야 합니다. 즉, 다음과 같습니다.
  • .idea/inspectionProfiles/Project_Default.xml — 분석기 설정, 컨테이너에서 검사를 시작할 때 분명히 사용됩니다.
  • .idea/modules.xml - 그렇지 않으면 '이 프로젝트에는 모듈이 없습니다'라는 오류가 발생합니다.
  • .idea/misc.xml - 그렇지 않으면 'JDK가 이 프로젝트에 대해 제대로 구성되지 않았습니다'라는 오류가 발생합니다.
  • *.iml-файлы - 그렇지 않으면 모듈에서 구성되지 않은 JDK에 대한 오류가 발생합니다.

이러한 파일은 일반적으로 .gitignore, 예를 들어 파일과 달리 특정 개발자의 환경에 특정한 정보를 포함하지 않습니다. workspace.xml, 그러한 정보가 포함되어 있으므로 커밋할 필요가 없습니다.

그 자체로 탈출구는 IDEA Community Edition과 함께 JDK를 분석된 프로젝트에서 "설정"할 준비가 된 형태의 컨테이너에 포장하도록 제안합니다. 적절한 기본 컨테이너를 선택하고 다음은 우리가 얻는 Dockerfile입니다.

도커 파일

FROM openkbs/ubuntu-bionic-jdk-mvn-py3

ARG INTELLIJ_VERSION="ideaIC-2019.1.1"

ARG INTELLIJ_IDE_TAR=${INTELLIJ_VERSION}.tar.gz

ENV IDEA_PROJECT_DIR="/var/project"

WORKDIR /opt

COPY jdk.table.xml /etc/idea/config/options/

RUN wget https://download-cf.jetbrains.com/idea/${INTELLIJ_IDE_TAR} && 
    tar xzf ${INTELLIJ_IDE_TAR} && 
    tar tzf ${INTELLIJ_IDE_TAR} | head -1 | sed -e 's//.*//' | xargs -I{} ln -s {} idea && 
    rm ${INTELLIJ_IDE_TAR} && 
    echo idea.config.path=/etc/idea/config >> idea/bin/idea.properties && 
    chmod -R 777 /etc/idea

CMD idea/bin/inspect.sh ${IDEA_PROJECT_DIR} ${IDEA_PROJECT_DIR}/.idea/inspectionProfiles/Project_Default.xml ${IDEA_PROJECT_DIR}/target/idea_inspections -v2

옵션 사용 idea.config.path IDEA가 폴더에서 전역 구성을 찾도록 했습니다. /etc/idea, CI의 작업 조건에서 사용자의 홈 폴더는 무기한이고 종종 완전히 없기 때문입니다.

컨테이너에 복사된 파일은 다음과 같습니다. jdk.table.xml, 컨테이너 내부에 설치된 OpenJDK의 경로를 포함합니다(자체 IDEA 설정 디렉토리의 유사한 파일을 기반으로 할 수 있음).

jdk.table.xml

<application>
 <component name="ProjectJdkTable">
   <jdk version="2">
     <name value="1.8" />
     <type value="JavaSDK" />
     <version value="1.8" />
     <homePath value="/usr/java" />
     <roots>
       <annotationsPath>
         <root type="composite">
           <root url="jar://$APPLICATION_HOME_DIR$/lib/jdkAnnotations.jar!/" type="simple" />
         </root>
       </annotationsPath>
       <classPath>
         <root type="composite">
           <root url="jar:///usr/java/jre/lib/charsets.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/deploy.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/access-bridge-64.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/cldrdata.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/dnsns.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/jaccess.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/jfxrt.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/localedata.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/nashorn.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/sunec.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/sunjce_provider.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/sunmscapi.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/sunpkcs11.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/zipfs.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/javaws.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/jce.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/jfr.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/jfxswt.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/jsse.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/management-agent.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/plugin.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/resources.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/rt.jar!/" type="simple" />
         </root>
       </classPath>
     </roots>
     <additional />
   </jdk>
 </component>
</application>

완성된 이미지 도커 허브에서 사용 가능.

계속 진행하기 전에 컨테이너에서 IDEA 구문 분석기 실행을 테스트해 보겠습니다.

docker run --rm -v <путь/к/вашему/проекту>:/var/project inponomarev/intellij-idea-analyzer

분석이 성공적으로 수행되고 분석기 보고서가 포함된 수많은 .xml 파일이 target/idea_inspections 하위 폴더에 나타나야 합니다.

이제 IDEA 분석기가 모든 CI 환경에서 독립형 모드로 실행될 수 있다는 데 의심의 여지가 없으며 두 번째 단계로 넘어갑니다.

2단계. 보고서 표시 및 분석

.xml 파일 형식으로 보고서를 받는 것은 전투의 절반입니다. 이제 사람이 읽을 수 있어야 합니다. 또한 그 결과는 수락된 변경 사항이 품질 기준에 따라 통과하는지 여부를 결정하는 논리인 품질 게이트에 사용되어야 합니다.

이것은 우리에게 도움이 될 것입니다 Jenkins 경고 NG 플러그인2019년 XNUMX월에 출시된 제품입니다. 소개와 함께 Jenkins(CheckStyle, FindBugs, PMD 등)에서 정적 분석 결과로 작업하기 위한 많은 개별 플러그인이 이제 사용되지 않는 것으로 표시됩니다.

플러그인은 두 부분으로 구성됩니다.

• 수많은 분석기 메시지 수집기(전체 목록 AcuCobol에서 ZPT Lint까지 과학에 알려진 모든 분석기를 포함),
• 그들 모두를 위한 단일 보고서 뷰어.

Warnings NG가 구문 분석할 수 있는 항목 목록에는 Java 컴파일러 경고 및 Maven 실행 로그의 경고가 포함됩니다. 지속적으로 표시되지만 의도적으로 분석되는 경우는 거의 없습니다. IntelliJ IDEA 보고서도 인식되는 형식 목록에 포함됩니다.

플러그인이 새롭기 때문에 처음에는 Jenkins 파이프라인과 잘 상호 작용합니다. 그가 참여하는 빌드 단계는 다음과 같습니다(우리는 인식하는 보고서 형식과 스캔해야 하는 파일을 플러그인에 알려줍니다).

stage ('Static analysis'){
    sh 'rm -rf target/idea_inspections'
    docker.image('inponomarev/intellij-idea-analyzer').inside {
       sh '/opt/idea/bin/inspect.sh $WORKSPACE $WORKSPACE/.idea/inspectionProfiles/Project_Default.xml $WORKSPACE/target/idea_inspections -v2'
    }
    recordIssues(
       tools: [ideaInspection(pattern: 'target/idea_inspections/*.xml')]
    )
}

보고서 인터페이스는 다음과 같습니다.

이 인터페이스는 인식 가능한 모든 파서에 대해 보편적이라는 것이 편리합니다. 여기에는 범주별 검색 결과 분포에 대한 대화형 차트와 검색 횟수 변화의 역학 그래프가 포함되어 있습니다. 페이지 하단의 그리드에서 빠른 검색을 수행할 수 있습니다. IDEA 검사에서 제대로 작동하지 않는 유일한 것은 Jenkins에서 직접 코드를 탐색하는 기능이었습니다(Checkstyle과 같은 다른 보고서의 경우 이 플러그인이 훌륭하게 수행할 수 있음). 수정해야 할 IDEA 보고서 파서의 버그인 것 같습니다.

Warnings NG의 기능 중에는 참조 어셈블리에 대한 "래칫"을 포함하여 하나의 보고서 및 프로그램 품질 게이트에서 여러 소스의 결과를 집계하는 기능이 있습니다. 일부 Quality Gates 프로그래밍 문서를 사용할 수 있습니다. 여기에 - 다만, 완성된 것은 아니며, 출처를 살펴봐야 합니다. 반면에 발생하는 상황을 완벽하게 제어하기 위해 "래칫"을 독립적으로 구현할 수 있습니다(제 предыдущий 포스트 이 주제에 대해).

결론

이 자료를 준비하기 전에 살펴보기로 했습니다. 이 주제에 대해 이미 Habré에 글을 쓴 사람이 있습니까? 나만 찾았어 인터뷰 2017 с 라니그것이 말하는 곳 :

내가 아는 한 Jenkins 또는 maven 플러그인과의 통합은 없습니다 [...] 원칙적으로 모든 애호가는 IDEA Community Edition 및 Jenkins 친구를 사귈 수 있으며 많은 사람들이 이점을 누릴 수 있습니다.

자, XNUMX년 후 우리는 Warnings NG Plugin을 가지게 되었고 마침내 이 우정이 이루어졌습니다!

출처 : habr.com