Качество кода — деликатная тема. Это влияет на ваши расходы на техническое обслуживание, а также на удовлетворенность клиентов. Не говоря уже о мотивации ваших разработчиков к работе с кодом. Кто хочет исправить некрасивый код, верно?
Для обсуждения качества кода всегда нужны точные факты и цифры! Итак, это краткое руководство по созданию простых отчетов для анализа некоторых показателей качества кода.
Отчеты
Этот раздел кратко объяснит используемые отчеты.
FindBugs
FindBugs ищет ошибки в программах Java. Он основан на концепции шаблонов ошибок. Шаблон ошибки — это идиома кода, которая часто является ошибкой
Анализ FindBugs
Checkstyle
Checkstyle — инструмент разработки, помогающий программистам писать код Java, соответствующий стандарту кодирования. Он автоматизирует процесс проверки кода Java, чтобы избавить людей от этой скучной (но важной) задачи. Это делает его идеальным для проектов, которые хотят обеспечить соблюдение стандарта кодирования.
Анализ контрольного стиля
Cobertura Code Coverage
Cobertura — это бесплатный инструмент Java, который вычисляет процент кода, доступного тестам. Его можно использовать для определения того, в каких частях вашей Java-программы отсутствует тестовое покрытие. Он основан на jcoverage.
Отчет о Кобертуре
Отчет об испытаниях Surefire
Плагин Surefire используется на этапе test жизненного цикла сборки для выполнения модульных тестов приложения. Он генерирует отчеты …
Верный отчет об испытаниях
Базовый pom.xml
Начиная с базовой конфигурации pom:
|
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
<project> ... <properties> <findbugs.version>2.5.2</findbugs.version> <checkstyle.version>2.9.1</checkstyle.version> <surefire.reportplugin.version>2.12.4</surefire.reportplugin.version> <cobertura.version>2.5.2</cobertura.version> </properties> <build> <plugins> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>findbugs-maven-plugin</artifactId> <version>${findbugs.version}</version> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>cobertura-maven-plugin</artifactId> <version>${cobertura.version}</version> <configuration> <formats> <format>xml</format> </formats> </configuration> </plugin> </plugins> </build> <reporting> <plugins> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>findbugs-maven-plugin</artifactId> <version>${findbugs.version}</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> <version>${checkstyle.version}</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-report-plugin</artifactId> <version>${surefire.reportplugin.version}</version> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>cobertura-maven-plugin</artifactId> <version>${cobertura.version}</version> <configuration> <formats> <format>xml</format> </formats> </configuration> </plugin> </plugins> </reporting></project> |
Дженкинс Плагины
Вам нужно установить несколько плагинов jenkins, чтобы получить хорошую интеграцию с вашими отчетами.
- Модуль сбора статического анализа
- Утилиты статического анализа
- Плагин Checkstyle
- Плагин FindBugs
- Дженкинс Кобертура Плагин
Конфигурация проекта
Теперь вам нужно настроить проект так, чтобы он отображал результаты ваших отчетов.
Findbugs и Checkstyle
FindBugs и Checkstyle
Вы можете настроить их на вкладке «Настройка конфигурации». Существуют некоторые ограничения, которые влияют на представление.
Cobertura
Cobertura Config
Cobertura настраивается в «действиях после сборки». Те же конфигурации, что и в плагине findbugs и checkstyle.
Результат
На главной странице вашего проекта у вас есть несколько новых графиков и ссылок.
Дженкинс Графики трендов
Дженкинс Навбар