Ant 스크립트에서 코드 적용 범위 사용

빌드 중인 코드가 지정된 코드 적용 범위 승인 기준을 충족하는지 확인하기 위해 Ant 스크립트에서 코드 적용 범위를 사용 가능하게 할 수 있습니다. 이렇게 하려면 다음을 수행해야 합니다.

코드 적용 범위를 사용하도록 Ant 스크립트 구성
Ant 스크립트 실행
코드 적용 범위 통계 생성
코드 적용 범위 보고서 생성
코드 적용 범위 사용 안함

코드 적용 범위를 사용하도록 Ant 스크립트 구성

코드 적용 범위를 사용하도록 Ant 스크립트를 구성하려면 CLASSPATH 환경 변수에 다음을 추가하십시오.
<install_dir>/plugins/com.ibm.rational.llc.engine_1.0.0.<version_number>
그런 다음 빌드 파일에 새 태스크를 정의하십시오. 예를 들어, 다음과 같습니다.

<taskdef name="instrument" classname="com.ibm.rational.llc.engine.instrumentation.anttask.InstrumentationTask" classpath="${install_dir}/plugins/com.ibm.rational.llc.engine_1.0.0.<version_number>"/>

인스트루먼테이션 태스크의 형식은 다음과 같습니다.

<instrument buildPath="" baseLineFile="" saveBackups="" outputDir=""/>

여기서,

buildPath:: 코드 적용 범위 데이터를 수집할 대상 파일을 지정합니다. 빌드 경로는 클래스 파일 이름, JAR 파일 이름 또는 디렉토리 이름을 참조할 수 있습니다. Ant에 사용된 다른 경로 참조와 같이 정의할 수 있습니다.
baseLineFile:: 기준선 파일이 저장된 경로를 지정합니다. 기준선 파일은 인스트루먼트된 코드가 비교되고 코드 적용 범위 통계가 생성되는 대상 파일입니다. 또한 보고서 생성 Ant 태스크에 대한 입력으로 사용됩니다.
saveBackups:: 원본 클래스 및 JAR 파일의 이름을 *.bak으로 바꿀지 여부를 지정합니다. saveBackups를 true로 설정하면 백업 파일이 생성되고 saveBackups를 false로 설정하면 원본 파일을 겹쳐씁니다(따라서 손실됨).
참고: saveBackups는 선택사항이며 기본값은 false입니다.
outputDir:: 인스트루먼트된 파일을 저장할 위치를 지정합니다. 기본적으로 인스트루먼트된 파일은 인스트루먼트 중인 파일과 같은 위치에 저장됩니다.

예제 1

다음 예제에서는 bin/의 모든 파일에 대해 코드 적용 범위 데이터가 수집되고 기준선 파일은 blfile.coveragedata에 저장되며 이러한 파일의 백업은 생성되지 않고 인스트루먼트된 파일은 coverageData_files에 저장됩니다.

<instrument saveBackups="false" baseLineFile="blfile.coveragedata" buildPath="bin/" outputDir="coverageData_files"/>

예제 2

다음 예제에서는 build.Dir로 참조된 bin의 모든 파일에 대해 코드 적용 범위 데이터가 수집되고 기준선 파일은 blfile.coveragedata에 저장되며 각 해당 파일의 백업이 생성됩니다.

<path id="build.Dir"> <pathelement location="bin"/> </path> <instrument saveBackups="true" baseLineFile="blfile.coveragedata" buildPathRef="build.Dir" />

예제 3

다음 예제에서는 bin/의 모든 파일에 대해 코드 적용 범위 데이터가 수집되고 기준선 파일은 blfile.coveragedata에 저장되며 각 해당 파일의 백업이 생성됩니다.

<instrument saveBackups="true" baseLineFile="blfile.coveragedata"> <buildPath> <pathelement location="bin"/> </buildPath> </instrument>

예제 4

다음 예제에서는 이름에 Test가 들어 있는 서브디렉토리의 파일은 제외하고 디렉토리 이름에 com이 들어 있는 bin/의 모든 서브디렉토리에 대해 코드 적용 범위 데이터가 사용 가능합니다. 코드 적용 범위 분석이 수행되는 각 파일에 대해 백업이 생성되고 기준선 파일은 blfile.coveragedata에 저장됩니다.

<instrument saveBackups="true" baseLineFile="blfile.coveragedata"> <buildPath> <fileset dir="bin"> <exclude name="**/*Test*"/> <include name="**/*com*/*"> </fileset> </buildPath> </instrument>

예제 5

다음 예제에서는 이름에 Test가 들어 있는 bin의 서브디렉토리에 있는 파일을 제외하고 bin/의 모든 파일과 bin2/에 대해 코드 적용 범위 데이터가 사용 가능합니다. 코드 적용 범위 분석이 수행되는 각 파일에 대해 백업이 생성되고 기준선 파일은 blfile.coveragedata에 저장됩니다.

<instrument saveBackups="true" baseLineFile="blfile.coveragedata"> <buildPath> <fileset dir="bin"> <exclude name="**/*Test*"/> </fileset> </buildPath> <buildPath> <pathelement location="bin2"/> </buildPath> </instrument>

Ant 스크립트 실행

코드 적용 범위를 사용하도록 Ant 스크립트를 구성한 후 명령행 또는 워크벤치에서 Ant 스크립트를 실행할 수 있습니다.

명령행에서 실행

명령행에서 Ant 스크립트를 실행하려면 다음을 수행하십시오.

JAVA_HOME 환경 변수를 JDK가 설치된 디렉토리로 설정하십시오.
CLASSPATH 환경 변수에 probekit.jar 파일의 전체 경로 및 파일 이름이 포함되어 있는지 확인하십시오. probekit.jar 파일은 제품 설치의 플러그인 폴더에서 더 높은 버전 번호와 최신 시간 소인이 있는 org.eclipse.hyades.probekit 서브폴더에 있습니다.
CLASSPATH 환경 변수에 JAVA_HOME이 포함되어 있는지(JAVA_HOME/bin/java와 같은 자바 설치 경로가 올바른지) 확인하십시오.
PATH 환경 변수에 사용자 플랫폼에 적당한 org.eclipse.hyades.probekit 서브폴더의 전체 경로가 포함되어 있는지 확인하십시오. 예를 들어, 다음과 같습니다.
- Windows의 경우:
  <install_dir>\plugins\org.eclipse.hyades.probekit_<version>\os\win32\x86
- Linux의 경우:
  <install_dir>/plugins/org.eclipse.hyades.probekit_<version>/os/linux/x86
LLC_PLUGIN을 플러그인 폴더의 경로로 설정하십시오.
set LLC_PLUGIN=<install_dir>\plugins

예제

ant -lib=<install_dir>\plugins\org.eclipse.hyades.probekit_<version>\probekit.jar myTarget

워크벤치에서 실행

워크벤치에서 Ant 스크립트를 실행하려면 다음을 수행하십시오.

빌드 파일을 선택하십시오.
마우스 오른쪽 단추를 클릭하고 다음으로 실행 > Ant 빌드...를 선택하십시오.
클래스 경로 탭을 선택하십시오.
사용자 항목을 선택하십시오.
외부 JAR 추가...를 클릭하십시오.
더 높은 버전 번호와 최신 시간 소인이 있는 org.eclipse.hyades.probekit 플러그인 서브폴더에서 <install_dir>\plugins\org.eclipse.hyades.probekit_<version>\probekit.jar를 CLASSPATH에 추가하십시오.
대상 탭을 선택하십시오.
원하는 대상을 선택하십시오.
환경 탭을 선택하십시오.
새로 작성... 단추를 클릭하십시오.
새 환경 변수 대화 상자에서 이름 필드에 LLC_Plugin을 입력하고 값 필드에 LLC_PLUGIN 경로를 입력하십시오(예: <install_dir>\plugins).
확인을 클릭하십시오.
새로 작성... 단추를 클릭하십시오.
새 환경 변수 대화 상자에서 이름 필드에 PATH를 입력하고 값 필드에 <install_dir>\plugins\org.eclipse.hyades.probekit_<version>\os\win32\x86을 입력하십시오.
확인을 클릭하십시오.
실행을 클릭하십시오.

코드 적용 범위 통계 생성

클래스 경로에 다음이 포함되어 있는지 확인하십시오.
<install_dir>\plugins\com.ibm.rational.llc.engine_1.0.0.<version_number>

명령행에서 코드 적용 범위 통계를 생성하려면 위 코드의 디렉토리에서 다음을 실행하십시오.

java -Dcoverage.out.file=C:\coverage_report\coverage_data.coveragedata com.ibm.rational.llc.example

참고: 사용자의 자바를 제품 설치의 자바와 일치하도록 설정해야 합니다.

코드 적용 범위 보고서 생성

Ant를 사용하여 보고서를 생성하려면 다음을 수행하십시오.
BIRT 런타임 보고서 엔진을 다운로드하고 해당 컨텐츠를 압축 해제하십시오. 다음 환경 변수를 설정하십시오.

CLASSPATH - org.eclipse.equinox.common_<version_number>.jar를 가리키도록 설정
LLC_COMMON_PLUGIN - com.ibm.rational.llc.common_1.0.0.<version_number>를 가리키도록 설정
LLC_REPORT_PLUGIN - com.ibm.rational.llc.report.birt_1.0.0.<version_number>를 가리키도록 설정
BIRT_HOME - BIRT 런타임에서 ReportEngine 디렉토리를 가리키도록 설정

예를 들어, 다음과 같습니다.
<path id="lib.path"> <pathelement location="${env.LLC_COMMON_PLUGIN}"/> <pathelement location="${env.LLC_REPORT_PLUGIN}"/> <fileset dir="${env.BIRT_HOME}/lib" includes="*.jar"/> </path>

빌드 파일에 코드 적용 범위 보고서 생성을 위해 새 태스크를 정의하십시오. 예를 들어, 다음과 같습니다.

<taskdef name="code-coverage-report" classname="com.ibm.rational.llc.report.birt.adapters.ant.ReportGenerationTask" classpathref="lib.path"/>

코드 적용 범위 보고서 태스크의 형식은 다음과 같습니다.

<code-coverage-report outputDir="" coverageDataFile="" baseLineFiles=""> <filters> <filter type="" value=""/> </filters> <configurations> <configuration name="" value=""/> </configurations> </code-coverage-report>

여기서,

outputDir:

보고서 결과를 저장할 위치를 지정합니다.

coverageDataFile:

보고서를 생성할 하나 이상의 적용 범위 데이터 파일을 지정합니다. Ant에 사용된 다른 경로 참조와 같이 정의할 수 있습니다.

baseLineFiles:

인스트루먼테이션 태스크의 일부로 생성된 하나 이상의 기준선 파일을 지정합니다. Ant에 사용된 다른 경로 참조와 같이 정의할 수 있습니다.

filters:

선택사항: 보고서 결과를 필터링하는 데 사용됩니다.

filter:

type: 보고서에 적용할 필터의 유형입니다.

value: 보고서에 적용할 필터의 값입니다.

사용 가능한 필터:

행 적용 범위 임계값: 지정된 백분율 값 아래에 데이터를 표시하도록 행 적용 범위 보고서의 임계값을 설정합니다. type=line_coverage_threshold, value=threshold value

Configurations:

선택사항: 여러 가지 계산 구성을 지정하는 데 사용됩니다.

Configuration:

name: 구성 이름입니다.

value: 구성의 값입니다.

사용 가능한 구성:

기본 생성자 포함: 코드 적용 범위 계산에 기본 생성자를 제외할지 또는 포함할지를 구성하십시오. 기본적으로 기본 생성자는 포함됩니다. 클래스가 생성자를 정의하지 않는 경우, 컴파일러는 인수 없는 기본 생성자를 생성합니다. 그러나 이 생성자는 실제 소스 파일에 표시되지 않습니다. 프로그램 실행 중에 이 클래스가 인스턴스화되지 않는 경우, 이 숨겨진 기본 생성자는 실행되지 않으며 따라서 적용 범위는 예상대로 100%가 되지 않습니다. 이 동작은 name=excludeDefaultConstructor, value=true 또는 false 구성으로 변경할 수 있습니다.

예제 1

다음 예제에서는 coverage-data/blfile.coveragedata를 기준선 파일로 사용하는 coverage-data/coverage.coveragedata에서 보고서 생성이 수집되고 보고서는 coverage-reports에 저장되며 임계값이 80퍼센트인 line_coverage_threshold 필터가 적용됩니다. 기본 생성자는 코드 적용 범위 계산에서 제외됩니다.

<code-coverage-report outputDir="coverage-reports/" coverageDataFile="coverage-data/coverage.coveragedata" baseLineFiles="coverage-data/blfile.coveragedata"> <filters> <filter type="line_coverage_threshold" value="80"/> </filters> <configurations> <configuration name="excludeDefaultConstructor" value="true"/> </configurations> </code-coverage-report>

예제 2

다음 예제에서는 blfile1.coveragedata 및 blfile2.coveragedata를 기준선 파일로 사용하는 두 개의 적용 범위 파일 coverage1.coveragedata 및 coverage2.coveragedata에서 보고서 생성이 수집되고 보고서는 coverage-reports에 저장됩니다. 기본적으로 기본 생성자는 코드 적용 범위 계산에 포함됩니다.

<code-coverage-report outputDir="coverage-reports/" coverageDataFile="coverage-data/coverage1.coveragedata;coverage-data/coverage2.coveragedata" baseLineFiles="coverage-data/blfile1.coveragedata;coverage-data/blfile2.coveragedata"> </code-coverage-report>

워크벤치에서 코드 적용 범위 결과 보기

워크벤치에서 Ant 스크립트 코드 적용 범위 결과를 보려면 다음을 수행하십시오.

적용 범위 데이터 결과 파일을 가져옵니다.

파일 > 가져오기...를 선택하십시오.
코드 적용 범위 > 코드 적용 범위 데이터 파일을 선택하십시오.
다음 단추를 클릭하십시오.
파일 시스템 가져오기 유형을 선택하십시오.
다음 단추를 클릭하십시오.
가져올 적용 범위 데이터 파일의 위치(위의 예제에서는 coverage_data.coveragedata), 해당 파일을 가져와서 넣을 폴더의 이름 및 적용 범위 데이터 파일과 연관된 프로젝트를 입력하십시오.
완료 단추를 클릭하십시오. 코드 적용 범위에 대해 프로젝트가 아직 사용 가능하지 않은 경우 프로젝트를 다시 빌드하라는 프롬프트가 표시됩니다.

코드 적용 범위 보고서를 생성합니다.

실행 > 코드 적용 범위 > 보고서 생성...을 선택하십시오.
이름 열 아래에서 하나 이상의 자바 실행을 선택하십시오.
Eclipse 기반 또는 HTML 기반 보고서 중 하나를 선택하십시오.
실행을 클릭하십시오.

참고: 적용 범위 데이터 파일을 하나 이상 선택하는 대신에 마우스 오른쪽 단추를 클릭한 다음 코드 적용 범위 > 보고서 생성...을 선택하는 옵션이 있습니다. 보고서의 연관된 프로젝트 및 폴더 위치를 지정하고 완료를 클릭하십시오.

코드 적용 범위 사용 안함

Ant 태스크를 사용하여 인스트루먼트된 클래스를 사용하지 않으려면 프로젝트를 다시 컴파일하거나 saveBackups가 사용 가능한 경우 .class 파일을 .class.bak 파일로 바꾸십시오.