Статьи

Cobertura и Maven: покрытие кода для интеграции и модульных тестов

В проекте куркумы мы поддерживаем ночные панели. На панели инструментов мы собираем статистику о проекте, включая покрытие кода, анализ findbugs и другие метрики. Мы использовали плагин Maven EMMA для обеспечения покрытия кода, но столкнулись с проблемой EMMA. Это было причиной неудачных испытаний после инструктажа в классах. Поэтому мы отключили покрытие кода, так как нам требовались точные результаты тестирования во время наших сборок. Однако нам по-прежнему требовалось покрытие кода, что более важно, нам также необходимо покрытие для существующего набора тестов, который на самом деле представляет собой набор интеграционных тестов вместо набора модульных тестов.

Плагины Cobertura и EMMA действительно предназначены для работы с юнит-тестами. Таким образом, мы должны обойти ограничения.

  1. Сначала мы должны инструктировать классы.
  2. Во-вторых, нам нужно собрать инструментальные классы и использовать их позже при сборке.
  3. Нужно сказать интеграционным тестам использовать инструментальные классы для своих зависимостей.
  4. Создайте XML-отчет о результатах.

Я попытался сделать это, не обращаясь к ant, но каждый раз, когда я пытался использовать maven-site-plugin и настраивать его для генерации отчетов, он жаловался, что cobertura: check не был настроен правильно. В нашем случае мне не нужно было запускать проверку, мне просто нужно было генерировать отчеты. Так что Ant и AntContrib на помощь. Ниже приведен полный профиль Maven, который я придумал:

001
002
003
004
005
006
007
008
009
010
011
012
013
014
015
016
017
018
019
020
021
022
023
024
025
026
027
028
029
030
031
032
033
034
035
036
037
038
039
040
041
042
043
044
045
046
047
048
049
050
051
052
053
054
055
056
057
058
059
060
061
062
063
064
065
066
067
068
069
070
071
072
073
074
075
076
077
078
079
080
081
082
083
084
085
086
087
088
089
090
091
092
093
094
095
096
097
098
099
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
<profile>
    <id>cobertura</id>
    <dependencies>
       <dependency>
          <groupId>net.sourceforge.cobertura</groupId>
          <artifactId>cobertura</artifactId>
          <optional>true</optional>
          <version>1.9.4.1</version>
       </dependency>
    </dependencies>
    <build>
       <plugins>
          <plugin>
             <groupId>org.codehaus.mojo</groupId>
             <artifactId>cobertura-maven-plugin</artifactId>
             <configuration>
                <instrumentation>
                   <excludes>
                      <exclude>org/ebayopensource/turmeric/test/**/*.class</exclude>
                      <exclude>org/ebayopensource/turmeric/common/v1/**/*.class</exclude>
                   </excludes>
                </instrumentation>
             </configuration>
             <executions>
                <execution>
                   <id>cobertura-instrument</id>
                   <phase>process-classes</phase>
                   <goals>
                      <goal>instrument</goal>
                   </goals>
                </execution>
             </executions>
          </plugin>
          <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-jar-plugin</artifactId>
             <executions>
                <execution>
                   <id>cobertura-jar</id>
                   <phase>post-integration-test</phase>
                   <goals>
                      <goal>jar</goal>
                   </goals>
                   <configuration>
                      <classifier>cobertura</classifier>
                      <classesDirectory>${basedir}/target/generated-classes/cobertura</classesDirectory>
                   </configuration>
                </execution>
             </executions>
          </plugin>
          <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-install-plugin</artifactId>
             <version>2.3.1</version>
             <executions>
                <execution>
                   <id>cobertura-install</id>
                   <phase>install</phase>
                   <goals>
                      <goal>install</goal>
                   </goals>
                   <configuration>
                      <classifier>cobertura</classifier>
                   </configuration>
                </execution>
             </executions>
          </plugin>
          <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-antrun-plugin</artifactId>
             <executions>
                <execution>
                   <phase>verify</phase>
                   <configuration>
                      <tasks>
                         <taskdef classpathref='maven.runtime.classpath'
                            resource='tasks.properties' />
                         <taskdef classpathref='maven.runtime.classpath'
                            resource='net/sf/antcontrib/antcontrib.properties' />
                         <available
                            file='${project.build.directory}/cobertura/cobertura.ser'
                            property='ser.file.exists' />
                         <if>
                            <equals arg1='${ser.file.exists}'
                               arg2='true' />
                            <then>
                               <echo message='Executing cobertura report' />
                               <mkdir
                                  dir='${project.build.directory}/site/cobertura' />
                               <cobertura-report
                                  format='xml'
                                  destdir='${project.build.directory}/site/cobertura'
                                  datafile='${project.build.directory}/cobertura/cobertura.ser' />
                            </then>
                            <else>
                               <echo message='No SER file found.' />
                            </else>
                         </if>
                      </tasks>
                   </configuration>
                   <goals>
                      <goal>run</goal>
                   </goals>
                </execution>
             </executions>
             <dependencies>
                <dependency>
                   <groupId>ant-contrib</groupId>
                   <artifactId>ant-contrib</artifactId>
                   <version>20020829</version>
                </dependency>
             </dependencies>
          </plugin>
       </plugins>
    </build>
 </profile>

Примечание: не используйте цель cobertura: cobertura с этим профилем. Он потерпит неудачу при сборке, потому что попытается применить классы дважды.

Использование Ant и AntContrib было необходимостью, потому что нет cobertura: сообщить о цели, так как ожидается ее запуск на этапе создания сайта. Однако это также приводит к запуску цели проверки, и нам это не нужно. Так что, может быть, я разработаю патч для добавления цели отчетности просто для запуска отчета без необходимости запуска цели сайта. Надеюсь, это поможет некоторым людям, так как я потерял много волос, работая над этим.

Приятного кодирования и не забудьте поделиться!

Ссылка: включите покрытие кода для интеграции и модульных тестов, используя Cobertura и Maven от нашего партнера JCG Дэвида Карвера в блоге Intellectual Cramps .