/stebi

Sonar Transform External Bsl Issues. Работа с диагностиками для SonarQube 1C (BSL) Community Plugin

Primary Language1C EnterpriseMIT LicenseMIT

Sonar Transform External Bsl Issues

Экспорт диагностик 1С: EDT для SonarQube 1C (BSL) Community Plugin. Трансформация диагностик: изменение параметров, удаление файлов на поддержке, удаление неактуальных диагностик. Получение версии конфигурации.

Получение джсон файла для сонара по отчету о проверке EDT

stebi c ./edt-result.out ./edt-json.json ./src

Команда: c, convert
 Конвертировать результат EDT в json для SonarQube 1C (BSL) Community Plugin

Строка запуска: stebi c [ОПЦИИ] EDT_VALIDATION_RESULT EDT_VALIDATION_JSON SRC

Аргументы:
  EDT_VALIDATION_RESULT         Путь к файлу с результатом проверки edt. Например ./edt-result.out (env $EDT_VALIDATION_RESULT)
  EDT_VALIDATION_JSON           Путь к файлу результату. Например ./edt-json.json (env $EDT_VALIDATION_JSON)
  SRC                           Путь к каталогу с исходниками. Например ./src (env $SRC)

Опции:
  -e, --ObjectErrors            Ошибки объектов назначать на первую строку модуля формы/объекта
  -r, --UseRelativePaths        В файл результата записывать относительные пути

Пример настроек проекта Сонара

sonar.host.url=http://localhost:9000
sonar.projectKey=UNF
sonar.projectVersion=1.6.17
sonar.sources=src
sonar.sourceEncoding=UTF-8
sonar.inclusions=**/*.bsl
sonar.externalIssuesReportPaths=edt-json.json,acc-generic-issue.json,bsl-generic-json.json

Переопределение файла с ошибками

Приложение позволяет создать файл настроек по существующим выгрузкам формата generic-issue и применить эти настройки к указанным файлам generic-issue.

Таким образом возможно указать effortMinutes, переопределить type и severity.

Файл настроек

Для создания файла используется команда p или prepare.
GENERIC_ISSUE_SETTINGS_JSON - Путь к файлу настроек. Если файл существует, то он будет обновлен.
GENERIC_ISSUE_JSON - Путь к файлам generic-issue.json, на основе которых будет создан файл настроек.

Пример команды stebi prepare ./test/settigs.json ./test/acc-generic-issue.json,./test/edt-json.json

Будет создан файл json с массивом настроек. В каждой настройке есть ключевые поля: ruleId, message, filePath и значения для переопределения severity, type и effortMinutes.

Ошибка соответствует ключевому полю, если значения совпадают, ключевое поле пустое или поле ошибки соответствует ключевому полю с учетом регулярного выражения.

Если все ключевые поля соответствуют ошибке, то в ошибке подменяются заполненные значения для переопределения.

Например, файл настроек с таким содержимым:

[
{
"ruleId": "",
"message": "",
"filePath": ".*Documents.*",
"severity": null,
"type": null,
"effortMinutes": 500
}
]

Установит всем документам effortMinutes = 500.

Настройки проверяются и применяются по очереди, поэтому могут друг друга переопределять.

Применение настроек и удаление файлов на поддержке

Для применения файла настроек к файлам используется команда t или transform.

Аргумент GENERIC_ISSUE_JSON - путь к отчетам через запятую. Может быть задан через переменную окружения.

Опция s settings - путь к файлу настроек. Может быть задан через переменную окружения GENERIC_ISSUE_SETTINGS_JSON.

Опция src - путь к каталогу исходных файлов. Используется для получения информации о поддержке.

Опция r remove_support - уровень удаляемой поддержки.
0 - удалить файлы на замке,
1 - удалить файлы на замке и на поддержке
2 - удалить файлы на замке, на поддержке и снятые с поддержки

Пример команды:

@set GENERIC_ISSUE_SETTINGS_JSON=%1conf\settigs.json
@set GENERIC_ISSUE_JSON=%1acc-generic-issue.json,%1bsl-generic-json.json,%1edt-json.json
@set SRC=%1src

@call stebi convert "%1temp\edt-result.out" "%1edt-json.json" 

@call stebi transform -r=1