1
0
mirror of https://github.com/firstBitMarksistskaya/jenkins-lib.git synced 2025-08-25 20:09:25 +02:00

fix defaults and doc

This commit is contained in:
Dima
2024-08-30 17:09:49 +03:00
parent 0647dcb3f8
commit e0f349a475
4 changed files with 16 additions and 9 deletions

View File

@@ -39,7 +39,7 @@
1. Запуск BDD сценариев с сохранением результатов в формате Allure.
1. Запуск юнит-тестов с помощью фреймворка YAXUnit с сохранением результатов в формате jUnit и Allure.
1. Запуск синтаксического контроля средствами конфигуратора и сохранение результатов в виде отчета jUnit.
1. Запуск валидации проекта средствами EDT и конвертация отчета в форматах BSL LS или Generic Issue.
1. Валидация проекта средствами EDT и трансформация отчета EDT в формат BSL LS с помощью `edt-ripper` или Generic Issue с помощью `stebi`.
1. Запуск статического анализа для SonarQube.
1. Публикация результатов junit и Allure в интерфейс Jenkins.
@@ -150,7 +150,9 @@ pipeline1C()
* Если в репозитории существует файл `./tools/syntax-check-exception-file.txt`, то команде запуска синтаксического контроля конфигурации данный файл будет передаваться как файл с исключениями сообщений об ошибках (параметр `--exception-file`) (`syntaxCheck` -> `exceptionFile`).
* Конфигурационный файл по умолчанию уже содержит ряд "режимов проверки" для синтаксического контроля конфигурации (`syntaxCheck` -> `checkModes`).
* Трансформация результатов валидации EDT:
* При использовании stebi по умолчанию из результатов анализа исключаются замечания, сработавшие на модулях с включенным запретом редактирования (желтый куб с замком) (параметры `resultsTransform` -> `removeSupport` и `resultsTransform` -> `supportLevel`).
* Используется `stebi` (параметр `resultsTransform` -> `transformer`)
* Формат файла - `generic issues` для SonarQube 10.3+ (параметр `resultsTransform` -> `genericIssueFormat`)
* `stebi` исключает из результатов анализа замечания, сработавшие на модулях с включенным запретом редактирования (желтый куб с замком) (параметры `resultsTransform` -> `removeSupport` и `resultsTransform` -> `supportLevel`).
* Анализ SonarQube:
* Предполагается наличие единственной настройки `SonarQube installation` (`sonarqube` -> `sonarQubeInstallation`).
* Используется `sonar-scanner` из переменной окружения `PATH` (`sonarqube` -> `useSonarScannerFromPath`).
@@ -174,9 +176,9 @@ pipeline1C()
## Настройка загрузки расширений
Если у вас есть расширения которые необходимо загрузить в базу для проведения тестов и проверок, это можно сделать на этапе подготовки базы.
Если у вас есть расширения, которые необходимо загрузить в базу для проведения тестов и проверок, это можно сделать на этапе подготовки базы.
* При загрузке из исходников расширения должны быть в том же формате(edt или конфигуратора) что и основная конфигурация.
* При загрузке из исходников расширения должны быть в том же формате (edt или конфигуратора), что и основная конфигурация.
* Для загрузки расширений необходимо описать каждое из них в массиве (`initInfobase` -> `extensions`).
Для загрузки расширений в информационную базу необходимо выполнить следующие шаги:
@@ -234,4 +236,9 @@ pipeline1C()
* Добавить расширение `YAXUnit` и дополнительные расширения с тестами можно в `jobConfiguration.json` -> `initInfobase` -> `extensions`. Они будут загружены при инициализации ИБ.
* Если ваши тесты размещены в отдельных расширениях, скопируйте файл `./resources/yaxunit.json` из текущей библиотеки в свой репозиторий (`./tools/yaxunit.json`) и перечислите в нем имена ваших расширений.
* Если используется собственный файл `tools/yaxunit.json`, то значение параметра reportPath в нем должно быть равно `./build/out/yaxunit/junit.xml`
* Если используется собственный файл `tools/yaxunit.json`, то значение параметра `reportPath` в нем должно быть равно `./build/out/yaxunit/junit.xml`
## Настройка трансформации результата валидации EDT
* При использовании SonarQube версии <10.3 и `stebi` формат отчета должен быть `Generic_Issue` (параметр `resultsTransform` -> `genericIssueFormat`)
* Трансформацию результатов может выполнять `edt-ripper` (параметр `resultsTransform` -> `transformer`). В этом случае замечания будут загружены в SonarQube в формате BSL LS, что позволяет полноценно управлять ими в SonarQube.

View File

@@ -93,7 +93,7 @@
},
"resultsTransform": {
"transformer": "stebi",
"genericIssueFormat": "Generic_Issue",
"genericIssueFormat": "Generic_Issue_10_3",
"removeSupport": true,
"supportLevel": 0
},

View File

@@ -359,7 +359,7 @@
},
"genericIssueFormat" : {
"type" : "string",
"description" : "Формат отчета generic issue. Только для stebi.\n Для SonarQube 10.3+ необходимо использовать Generic_Issue_10_3.\n По умолчанию Generic_Issue\n ",
"description" : "Формат отчета generic issue. Только для stebi.\n Для SonarQube 10.3+ необходимо использовать Generic_Issue_10_3.\n По умолчанию Generic_Issue_10_3\n ",
"enum" : [ "Generic_Issue", "Generic_Issue_10_3" ]
}
}

View File

@@ -26,9 +26,9 @@ class ResultsTransformOptions implements Serializable {
@JsonPropertyDescription("""Формат отчета generic issue. Только для stebi.
Для SonarQube 10.3+ необходимо использовать Generic_Issue_10_3.
По умолчанию Generic_Issue
По умолчанию Generic_Issue_10_3
""")
GenericIssueFormat genericIssueFormat = GenericIssueFormat.GENERIC_ISSUE
GenericIssueFormat genericIssueFormat = GenericIssueFormat.GENERIC_ISSUE_10_3
@Override
@NonCPS