warnings ng plugin devenv

Среда разработки для плагинов Дженкинса

Эта среда разработки на основе Docker предназначена для новых участников предупреждений Дженкинса и плагинов покрытия, чтобы сократить начальное время наращивания. Он состоит из следующих частей:

• Сценарии, чтобы проверить все модули этих плагинов Jenkins от GitHub. В зависимости от той части, в которой вы хотите внести свой вклад, вы обычно работаете только с одним из этих модулей. Тем не менее, это упрощает разработку, если все модули уже являются частью рабочего пространства. Затем вы можете переключиться в любое время на один из других модулей.
• Контроллер на основе Docker Jenkins, который установлен все необходимые плагины, чтобы увидеть эти плагины в действии. Этот контроллер Jenkins уже настроен правильно с использованием JCASC для создания модулей Java на агенте на основе Linux (также предоставляется в качестве контейнера Docker). Он уже содержит некоторые задания, которые используют все эти плагины (тесты, покрытие, статический анализ).
• IntelliJ Project, который настраивает эти плагины как модули Maven. Этот проект содержит пресеты моего стиля кодирования и некоторые другие полезные конфигурации. В частности, у него есть бегуны, настроенные для отладки плагинов Jenkins либо на контроллере или агенте.

Я представил эту среду разработки на зарегистрированной онлайн -встрече Jenkins в январе 2022 года.

Поддерживаемые операционные системы

Среда разработки была протестирована на MacOS, Ubuntu Linux (в виртуальной машине, работающей на MacOS) и Windows. Запросы на вытягивание всегда приветствуются.

Tldr

Требования к установке

Основное развитие

Последняя версия следующих инструментов:

• Docker (для Windows и MacOS: Установите Docker Desktop)
• Intellij Ultimate (или сообщество)
• Мавен
• JDK 21
• Git

Тестирование пользовательского интерфейса

Кроме того, требуются последние версии следующих инструментов:

• Firefox и Gecko-Driver
• Хром и хром-драйвер

Шаги установки

Если возникают ошибки, обратите внимание на намеки на устранение неполадок ниже. Для пользователей Windows: используйте Git Bash, чтобы выполнить сценарии оболочки.

1. Клонировать и построить модули плагина, используя скрипт ./bin/clone-repos-https.sh (или ./bin/clone-repos.sh , если у вас уже есть ключ SSH в Github). Вы должны подождать, пока сборка не достигнет успеха, прежде чем открыть IntelliJ, в противном случае IntelliJ не найдет все сгенерированные классы. В первый раз пользователям Maven нужно подождать пару минут, пока все зависимости не будут загружены с Maven Central.
2. Импортировать проект в IntelliJ:
   1. Начните Intellij
   2. Выберите Open ...
   3. Выберите warnings-ng-plugin-devenv
   4. Необязательно (только в том случае, когда IntelliJ спрашивает): проекты Maven должны быть импортированы Select Inable Auti-Import .
   5. Необязательно (только в том случае, когда IntelliJ спрашивает): доверие и открытие проекта Maven Select Trust Project (см. Intellij Online Help)
3. Запустите тестовые пусковые установки в IntelliJ для проектов анализа и модели покрытия.
4. Для пользователей Windows: запустите Docker Desktop, если еще не сделано
5. Начните Дженкинс с ./bin/jenkins.sh . Эта команда создает изображение Jenkins Docker, загружает все зарегистрированные плагины и инициализирует рабочее пространство Jenkins с некоторыми заданиями. Это также требует нескольких минут (см. Шаг 9).
6. Войдите в Jenkins по адресу: http: // localhost: 8080/
7. Используйте следующие учетные данные:
   • Пользователь: администратор
   • Пароль: администратор
8. Начните предоставленные задания Jenkins, которые показывают плагины в действии:
   • Фристайл-анализ-модель : вакансия Jenkins Freestyle, которая создает библиотеку анализа-моделя. Все эти группы, все предупреждения в одном отчете Дженкинса и дополнительно показывают результаты покрытия кода Jacoco.
   • Pipeline-Codingstyle : сценарий Jenkins Pipeline, который создает библиотеку кодирования. Эта работа показывает индивидуальные результаты для различных анализаторов предупреждений. Кроме того, эта работа показывает подробную информацию о покрытии кода Jacoco и охвате мутаций PIT.
   • Модель по всему миру : сценарий Дженкинс, который создает все существующие выбросы проекта модели покрытия. Сборки займет некоторое время, но покажут, как работают диаграммы трендов и как выполняются расчеты Delta. Работа дает результаты для всех инструментов статического анализа, охвата кода Jacoco и охвата мутации PIT.
9. Разверните текущую главу плагинов в экземпляр Jenkins, используя пусковые установки в IntelliJ.

Установка - Устранение неполадок

Шаг 1 - Установка не удалась

Если все загрузки преуспели, но установка не удалась из -за ошибок, исправьте их и выполните mvn -V -U -e install –DskipTests чтобы повторно повторно установки.

Шаг 3 - «Командная строка слишком длинная».

Если командная строка ошибка «слишком длинная». происходит, выполнить следующие шаги:

1. Нажмите «Редактировать конфигурацию» и выберите «Неудачную конфигурацию запуска» (или нажмите на имя тестового запуска в сообщении об ошибке)
2. Нажмите «Создать и запустить» > «Изменить параметры» > «Командная строка»
3. В пределах появления командной строки поля Shorten выберите @argfile (Java9+)
4. Нажмите Apply и OK и снова выполните тестовый запуск
5. (Возможно, IntelliJ должен быть перезапущен, если не найдено никаких тестов)

Шаг 3 - тайм -аут тестирования Дженкинса

Если тесты не сняты из -за тайм -аута тестирования Дженкинса, выполните следующие шаги:

1. Нажмите «Редактировать конфигурацию» и выберите «Неудачную конфигурацию запуска»
2. Добавить в виртуальную машину : -Djenkins.test.timeout=1000 . Это увеличивает ограничение тайм -аута до 1000 секунд.

Клонирование модулей

Вы можете использовать простой скрипт оболочки ( ./bin/clone-repos.sh ), чтобы клонировать и построить модули за один шаг. Сценарий проверяет следующие модули, используя протокол GIT SSH. Это требует, чтобы вы зарегистрировали свой открытый ключ в GitHub. Если у вас нет ключей в GitHub, вы можете альтернативно использовать скрипт ./bin/clone-repos-https.sh , который использует протокол HTTPS.

• CodingStyle: Мой стиль кодирования с предварительно настроенными правилами для контроля, PMD и SpotBugs. Эти конфигурации могут быть связаны в IntelliJ, чтобы убедиться, что код соответствует правилам.
• Анализ-модель: библиотека для чтения статических анализов отчеты в объектно-модели Java. Этот модуль не зависит от Дженкинса.
• Analysis-Model-Api-Plugin: простая обертка для библиотеки моделей анализа. Он обеспечивает классы анализа-модели как плагин Jenkins. Эта накладная расходы необходим для упрощения обновлений модуля анализа моделя в Дженкинсе.
• Предупреждения-нг-плугин: плагин для чтения отчетов о статическом анализе и показывает соответствующие результаты в Дженкинсе.
• Модель покрытия: библиотека для чтения отчетов о покрытии в объектно-модели Java. Этот модуль не зависит от Дженкинса.
• Покрытие-плугин: плагин для чтения отчетов о покрытии и показать соответствующие результаты в Дженкинсе.

Совместно несколько модулей

Когда вы планируете предоставить запрос на привлечение одного из плагинов, вам необходимо создать вилку репозитория и внести все изменения в этой вилке. Я создал документацию по совместной работе GitHub в своем проекте стиля кодирования.

Изменение и отладка кода с IntelliJ

Intellij (Ultimate) является основной поддерживаемой средой разработки для плагина предупреждений. Предопределенный проект хранится в папке .idea , который ссылается на все модули плагина предупреждений. Этот проект содержит пресеты моего стиля кодирования и некоторые другие полезные конфигурации.

Также следует использовать другие IDE (Eclipse, Netbeans, Visual Studio Code).

Заводящие устройства и интеграционные тесты

Используйте предоставленные конфигурации Intellij Run All in [module-name] чтобы запустить тесты и интеграции соответствующего модуля. Эти конфигурации уже настроены для записи охвата ветвей соответствующих пакетов модулей (используйте Run with Coverage ).

Отладка

Прежде чем вы сможете отладить свои изменения, вам сначала нужно выяснить, где работает ваш код: на контроллере или на агенте? Если вы не уверены, тогда запустите оба удаленных отладчика, установите некоторые точки останова и подождите, пока соответствующий отладчик остановится.

Отладка контроллера Дженкинса

Конфигурация Docker Compose запускает контроллер Jenkins автоматически в режиме «отладки», то есть, он прослушивает запросы удаленной отладки. Если ваш код работает в контроллере, вам необходимо прикрепить удаленный отладчик по адресу localhost:8000 (сопоставлен с тем же портом в контейнере Docker). Используйте предоставленную конфигурацию отладки Jenkins Controller (Remote Debugger) , чтобы подключить отладчика в IntelliJ.

Отладка агента Дженкинса

Конфигурация Docker Compose также запускает агент Jenkins автоматически в режиме «отладки», т. Е. Он прослушивает запросы удаленной отладки. Прикрепите удаленный отладчик по адресу localhost:8001 (сопоставлен с тем же портом в контейнере Docker) к коду отладки, который работает на агенте. Используйте предоставленную конфигурацию отладки Jenkins Agent (Remote Debugger) , чтобы подключить отладчика в IntelliJ.

Запуск тестов пользовательского интерфейса

Тесты пользовательского интерфейса могут быть запущены с использованием соответствующих UI Tests [module] (Firefox) или UI Tests [module] (Chrome) . Обратите внимание, что оба запуска требуют установки соответствующих драйверов селена. Если эти драйверы не установлены в /opt/bin на вашей локальной машине, вам необходимо адаптировать конфигурации запуска, чтобы соответствовать вашей настройке.

Все тесты пользовательского интерфейса требуют выполнения в разделе «Данного предмета» (т. Е., Тестирование Дженкинса, JUT), см. Проект Harness Harness для приема для получения более подробной информации.

Начало Дженкинса

Эта среда разработки содержит индивидуальную установку Jenkins, в которой вы можете развернуть свои модифицированные плагины, чтобы вы могли видеть свои изменения непосредственно в некоторых предварительно настроенных заданиях, которые используют эти плагины.

Начните предоставленный контроллер Jenkins в этом проекте (вам нужно установить Docker и Docker-Compose). Откройте терминал и запустите ./jenkins.sh в папке верхнего уровня. Эта команда представляет собой обертку для docker-compose up : она использует правильные настройки пользователя и группы, так что разрешения громкости Docker для домашней папки Jenkins были правильно установлены. Эта команда создает контейнер Docker для контроллера Jenkins и один для агента Java. Это потребует некоторое время при первом вызове, так как будут составлены изображения Docker. После того, как изображения были созданы, будут начаты следующие два контейнера:

• Jenkins-Controller: официальное изображение Jenkins LTS Docker (Alpine Linux). Контроллер предварительно настроен с использованием JCASC для создания приложений Java на агенте. Контроллер не разрешается выполнять задания.
• Java-Agent: минимальный агент Java, основанный на официальном изображении Docker OpenJDK8 (Alpine Linux). Контроллер и агент подключены с помощью SSH.

Затем вы можете открыть Jenkins на URL http: // localhost: 8080/. Используйте следующие учетные данные, чтобы войти в систему как администратор:

• Пользователь: администратор
• Пароль: администратор

Том для Jenkins_home

Домашний каталог контроллера Дженкинса (jenkins_home) монтируется в виде тома Docker. Т.е. это видно на хосте как обычный каталог по адресу ./docker/volumes/jenkins-controller . Он выживет в сессиях и может быть изменен непосредственно на хосте, см. В официальной документации подробно. Это помогает осмотреть файлы, которые были созданы контроллером Jenkins.

Из -за проблемы с производительностью в плагине Jenkins's Job DOM, настройка нового экземпляра Jenkins очень медленная. Поэтому имеет смысл удалить конфигурацию работы в вашем файле jenkins.yaml после создания заданий. Вы можете перезаписать содержание файла ./docker/volumes/jenkins-home/jenkins.yaml в вашем недавно созданном экземпляре Jenkins с контентом в jenkins-no-jobs.yaml .

Объемы под macos довольно медленные. На моем MacBook, работающем с предоставленной задачей Jenkins of the analysis-model в контейнере Docker, медленнее, чем выполнение той же работы Jenkins в контейнере Docker, который работает в виртуальной машине Linux на том же MacBook (звучит как бы абсурдно?).

Развертывание измененных плагинов в Дженкинс

После того, как вы закончите свои локальные изменения в разработке (то есть, модульные тесты станут зелеными), вы должны проверить свои изменения в Дженкинсе. Это также помогает подготовить интеграционный тест или тест пользовательского интерфейса для ваших изменений.

Изменение модели анализа без добавления новых методов API

Если у вас есть только изменения в модуле analysis-model (и вы не добавили новые методы API), вам необходимо восстановить и установить модуль Maven Module analysis-model.jar , а затем восстановить соответствующие плагины Jenkins Prapper analysis-model-api-plugin . Этот плагин должен быть развернут в Дженкинсе.

Этот процесс упрощается, запустив Script ./bin/go.sh в модуле analysis-model , он установит модульный analysis-model.jar в вашем локальном хранилище Maven. Затем этот сценарий создаст фактический плагин и развернется его в Дженкинс.

Изменение плагина предупреждений

Если у вас есть только изменения в плагине предупреждений-NG, вам необходимо восстановить warnings-ng.jpi и развернуть его в Jenkins. Вы можете использовать один из следующих сценариев оболочки для этой задачи:

• ./bin/clean.sh : создает плагин, используя mvn clean install и развертывает его на успехе в экземпляре Jenkins.
• ./bin/go.sh : создает плагин с использованием mvn clean install -DskipITs (пропускает интеграционные тесты) и развертывает его на успехе в инстанции Jenkins.
• ./bin/skip.sh : создает плагин с использованием mvn clean install -DskipTests (пропускает все тесты и статический анализ) и развертывает его на успехе в экземпляр Jenkins.

Изменение модели анализа путем добавления новых методов API

Тодо

Изменение криминалистика-апи-плугин и git-forensics-plugin

Если у вас есть изменения в одном из плагинов ForeSics (реализация API или GIT), вам необходимо восстановить эти плагины Jenkins и развернуть их в экземпляре Jenkins.

Чтобы упростить этот процесс запустить скрипт ./go.sh в соответствующей папке плагина, он создаст плагин и развернется его на успех в Дженкинс.

Изменение модуля с нарушением изменений API

Прежде чем внести переломные изменения, свяжитесь со мной. Как правило, можно внести изменения в обратном порядке.

IntelliJ Launchers для развертывания плагинов

Сценарии сборки из последнего раздела также можно начать с использованием одного из интеллектуальных строк Build and Deploy [module-name] . Эти пусковые установки создают соответствующий плагин и развертывают его в Дженкинсе.

Принятие теста жгута

Тесты пользовательского интерфейса могут быть запущены с использованием конфигурации запуска IntelliJ или с помощью сценария командной строки. Как уже упоминалось, все тесты пользовательского интерфейса требуются для запуска в пределах заданного предмета. В нашем случае мы используем последнюю доступную версию Jenkins LTS и предопределенный набор плагинов из нашего изображения Docker.

Запуск тестов пользовательского интерфейса в IntelliJ

Тесты пользовательского интерфейса могут быть запущены с использованием соответствующих UI Tests Warnings (Firefox) или UI Warnings Tests (Chrome) . Обратите внимание, что оба запуска требуют установки соответствующих драйверов селена. Если эти драйверы не установлены в /opt/bin на вашей локальной машине, вам необходимо адаптировать конфигурации запуска, чтобы соответствовать вашей настройке.

Запуск тестов пользовательского интерфейса из консоли

Вы также можете запустить тесты пользовательского интерфейса, используя предоставленные Shell Scrips testFirefox.sh или testChrome.sh . Обратите внимание, что вам также может потребоваться адаптировать эти сценарии (см. Предыдущий раздел).