В этой статье будет приведен простой пример использования JaCoCo агента через IDE IntelliJ IDEA. Этот пример подойдет для случая если нам требуется узнать покрытие внешними интеграфионными тестами, которые работают с запущенным или развернутым приложением.
Описаный ниже способ НЕ подойдет для анализа покрытия Unit тестами, т.к. юнит тесты выполняются при сборке проекта, а не на запущенном приложении.
Запуск или развертывание приложения будет производится через IDE IntelliJ IDEA IDE 2018.1, при желании подобным образом можно также написать скрипт для запуска приложения.
1. Для начала скачиваем архив с JaCoCo с сайта https://www.jacoco.org/jacoco/. На момент написания статьи последняя версия JaCoCo - 0.8.2.
Мы будем использовать для анализа покрытия JaCoCo Java Agent. Файл JaCoCo Java Agent находится в архиве с библиотекой по пути \lib\jacocoagent.jar
2. Распаковываем jacoco-0.8.2.zip в любое удобное место, например в D:/jacoco-0.8.2.
3. В IDEA открываем наш проект, заходим в Run -> Edit Configurations.
4. Если мы используем конфигурацию Tomcat Server, то ищем параметр VM options. Для других конфигураций ищем похожий по смылу (в зависимости от типа выбранной конфигурации запуска название параметра может отличаться).
Устанавливаем значение этого параметра, например, как показано ниже.
-javaagent:D:\jacoco-0.8.2\lib\jacocoagent.jar=destfile=D:/jacoco.exec,output=file,append=false,includes=my.company.*
Сразу после javaagent: указан на путь к JaCoCo java агенту.
Параметр destfile указывает на путь куда будет записан отчет о покрытии (coverage report). Здесь мы указали destfile=D:/jacoco.exec.
Параметр output - тип вывода. Может быть file, tcpserver, tcpclient, none
Параметр includes - позволяет ограничить список классов для анализа покрытия. Нас интересует только покрытие классов в проекте, и не интересует покрытие в классах подключенных библиотек, поэтому нужно добавить ограничение по пакету my.company.* (здесь нужно указать свои пакеты). Такое ограничение не обязательно, но его желательно добавлять, т.к. обычно оно очень существенно уменьшает размер файла отчета.
Более подробно про параметры JaCoCo агента можно почитать здесь
5. Применяем нашу конфигурацию и запускаем её используя команду Run.
6. Теперь мы можем запустить внешние тесты для которых мы хотим проверить покрытие. Это могут быть тесты на основе BDD фремворка Cucumber. По окончании работы тестов необходимо будет остановить приложение. Отчет по покрытию будет создан в момент остановки приложения по пути указанному в параметре destfile.
7. После создания отчета его можно импортировать и IDE чтобы посмотреть покрытие по классам и строкам. Это можно сделать используя меню Analyze -> Show Coverage Data, и выбрав там соответствующий .exec файл отчета.
Комментариев нет:
Отправить комментарий