Настройка HTML Publisher в Jenkins для отображения CSS

Быстрый ответ

Для корректного отображения CSS в HTML-отчётах Jenkins, вам потребуется модифицировать Политику Безопасности Содержимого (CSP). Введите следующую команду в скриптовой консоли Jenkins:

System.setProperty("hudson.model.DirectoryBrowserSupport.CSP", "style-src 'self' 'unsafe-inline';")

Такой подход разрешит использовать встроенные стили и CSS-файлы с вашего домена, возвращая ваши отчёты к их привычному виду, при этом ни на йоту не снижая уровень контроля над CSP.

Анализ CSP Jenkins и CSS

Понимание проблемы CSP

Jenkins применяет строгую политику CSP: по умолчанию блокируются все потенциально небезопасные элементы, включая JavaScript и CSS, чтобы избежать возможных угроз.

Подробнее об этом расскажет наш спикер на видео

Влияние CSP на отчёты Jenkins

В результате такой строгой безопасностной политики отчёты Jenkins теряют оформление — стили CSS и JavaScript в HTML документах не выполняются, вследствие чего документы выглядят упрощённо и безжизненно.

Применение решения с использованием CSP

Чтобы применить исправление, выполните следующие действия:

• Перейдите в раздел Управление Jenkins.
• Откройте Скриптовую Консоль.
• Вставьте и выполните скрипт из раздела "Быстрый ответ".
• Для пользователей IntelliJ IDEA бонусом будет то, что перезапускать сервер не потребуется.

Безопасность прежде всего

Не рекомендуется устанавливать CSP в нулевое значение, ведь этот шаг можно сравнить с открытием дверей вашего дома на полные настежь. Используйте специфические директивы, такие как 'self', 'unsafe-inline', для баланса между безопасностью и функциональностью.

Визуализация

Представьте следующую ситуацию: у вас есть дом:

Jenkins 🏠: существует стены и крыша, но нет выразительности, нет расцвета!

Затем вы активируете CSP:

💡 Политика Безопасности Содержимого: Позволим работать CSS! 🎨

И ваш дом вдруг оживает:

Jenkins 🏠, оживленный CSS: Яркие стены, великолепный сад! 🎨🌷

Освоение сложных сценариев

Автоматизация исправления CSP

Добавьте Groovy скрипт в ваш пайплайн или в процесс запуска Jenkins, чтобы CSP настраивался автоматически, избавляя вас от необходимости помнить о его установке.

Использование плагина Startup Trigger

Плагин Startup Trigger облегчит настройку CSP при каждом запуске Jenkins, создавая комфорт, подобный устройству для приготовления кофе по утрам.

Работа с отчётами в различных средах

Некоторые конфигурации, в частности Serenity BDD или же когда Jenkins работает на CentOS, могут столкнуться с проблемами доступа к ресурсам из-за политик SELinux. Убедитесь, что безопасность вашей системы совместима с настройками Jenkins.

Контроль после внесения изменений

После внесения изменений в CSP следите за состоянием вашей системы и плагином HTML Publisher Plugin, чтобы убедиться, что функционал отчётов остался неизменным, а результаты соответствуют ожиданиям.

Проверка корректности отчётов

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

Полезные материалы

1. HTML Publisher | Jenkins плагин — руководство по использованию плагина Jenkins HTML Publisher.
2. Настройка Политики Безопасности Содержимого — детализированное руководство по настройке CSP в Jenkins.
3. Типы MIME (IANA media types) – HTTP | MDN — подробное освещение типов MIME.
4. Как подключить CSS — руководство от W3Schools, подсказывающее, как правильно добавлять CSS, чтобы предотвратить возможные ошибки.
5. GitHub – jenkinsci/htmlpublisher-plugin: Jenkins htmlpublisher плагин — исходный код плагина для создания HTML-отчётов в Jenkins.
6. CSP Evaluator — инструмент от Google для оценки и улучшения стратегий CSP.