Help:CLI: Difference between revisions

From Svacer Wiki
(update command options)
 
(23 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Help]]
== CLI features ==
=== Получение справки ===
=== Перенос снимков ===
Запустив Svacer без параметров, можно получить информацию о доступных командах. Дополнительная информация о каждой команде доступна при использовании опции '''--help'''
Svacer предоставляет возможность по экспорту и импорту снимков посредством интерфейса командной строки и [[Help:UI manual#Работа со снимками|веб-интерфейса]]. Экспорт снимка включает все предупреждения, информацию о снимке, прикрепленные файлы, объект сборки, пользовательские атрибуты, разметку и комментарии. Подавленные предупреждения также включаются в экспортированную информацию и импортируются в статусе подавленных.


    svacer <command name> --help
Экспорт и импорт снимков из командной строки доступен пользователям с [[Help:UI manual#Описание ролевой модели|соответствующими правами]] для выбранного проекта/ветки.


Общий формат командной строки
Экспорт снимков:
    svacer server export
        --user <user>
        --password <pwd>
        --host <host>
        --port <port>
        --grpc <grpc port>
        --project <project name or id>
        --branch <branch name or id>
        --snapshot <snapshot name or id>
        <output file name>


     svacer [global options] command [command options] [arguments...]
Импорт снимков:
     svacer server import
        --user <user>
        --password <pwd>
        --host <host>
        --port <port>
        --grpc <grpc port>
        --project <project name or id>
        --branch <branch name or id>
        --name <new name for snapshot>
        [--force]
        <input file name>


Глобальные опции относятся ко всем командам.
Опция '''--force''' создаст проект и ветку, если их не было на сервере.
Опции команд имеют префикс «--». Их следует указывать до списка аргументов.
Для команд с опцией --password доступна возможность ввода пароля с клавиатуры.


=== Создание PDF отчета для проекта ===  
=== Создание PDF отчета ===
Для создания PDF отчета по проекту из интерфейса командной строки используется команда  '''pdfgen'''. Назначение команды состоит в том, чтобы добиться из консоли результатов (создание PDF файла отчета), аналогичным следующим действиям пользователя в GUI:
Для создания PDF отчета по проекту из интерфейса командной строки используется команда  '''pdfgen'''.  
# Выгрузка таблицы маркеров в формате PDF ([[#pic1|Рис. 1]])
# Предварительное формирование содержимого таблицы маркеров
#* По режимам сравнения (new, missing, same, matched) с указанием цели и источника сравнения, ([[#pic2|Рис. 2]])
#* По используемым фильтрам Custom (ограниченный набор из 4 параметров) ([[#pic3|Рис. 3]])
 
Ниже приводятся фрагменты GUI, которым соответствует cli команда в различных вариантах ее использования:
 
<span id="pic1" />
[[File:SimpleReport.png|none|left|alt=SimpleReport window]]
'''Рис. 1 — Отчет без сравнения'''
 
<span id="pic2" />
[[File:CompareReport.png|none|left|alt=CompareReport window]]
'''Рис. 2 — Отчет со сравнением'''
 
<span id="pic3" />
[[File:CompareFiltersReport.png|none|left|alt=CompareFiltersReport window]]
'''Рис. 3 — Отчет со сравнением и фильтрами'''


Общий вид команды следующий:
Общий вид команды следующий:
    '''svacer pdfgen''' --cmpMode [none|new|missing|matched|same] --project [name|id] --branch [name|id] --snapshot [name|id] [--targetProject [name|id] --targetBranch [name|id] --targetSnapshot [name|id]] [--file [re_exp] --checker [re_exp] --severity [re_exp] --review [re_exp]] --outFile report_name --tz time_zone --lang report_lang
  svacer pdfgen --cmp-mode [none|new|missing|matched|same] --project [name|id] --branch [name|id] --snapshot [name|id] [--target-project [name|id] --target-branch [name|id] --target-snapshot [name|id]] [--file [re_exp] --checker [re_exp] --severity [re_exp] --review [re_exp]] --out-file report_name --tz time_zone --lang report_lang


Описание параметров:
* '''cmpMode''' — параметры сравнения. Возможные значения: '''none''' — без сравнения, '''new''' — новые, '''missing''' — отсутствующие, '''matched''' — сопоставленные, '''same''' — одинаковые
* '''cmpMode''' — параметры сравнения. Возможные значения: '''none''' — без сравнения, '''new''' — новые, '''missing''' — отсутствующие, '''matched''' — сопоставленные, '''same''' — одинаковые
* '''Project, Branch, Snapshot''' — параметры, описывающие снимок, отчет для которого требуется создать. В качестве значений могут использоваться как имена, так и идентификаторы соответствующих сущностей. Например: --project zstd  --branch "7683ed6a-b838-4090-9945-10e148f94be3" --snapshot zstd_130
* '''project, branch, snapshot''' — параметры, описывающие снимок, отчет для которого требуется создать. В качестве значений могут использоваться как имена, так и идентификаторы соответствующих сущностей. Например: --project zstd  --branch "7683ed6a-b838-4090-9945-10e148f94be3" --snapshot zstd_130
* '''targetProject, targetBranch, targetSnapshot''' — параметры, описывающие снимок, с которым необходимо провести сравнение (обязательные параметры для режимов cmpMode: new, missing, matched, same).
* '''target-project, target-branch, target-snapshot''' — параметры, описывающие снимок, с которым необходимо провести сравнение (обязательные параметры для режимов cmpMode: new, missing, matched, same).
* '''File, checker, severity, review''' — параметры, задающие фильтры, применяемые к списку маркеров. Фильтры задают условия включения маркера в отчет. Значения фильтров задаются в формате регулярных выражений. В случае неверного формата, ошибочный фильтр не будет применяться и операция экспорта будет выполнена, как если бы фильтр не был указан. File — фильтр по пути к файлу, где был обнаружен маркер. Checker — фильтр по чекеру, предупреждение от которого было создано. Severity — серьезность сработавшего чекера. Review — статус разметки (confirmed, unclear и т.д.)  
* '''file, checker, severity, review''' — параметры, задающие фильтры, применяемые к списку маркеров. Фильтры задают условия включения маркера в отчет. Значения фильтров задаются в формате регулярных выражений. В случае неверного формата, ошибочный фильтр не будет применяться и операция экспорта будет выполнена, как если бы фильтр не был указан. File — фильтр по пути к файлу, где был обнаружен маркер. Checker — фильтр по чекеру, предупреждение от которого было создано. Severity — серьезность сработавшего чекера. Review — статус разметки (confirmed, unclear и т. д.)  
* '''outFile''' — имя создаваемого файла отчета. Если не будет указано расширение, будет добавлено расширение pdf
* '''out-file''' — имя создаваемого файла отчета. Если не указано расширение, будет добавлено расширение pdf
* '''tz''' — временная зона в минутах. Используется при формировании записи  о комментариях, которые оставил пользователь, производивший разметку
* '''tz''' — временная зона в минутах. Используется при формировании записи  о комментариях, которые оставил пользователь, производивший разметку
* '''lang''' — язык, который будет использован в создаваемом отчете (en — английский, ru — русский)
* '''lang''' — язык, который будет использован в создаваемом отчете (en — английский, ru — русский)


Для создания отчета без использования режима сравнения, необходимо указать cmpMode в значение none (это значение используется по умолчанию).
Для создания отчета без использования режима сравнения, необходимо указать cmpMode в значение none (это значение используется по умолчанию).
Для предварительного формирования таблицы маркеров с учетом сравнения, использовать значения cmpMode [new, missing, same, matched]. Названия этих режимов аналогичны названиями в GUI. При этом требуется указание как минимум одного параметра из списка: targetProject, targetBranch, targetSnapshot. Если какие-то параметры target* не указаны, они будут установлены в значение исходных (project → targetProject, branch → targetBranch, …). Сформированные на предварительном этапе  маркеры, проходят механизм фильтраций (параметры: severity, file, review, checker), после чего происходит создание отчета.


Для создания отчета можно также использовать public API. Необходимо использовать следующие параметры:
Для предварительного формирования таблицы маркеров с учетом сравнения, использовать значения cmpMode [new, missing, same, matched]. Названия этих режимов аналогичны названиями в GUI. При этом требуется указание как минимум одного параметра из списка: target-project, target-branch, target-snapshot. Если какие-то параметры target* не указаны, они будут установлены в значение исходных (project -> target-project, branch -> target-branch, ...). Сформированные на предварительном этапе маркеры, проходят механизм фильтраций (параметры: severity, file, review, checker), после чего происходит создание отчета.
 
Для создания отчета можно использовать public API:
:URL — /api/public/exportPDF
:URL — /api/public/exportPDF
:Метод — POST
:Метод — POST


Тело запроса — формат JSON, имеет следующий вид:  
Тело запроса — JSON, имеет следующий вид:  
     {
     {
     "compare_mode": "new",
     "compare_mode": "new",
Line 78: Line 79:
Данный запрос соответствует запросу на создание отчета, который получается в результате сравнения в рамках проекта zstd и ветки v13 двух снимков zstd_131 и zstd_132. При этом будут выбраны только новые маркеры. Среди выбранных останутся только те, что удовлетворяют условиям фильтров, а именно: чекер начинается с буквы Z, файл содержит слово example, серьезность чекера содержит подстроку Cr (что в силу ограниченного количества значений для данного фильтра соответствует значению Critical) в названии, а состояние разметки содержит подстроку Conf (что в силу ограниченного количества значений для данного фильтра соответствует значению Confirmed). Язык отчета — английский, часовой пояс — 180 минут (3 часа).
Данный запрос соответствует запросу на создание отчета, который получается в результате сравнения в рамках проекта zstd и ветки v13 двух снимков zstd_131 и zstd_132. При этом будут выбраны только новые маркеры. Среди выбранных останутся только те, что удовлетворяют условиям фильтров, а именно: чекер начинается с буквы Z, файл содержит слово example, серьезность чекера содержит подстроку Cr (что в силу ограниченного количества значений для данного фильтра соответствует значению Critical) в названии, а состояние разметки содержит подстроку Conf (что в силу ограниченного количества значений для данного фильтра соответствует значению Confirmed). Язык отчета — английский, часовой пояс — 180 минут (3 часа).


=== Импорт разметки из исходного кода на сервер истории ===
=== Импорт разметки из исходного кода ===
Импорт разметки из исходного кода на сервер истории возможен с помощью команды '''svacer markup import'''.
Импорт разметки из исходного кода на сервер истории возможен с помощью команды '''svacer markup import'''


Синтаксис:
Синтаксис:
    svacer markup --user <user> --password <password> --project <project id or name> --branch <branch id or name> --snapshot <snapshot id or name> import --template <name> [--excludePaths <path1, path2, ... ,pathN> --from-build-object]
  svacer markup --user <user> --password <password> --project <project id or name> --branch <branch id or name> --snapshot <snapshot id or name> import --template <name> [--exclude-paths <path1, path2, ..., pathN> --from-build-object]


Где:  
Где:  
* user, password — пользователь и пароль учетной записи на сервере истории
* user, password — пользователь и пароль учетной записи на сервере
* project — проект на сервере истории, в который будет произведен импорт разметки
* project — проект на сервере, в который будет произведен импорт разметки
* branch — ветка в проекте выбранном выше (по умолчанию master), в которую будет произведен импорт разметки
* branch — ветка в проекте выбранном выше (по умолчанию master), в которую будет произведен импорт разметки
* snapshot — снимок в выбранных проекте и ветке (по умолчанию последний загруженный), в который будет произведен импорт разметки
* snapshot — снимок в выбранных проекте и ветке (по умолчанию последний загруженный), в который будет произведен импорт разметки
* excludePaths — исключает файлы, соответствующие регулярным выражениям
* exclude-paths — исключает файлы, соответствующие регулярным выражениям
* template — определяет имя шаблона для импорта разметки (важно: флаг обязательный, в отличие от экспорта)
* template — определяет имя шаблона для импорта разметки (флаг обязательный, в отличие от экспорта)
* from-build-object — при включении этой опции, разметка будет выгружаться из объекта сборки того снимка, который был указан в опциях выше.
* from-build-object — при включении этой опции, разметка будет выгружаться из объекта сборки того снимка, который был указан в опциях выше.


После выполнения команды все комментарии оставленные в коде в соответствии с выбранным шаблоном разметки будут разобраны и добавлены на сервер истории в соответствующий проект/ветку/снимок.
После выполнения команды все комментарии оставленные в коде в соответствии с выбранным шаблоном разметки будут разобраны и добавлены на сервер истории в соответствующий проект, ветку и снимок.


Для подавления найденных предупреждений следует использовать следующий формат разметки в исходном коде
Для подавления найденных предупреждений следует использовать следующий формат разметки в исходном коде


    //svacer_review: -<warn class>[|-<warn class>]+  
  //svacer_review: -<warn class>[|-<warn class>]+  


Пример:  
Пример:  


      if (!strncmp("--filelimit",argv[i],11)) {
  if (!strncmp("--filelimit",argv[i],11)) {
        j = 11; //svacer_review: -UNUSED_VALUE
    j = 11; //svacer_review: -UNUSED_VALUE
        if (*(argv[i]+11) == '=') {
    if (*(argv[i]+11) == '=') {


Комментарий должен быть расположен в конце строки, где ожидается предупреждение от анализатора Svace.
Комментарий должен быть расположен в конце строки, где ожидается предупреждение от анализатора Svace.
Line 109: Line 110:
Для импорта разметки при использовании команд '''import --upload''' и '''upload''' следует указывать флаг '''--template <template>'''. В таком случае разметка будет импортирована из объекта сборки сразу после загрузки его на сервер.
Для импорта разметки при использовании команд '''import --upload''' и '''upload''' следует указывать флаг '''--template <template>'''. В таком случае разметка будет импортирована из объекта сборки сразу после загрузки его на сервер.


==== Описание шаблона разметки DEFAULT ====
==== Шаблон разметки DEFAULT ====
Сервер позволяет добавить собственные шаблоны разметки, для удобства добавлен не удаляемый шаблон DEFAULT. Список шаблонов можно увидеть в '''Settings > Markup templates''' (при наличии у пользователя доступа).
Сервер позволяет добавить собственные шаблоны разметки, для удобства добавлен неудаляемый шаблон DEFAULT. Список шаблонов можно увидеть в '''Settings > Markup templates''' (при наличии прав доступа).


Шаблон можно использовать как для импорта, так и для экспорта разметки, поэтому можно проверить ожидаемый формат [[Help:UI_manual#Экспорт_кода_с_разметкой|через выгрузку кода с указанием шаблона]].
Шаблон можно использовать как для импорта, так и для экспорта разметки, поэтому можно проверить ожидаемый формат через [[Help:UI manual#Экспорт кода с разметкой|выгрузку кода]] с указанием шаблона.


В шаблоне DEFAULT каждая разметка описывается на отдельной строчке перед маркером, при необходимости можно использовать несколько строчек.
В шаблоне DEFAULT каждая разметка описывается на отдельной строчке перед маркером, при необходимости можно использовать несколько строчек. Импорт разметки с неправильным статусом или со статусом Undecided не производится, включая комментарии к ней.


Пример:
Пример:


    //svacer_review: FORMAT_STRING.PARAM_EXCESS r:Confirmed|s:Minor|a:Undecided|c:
  //svacer_review: FORMAT_STRING.PARAM_EXCESS r:Confirmed|s:Minor|a:Undecided|c:
    //svacer_review: UNINIT.LOCAL_VAR r:Confirmed|s:Unspecified|a:Fix required|c:will be fixed
  //svacer_review: UNINIT.LOCAL_VAR r:Confirmed|s:Unspecified|a:Fix required|c:will be fixed
    printf("v = %d", fl3(), i);
  printf("v = %d", fl3(), i);


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


=== Изменение инвариантов для распространения разметки между снимками с несовпадающими путями ===
=== Изменение инвариантов (--path-prefix) ===
Если на сервер был загружен снимок, в котором расположение некоторых (или всех) файлов поменялось, а при импорте не был указан флаг '''--pathPrefix''', то разметка с прошлого снимка не распространится на новый снимок. Для решения данной проблемы следует использовать команду '''svacer markup update'''.
Если на сервер был загружен снимок, в котором расположение некоторых (или всех) файлов поменялось, а при импорте не был указан флаг '''--path-prefix''', то разметка с прошлого снимка не распространится на новый снимок. Для решения данной проблемы следует использовать команду '''svacer markup update'''.


Синтаксис:
Синтаксис:
    svacer markup update --user <user> --password <password> --project <project id or name> --branch <branch id or name> --pathPrefix <prefix:replacement; prefix:replacement> [<snapshot id or name>1, <snapshot id or name>2, , <snapshot id or name>N]
  svacer markup update --user <user> --password <password> --project <project id or name> --branch <branch id or name> --path-prefix <prefix:replacement; prefix:replacement> [<snapshot id or name>1, <snapshot id or name>2, ..., <snapshot id or name>N]


Где:  
Где:  
* user, password — пользователь и пароль учетной записи на сервере истории
* user, password — пользователь и пароль учетной записи на сервере
* project — проект на сервере истории, в котором будет обновлена разметка
* project — проект на сервере, в котором будет обновлена разметка
* branch — ветка в проекте выбранном выше (по умолчанию master), в которой будет обновлена разметка
* branch — ветка в проекте выбранном выше (по умолчанию master), в которой будет обновлена разметка
* pathPrefix — правило отображения для префиксов путей в формате: <file> или line prefix:replacement;prefix:replacement
* path-prefix — правило отображения для префиксов путей в формате: <file> или line prefix:replacement;prefix:replacement


В конце команды опционально могут быть указаны имена или идентификаторы снимков, в которых будет обновлена разметка в соответствии с указанными префиксами путей. Если они указаны не будут, изменения будут применены ко всей ветке. После запуска команды на сервер будет отправлен асинхронный запрос на обновление разметки, за дальнейшим прогрессом исполнения можно следить в логе сервера (через UI он доступен пользователям с ролью admin в '''Settings > Server information''').
В конце команды опционально могут быть указаны имена или идентификаторы снимков, в которых будет обновлена разметка в соответствии с указанными префиксами путей. Если они указаны не будут, изменения будут применены ко всей ветке. После запуска команды на сервер будет отправлен асинхронный запрос на обновление разметки, за дальнейшим прогрессом исполнения можно следить в логе сервера (через UI он доступен пользователям с ролью admin в '''Settings > Server information''').
Line 142: Line 143:


Список подавленных предупреждений (печатает JSON)
Список подавленных предупреждений (печатает JSON)
    svacer markup [auth/selection] suppress list
  svacer markup [auth/selection] suppress list
Пример:
 
    svacer markup --user admin --password admin --project tree-command suppress list
Пример
  svacer markup --user admin --password admin --project tree-command suppress list
 


Подавить предупреждение
Подавить предупреждение
    svacer markup [auth/selection] suppress add id1 id2 id3
  svacer markup [auth/selection] suppress add id1 id2 id3
Пример:
 
    svacer markup --user admin --password admin --project tree-command suppress add 29d298cd-752d-4d19-b535-2089a72a96af
Пример
  svacer markup --user admin --password admin --project tree-command suppress add 29d298cd-752d-4d19-b535-2089a72a96af
 


Убрать подавление предупреждения
Убрать подавление предупреждения
    svacer markup [auth/selection] suppress remove id1 id2 id3  
  svacer markup [auth/selection] suppress remove id1 id2 id3
Пример:
    svacer markup --user admin --password admin --project tree-command suppress remove 29d298cd-752d-4d19-b535-2089a72a96af
 
Убрать все подавления
    svacer markup [auth/selection] suppress remove
Пример:
    svacer markup --user admin --password admin --project tree-command suppress remove


Список предупреждений с ID доступен посредством public REST API. Функциональность предназначена для интеграции со сторонними инструментами и встраивание в CI/CD pipeline.
Пример
На текущий момент информация о подавленных предупреждения недоступна в веб-интерфейсе.
  svacer markup --user admin --password admin --project tree-command suppress remove 29d298cd-752d-4d19-b535-2089a72a96af


При экспортировании снимка где есть подавленные предупреждения, сами предупреждения будут так же экспортированы как подавленные.
=== Поддержка протокола LDAP для аутентификации пользователей ===
====  Общий принцип аутентификации ====
Схема аутентификации с помощью протокола LDAP следующая:


# Сервер запускается с указанием конфигурационного файла с настройками для LDAP аутентификации
Убрать все подавления
# В форме аутентификации пользователь выбирает нужный тип аутентификации (svacer или LDAP)
  svacer markup [auth/selection] suppress remove
# При выборе аутентификации LDAP, после заполнения необходимых параметров, запрос на аутентификацию отправляется на сервер svacer
# Сервер Svacer, используя настройки из конфигурационного файла, обращается к внешнему LDAP серверу и проводит проверку пользователя
# В случае успешной аутентификации, в БД сервера Svacer создается запись (если ее еще нет) для пользователя, чтобы можно было управлять ролями данного пользователя
# Сервер возвращает токен безопасности для дальнейшей работы, аналогичный токену, возвращаемому при аутентификации локальных пользователей


Для каждого пользователя, успешно прошедшего проверку на LDAP сервере, создается локальная запись в БД Svacer. Управлять таким пользователем можно как и обычным пользователем, за исключением:
Пример
* Пользователю нельзя сменить пароль
  svacer markup --user admin --password admin --project tree-command suppress remove
* Пользователь не может сменить пароль самостоятельно
* В случае отсутствия связи между сервером Svacer и сервером LDAP, данный пользователь не сможет зайти в систему


====  Запуск сервера с поддержкой LDAP ====
Список предупреждений с ID доступен посредством public REST API. Функциональность предназначена для интеграции со сторонними инструментами и встраивания в CI/CD pipeline.
Сервер может быть запущен как в с поддержкой аутентификации через LDAP, так и без. Для того, чтобы включить аутентификацию через LDAP необходимо указать конфигурационный файл. Типовой пример конфигурационного файла для подключения к контроллеру домена MS ActiveDirectory или серверу openLDAP можно получить с помощью команды:
На текущий момент информация о подавленных предупреждениях недоступна в веб-интерфейсе.


    svacer ldap print
При экспортировании снимка где есть подавленные предупреждения, сами предупреждения будут так же экспортированы как подавленные.


Запуск сервера с поддержкой LDAP осуществляется командой:
=== Автомиграция разметки ===
В Svacer возможно настроить автомиграцию разметки с ветки на ветку (у пользователя должны быть права на администрирование сервера).


    svacer server --ldap ldap.json
  svacer server automigrate [command] [flags]


При запуске сервер svacer формирует список доступных для LDAP аутентификации серверов и выводит соответствующее сообщение. Ниже приведен лог сервера, запущенного с поддержкой протокола LDAP.
Существующие command:
[[File:LdapServerAdded.png|none|left|1000px|alt=LdapServerAdded]]
* add — добавляет автомиграцию в соответствии с паттерном
* delete — удаляет автомиграцию
* show_config — показывает все заданные миграции (Config Table), их id, время создания и пользователя, который их создал
* show_automigrate — показывает таблицу всех существующих проектов и веток с которых и на которые происходят автоматические миграции (Automigrate Table)
* log — выводит список всех совершенных миграций (Done Automigrate Table)


После запуска сервера svacer с поддержкой LDAP в GUI становится активна вкладка LDAP.
Флаг '''pattern''', применяется для команд <code><add|delete|show_config|log></code>


Для аутентификации с помощью LDAP необходимо выбрать сервер из выпадающего списка.  
* Для '''add''': Паттерн автомиграции в формате: <code>srcProject{id|name}/srcBranch{id|name}=>receiveProject{id|name|regEx}/receiveBranch{id|name|regEx}</code>
:regEx — в [https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP формате как для PostgreSQL]


[[File:LdapServerChoose.png|none|left|alt=LdapServerChoose]]
* Для '''delete''': Паттерн автомиграции в формате: <code>srcProject{id|name}/srcBranch{id|name}=>receiveProject{id|name|regEx}/receiveBranch{id|name|regEx}</code>
:Паттерн должен быть точно таким же, как он записан в Config Table


При нажатии на кнопку '''Details''' появляется более подробная информация о сервере и его доступности (параметр '''Alive'''). Доступность сервера LDAP проверяется в момент запуска сервера Svacer, при аутентификации пользователя, а также (в случае наличия соответствующего параметра в конфигурационном файле) периодически.
* Для '''show_config''': Паттерн автомиграции. Поиск будет происходить в следующем виде: <code>ILIKE "'%"+pattern+"%'"</code>
В случае конфигурации сервера Svacer с поддержкой LDAP можно отключить возможность аутентификации пользователей встроенными средствами сервера Svacer (вкладка Svacer на странице входа). В этом случае вкладка Svacer на странице входа будет неактивной и пользователи смогут заходить в систему только с помощью LDAP аутентификации. Данное поведение распространяется и на работу с сервером с помощью интерфейса командной строки.


Для отключения возможности аутентификации встроенными средствами сервера Svacer нужно использовать опцию '''disable-svacer-auth'''.
* Для '''log''': Флаг в формате <code>srcProjectId/srcBranchId=>receiveProjectId/receiveBranchId</code> или <code>srcProjectName/srcBranchName=>receiveProjectName/receiveBranchName</code> для вывода автомиграций с данным паттерном


Пример:
Флаг '''id''', применяется для command <code><delete|show_automigrate></code> в формате uuid
    svacer server --ldap ldap.json --disable-svacer-auth


====  Конфигурационный файл сервера для поддержки LDAP  ====
* Для '''delete''': id для удаления автомиграции (из Config Table)
Типовой пример конфигурации представлен ниже.


    {
* Для '''show_automigrate''': id ветки/проекта или конфигурации для нахождения его в таблице автомиграций (Automigrate Table) и вывода автомиграций, где присутствует данный id
      "servers": [
        {
          "name": "active_directory",
          "basedn": "dc=domain,dc=home,dc=org",
          "useGroup": true,
          "hideURL": true,
          "checkAlivePeriod": 60,
          "connection": {
            "url": "ldaps://192.168.11.71:636",
            "mirrors":["ldaps://192.168.11.72:636","ldaps://192.168.11.73:636"]
            "connectAs": "cn=ldap_service,cn=users,dc=domain,dc=home,dc=org",
            "password": "12345678",
            "ignoreCertCheck": false,
            "caCertFiles":["/etc/ssl/certs/a*","/etc/ssl/certs/my_certs/*"]
          },
          "group": {
            "basedn": "cn=users",
            "filter": "(&(objectCategory=Group)(cn=dep_devops))",
            "userMember": "member",
            "display":"cn",
            "svacerRole":"cn"
          },
          "user": {
            "basedn": "cn=users",
            "filter": "(&(objectCategory=Person)(sAMAccountName=*))",
            "login": "sAMAccountName",
            "group": "dn",
            "info": {
              "display": "cn",
              "email": "email",
              "firstName": "givenName",
              "lastName": "sn"
            }
          },
          "enabled": true
        },
        {
          "name": "open_ldap",
          "basedn": "dc=example,dc=com",
          "useGroup": true,
          "connection": {
            "url": "ldap://127.0.0.1:389",
            "connectAs": "cn=admin,dc=example,dc=com",
            "password": "12345678"
          },
          "group": {
            "basedn": "ou=groups",
            "filter": "(&(objectClass=groupOfNames)(cn=svacer))",
            "userMember": "member",
            "display":"cn"
          },
          "user": {
            "basedn": "ou=users",
            "filter": "(&(objectClass=PosixAccount))",
            "login": "uid",
            "group": "dn",
            "info": {
              "display": "dn",
              "email": "mail",
              "firstName": "givenName",
              "lastName": "sn"
            }
          },
          "enabled": true
        }
      ]
    }


В конфигурации можно указать несколько серверов. Все сервера в совокупности рассматриваются как единый источник проверки пользователей. То есть если на двух серверах будут два пользователя с одинаковым логином, они будут считаться идентичными. Ниже приводится описание параметров конфигурации.
Флаг '''format''' формат вывода таблицы. Применяется для command <code><show_config|show_automigrate|log></code>
* name — произвольное имя (уникальное для каждого сервера)
* basedn — DN относительно которого будут проводится все операции в LDAP каталоге
* useGroup — проверять ли принадлежность пользователя к группе
* hideURL — не передавать сетевой адрес LDAP сервера. Конечные пользователи будут видеть в выпадающем списке только имя сервера, указанное в поле name. В поле URL будет пустая строка.
* checkAlivePeriod — Промежуток времени в секундах, который должен проходить между периодическими проверками доступности сервера LDAP. Если параметр равен 0 или не указан, такая проверка не проводится.
* connection — подсекция, описывающая параметры соединения с сервером
:* url — адрес сервера, формата: ldap[s]://domain:port В случае использования TLS для подключения к LDAP серверу, необходимо указать правильный порт (по умолчанию 636).
:* mirrors список хостов, которые будут использованы в случае недоступности основного хоста, указанного в поле URL. Формат указания хостов тот же, что и в поле URL. Префикс ldap[s] должен быть одинаковым для всех хостов и совпадать с префиксом в поле URL.
:* connectAs — имя пользователя в формате DN, из под которого будут производится операции в LDAP каталоге
:* password — пароль пользователя
:* ignoreCheck — не проверять сертификат в случае ldaps:// соединения. Полезно при самоподписанных сертификатах. Если флаг установлен в значение false, необходимо установить значение поля caCertFiles.
:* CaCertFiles — массив значений, описывающих какие файлы корневых сертификатов добавлять в конфигурацию Svacer. Формат файлов сертификатов — PEM
* group — подсекция, описывает параметры проверки принадлежности пользователя к группе
:* basedn — RDN, добавляемая к общей DN. Относительно этого DN производится поиск группы
:* filter — фильтр, используемый при поиске группы. Необходимо, если надо указать несколько групп
:* userMember — атрибут в группе, содержащий пользователей, принадлежащих группе
:* display — атрибут, содержащий имя группы для отображения
:* svacerRole — атрибут, из которого будет извлечено имя роли, созданной в Svacer, и автоматически сопоставляемой с пользователем.
* user — подсекция, описывает параметры получения информации о пользователе
:* basedn — RDN, добавляемая к общей DN. Относительно этого DN производится поиск группы
:* filter — фильтр, используемый при поиске пользователей.
:* login — атрибут, в котором находится login пользователя.
:* group — атрибут в пользователе, на который ссылается атрибут group.userMember (обычно это «dn» пользователя)
:* info — подсекция описывающая в каких атрибутах находится информация о пользователе
::* display — атрибут, содержащий полное имя пользователя для отображения (ФИО)
::* email — атрибут с почтовым адресом
::* firstName — атрибут с именем
::* lastName — атрибут с фамилией
* enabled — использовать или нет данный сервер


[[LDAP_configuration|Примеры конфигурации взаимодействия с LDAP сервером]]
* Для '''show_config''':
:* table — вывод в виде таблицы
:* json — вывод в виде json
:* no-id — вывод без config id
:Значения можно перечислить через запятую: <code>json,no-id</code>. По умолчанию — table.


Рассмотрим пример обработки запроса на вход в систему LDAP пользователя, указавшего значение ivanov_ii в поле логина и выбравшего конфигурацию active_directory из примера выше
* Для '''show_automigrate|log''':
:# Svacer создает служебное подключение к хосту 192.168.11.71 со следующими параметрами
:* table вывод в виде таблицы
:#* используется TLS соединение (ldaps префикс)
:* json вывод в виде json
:#* порт 636
:По умолчанию table.
:#* проверяется сертификат LDAP сервера (ignoreCertCheck = false); для проверки используются сертификаты CA (из папки /etc/ssl/certs — все сертификаты, начинающиеся с буквы a; из папки /etc/ssl/certs/my_certs/ все сертификаты)
:#* логин для подключения к LDAP серверу: "cn=ldap_service,cn=users,dc=domain,dc=home,dc=org" (connectAs); пароль: 12345678 (password)
:# Если подключение к хосту невозможно (хост недоступен), то пробуются хосты 192.168.11.72,192.168.11.73 с параметрами, аналогичными параметрам пункта 1
:# Если подключение невозможно, процесс входа завершается с ошибкой
:# Производится поиск пользователя в LDAP каталоге со следующими параметрами:
:#* строка запроса: (&(sAMAccountName=ivanov_ii)((&(objectCategory=Person)(sAMAccountName=*)))), sAMAccountName взят из поля user.login конфиг файла; ivanov_ii — введено пользователем; (&(objectCategory=Person)(sAMAccountName=*)) — взято из поля user.filter конфиг файла
:#*начальный узел, с которого будет произведен поиск: cn=users, dc=domain,dc=home,dc=org
:#*поиск производится по всему поддереву
:# Если пользователей не найдено или найдено больше 1 пользователя, процесс входа завершается с ошибкой
:# Флаг useGroup = true, поэтому производится дополнительная проверка группы пользователя
:#* выполняется поиск групп в каталоге LDAP со следующими параметрами:
:#**строка запроса: (&(objectCategory=Group)(cn=dep_devops)) — взято из поля group.filter
:#**начальный узел: cn=users, dc=domain,dc=home,dc=org, где cn=users — взято из поля group.basedn; значение dc=domain,dc=home,dc=org взято из поля basedn конфиг файла
:#**поиск производится по всему поддереву
:#**определяется список пользователей группы (каждому пользователю соответствует значение атрибута с именем member (взято из поля group.userMember конфиг файла))
:#* Если ни одной группы не найдено, то процесс входа завершается с ошибкой
:#*Определяются группы, в которые входит пользователь. Для этого для каждой группы, найденной в пункте выше, просматривается список пользователей и ищется значение cn=ivanov_ii,cn=users,dc=domain,dc=home,dc=org (в поле user.group конфиг файла указано значение dn, что означает, что необходимо использовать DN пользователя для данной процедуры). Если атрибут найден, считается что пользователь принадлежит группе. 
:#* Если пользователь не принадлежит ни к одной группе, процесс входа завершается с ошибкой
:# Производится попытка подключения к хосту LDAP с параметрами, аналогичными параметрам из пункта 1, за исключением логина (cn=ivanov_ii,cn=users,dc=domain,dc=home,dc=org) и пароля пользователя (введен в поле пароль формы входа)
:# Если подключение не удалось создать, то процесс входа завершается с ошибкой
:# Процесс аутентификации пользователя произведен успешно
:# Производится создание локального пользователя svacer с именем ivanov_ii, если его еще нет
:# Так как useGroup = true и указан атрибут svacerRole с непустым значением, то производится привязка ролей Savcer пользователя на основе его участия в группах LDAP (смотри соответствующий пункт)


==== Привязка группы LDAP к роли Svacer ====
Также возможно использовать POST запрос по адресу <code>/api/automigrate</code>. В теле передается json, с полями <code>action(not null), pattern, id</code>. Выполняется по тому же принципу, что и в CLI.
Возможно автоматическое назначение пользователям LDAP ролей Svacer. Для использования данной функции необходимо выполнить следующие предварительные действия:
:* Администратор LDAP сервера создает в каталоге LDAP нужные группы (например cn=users,ou=svacer,dc=example,dc=com и cn=admins, ou=svacer,dc=example,dc=com), которые будут привязаны к ролям Svacer.
:* Администратор LDAP сервера помещает пользователей LDAP в соответствующие LDAP группы (cn=users,ou=svacer,dc=example,dc=com или cn=admins, ou=svacer,dc=example,dc=com)
:* Администратор Svacer создает роли в Svacer, имеющие в точности такое же название, как значение атрибута, указанного в поле svacerRole конфигурационного файла. В пример можно использовать аттрибут cn и в этом случае необходимо создать роли users и admins
:* Администратор Svacer добавляет в конфигурационный файл в поле svacerRole имя атрибута, по которому будет производится привязка. Для примера выше — строчку svacerRole="cn"
После выполнения данных действий, во время входа пользователя в систему пользователю будут добавлены роли по следующему алгоритму:
:* Производится поиск групп, к которым принадлежит пользователь. Поиск производится по параметрам, указанным в секции group конфигурационного файла. Для примера, пользователь может состоять в следующих группах: (cn=users,ou=svacer,dc=example,dc=com), (cn=dep_dev,dc=example,dc=com)
:* Для каждой найденной группы, выбирается значение атрибута, указанного в поле svacerRole. В примере — имя атрибута cn. Получаются два имени: users, dep_dev
:* Производится поиск ролей Svacer с именем users и dep_dev. Если такие роли найдены, то пользователю они будут добавлены. Так как в примере роль dep_dev не создана, то будет добавлена только роль users.


Удаление ролей автоматически не производится. Вместо этого предлагается ручного режим синхронизации ролей пользователя. Для синхронизации ролей с текущими группами, в которых состоит пользователь, используется команда cli
Принцип работы сервиса:
* При запуске сервера запускается сервис automigrate
* При занесении новой миграции, находит все миграции, подходящие под паттерн, и копирует разметку на них
* При удалении миграции, удаляет её из таблицы Config и удаляет из таблицы автомиграций
* Не может копировать разметку с нескольких веток на одну (будет выдавать ошибку)


  svacer ldap sync_roles --login [user_login] --server [server_name] --apply
* При любом изменении разметки у существующих веток (добавление/удаление/изменение комментариев, добавление снимка, добавление проекта, добавление ветки, изменение имени ветки/проекта, удаление контейнера, удаление снимка) происходит либо миграция разметки, либо добавление новых миграций в таблицу автомиграций и миграция разметки, либо удаление миграции из таблицы автомиграций (в зависимости от конкретной ситуации). При какой-либо ошибке выдает предупреждение, но даёт выполнить действие.


Данная команда проверит наличие пользователя user_login в соответствующей роли группе LDAP и если его в группе не будет, уберет роль у пользователя. Также команда добавит недостающие роли, на основе механизма, описанного выше (при входе пользователя). Флаг apply позволяет "оценить" получаемые изменения прежде чем они будут применены. По умолчанию флаг apply = false.
* Единственный случай, когда сервис не даёт выполнить действие — загрузка результатов Svace через CLI: upload, либо import с флагом --upload. В этом случае сервис выдает ошибку миграции и отменяет загрузку. Такое может произойти, когда имя данной ветки (в качестве to_branch) подходит под несколько паттернов.


==== Использование CLI сервера Svacer с поддержкой LDAP ====
=== Аутентификация из переменных окружения ===
Для выполнения некоторых действий в cli с помощью команды svacer требуется аутентификация пользователя. Для аутентификации с помощью ldap сервера необходимо указать в команде кроме имени пользователя и пароля имя сервера с помощью флага ldap_server (имя сервера регистр-зависимо).  Например:
Пользователь может использовать следующие переменные окружения для выполнения аутентификации при использовании CLI
   
  SVACER_AUTH_CREDS=login:password
    ./svacer quickdiff --user loginok --password loginok --ldap_server openLDAP2 --project zstd --branch zstd_14 --snapshot_v1 v1.4.1 --snapshot_v2 zstd_140
SVACER_AUTH_TOKEN=token
В качестве токена нужно использовать токен, получаемый через REST endpoint <code>/api/public/login</code>


Если флаг ldap_server не указан, аутентификация производится механизмами сервера svacer, как и в предыдущих версиях. Параметр ldap_server можно опустить, указав сервер в переменной окружения SVACER_LDAP_SERVER. Например:
=== Аутентификация из файла ===
Для упрощения работы с клиентом svacer возможно сохранять некоторые параметры соединения и токен аутентификации для дальнейшего использования. Сохранение данных производится с помощью команды:
svacer server login --host [hostname] --port [restPort] --grpc [grpcPort] --ssl-ca-certs [certs_path] --user [username] --password [password] --out [file]
Команда выполняет подключение к серверу svacer по указанным параметрам (host, port, user, password), получает токен аутентификации и сохраняет все эти данные в файл. Для указания файла, в котором следует сохранять данные, используется опция --out . Если опция --out опущена, то данные будут записаны в файл svacer_conn.json в текущей папке. Пример использования команды приведен ниже:
svacer server login --host svacer.local --port 8080 --grpc 3002 --user admin --password --out cn.json
В данном примере клиент произведет попытку аутентификации на сервере svacer.local и полученный токен вместе с параметрами (host, port, grpc) будет записан в файл cn.json.


    SVACER_LDAP_SERVER=“openLDAP2“ ./svacer quickdiff --user loginok --password loginok --project zstd --branch zstd_14 --snapshot_v1 v1.4.1 --snapshot_v2 zstd_140
Для использования созданного ранее файла с данными необходимо использовать опцию --conn_file. Данная опция определена во всех командах, в которых определены параметры --user --password (то есть параметры аутентификации). Например, для выполнения импорта данных на сервер с использованием сохраненной информации можно использовать следующую команду:
svacer import --conn_file cn.json .
В примере выше клиент считает токен из файла cn.json и выполнит загрузку данных по указанным в файле параметрам host, port, grpc.  


Для получения списка поддерживаемых свейсером LDAP серверов можно использовать команду:
Также имя файла с данными подключения можно передавать через переменную окружения SVACER_CONN_FILE.


    ./svacer ldap servers --host 127.0.0.1 --port 8080
=== Вывод списка предупреждений ===
Пользователь может получить таблицу предупреждений с сервера, используя команду


Вывод содержит два столбца (имя и URL сервера). В качестве значения для параметра ldap_server необходимо использовать содержимое первого столбца.
svacer marker list --host host --user user --password password --project project_name_or_id --branch branch_name_or_id --snapshot snapshot_name_or_id


==== Обновление данных LDAP пользователей ====
Вывод:
Для каждого LDAP пользователя создается соответствующая ему запись в БД Svacer, в которую включается ФИО из LDAP и адрес его электронной почтыЧерез какое-то время данные пользователей могут меняться, в этом случае возможно обновить данные LDAP пользователей, хранящиеся в Svacer, синхронизировав их с данными LDAP сервера.  
  #    warn                                file                            line  review  msg                                               
Для обновления данных одного пользователя можно воспользоваться окном редактирования пользователя, в котором можно нажать кнопку '''Load from LDAP'''. В соответствующие окна будут добавлены данные, загруженные из LDAP сервера.
1000  INVARIANT_RESULT                    /.build/subst.c                7080          Expression 'tl->word->flags | (1 << 21)' is always 
                                                                                          true , which may be caused by a logical error     
1001  DEREF_AFTER_NULL.LOOP                /.build/execute_cmd.c          3327          After having been compared to NULL value at execut  
                                                                                          e_cmd.c:3325, pointer 'l' is dereferenced at execu 
                                                                                          te_cmd.c:3327.                                     
1002  DEREF_AFTER_NULL.LOOP                /.build/variables.c            2749          After having been compared to NULL value at variab 
                                                                                          les.c:2656, pointer 'vc' is dereferenced at variab 
                                                                                          les.c:2749.                                       
1003  CHECK_AFTER_PASS_TO_PROC            /.build/redir.c                1219          Variable 'redirector' was passed to function at re 
                                                                                          dir.c:1215 by calling function 'fcntl' that can'
                                                                                          use negative values is checked for negative value 
                                                                                          at redir.c:1219.                              


[[File:ChangeUserProfile.png|none|left|alt=ChangeUserProfile]]
При указании флага <code>--out-format=json</code> вывод будет произведен в JSON формате:


Также данные пользователей можно обновить с помощью интерфейса командной строки. Для этого можно использовать подкоманду '''updateUsers''' команды '''ldap'''. Общий синтаксис команды выглядит следующим образом:
[{"id":"e0ec7389-42a0-403c-9ce2-bfaa3bfa0228","file":"/.build/subst.c","function":"WORD_DESC * parameter_brace_expand_rhs()","line":7080,"locID":1000,"lang":"CXX","tool":"CSA","warnClass":"INVARIANT_RESULT","mtid":"CSA.INVARIANT_RESULT.1","msg":"Expression 'tl-\u003eword-\u003eflags | (1 \u003c\u003c 21)' is always true , which may be caused by a logical error","details":"811ed8f680ae9b540707436615348aed6d32ee93","flags":0,"invariant":"TBXA/IYVZKVlH6f19tiGsd3stuI"},{"id":"184b85bf-a63f-4187-b290-25a5950b3353","file":"/.build/execute_cmd.c","function":"select_query","line":3327,"locID":1001,"


    ./svacer ldap updateUsers --onlyEmpty
=== Слияние снимков из CLI (экспериментальная опция) ===
Пользователь может объединить несколько снимков в один используя команду
svacer container snapshot merge --host host --user user --password password --branch target_branch --name target_snapshot_name --snapshot val1 --snapshot val2 --snapshot val3 ...
При указании снимков для слияния и целевой ветки, пользователь может использовать либо UUID объектов либо формат
целевая ветка: <project name>:::<branch name>
снимок:        <project name>:::<branch name>:::<snapshot name>
При слиянии можно использовать снимки из разных проектов и веток. Пользователь должен иметь доступ на чтение ко всем снимкам и на запись для целевой ветки


Флаг '''onlyEmpty''' позволяет обновлять только пустые поля ФИО и eMail. Заполненные поля не будут изменены. Команда обновит данные всех пользователей, записи о которых имеются в базе Svacer.
== Svacer server features ==


=== Поддержка сквозной аутентификации ===
=== Поддержка сквозной аутентификации ===
Svacer поддерживает сквозную аутентификацию через reverse proxy. Для этого используется опция proxy-mode. При включении этой опции есть возможность проходить аутентификацию (используя HTTP Basic Authentication) на reverse proxy сервере и использовать эти данные для аутентификации на сервере Svacer.
Svacer поддерживает сквозную аутентификацию через reverse proxy. Для этого используется опция proxy-mode. При включении этой опции есть возможность проходить аутентификацию (используя HTTP Basic Authentication) на reverse proxy сервере и использовать эти данные для аутентификации на сервере Svacer.


При включенном proxy-mode используется header с прокси '''Authorization Basic ...''', откуда Svacer берет имя пользователя и пароль, проверяет и аутентифицирует пользователя, если аккаунт с таким логином и паролем существует в БД пользователей Svacer.
При включенном proxy-mode используется header с прокси '''Authorization Basic ...''', откуда Svacer берет имя пользователя и пароль, проверяет и аутентифицирует пользователя, если аккаунт с таким логином и паролем есть в БД пользователей Svacer.


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


    ./svacer server --proxy-mode
  svacer-server run --proxy-mode


=== Хуки ===
=== Хуки ===
Для получения данных хуков при запуске сервера нужно указать опцию '''--hooks <path to JSON file>'''. Эта опция задаёт файл, содержащий информацию о расширении сервера посредством хуков, которые пользователь может вызывать из web-интерфейса.  
Для использования хуков при запуске сервера нужно указать опцию '''--hooks <path to JSON file>'''. Эта опция задаёт файл, содержащий описание хуков, которые пользователь может вызывать из web-интерфейса. Каждый хук соответствует процессу или скрипту, который сервер запускает при вызове соответствующей команды из web-интерфейса.
Каждый хук соответствует некоторому процессу или скрипту, который сервер запускает в ответ на вызов соответствующей команды из web-интерфейса.
 
Формат файла Hooks следующий:
Формат файла описания хуков следующий:
    {
  {
      "hooks": [
    "hooks": [
        {
      {
          "id": "<id>",
        "id": "<id>",
          "label": "<label >",
        "label": "<label >",
          "target": "<target>",
        "target": "<target>",
          "input": ["<param1>", "<param2>",],
        "input": ["<param1>", "<param2>", ...],
          "cmd": "<path to executable>",
        "cmd": "<path to executable>",
          "args": ["<arg1>", “<arg2>”, ]
        "args": ["<arg1>", “<arg2>”, ...]
        },
      },
        ...
      ...
      ]
    ]
    }
  }


'''Параметры хуков '''
'''Параметры хуков '''
{| class="wikitable"
{| class="wikitable"
! style="width:100px;" | Параметр || Описание
| style="width:100px;" | ''id''
|-
| Идентификатор хука. Должен быть уникальным в файле
| ''id''
| Идентификатор хука.<br>Должен быть уникальным в файле
|-
|-
| ''label''
| ''label''
Line 423: Line 318:
|-
|-
| ''target''
| ''target''
| Место в UI, в которое будет добавлена команда.<br>
| Место в UI, в которое будет добавлена команда. Сейчас поддерживается только одно значение — default. Оно соответствует вкладке Details на правой панели пользовательского интерфейса
Сейчас поддерживается только одно значение — default. Оно соответствует вкладке Details на правой панели пользовательского интерфейса
|-
|-
| ''input''
| ''input''
| Параметры, которые можно передать в запускаемый процесс, исходя из контекста вызова команды в web-интерфейсе.<br>
| Параметры, которые можно передать в запускаемый процесс, исходя из контекста вызова команды в web-интерфейсе. <br/>
Поддерживаемые значения:
Поддерживаемые значения:
* markerID — UUID идентификатор маркера;
* markerID — UUID идентификатор маркера;
Line 443: Line 337:
|}
|}


Одним из типичных сценариев использования хуков является создание кейсов для выбранного предупреждения в системах отслеживания ошибок, таких как Jira и Gitlab. Примеры скриптов для этого можно найти на странице [[Примеры использования хуков]].
Типичный сценарий использования хуков создание кейсов для выбранного предупреждения в системах отслеживания ошибок, таких как Jira или Gitlab. Примеры скриптов для этого можно найти на странице [[Примеры использования хуков]].
 
=== Ограничение числа запросов ===
Чтобы ограничить число запросов на сервер Svacer, перед запуском сервера определите переменную окружения со следующими параметрами
 
SVACER_SERVER_THROTTLE_PARAMS=limit,backlogLimit,timeout
 
* limit — число одновременных запросов           
* backlogLimit — размер бэклога для запросов, которые нельзя обработать сейчас           
* timeout — время ожидания запроса в бэклоге (формат 1m12s — duration)

Latest revision as of 13:47, 24 June 2024

CLI features

Перенос снимков

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

Экспорт и импорт снимков из командной строки доступен пользователям с соответствующими правами для выбранного проекта/ветки.

Экспорт снимков:

   svacer server export
       --user <user> 
       --password <pwd> 
       --host <host> 
       --port <port> 
       --grpc <grpc port> 
       --project <project name or id> 
       --branch <branch name or id> 
       --snapshot <snapshot name or id> 
       <output file name>

Импорт снимков:

   svacer server import
       --user <user> 
       --password <pwd> 
       --host <host> 
       --port <port> 
       --grpc <grpc port> 
       --project <project name or id> 
       --branch <branch name or id> 
       --name <new name for snapshot>
       [--force]
       <input file name>

Опция --force создаст проект и ветку, если их не было на сервере.

Создание PDF отчета

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

Общий вид команды следующий:

 svacer pdfgen --cmp-mode [none|new|missing|matched|same] --project [name|id] --branch [name|id] --snapshot [name|id] [--target-project [name|id] --target-branch [name|id] --target-snapshot [name|id]] [--file [re_exp] --checker [re_exp] --severity [re_exp] --review [re_exp]] --out-file report_name --tz time_zone --lang report_lang
  • cmpMode — параметры сравнения. Возможные значения: none — без сравнения, new — новые, missing — отсутствующие, matched — сопоставленные, same — одинаковые
  • project, branch, snapshot — параметры, описывающие снимок, отчет для которого требуется создать. В качестве значений могут использоваться как имена, так и идентификаторы соответствующих сущностей. Например: --project zstd --branch "7683ed6a-b838-4090-9945-10e148f94be3" --snapshot zstd_130
  • target-project, target-branch, target-snapshot — параметры, описывающие снимок, с которым необходимо провести сравнение (обязательные параметры для режимов cmpMode: new, missing, matched, same).
  • file, checker, severity, review — параметры, задающие фильтры, применяемые к списку маркеров. Фильтры задают условия включения маркера в отчет. Значения фильтров задаются в формате регулярных выражений. В случае неверного формата, ошибочный фильтр не будет применяться и операция экспорта будет выполнена, как если бы фильтр не был указан. File — фильтр по пути к файлу, где был обнаружен маркер. Checker — фильтр по чекеру, предупреждение от которого было создано. Severity — серьезность сработавшего чекера. Review — статус разметки (confirmed, unclear и т. д.)
  • out-file — имя создаваемого файла отчета. Если не указано расширение, будет добавлено расширение pdf
  • tz — временная зона в минутах. Используется при формировании записи о комментариях, которые оставил пользователь, производивший разметку
  • lang — язык, который будет использован в создаваемом отчете (en — английский, ru — русский)

Для создания отчета без использования режима сравнения, необходимо указать cmpMode в значение none (это значение используется по умолчанию).

Для предварительного формирования таблицы маркеров с учетом сравнения, использовать значения cmpMode [new, missing, same, matched]. Названия этих режимов аналогичны названиями в GUI. При этом требуется указание как минимум одного параметра из списка: target-project, target-branch, target-snapshot. Если какие-то параметры target* не указаны, они будут установлены в значение исходных (project -> target-project, branch -> target-branch, ...). Сформированные на предварительном этапе маркеры, проходят механизм фильтраций (параметры: severity, file, review, checker), после чего происходит создание отчета.

Для создания отчета можно использовать public API:

URL — /api/public/exportPDF
Метод — POST

Тело запроса — JSON, имеет следующий вид:

   {
   "compare_mode": "new",
   "context":{
     "project": "zstd",
     "branch": "v13",
     "snapshot": "zstd_131"
    },
   "target_context":{
     "project": "zstd",
     "branch": "v13",
     "snapshot": "zstd_132"
    },
    "language": "en",
    "timezone": 180,
    "filters": {
      "checker": "^Z.*$",
      "file": ".*example.*",
      "severity": "Cr.*",
      "review": "Conf.*"
    } 
   }

Данный запрос соответствует запросу на создание отчета, который получается в результате сравнения в рамках проекта zstd и ветки v13 двух снимков zstd_131 и zstd_132. При этом будут выбраны только новые маркеры. Среди выбранных останутся только те, что удовлетворяют условиям фильтров, а именно: чекер начинается с буквы Z, файл содержит слово example, серьезность чекера содержит подстроку Cr (что в силу ограниченного количества значений для данного фильтра соответствует значению Critical) в названии, а состояние разметки содержит подстроку Conf (что в силу ограниченного количества значений для данного фильтра соответствует значению Confirmed). Язык отчета — английский, часовой пояс — 180 минут (3 часа).

Импорт разметки из исходного кода

Импорт разметки из исходного кода на сервер истории возможен с помощью команды svacer markup import

Синтаксис:

 svacer markup --user <user> --password <password> --project <project id or name> --branch <branch id or name> --snapshot <snapshot id or name> import --template <name> [--exclude-paths <path1, path2, ..., pathN> --from-build-object]

Где:

  • user, password — пользователь и пароль учетной записи на сервере
  • project — проект на сервере, в который будет произведен импорт разметки
  • branch — ветка в проекте выбранном выше (по умолчанию master), в которую будет произведен импорт разметки
  • snapshot — снимок в выбранных проекте и ветке (по умолчанию последний загруженный), в который будет произведен импорт разметки
  • exclude-paths — исключает файлы, соответствующие регулярным выражениям
  • template — определяет имя шаблона для импорта разметки (флаг обязательный, в отличие от экспорта)
  • from-build-object — при включении этой опции, разметка будет выгружаться из объекта сборки того снимка, который был указан в опциях выше.

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

Для подавления найденных предупреждений следует использовать следующий формат разметки в исходном коде

 //svacer_review: -<warn class>[|-<warn class>]+ 

Пример:

 if (!strncmp("--filelimit",argv[i],11)) {
   j = 11; //svacer_review: -UNUSED_VALUE
   if (*(argv[i]+11) == '=') {

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

Для импорта разметки при использовании команд import --upload и upload следует указывать флаг --template <template>. В таком случае разметка будет импортирована из объекта сборки сразу после загрузки его на сервер.

Шаблон разметки DEFAULT

Сервер позволяет добавить собственные шаблоны разметки, для удобства добавлен неудаляемый шаблон DEFAULT. Список шаблонов можно увидеть в Settings > Markup templates (при наличии прав доступа).

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

В шаблоне DEFAULT каждая разметка описывается на отдельной строчке перед маркером, при необходимости можно использовать несколько строчек. Импорт разметки с неправильным статусом или со статусом Undecided не производится, включая комментарии к ней.

Пример:

 //svacer_review: FORMAT_STRING.PARAM_EXCESS r:Confirmed|s:Minor|a:Undecided|c:
 //svacer_review: UNINIT.LOCAL_VAR r:Confirmed|s:Unspecified|a:Fix required|c:will be fixed
 printf("v = %d", fl3(), i);

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

Изменение инвариантов (--path-prefix)

Если на сервер был загружен снимок, в котором расположение некоторых (или всех) файлов поменялось, а при импорте не был указан флаг --path-prefix, то разметка с прошлого снимка не распространится на новый снимок. Для решения данной проблемы следует использовать команду svacer markup update.

Синтаксис:

 svacer markup update --user <user> --password <password> --project <project id or name> --branch <branch id or name> --path-prefix <prefix:replacement; prefix:replacement> [<snapshot id or name>1, <snapshot id or name>2, ..., <snapshot id or name>N]

Где:

  • user, password — пользователь и пароль учетной записи на сервере
  • project — проект на сервере, в котором будет обновлена разметка
  • branch — ветка в проекте выбранном выше (по умолчанию master), в которой будет обновлена разметка
  • path-prefix — правило отображения для префиксов путей в формате: <file> или line prefix:replacement;prefix:replacement

В конце команды опционально могут быть указаны имена или идентификаторы снимков, в которых будет обновлена разметка в соответствии с указанными префиксами путей. Если они указаны не будут, изменения будут применены ко всей ветке. После запуска команды на сервер будет отправлен асинхронный запрос на обновление разметки, за дальнейшим прогрессом исполнения можно следить в логе сервера (через UI он доступен пользователям с ролью admin в Settings > Server information).

Подавление предупреждений

Для подавление выбранных пользователем предупреждений предоставляется следующий интерфейс командной строки:

Список подавленных предупреждений (печатает JSON)

 svacer markup [auth/selection] suppress list

Пример

 svacer markup --user admin --password admin --project tree-command suppress list


Подавить предупреждение

 svacer markup [auth/selection] suppress add id1 id2 id3

Пример

 svacer markup --user admin --password admin --project tree-command suppress add 29d298cd-752d-4d19-b535-2089a72a96af


Убрать подавление предупреждения

 svacer markup [auth/selection] suppress remove id1 id2 id3

Пример

 svacer markup --user admin --password admin --project tree-command suppress remove 29d298cd-752d-4d19-b535-2089a72a96af


Убрать все подавления

 svacer markup [auth/selection] suppress remove

Пример

 svacer markup --user admin --password admin --project tree-command suppress remove

Список предупреждений с ID доступен посредством public REST API. Функциональность предназначена для интеграции со сторонними инструментами и встраивания в CI/CD pipeline. На текущий момент информация о подавленных предупреждениях недоступна в веб-интерфейсе.

При экспортировании снимка где есть подавленные предупреждения, сами предупреждения будут так же экспортированы как подавленные.

Автомиграция разметки

В Svacer возможно настроить автомиграцию разметки с ветки на ветку (у пользователя должны быть права на администрирование сервера).

 svacer server automigrate [command] [flags]

Существующие command:

  • add — добавляет автомиграцию в соответствии с паттерном
  • delete — удаляет автомиграцию
  • show_config — показывает все заданные миграции (Config Table), их id, время создания и пользователя, который их создал
  • show_automigrate — показывает таблицу всех существующих проектов и веток с которых и на которые происходят автоматические миграции (Automigrate Table)
  • log — выводит список всех совершенных миграций (Done Automigrate Table)

Флаг pattern, применяется для команд <add|delete|show_config|log>

  • Для add: Паттерн автомиграции в формате: srcProject{id|name}/srcBranch{id|name}=>receiveProject{id|name|regEx}/receiveBranch{id|name|regEx}
regEx — в формате как для PostgreSQL
  • Для delete: Паттерн автомиграции в формате: srcProject{id|name}/srcBranch{id|name}=>receiveProject{id|name|regEx}/receiveBranch{id|name|regEx}
Паттерн должен быть точно таким же, как он записан в Config Table
  • Для show_config: Паттерн автомиграции. Поиск будет происходить в следующем виде: ILIKE "'%"+pattern+"%'"
  • Для log: Флаг в формате srcProjectId/srcBranchId=>receiveProjectId/receiveBranchId или srcProjectName/srcBranchName=>receiveProjectName/receiveBranchName для вывода автомиграций с данным паттерном

Флаг id, применяется для command <delete|show_automigrate> в формате uuid

  • Для delete: id для удаления автомиграции (из Config Table)
  • Для show_automigrate: id ветки/проекта или конфигурации для нахождения его в таблице автомиграций (Automigrate Table) и вывода автомиграций, где присутствует данный id

Флаг format — формат вывода таблицы. Применяется для command <show_config|show_automigrate|log>

  • Для show_config:
  • table — вывод в виде таблицы
  • json — вывод в виде json
  • no-id — вывод без config id
Значения можно перечислить через запятую: json,no-id. По умолчанию — table.
  • Для show_automigrate|log:
  • table — вывод в виде таблицы
  • json — вывод в виде json
По умолчанию — table.

Также возможно использовать POST запрос по адресу /api/automigrate. В теле передается json, с полями action(not null), pattern, id. Выполняется по тому же принципу, что и в CLI.

Принцип работы сервиса:

  • При запуске сервера запускается сервис automigrate
  • При занесении новой миграции, находит все миграции, подходящие под паттерн, и копирует разметку на них
  • При удалении миграции, удаляет её из таблицы Config и удаляет из таблицы автомиграций
  • Не может копировать разметку с нескольких веток на одну (будет выдавать ошибку)
  • При любом изменении разметки у существующих веток (добавление/удаление/изменение комментариев, добавление снимка, добавление проекта, добавление ветки, изменение имени ветки/проекта, удаление контейнера, удаление снимка) происходит либо миграция разметки, либо добавление новых миграций в таблицу автомиграций и миграция разметки, либо удаление миграции из таблицы автомиграций (в зависимости от конкретной ситуации). При какой-либо ошибке выдает предупреждение, но даёт выполнить действие.
  • Единственный случай, когда сервис не даёт выполнить действие — загрузка результатов Svace через CLI: upload, либо import с флагом --upload. В этом случае сервис выдает ошибку миграции и отменяет загрузку. Такое может произойти, когда имя данной ветки (в качестве to_branch) подходит под несколько паттернов.

Аутентификация из переменных окружения

Пользователь может использовать следующие переменные окружения для выполнения аутентификации при использовании CLI

SVACER_AUTH_CREDS=login:password
SVACER_AUTH_TOKEN=token

В качестве токена нужно использовать токен, получаемый через REST endpoint /api/public/login

Аутентификация из файла

Для упрощения работы с клиентом svacer возможно сохранять некоторые параметры соединения и токен аутентификации для дальнейшего использования. Сохранение данных производится с помощью команды:

svacer server login --host [hostname] --port [restPort] --grpc [grpcPort] --ssl-ca-certs [certs_path] --user [username] --password [password] --out [file]

Команда выполняет подключение к серверу svacer по указанным параметрам (host, port, user, password), получает токен аутентификации и сохраняет все эти данные в файл. Для указания файла, в котором следует сохранять данные, используется опция --out . Если опция --out опущена, то данные будут записаны в файл svacer_conn.json в текущей папке. Пример использования команды приведен ниже:

svacer server login --host svacer.local --port 8080 --grpc 3002 --user admin --password --out cn.json

В данном примере клиент произведет попытку аутентификации на сервере svacer.local и полученный токен вместе с параметрами (host, port, grpc) будет записан в файл cn.json.

Для использования созданного ранее файла с данными необходимо использовать опцию --conn_file. Данная опция определена во всех командах, в которых определены параметры --user --password (то есть параметры аутентификации). Например, для выполнения импорта данных на сервер с использованием сохраненной информации можно использовать следующую команду:

svacer import --conn_file cn.json .

В примере выше клиент считает токен из файла cn.json и выполнит загрузку данных по указанным в файле параметрам host, port, grpc.

Также имя файла с данными подключения можно передавать через переменную окружения SVACER_CONN_FILE.

Вывод списка предупреждений

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

svacer marker list --host host --user user --password password --project project_name_or_id --branch branch_name_or_id --snapshot snapshot_name_or_id

Вывод:

#     warn                                 file                            line   review  msg                                                 
1000  INVARIANT_RESULT                     /.build/subst.c                 7080           Expression 'tl->word->flags | (1 << 21)' is always  
                                                                                          true , which may be caused by a logical error       
1001  DEREF_AFTER_NULL.LOOP                /.build/execute_cmd.c           3327           After having been compared to NULL value at execut  
                                                                                          e_cmd.c:3325, pointer 'l' is dereferenced at execu  
                                                                                          te_cmd.c:3327.                                      
1002  DEREF_AFTER_NULL.LOOP                /.build/variables.c             2749           After having been compared to NULL value at variab  
                                                                                          les.c:2656, pointer 'vc' is dereferenced at variab  
                                                                                          les.c:2749.                                         
1003  CHECK_AFTER_PASS_TO_PROC             /.build/redir.c                 1219           Variable 'redirector' was passed to function at re  
                                                                                          dir.c:1215 by calling function 'fcntl' that can't   
                                                                                          use negative values is checked for negative value   
                                                                                          at redir.c:1219.                                

При указании флага --out-format=json вывод будет произведен в JSON формате:

[{"id":"e0ec7389-42a0-403c-9ce2-bfaa3bfa0228","file":"/.build/subst.c","function":"WORD_DESC * parameter_brace_expand_rhs()","line":7080,"locID":1000,"lang":"CXX","tool":"CSA","warnClass":"INVARIANT_RESULT","mtid":"CSA.INVARIANT_RESULT.1","msg":"Expression 'tl-\u003eword-\u003eflags | (1 \u003c\u003c 21)' is always true , which may be caused by a logical error","details":"811ed8f680ae9b540707436615348aed6d32ee93","flags":0,"invariant":"TBXA/IYVZKVlH6f19tiGsd3stuI"},{"id":"184b85bf-a63f-4187-b290-25a5950b3353","file":"/.build/execute_cmd.c","function":"select_query","line":3327,"locID":1001,"

Слияние снимков из CLI (экспериментальная опция)

Пользователь может объединить несколько снимков в один используя команду

svacer container snapshot merge --host host --user user --password password --branch target_branch --name target_snapshot_name --snapshot val1 --snapshot val2 --snapshot val3 ...

При указании снимков для слияния и целевой ветки, пользователь может использовать либо UUID объектов либо формат

целевая ветка: <project name>:::<branch name>
снимок:        <project name>:::<branch name>:::<snapshot name>

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

Svacer server features

Поддержка сквозной аутентификации

Svacer поддерживает сквозную аутентификацию через reverse proxy. Для этого используется опция proxy-mode. При включении этой опции есть возможность проходить аутентификацию (используя HTTP Basic Authentication) на reverse proxy сервере и использовать эти данные для аутентификации на сервере Svacer.

При включенном proxy-mode используется header с прокси Authorization Basic ..., откуда Svacer берет имя пользователя и пароль, проверяет и аутентифицирует пользователя, если аккаунт с таким логином и паролем есть в БД пользователей Svacer.

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

 svacer-server run --proxy-mode

Хуки

Для использования хуков при запуске сервера нужно указать опцию --hooks <path to JSON file>. Эта опция задаёт файл, содержащий описание хуков, которые пользователь может вызывать из web-интерфейса. Каждый хук соответствует процессу или скрипту, который сервер запускает при вызове соответствующей команды из web-интерфейса.

Формат файла описания хуков следующий:

 {
   "hooks": [
     {
       "id": "<id>",
       "label": "<label >",
       "target": "<target>",
       "input": ["<param1>", "<param2>", ...],
       "cmd": "<path to executable>",
       "args": ["<arg1>", “<arg2>”, ...]
     },
     ...
   ]
 }

Параметры хуков

id Идентификатор хука. Должен быть уникальным в файле
label Имя команды, которую пользователь видит в web-интерфейсе
target Место в UI, в которое будет добавлена команда. Сейчас поддерживается только одно значение — default. Оно соответствует вкладке Details на правой панели пользовательского интерфейса
input Параметры, которые можно передать в запускаемый процесс, исходя из контекста вызова команды в web-интерфейсе.

Поддерживаемые значения:

  • markerID — UUID идентификатор маркера;
  • branchID — UUID идентификатор ветки;
  • snapshotID — UUID идентификатор снимка;
  • projectID — UUID идентификатор проекта;
  • url — URL маркера в web-интерфейсе, на котором была вызвана команда;
  • marker — будет заменен на полное имя временного файла, содержащего сериализованное в JSON представление маркера, который включает в себя его трассу и информацию о разметке
cmd Полный путь к процессу, который будет запущен. Не должен включать аргументы запуска
args Аргументы, передаваемые в запускаемый процесс. Полный список аргументов запускаемого процесса состоит из списка <args> и списка значений, соответствующих полю <input>

Типичный сценарий использования хуков — создание кейсов для выбранного предупреждения в системах отслеживания ошибок, таких как Jira или Gitlab. Примеры скриптов для этого можно найти на странице Примеры использования хуков.

Ограничение числа запросов

Чтобы ограничить число запросов на сервер Svacer, перед запуском сервера определите переменную окружения со следующими параметрами

SVACER_SERVER_THROTTLE_PARAMS=limit,backlogLimit,timeout
  • limit — число одновременных запросов
  • backlogLimit — размер бэклога для запросов, которые нельзя обработать сейчас
  • timeout — время ожидания запроса в бэклоге (формат 1m12s — duration)