하도 오래전에 Jenkins와 Sonar를 연동해봤었는데,

요번에 BMS 프로젝트 진행하면서 Sonar한번 설치할래니 기억이 가물가물..;;


그래서 다시 이곳에 정리하기로 했다. 우선 Jenkins와 Sonar가 설치되어 있다는 가정하에 내용을 정리하겠다.


  1. Jenkins에 Sonar Plugin을 설치해야 한다. 
    • Jenkins 관리 > 플러그인 관리
  2. Maven 관련 설정을 한다. Sonar 자체가 Maven기반으로 동작하기 때문에 Maven설정은 필수다.
    • Jenkins 관리 > Configuration (시스템 설정) > Maven
  3. Sonar 관련 설정을 한다.
    • Jenkins 관리 > Configuration (시스템 설정) > Sonar
  4. Build Job을 생성하고 Build 관련 설정을 한다. 
    1. Build Job > 설정 > Build 관련 설정
      • root pom.xml 을 설정하고, goal에서는 -DskipTests=true를 꼭 넣어준다. sonar에서 test를 수행하기 때문에 저 옵션을 넣지 않으면 test가 두번 수행된다.
    2. Build Job > 설정 > Post-build Actions > Sonar 관련 설정
      • Add post-build action에서 Sonar를 선택하고, Sonar관련 설정을 한다.
      • -Dsonar.projectVersion옵션을 사용하면 Sonar에 version 정보를 전달할수 있다. 옵션을 사용하지 않으면 pom.xml의 <version> 정보가 sonar로 넘어간다. 
  5. Jenkins에서 Build를 수행한다. 연동 완료!


'QA > Test Automation' 카테고리의 다른 글

API 테스트 방법  (0) 2018.01.27
자동화에 extent report 적용하기  (0) 2018.01.22
Ant 로 Sonar 수행하기.  (0) 2011.04.12
Sonar 소개  (0) 2011.02.14
CI(Continuous Integration) 서버 구성안  (0) 2011.02.14
빌드는 maven으로 하고, sonar 구동 및 전체 수행은 ant 로 수행시키는 build.xml 예제.

사내 build에 적용해야 하는데, 아직 미 완성.
좀 더 프로세스를 구체화 시킨 후 적용할 예정이다.

<?xml version="1.0" encoding="UTF-8"?>
<project name="Sonar Ant Project" default="build" basedir="." xmlns:artifact="antlib:org.apache.maven.artifact.ant">
 <property environment="env"/>
 <path id="maven-ant-tasks.classpath" path="${basedir}/lib/maven-ant-tasks-2.1.1.jar"/>
 <typedef resource="org/apache/maven/artifact/ant/antlib.xml"
             uri="antlib:org.apache.maven.artifact.ant"
             classpathref="maven-ant-tasks.classpath" />
 <taskdef resource="net/sf/antcontrib/antlib.xml">
   <classpath>
     <pathelement location="${basedir}/lib/ant-contrib-1.0b3.jar" />
   </classpath>
 </taskdef>
 <taskdef uri="antlib:org.sonar.ant" resource="org/sonar/ant/antlib.xml">
    <classpath path="lib/sonar-ant-task-1.0.jar" />
 </taskdef>
 <target name="build" depends="mvn,sonar"/>
 <target name="mvn">
   <property name="maven.home" value="${env.M2_HOME}"/>
   <echo message="M2_HOME = ${maven.home}"/>
   <artifact:mvn pom="pom.xml" mavenHome="${maven.home}" fork="true" failonerror="true">
     <arg value="clean"/>
     <arg value="install"/>
     <arg value="-Dmaven.test.skip=true"/>
    </artifact:mvn>
 </target>
 <target name="sonar">
   <tstamp>
     <format property="build.time" pattern="yyyy-MM-dd.hh:mm" locale="en"/>
   </tstamp>
  <!--
  <property file="build.number" />
  <echo message="build.number = ${build.number}"/>
  <buildnumber file="build.number" />
  -->
  <!-- The workDir directory is used by Sonar to store temporary files -->
  <sonar:sonar workDir="." key="org.example:example" version="${build.time}" xmlns:sonar="antlib:org.sonar.ant">
    <sources>
      <path location="${basedir}/common/src/main/java"/>
      <path location="${basedir}/model/src/main/java"/>
      <path location="${basedir}/dao-api/src/main/java"/>
      <path location="${basedir}/dao-hibernate/src/main/java"/>
      <path location="${basedir}/agent/src/main/java"/>
      <path location="${basedir}/manager/src/main/java"/>
    </sources>
    <tests>
      <path location="${basedir}/common/src/test/java"/>
      <path location="${basedir}/model/src/test/java"/>
      <path location="${basedir}/dao-api/src/test/java"/>
      <path location="${basedir}/dao-hibernate/src/test/java"/>
      <path location="${basedir}/agent/src/test/java"/>
      <path location="${basedir}/manager/src/test/java"/>
    </tests>
   <!--
    1. binaries: binaries directories, which contain for example the compiled Java bytecode (optional)
    2. libraries: path to libraries (optional). These libraries are for example used by the Java Findbugs plugin
    <binaries>
      <path location="..." />
    </binaries>
    <libraries>
      <path location="..." />
    </libraries>
   -->
   <!-- list of properties (optional) -->
   <property key="sonar.projectName" value="Sonar Ant Project" />
   <property key="sonar.dynamicAnalysis" value="true" />
   <property key="sonar.jdbc.url" value="jdbc:mysql://localhost:3306/sonar?useUnicode=true&amp;characterEncoding=utf8" />
   <property key="sonar.jdbc.driverClassName" value="com.mysql.jdbc.Driver" />
   <property key="sonar.jdbc.username" value="sonar" />
   <property key="sonar.jdbc.password" value="sonar" />
   <property key="sonar.host.url" value="http://192.168.20.34:9000" />
   <property key="sonar.java.source" value="1.6" />
   <property key="sonar.java.target" value="1.6" />
  </sonar:sonar>
 </target>
</project>
sonar를 ant로 구동시키면, modules(sub-projects)가 지원되지 않는 점 때문인지, tree map이 package이름으로 번잡하게 나오고, tangle index 정보가 나오지 않는다. 안타깝다;

CI서버를 어떻게 구축하느냐 고민하면서 자료 검색을 하던 도중에
Sonar라는 것을 알게 되었다.

Sonar는 Codehaus에서 개발한 코드 품질 관리 플랫폼으로, 오픈소스다.

사실 이전에 작성하였던 PMD, Checkstyle, Findbugs, Cobertura, JavaNCSS 등을 Maven에 연동하다가 안되는 것이 많아서, 고민하던 차에 알게된 것이라 더욱 반가웠다.

PMD, CheckStyle, Findbugs, Cobertura등을 이용해서 코드검사, 코드커버리지, 중복도, 복잡도 등의 데이터를 추출해주고,
그 외 품질관련 데이터도 뽑아주기 때문에 수월하게 좋은 데이터를 얻을 수 있다.
 

설치도 간단하고, 사용도 쉬워서
이미 엄청나게 유명할 수도 있겠지만, 국내에서도 많이 사용할 것 같다.

테스트 후 나온 Sonar 결과 화면을 아래 첨부한다. 보시다시피, 왠지 엄청 좋아보인다. Quality Index나 Technical Debt까지 계산해주다니...훗^^

다음에는 Sonar 설치, Hudson 연동 방법, Sonar Profile 설정 방법, Sonar 결과화면의 각 데이터의 의미에 대해서 차례로 등록할 예정이다.

+ Recent posts